type-crafter 0.6.1 → 0.8.0

package/dist/index.js

@@ -3533,9 +3533,20 @@ function decodeTypes(rawInput) {
     }
     return null;
 }
+function decodeAdditionalPropertiesKeyType(rawInput) {
+    if (typeof rawInput === 'string') {
+        switch (rawInput) {
+            case 'string':
+            case 'number':
+                return rawInput;
+        }
+    }
+    return null;
+}
 function decodeTypeInfo(rawInput) {
     if (isJSON(rawInput)) {
         const _type = decodeTypeDataType(rawInput.type);
+        const additionalProperties = decodeAdditionalProperties(rawInput.additionalProperties);
         const result = {
             type: _type,
             required: decodeArray(rawInput.required, decodeString),
@@ -3547,6 +3558,8 @@ function decodeTypeInfo(rawInput) {
             description: decodeString(rawInput.description),
             example: decodeString(rawInput.example) ?? decodeNumber(rawInput.example),
             oneOf: decodeArray(rawInput.oneOf, decodeTypeInfo),
+            allOf: decodeArray(rawInput.allOf, decodeTypeInfo),
+            additionalProperties,
             enum: _type === 'string'
                 ? decodeArray(rawInput.enum, decodeString)
                 : _type === 'number'
@@ -3557,6 +3570,28 @@ function decodeTypeInfo(rawInput) {
     }
     return null;
 }
+function decodeAdditionalProperties(rawInput) {
+    return (decodeKeyedAdditionalProperties(rawInput) ?? decodeTypeInfo(rawInput) ?? decodeBoolean(rawInput));
+}
+function decodeKeyedAdditionalProperties(rawInput) {
+    if (isJSON(rawInput)) {
+        const keyType = decodeAdditionalPropertiesKeyType(rawInput.keyType);
+        const valueType = decodeTypeInfo(rawInput.valueType);
+        if (keyType !== null && valueType !== null) {
+            return {
+                keyType,
+                valueType
+            };
+        }
+    }
+    return null;
+}
+function valueIsKeyedAdditionalProperties(value) {
+    return decodeKeyedAdditionalProperties(value) !== null;
+}
+function valueIsTypeInfo(value) {
+    return decodeTypeInfo(value) !== null;
+}
 function decodeTypeProperties(rawInput) {
     if (isJSON(rawInput)) {
         const result = {};
@@ -11948,6 +11983,7 @@ let exporterModuleSyntaxTemplate = null;
 let typesFileSyntaxTemplate = null;
 let oneOfSyntaxTemplate = null;
 let enumSyntaxTemplate = null;
+let allOfSyntaxTemplate = null;
 const cachedReferencedTypes = new Map();
 let expectedOutputFiles = null;
 function setConfig(newConfig) {
@@ -11975,6 +12011,7 @@ function compileTemplates() {
     typesFileSyntaxTemplate = Handlebars.compile(config.template.typesFileSyntax);
     enumSyntaxTemplate = Handlebars.compile(config.template.enumSyntax);
     oneOfSyntaxTemplate = Handlebars.compile(config.template.oneOfSyntax);
+    allOfSyntaxTemplate = Handlebars.compile(config.template.allOfSyntax);
 }
 function getObjectTemplate() {
     if (objectSyntaxTemplate === null) {
@@ -12030,6 +12067,12 @@ function getInputFilePath(absolutePath = true) {
     }
     return absolutePath ? resolveFilePath(config$2.input) : config$2.input;
 }
+function getAllOfTemplate() {
+    if (allOfSyntaxTemplate === null) {
+        throw new RuntimeError('AllOf template not compiled!');
+    }
+    return allOfSyntaxTemplate;
+}
 var Runtime = {
     getConfig,
     setConfig,
@@ -12046,7 +12089,8 @@ var Runtime = {
     getCachedReferencedTypes,
     getCachedReferenceType,
     cacheReferenceType,
-    getInputFilePath
+    getInputFilePath,
+    getAllOfTemplate
 };
 
 const ALIAS = Symbol.for('yaml.alias');
@@ -19647,6 +19691,21 @@ function fillPatterns(input, patterns) {
     return result;
 }
 
+const placeholderTypeInfo = {
+    required: null,
+    type: null,
+    format: null,
+    items: null,
+    properties: null,
+    $ref: null,
+    oneOf: null,
+    allOf: null,
+    enum: null,
+    additionalProperties: null,
+    summary: null,
+    description: null,
+    example: null
+};
 /**
  * @description Generates the primitive type for the unit attribute in the spec.
  * @param typeName { string }
@@ -19688,6 +19747,39 @@ function getPrimitiveType(typeName, typeInfo) {
     result.primitives.add(languageDataType);
     return result;
 }
+async function generateAdditionalPropertiesType(typeName, typeInfo, parentTypes) {
+    let result = null;
+    const stringKeyType = getPrimitiveType(typeName, {
+        ...placeholderTypeInfo,
+        type: 'string'
+    }).templateInput.type;
+    if (typeof typeInfo.additionalProperties === 'boolean') {
+        result = {
+            keyType: stringKeyType,
+            valueType: getPrimitiveType(typeName, {
+                ...placeholderTypeInfo,
+                type: 'unknown'
+            }).templateInput.type
+        };
+    }
+    else if (valueIsKeyedAdditionalProperties(typeInfo.additionalProperties)) {
+        result = {
+            keyType: getPrimitiveType(typeName, {
+                ...placeholderTypeInfo,
+                type: typeInfo.additionalProperties.keyType
+            }).templateInput.type,
+            valueType: (await generateType(typeName + 'ValueType', typeInfo.additionalProperties.valueType, parentTypes)).templateInput.type
+        };
+    }
+    else if (valueIsTypeInfo(typeInfo.additionalProperties)) {
+        const valueType = await generateType(typeName + 'ValueType', typeInfo.additionalProperties, parentTypes);
+        result = {
+            keyType: stringKeyType,
+            valueType: valueType.templateInput.type
+        };
+    }
+    return result;
+}
 async function generateObjectType(typeName, typeInfo, parentTypes) {
     const templateInput = {
         typeName,
@@ -19708,7 +19800,10 @@ async function generateObjectType(typeName, typeInfo, parentTypes) {
         const reference = propertyDetails.$ref ?? null;
         const enumValues = propertyDetails.enum ?? null;
         // Throwing error in case neither property type nor reference to a different type is present
-        if (propertyType === null && reference === null && propertyDetails.oneOf === null) {
+        if (propertyType === null &&
+            reference === null &&
+            propertyDetails.oneOf === null &&
+            propertyDetails.additionalProperties === null) {
             throw new InvalidSpecFileError('Invalid property type for: ' + typeName + '.' + propertyName);
         }
         const primitiveType = propertyType ?? 'object';
@@ -19767,6 +19862,11 @@ async function generateObjectType(typeName, typeInfo, parentTypes) {
             }
         };
     }
+    // Generating additional property types
+    const additionalProperties = await generateAdditionalPropertiesType(typeName + 'AdditionalProperty', typeInfo, parentTypes);
+    if (additionalProperties !== null) {
+        templateInput.additionalProperties = additionalProperties;
+    }
     const result = {
         content: Runtime.getObjectTemplate()(templateInput) +
             (recursiveTypeGenOutput?.content ?? '') +
@@ -19924,6 +20024,58 @@ async function generateOneOfTypes(typeName, typeInfo, parentTypes) {
     result.content = Runtime.getOneOfTemplate()(templateInput);
     return result;
 }
+async function generateAllOfTypes(typeName, typeInfo, parentTypes) {
+    if (typeInfo.allOf === null || typeInfo.allOf.length === 0) {
+        throw new InvalidSpecFileError('Invalid allOf type for: ' + typeName);
+    }
+    const templateInput = {
+        typeName,
+        type: typeName,
+        compositions: [],
+        description: typeInfo.description,
+        example: typeInfo.example,
+        summary: typeInfo.summary
+    };
+    const result = {
+        content: '',
+        references: new Set(),
+        primitives: new Set(),
+        templateInput
+    };
+    for (let index = 0; index < typeInfo.allOf.length; index++) {
+        const allOfItem = typeInfo.allOf[index];
+        if (allOfItem.$ref !== null) {
+            const referenceData = await resolveTypeReference(allOfItem.$ref);
+            const composition = {
+                source: 'referenced',
+                referencedType: referenceData.name
+            };
+            templateInput.compositions.push(composition);
+            result.references.add(referenceData.name);
+        }
+        else {
+            const generatedType = await generateType(typeName + (index + 1), allOfItem, parentTypes);
+            if (generatedType === null) {
+                throw new InvalidSpecFileError('Invalid allOf type for: ' + typeName);
+            }
+            const composition = {
+                dataType: allOfItem.type,
+                templateInput: generatedType.templateInput,
+                source: 'inline',
+                content: generatedType.content
+            };
+            templateInput.compositions.push(composition);
+            for (const reference of generatedType.references.values()) {
+                result.references.add(reference);
+            }
+            for (const primitive of generatedType.primitives.values()) {
+                result.primitives.add(primitive);
+            }
+        }
+    }
+    result.content = Runtime.getAllOfTemplate()(templateInput);
+    return result;
+}
 function returnCyclicReference(typeName) {
     const templateInput = {
         typeName,
@@ -19954,6 +20106,9 @@ async function generateType(typeName, typeInfo, parentTypes) {
     if (typeInfo.oneOf !== null) {
         return await generateOneOfTypes(typeName, typeInfo, parentTypes);
     }
+    if (typeInfo.allOf !== null) {
+        return await generateAllOfTypes(typeName, typeInfo, parentTypes);
+    }
     if (typeInfo.type === 'array') {
         return await generateArrayType(typeName, typeInfo, parentTypes);
     }
@@ -20203,6 +20358,7 @@ async function config$1(inputFilePath, outputDirectory, typesWriterMode, grouped
     const typesFileSyntax = await readFile(directoryPrefix + 'templates/typescript/types-file-syntax.hbs', devMode);
     const enumSyntax = await readFile(directoryPrefix + 'templates/typescript/enum-syntax.hbs', devMode);
     const oneOfSyntax = await readFile(directoryPrefix + 'templates/typescript/oneOf-syntax.hbs', devMode);
+    const allOfSyntax = await readFile(directoryPrefix + 'templates/typescript/allOf-syntax.hbs', devMode);
     const config = {
         input: inputFilePath,
         output: {
@@ -20219,7 +20375,8 @@ async function config$1(inputFilePath, outputDirectory, typesWriterMode, grouped
             exporterModuleSyntax,
             typesFileSyntax,
             enumSyntax,
-            oneOfSyntax
+            oneOfSyntax,
+            allOfSyntax
         },
         language: {
             exporterModuleName: 'index',
@@ -20245,6 +20402,7 @@ async function config(inputFilePath, outputDirectory, typesWriterMode, groupedTy
     const typesFileSyntax = await readFile(directoryPrefix + 'templates/typescript-with-decoders/types-file-syntax.hbs', devMode);
     const enumSyntax = await readFile(directoryPrefix + 'templates/typescript-with-decoders/enum-syntax.hbs', devMode);
     const oneOfSyntax = await readFile(directoryPrefix + 'templates/typescript-with-decoders/oneOf-syntax.hbs', devMode);
+    const allOfSyntax = await readFile(directoryPrefix + 'templates/typescript-with-decoders/allOf-syntax.hbs', devMode);
     const config = {
         input: inputFilePath,
         output: {
@@ -20261,7 +20419,8 @@ async function config(inputFilePath, outputDirectory, typesWriterMode, groupedTy
             exporterModuleSyntax,
             typesFileSyntax,
             enumSyntax,
-            oneOfSyntax
+            oneOfSyntax,
+            allOfSyntax
         },
         language: {
             exporterModuleName: 'index',
@@ -20325,7 +20484,7 @@ async function runner(language, inputFilePath, outputDirectory, _typesWriterMode
     }
 }
 greeting();
-const program = new Command().version('0.6.1');
+const program = new Command().version('0.8.0');
 program
     .command('generate')
     .description('Generate types for your language from a type spec file')

package/dist/runtime.d.ts

@@ -1,4 +1,4 @@
-import type { Configuration, EnumTemplateInput, ExporterModuleTemplateInput, GeneratedReferencedType, ObjectTemplateInput, OneOfTemplateInput, SpecFileData, TypeFilePath, TypesFileTemplateInput } from '$types';
+import type { AllOfTemplateInput, 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;
@@ -15,6 +15,7 @@ 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 function getAllOfTemplate(): HandlebarsTemplateDelegate<AllOfTemplateInput>;
 declare const _default: {
     getConfig: typeof getConfig;
     setConfig: typeof setConfig;
@@ -32,5 +33,6 @@ declare const _default: {
     getCachedReferenceType: typeof getCachedReferenceType;
     cacheReferenceType: typeof cacheReferenceType;
     getInputFilePath: typeof getInputFilePath;
+    getAllOfTemplate: typeof getAllOfTemplate;
 };
 export default _default;

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

@@ -0,0 +1,19 @@
+export type {{typeName}} =
+  {{#each compositions}}
+  {{#if (eq this.source 'referenced')}}{{referencedType}}
+  {{else if (eq this.source 'inline')}}
+    {{#if this.templateInput.values}}
+      {{this.templateInput.typeName}}
+    {{else if (eq this.dataType 'object')}}
+      {{this.templateInput.typeName}}
+    {{else}}
+      {{this.templateInput.type}}
+    {{/if}}
+  {{/if}} {{#unless @last}} & {{/unless}}
+{{/each}};
+
+{{#each compositions}}
+{{#if (eq this.dataType 'object')}}
+{{{this.content}}}
+{{/if}}
+{{/each}}

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

@@ -21,4 +21,7 @@ export type {{typeName}} = {
    */
   {{{jsonKey @key}}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
   {{/each}}
+  {{#if additionalProperties}}
+  [keys: {{jsonKey additionalProperties.keyType}}]: {{additionalProperties.valueType}};
+  {{/if}}
 };

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

@@ -4,7 +4,7 @@ export type {{typeName}} =
   {{else if (eq this.source 'inline')}}
     {{#if this.templateInput.values}}
       {{#each this.templateInput.values}}
-        {{#unless @first}}|{{/unless}} {{#if (eq ../this.templateInput.enumType 'string') }}'{{/if}}{{{this}}}{{#if (eq ../this.templateInput/enumType 'string')}}'{{/if}}
+        {{#unless @first}}|{{/unless}} {{#if (eq ../this.templateInput.type 'string') }}'{{/if}}{{{this}}}{{#if (eq ../this.templateInput/type 'string')}}'{{/if}}
       {{/each}}
     {{else if (eq this.dataType 'object')}}
       {

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

@@ -0,0 +1,42 @@
+export type {{typeName}} =
+  {{#each compositions}}
+  {{#if (eq this.source 'referenced')}}{{referencedType}}
+  {{else if (eq this.source 'inline')}}
+    {{#if this.templateInput.values}}
+      {{this.templateInput.typeName}}
+    {{else if (eq this.dataType 'object')}}
+      {{this.templateInput.typeName}}
+    {{else}}
+      {{this.templateInput.type}}
+    {{/if}}
+  {{/if}} {{#unless @last}} & {{/unless}}
+{{/each}};
+
+{{#each compositions}}
+{{#if (eq this.dataType 'object')}}
+{{{this.content}}}
+{{/if}}
+{{/each}}
+
+export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
+  {{#each compositions}}
+  {{#if (eq this.source 'referenced')}}
+  const decoded{{referencedType}} = decode{{referencedType}}(rawInput);
+  {{else if (eq this.source 'inline')}}
+  const decoded{{toPascalCase this.templateInput.typeName}} = decode{{this.templateInput.typeName}}(rawInput);
+  {{/if}}
+  {{/each}}
+
+  if (
+    {{#each compositions}}decoded{{#if (eq this.source 'referenced')}}{{referencedType}}{{else}}{{toPascalCase this.templateInput.typeName}}{{/if}} !== null {{#unless @last}} && {{/unless}} {{/each}}
+    ) {
+      return {
+        {{#each compositions}}
+        {{#if (eq this.source 'referenced')}}...decoded{{referencedType}},
+        {{else}}...decoded{{toPascalCase this.templateInput.typeName}},
+        {{/if}}
+        {{/each}}
+      };
+    }
+  return null;
+}

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

@@ -21,6 +21,9 @@ export type {{typeName}} = {
    */
   {{{jsonKey @key}}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
   {{/each}}
+  {{#if additionalProperties}}
+  [keys: {{jsonKey additionalProperties.keyType}}]: {{additionalProperties.valueType}};
+  {{/if}}
 };
 
 export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
@@ -40,6 +43,9 @@ export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
     {{/if}}
 
     return {
+      {{#if additionalProperties}}
+      ...rawInput,
+      {{/if}}
       {{#each properties}}
       {{{jsonKey @key}}}: decoded{{{variableName @key}}},
       {{/each}}

package/dist/types/decoders.d.ts

@@ -1,9 +1,12 @@
-import type { GroupRef, EnumTemplateInput, GroupedTypesWriterMode, ObjectTemplateInputProperties, SpecFileData, TypeInfo, Types, TypesWriterMode, GroupTypesData } from '.';
+import type { GroupRef, EnumTemplateInput, GroupedTypesWriterMode, ObjectTemplateInputProperties, SpecFileData, TypeInfo, Types, TypesWriterMode, GroupTypesData, KeyedAdditionalProperties, AdditionalPropertiesKeyType } 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 decodeAdditionalPropertiesKeyType(rawInput: unknown): AdditionalPropertiesKeyType | null;
 export declare function decodeTypeInfo(rawInput: unknown): TypeInfo | null;
+export declare function valueIsKeyedAdditionalProperties(value: unknown): value is KeyedAdditionalProperties;
+export declare function valueIsTypeInfo(value: unknown): value is TypeInfo;
 export declare function decodeObjectTemplateInputProperties(rawInput: unknown): ObjectTemplateInputProperties | null;
 export declare function decodeEnumTemplateInput(rawInput: unknown): EnumTemplateInput | null;

package/dist/types/index.d.ts

@@ -22,6 +22,7 @@ export type Template = {
     typesFileSyntax: string;
     enumSyntax: string;
     oneOfSyntax: string;
+    allOfSyntax: string;
 };
 export type LanguageConfig = {
     exporterModuleName: string;
@@ -78,8 +79,16 @@ export type TypeInfo = TypeDescriptors & {
     properties: TypeProperties | null;
     $ref: string | null;
     oneOf: TypeInfo[] | null;
+    allOf: TypeInfo[] | null;
     enum: string[] | number[] | null;
+    additionalProperties: AdditionalProperties | null;
 };
+export type AdditionalProperties = KeyedAdditionalProperties | TypeInfo | boolean;
+export type KeyedAdditionalProperties = {
+    keyType: AdditionalPropertiesKeyType;
+    valueType: TypeInfo;
+};
+export type AdditionalPropertiesKeyType = 'string' | 'number';
 type PropertyName = string;
 export type TypeProperties = Record<PropertyName, TypeInfo>;
 export type TypeDataType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object' | 'unknown';
@@ -92,6 +101,7 @@ export type ObjectTemplateInput = TypeDescriptors & {
     typeName: string;
     type: string;
     properties: ObjectTemplateInputProperties;
+    additionalProperties?: AdditionalPropertiesTemplateInput;
 };
 export type ObjectTemplateInputProperties = Record<PropertyName, ObjectTemplateInputProperty>;
 export type ObjectTemplateInputProperty = TypeDescriptors & {
@@ -101,6 +111,10 @@ export type ObjectTemplateInputProperty = TypeDescriptors & {
     primitiveType: string;
     composerType: string | null;
 };
+export type AdditionalPropertiesTemplateInput = {
+    keyType: string;
+    valueType: string;
+};
 export type ExporterModuleTemplateInput = {
     modules: string[];
 };
@@ -132,12 +146,24 @@ export type OneOfTemplateInputComposition = {
     referencedType?: string;
     content?: string;
 };
+export type AllOfTemplateInput = TypeDescriptors & {
+    typeName: string;
+    type: string;
+    compositions: AllOfTemplateInputComposition[];
+};
+export type AllOfTemplateInputComposition = {
+    dataType?: TypeDataType | null;
+    templateInput?: TemplateInput;
+    source: 'inline' | 'referenced';
+    referencedType?: string;
+    content?: string;
+};
 export type VariableTemplateInput = TypeDescriptors & {
     typeName: string;
     type: string;
     composerType?: string;
 };
-export type TemplateInput = ObjectTemplateInput | EnumTemplateInput | OneOfTemplateInput | VariableTemplateInput;
+export type TemplateInput = ObjectTemplateInput | EnumTemplateInput | OneOfTemplateInput | AllOfTemplateInput | VariableTemplateInput;
 export type GenerationResult = {
     groupedTypes: GroupedTypesOutput;
     types: GeneratedTypes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-crafter",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "description": "A tool to generate types from a yaml schema for any language",
   "main": "./dist/index.js",
   "type": "module",