✨ feat: support programmatic usage

Author: linbudu599

CHANGELOG.md

@@ -1,12 +1,12 @@
-## 0.2.2 (2021-08-31)
+## 0.5.3 (2021-11-16)
 
 ### Changelog
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-#### 0.2.2
+#### 0.5.3
 
 - :construction: chore: update release workflow [`5ccfa43`](https://github.com/linbudu599/JSON2TypeGraphQLClass/commit/5ccfa43994a949dd89c1582f191f438312a0240d)
 - refactor [`584830a`](https://github.com/linbudu599/JSON2TypeGraphQLClass/commit/584830a263349b6db7653470e9439a70baae150d)

README.md

@@ -133,6 +133,42 @@ export class Root {
 }
 ```
 
+## Programmatic Usage
+
+```typescript
+import {
+  reader,
+  parser,
+  preprocessor,
+  generator,
+  writter,
+} from "json-type-graphql";
+
+export default async function handler(options: Options): Promise<void> {
+  // read from data source you want
+  // you can also use custom reader
+  const content = await reader(options.reader);
+
+  // make some custom processing
+  const preprocessed = preprocessor(content, normalizedPreprocessorOptions);
+
+  // parse content
+  const parsedInfo = parser(preprocessed, normalizedParserOptions);
+
+  fs.ensureFileSync(normalizedWritterOptions.outputPath);
+
+  const source = new Project().addSourceFileAtPath(
+    normalizedWritterOptions.outputPath
+  );
+
+  // generate AST and result!
+  generator(source, parsedInfo, normalizedGeneratorOptions);
+
+  // write!
+  writter(normalizedWritterOptions);
+}
+```
+
 ## Options
 
 ### Reader

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-type-graphql",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "Generate TypeGraphQL Class From JSON Object",
   "main": "dist/index.js",
   "repository": "https://github.com/linbudu599/JSON2TypeGraphQLClass.git",

src/index.ts

@@ -1,6 +1,5 @@
 import fs from "fs-extra";
 import { Project } from "ts-morph";
-import util from "util";
 
 import { reader } from "./reader";
 import { preprocessor } from "./preprocessor";
@@ -10,7 +9,7 @@ import { postprocessor } from "./postprocessor";
 import { checker } from "./checker";
 import { writter } from "./writter";
 
-import { ARRAY_ENTRY_STRUCTURE_PROP, DEFAULT_ENTRY_CLASS_NAME } from "./utils";
+import { normalizeOptions } from "./utils";
 import type { Options } from "./utils";
 
 /**
@@ -22,81 +21,39 @@ import type { Options } from "./utils";
 export default async function handler(options: Options): Promise<void> {
   const content = await reader(options.reader);
 
-  const { preserveObjectOnlyInArray = true, customPreprocessor = undefined } =
-    options?.preprocessor ?? {};
-
-  const {
-    forceNonNullable = true,
-    forceReturnType = false,
-    arrayEntryProp = ARRAY_ENTRY_STRUCTURE_PROP,
-    forceNonNullableListItem = false,
-  } = options.parser ?? {};
-
-  const {
-    prefix = false,
-    publicProps = [],
-    readonlyProps = [],
-    suffix = false,
-    entryClassName = DEFAULT_ENTRY_CLASS_NAME,
-    sort = true,
-  } = options.generator ?? {};
-
-  const { customPostprocessor = undefined } = options.postprocessor ?? {};
-
-  const {
-    disable: disableChecker = true,
-    keep = false,
-    execaOptions = {},
-    executeOptions = {},
-    buildSchemaOptions = {},
-  } = options.checker ?? {};
-
   const {
-    format = true,
-    override,
-    formatOptions,
-    outputPath,
-  } = options.writter ?? {};
+    normalizedPreprocessorOptions,
+    normalizedParserOptions,
+    normalizedGeneratorOptions,
+    normalizedPostprocessorOptions,
+    normalizedCheckerOptions,
+    normalizedWritterOptions,
+  } = normalizeOptions(options);
 
   const originInput = content;
 
-  const preprocessed = preprocessor(originInput, {
-    preserveObjectOnlyInArray,
-    customPreprocessor,
-  });
+  const preprocessed = preprocessor(originInput, normalizedPreprocessorOptions);
 
-  const parsedInfo = parser(preprocessed, {
-    forceNonNullable,
-    forceReturnType,
-    arrayEntryProp,
-    forceNonNullableListItem,
-  });
+  const parsedInfo = parser(preprocessed, normalizedParserOptions);
 
-  fs.ensureFileSync(outputPath);
+  fs.ensureFileSync(normalizedWritterOptions.outputPath);
 
-  const source = new Project().addSourceFileAtPath(outputPath);
+  const source = new Project().addSourceFileAtPath(
+    normalizedWritterOptions.outputPath
+  );
 
-  generator(source, parsedInfo, {
-    prefix,
-    publicProps,
-    readonlyProps,
-    entryClassName,
-    suffix,
-    sort,
-  });
+  generator(source, parsedInfo, normalizedGeneratorOptions);
 
-  postprocessor(source, {
-    customPostprocessor,
-    // removeUnusedDecorators,
-  });
+  postprocessor(source, normalizedPostprocessorOptions);
 
-  await checker(outputPath, {
-    disable: sort || disableChecker,
-    keep,
-    execaOptions,
-    executeOptions,
-    buildSchemaOptions,
-  });
-
-  writter({ outputPath, format, formatOptions, override });
+  await checker(normalizedWritterOptions.outputPath, normalizedCheckerOptions);
+  writter(normalizedWritterOptions);
 }
+
+export * from "./reader";
+export * from "./preprocessor";
+export * from "./parser";
+export * from "./generator";
+export * from "./postprocessor";
+export * from "./checker";
+export * from "./writter";

src/sample/demo.json

@@ -16,7 +16,7 @@
     "numberField": 200,
     "stringField": "success",
     "primitiveArrayField": [1, 2, 3, 4, 5],
-    "mixedFieldrs": [
+    "mixedFields": [
       1,
       2,
       {

src/sample/demo.ts

@@ -1,6 +1,7 @@
 import path from "path";
 import fs from "fs-extra";
 import transformer from "..";
+import { reader, parser, generator, checker, writter } from "..";
 
 const outputPath = path.join(__dirname, "./generated.ts");
 

src/utils.ts

@@ -155,6 +155,92 @@ export type Options = {
   writter: WriterOptions;
 };
 
+export type InferPartialTypeParam<T> = T extends Partial<infer R> ? R : T;
+
+export type NormalizedOptions = {
+  [K in keyof Omit<
+    Options,
+    "reader"
+  > as `normalized${Capitalize<K>}Options`]-?: InferPartialTypeParam<
+    Options[K]
+  >;
+};
+
+export function normalizeOptions(options: Options): NormalizedOptions {
+  const { preserveObjectOnlyInArray = true, customPreprocessor = undefined } =
+    options?.preprocessor ?? {};
+
+  const {
+    forceNonNullable = true,
+    forceReturnType = false,
+    arrayEntryProp = ARRAY_ENTRY_STRUCTURE_PROP,
+    forceNonNullableListItem = false,
+  } = options.parser ?? {};
+
+  const {
+    prefix = false,
+    publicProps = [],
+    readonlyProps = [],
+    suffix = false,
+    entryClassName = DEFAULT_ENTRY_CLASS_NAME,
+    sort = true,
+  } = options.generator ?? {};
+
+  const { customPostprocessor = undefined } = options.postprocessor ?? {};
+
+  const {
+    disable: disableChecker = true,
+    keep = false,
+    execaOptions = {},
+    executeOptions = {},
+    buildSchemaOptions = {},
+  } = options.checker ?? {};
+
+  const {
+    format = true,
+    override = false,
+    formatOptions = {},
+    outputPath,
+  } = options.writter ?? {};
+
+  return {
+    normalizedPreprocessorOptions: {
+      preserveObjectOnlyInArray,
+      customPreprocessor,
+    },
+    normalizedParserOptions: {
+      forceNonNullable,
+      forceReturnType,
+      arrayEntryProp,
+      forceNonNullableListItem,
+    },
+    normalizedGeneratorOptions: {
+      prefix,
+      publicProps,
+      readonlyProps,
+      suffix,
+      entryClassName,
+      sort,
+    },
+    normalizedPostprocessorOptions: {
+      customPostprocessor,
+    },
+    normalizedCheckerOptions: {
+      disable: sort || disableChecker,
+      keep,
+      execaOptions,
+      executeOptions,
+      buildSchemaOptions,
+    },
+    normalizedWritterOptions: {
+      format,
+      override,
+      formatOptions,
+      outputPath,
+    },
+  };
+}
+
 export type ProcessedFieldInfoObject = Record<string, ParsedFieldInfo>;
 
 /**