type-crafter 0.4.0 → 0.6.0

package/dist/runtime.d.ts

@@ -1,4 +1,4 @@
-import type { Configuration, EnumTemplateInput, ExporterModuleTemplateInput, ObjectTemplateInput, OneOfTemplateInput, SpecFileData, TypeFilePath, TypesFileTemplateInput } from '$types';
+import type { Configuration, EnumTemplateInput, ExporterModuleTemplateInput, GeneratedReferencedType, ObjectTemplateInput, OneOfTemplateInput, SpecFileData, TypeFilePath, TypesFileTemplateInput } from '$types';
 declare function setConfig(newConfig: Configuration): void;
 declare function getConfig(): Configuration;
 declare function setSpecFileData(newSpecFileData: SpecFileData): void;
@@ -11,6 +11,10 @@ declare function getEnumTemplate(): HandlebarsTemplateDelegate<EnumTemplateInput
 declare function getOneOfTemplate(): HandlebarsTemplateDelegate<OneOfTemplateInput>;
 declare function setExpectedOutputFiles(newExpectedOutputFiles: Map<string, TypeFilePath>): void;
 declare function getExpectedOutputFiles(): Map<string, TypeFilePath>;
+declare function getCachedReferencedTypes(): Map<string, GeneratedReferencedType>;
+declare function getCachedReferenceType(referencePath: string): GeneratedReferencedType | null;
+declare function cacheReferenceType(referencePath: string, generatedData: GeneratedReferencedType): void;
+declare function getInputFilePath(absolutePath?: boolean): string;
 declare const _default: {
     getConfig: typeof getConfig;
     setConfig: typeof setConfig;
@@ -24,5 +28,9 @@ declare const _default: {
     getExpectedOutputFiles: typeof getExpectedOutputFiles;
     compileTemplates: typeof compileTemplates;
     getOneOfTemplate: typeof getOneOfTemplate;
+    getCachedReferencedTypes: typeof getCachedReferencedTypes;
+    getCachedReferenceType: typeof getCachedReferenceType;
+    cacheReferenceType: typeof cacheReferenceType;
+    getInputFilePath: typeof getInputFilePath;
 };
 export default _default;

package/dist/templates/typescript/enum-syntax.hbs

@@ -9,5 +9,5 @@
  */
 export type {{typeName}} =
 {{#each values}}
-  | {{#if (eq ../enumType 'string') }}'{{/if}}{{{this}}}{{#if (eq ../enumType 'string')}}'{{/if}}
+  | {{#if (eq ../type 'string') }}'{{/if}}{{{this}}}{{#if (eq ../type 'string')}}'{{/if}}
 {{/each}};

package/dist/templates/typescript/object-syntax.hbs

@@ -19,6 +19,6 @@ export type {{typeName}} = {
    * @example {{{this.example}}}
   {{/if}}
    */
-  {{@key}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
+  {{{jsonKey @key}}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
   {{/each}}
 };

package/dist/templates/typescript/oneOf-syntax.hbs

@@ -13,7 +13,7 @@ export type {{typeName}} =
         {{/each}}
       }
     {{else}}
-      {{this.templateInput.dataType}}
+      {{this.templateInput.type}}
     {{/if}}
   {{/if}}
 {{/each}};

package/dist/templates/typescript-with-decoders/enum-syntax.hbs

@@ -9,13 +9,13 @@
  */
 export type {{typeName}} =
 {{#each values}}
-  | {{#if (eq ../enumType 'string') }}'{{/if}}{{{this}}}{{#if (eq ../enumType 'string')}}'{{/if}}
+  | {{#if (eq ../type 'string') }}'{{/if}}{{{this}}}{{#if (eq ../type 'string')}}'{{/if}}
 {{/each}};
 
 export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
   switch (rawInput) {
     {{#each values}}
-    case {{#if (eq ../enumType 'string') }}'{{/if}}{{this}}{{#if (eq ../enumType 'string')}}'{{/if}}:
+    case {{#if (eq ../type 'string') }}'{{/if}}{{this}}{{#if (eq ../type 'string')}}'{{/if}}:
     {{/each}}
      return rawInput;
   }

package/dist/templates/typescript-with-decoders/object-syntax.hbs

@@ -19,20 +19,20 @@ export type {{typeName}} = {
    * @example {{{this.example}}}
   {{/if}}
    */
-  {{@key}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
+  {{{jsonKey @key}}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
   {{/each}}
 };
 
 export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
   if (isJSON(rawInput)) {
     {{#each properties}}
-    const {{@key}} = {{#if (eq this.primitiveType 'array') }} decodeArray(rawInput.{{@key}}, decode{{{toPascalCase this.composerType}}}){{else}} decode{{{toPascalCase this.type}}}(rawInput.{{@key}}){{/if}};
+    const decoded{{variableName @key}} = {{#if (eq this.primitiveType 'array') }} decodeArray(rawInput[{{{indexKey @key}}}], decode{{{toPascalCase this.composerType}}}){{else}} decode{{{toPascalCase this.type}}}(rawInput[{{{indexKey @key}}}]){{/if}};
     {{/each}}
 
     {{#if (areRequiredKeysPresent properties)}}
     if (
       {{#each (getRequiredKeys properties)}}
-      {{this}} === null{{#unless @last}} ||{{/unless}}
+      decoded{{toPascalCase this}} === null{{#unless @last}} ||{{/unless}}
       {{/each}}
     ) {
       return null;
@@ -41,7 +41,7 @@ export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
 
     return {
       {{#each properties}}
-      {{@key}},
+      {{{jsonKey @key}}}: decoded{{{variableName @key}}},
       {{/each}}
     };
   }

package/dist/templates/typescript-with-decoders/oneOf-syntax.hbs

@@ -7,7 +7,7 @@ export type {{typeName}} =
     {{else if (eq this.dataType 'object')}}
       C{{this.templateInput.typeName}}
     {{else}}
-      {{this.templateInput.dataType}}
+      {{this.templateInput.type}}
     {{/if}}
   {{/if}}
 {{/each}};
@@ -19,12 +19,12 @@ export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
     decodeC{{referencedType}}(rawInput)
   {{else if (eq this.dataType 'object')}}
     decodeC{{this.templateInput.typeName}}(rawInput)
-  {{else if (eq this.templateInput.primitiveType 'array')}}
-    decodeArray(rawInput, decode{{{toPascalCase this.templateInput.itemType}}})
+  {{else if (eq this.dataType 'array')}}
+    decodeArray(rawInput, decode{{{toPascalCase this.templateInput.composerType}}})
   {{else if this.templateInput.values}}
     decode{{this.templateInput.typeName}}(rawInput)
   {{else}}
-    decode{{{toPascalCase this.templateInput.dataType}}}(rawInput)
+    decode{{{toPascalCase this.templateInput.type}}}(rawInput)
   {{/if}}{{#unless @last}}??{{/unless}}
   {{/each}};
   return result;

package/dist/types/decoders.d.ts

@@ -1,6 +1,9 @@
-import type { EnumTemplateInput, GroupedTypesWriterMode, ObjectTemplateInputProperties, SpecFileData, TypesWriterMode } from '.';
+import type { GroupRef, EnumTemplateInput, GroupedTypesWriterMode, ObjectTemplateInputProperties, SpecFileData, TypeInfo, Types, TypesWriterMode, GroupTypesData } from '.';
 export declare function decodeGroupedTypesWriterMode(rawInput: unknown): GroupedTypesWriterMode | null;
 export declare function decodeTypesWriterMode(rawInput: unknown): TypesWriterMode | null;
 export declare function decodeSpecFileData(rawInput: unknown): SpecFileData | null;
+export declare function valueIsGroupRef(value: GroupTypesData): value is GroupRef;
+export declare function decodeTypes(rawInput: unknown): Types | null;
+export declare function decodeTypeInfo(rawInput: unknown): TypeInfo | null;
 export declare function decodeObjectTemplateInputProperties(rawInput: unknown): ObjectTemplateInputProperties | null;
 export declare function decodeEnumTemplateInput(rawInput: unknown): EnumTemplateInput | null;

package/dist/types/index.d.ts

@@ -36,6 +36,23 @@ export type FormatType = {
     default: string;
     [format: string]: string | undefined;
 };
+export type ReferenceType = 'local' | 'remote' | 'url';
+export type ReferenceMeta = {
+    completeSource: string;
+    sourceFile: string;
+    path: string;
+    type: ReferenceType;
+    name: string;
+};
+export type ResolvedTypeReferenceData = ReferenceMeta & {
+    typeInfo: TypeInfo;
+};
+export type ResolvedGroupReferenceData = ReferenceMeta & {
+    groupedTypes: Types;
+};
+export type GeneratedReferencedType = ResolvedTypeReferenceData & {
+    templateData: GeneratedType<TemplateInput>;
+};
 export type SpecFileData = {
     info: SpecInfo;
     groupedTypes: GroupedTypes | null;
@@ -46,10 +63,14 @@ export type SpecInfo = {
     title: string;
 };
 type GroupName = string;
-export type GroupedTypes = Record<GroupName, Types>;
+export type GroupedTypes = Record<GroupName, GroupTypesData>;
+export type GroupTypesData = Types | GroupRef;
+export type GroupRef = {
+    $ref: string;
+};
 type TypeName = string;
 export type Types = Record<TypeName, TypeInfo>;
-export type TypeInfo = {
+export type TypeInfo = TypeDescriptors & {
     required: string[] | null;
     type: TypeDataType | null;
     format: string | null;
@@ -58,27 +79,27 @@ export type TypeInfo = {
     $ref: string | null;
     oneOf: TypeInfo[] | null;
     enum: string[] | number[] | null;
-    description: string | null;
-    example: string | number | null;
 };
 type PropertyName = string;
 export type TypeProperties = Record<PropertyName, TypeInfo>;
 export type TypeDataType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object' | 'unknown';
-export type ObjectTemplateInput = {
-    typeName: string;
+export type TypeDescriptors = {
+    summary: string | null;
     example: string | number | null;
     description: string | null;
+};
+export type ObjectTemplateInput = TypeDescriptors & {
+    typeName: string;
+    type: string;
     properties: ObjectTemplateInputProperties;
 };
 export type ObjectTemplateInputProperties = Record<PropertyName, ObjectTemplateInputProperty>;
-export type ObjectTemplateInputProperty = {
+export type ObjectTemplateInputProperty = TypeDescriptors & {
     type: string;
     required: boolean;
     referenced: boolean;
     primitiveType: string;
     composerType: string | null;
-    example: string | number | null;
-    description: string | null;
 };
 export type ExporterModuleTemplateInput = {
     modules: string[];
@@ -94,15 +115,14 @@ export type ReferencedModule = {
     moduleRelativePath: string;
     referencedTypes: string[];
 };
-export type EnumTemplateInput = {
+export type EnumTemplateInput = TypeDescriptors & {
     typeName: string;
-    enumType: string;
+    type: string;
     values: string[] | number[];
-    example: string | number | null;
-    description: string | null;
 };
-export type OneOfTemplateInput = {
+export type OneOfTemplateInput = TypeDescriptors & {
     typeName: string;
+    type: string;
     compositions: OneOfTemplateInputComposition[];
 };
 export type OneOfTemplateInputComposition = {
@@ -112,25 +132,24 @@ export type OneOfTemplateInputComposition = {
     referencedType?: string;
     content?: string;
 };
-export type VariableTemplateInput = {
+export type VariableTemplateInput = TypeDescriptors & {
     typeName: string;
-    dataType: string;
-    primitiveType: string;
-    itemType?: string;
+    type: string;
+    composerType?: string;
 };
-export type TemplateInput = ObjectTemplateInput | EnumTemplateInput | VariableTemplateInput;
+export type TemplateInput = ObjectTemplateInput | EnumTemplateInput | OneOfTemplateInput | VariableTemplateInput;
 export type GenerationResult = {
     groupedTypes: GroupedTypesOutput;
     types: GeneratedTypes;
 };
-export type GeneratedType = {
+export type GeneratedType<TemplateType extends TemplateInput> = {
     content: string;
     references: Set<string>;
     primitives: Set<string>;
-    templateInput?: TemplateInput;
+    templateInput: TemplateType;
 };
 export type GroupedTypesOutput = Record<GroupName, GeneratedTypes>;
-export type GeneratedTypes = Record<TypeName, GeneratedType>;
+export type GeneratedTypes = Record<TypeName, GeneratedType<TemplateInput>>;
 export type TypeFilePath = {
     modulePath: string;
     filePath: string;

package/dist/utils/file-system.d.ts

@@ -6,3 +6,4 @@ export declare function deleteFolder(folderPath: string): Promise<void>;
 export declare function getCompleteFolderPath(folderName: string): Promise<string>;
 export declare function getExpectedWrittenPath(basePath: string, fileName: string): Promise<string>;
 export declare function writeFile(basePath: string, fileName: string, content: string): Promise<void>;
+export declare function readYaml(filePath: string): Promise<unknown>;

package/dist/utils/index.d.ts

@@ -8,7 +8,10 @@ export declare function getReferencedTypes(object: unknown): string[];
 export declare function getReferencedTypeModules(_referencedTypes: unknown, _writtenAt: string): unknown[];
 export declare function toPascalCase(input: string): string;
 export declare function toPascalCaseHelper(input: unknown): string | unknown;
+export declare function refineJSONKey(input: unknown): unknown;
+export declare function refineVariableName(input: unknown): unknown;
+export declare function refineIndexKey(input: unknown): unknown;
 export declare function registerTemplateHelpers(): void;
-export declare function readNestedValue(json: JSONObject, keyPath: string[]): JSONObject;
+export declare function readNestedValue(json: unknown, keyPath: string[]): JSONObject;
 export declare function generateRelativePath(fromPath: string, toPath: string): string;
 export declare function stripPrefix(value: string, prefix: string): string;

package/dist/writer/helpers.d.ts

@@ -1,3 +1,3 @@
-import type { TypeFilePath, Types } from '$types';
+import { type TypeFilePath, type Types } from '$types';
 export declare function generateTypesOutputFiles(types: Types | null, groupName?: string | null): Map<string, TypeFilePath>;
 export declare function generateExpectedOutputFile(): Map<string, TypeFilePath>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-crafter",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "A tool to generate types from a yaml schema for any language",
   "main": "./dist/index.js",
   "type": "module",
@@ -68,7 +68,7 @@
     "rollup": "^4.5.1",
     "rollup-plugin-copy": "^3.5.0",
     "tslib": "^2.6.2",
-    "type-decoder": "^1.2.0",
+    "type-decoder": "^2.0.1",
     "typescript": "^5.2.2",
     "yaml": "^2.3.2"
   }