type-crafter 0.8.2 → 0.9.0

package/dist/index.js

@@ -3550,6 +3550,7 @@ function decodeTypeInfo(rawInput) {
         const result = {
             type: _type,
             required: decodeArray(rawInput.required, decodeString),
+            optional: decodeArray(rawInput.optional, decodeString),
             properties: decodeTypeProperties(rawInput.properties),
             items: decodeTypeInfo(rawInput.items),
             format: decodeString(rawInput.format),
@@ -3627,6 +3628,7 @@ function decodeTypeDataType(rawInput) {
 function decodeObjectTemplateInputProperty(rawInput) {
     if (isJSON(rawInput)) {
         const required = decodeBoolean(rawInput.required);
+        const optional = decodeBoolean(rawInput.optional);
         const _type = decodeString(rawInput.type);
         const referenced = decodeBoolean(rawInput.referenced);
         const primitiveType = decodeString(rawInput.primitiveType);
@@ -3634,10 +3636,11 @@ function decodeObjectTemplateInputProperty(rawInput) {
         const summary = decodeString(rawInput.summary);
         const example = decodeString(rawInput.example) ?? decodeNumber(rawInput.example);
         const description = decodeString(rawInput.description);
-        if (required !== null && _type !== null && referenced !== null && primitiveType !== null) {
+        if (required !== null && _type !== null && referenced !== null && primitiveType !== null && optional !== null) {
             return {
                 type: _type,
                 required,
+                optional,
                 referenced,
                 primitiveType,
                 composerType,
@@ -19714,6 +19717,7 @@ function fillPatterns(input, patterns) {
 
 const placeholderTypeInfo = {
     required: null,
+    optional: null,
     type: null,
     format: null,
     items: null,
@@ -19880,7 +19884,8 @@ async function generateObjectType(typeName, typeInfo, parentTypes) {
                 composerType,
                 example: propertyDetails.example,
                 description: propertyDetails.description,
-                summary: propertyDetails.summary
+                summary: propertyDetails.summary,
+                optional: typeInfo.optional?.includes(propertyName) ?? false
             }
         };
     }
@@ -20508,7 +20513,7 @@ async function runner(language, inputFilePath, outputDirectory, _typesWriterMode
     }
 }
 greeting();
-const program = new Command().version('0.8.2');
+const program = new Command().version('0.9.0');
 program
     .command('generate')
     .description('Generate types for your language from a type spec file')

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

@@ -7,7 +7,7 @@
  * @example {{{example}}}
  {{/if}}
  */
-export type {{typeName}} = {{#if (not (isEmptyObject properties))}}  {
+export type {{typeName}} = {{#if (not (isEmptyObject properties))}}{
   {{#each properties}}
   /**
   {{#if this.description}}
@@ -18,8 +18,14 @@ export type {{typeName}} = {{#if (not (isEmptyObject properties))}}  {
   {{#if this.example}}
    * @example {{{this.example}}}
   {{/if}}
-   */
-  {{{jsonKey @key}}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
+  */
+  {{#if this.required}}
+  {{{jsonKey @key}}}: {{{this.type}}};
+  {{else if this.optional}}
+  {{{jsonKey @key}}}?: {{{this.type}}};
+  {{else}}
+  {{{jsonKey @key}}}: {{{this.type}}} | null;
+  {{/if}}
   {{/each}}
   {{#if additionalProperties}}
   [keys: {{jsonKey additionalProperties.keyType}}]: {{additionalProperties.valueType}};
@@ -32,7 +38,16 @@ Record<{{jsonKey additionalProperties.keyType}}, {{additionalProperties.valueTyp
 export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
   if (isJSON(rawInput)) {
     {{#each properties}}
-    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}};
+    const decoded{{variableName @key}} = {{#if this.referenced ~}}
+      decode{{{toPascalCase this.type}}}(rawInput[{{{indexKey @key}}}]);
+    {{~else~}}
+      {{~#if (eq this.primitiveType 'array')~}} 
+      decodeArray(rawInput[{{{indexKey @key}}}], decode{{{toPascalCase this.composerType}}})
+      {{~else~}}
+       {{#if this.optional}}_{{/if}}decode{{{toPascalCase this.type}}}(rawInput[{{{indexKey @key}}}])
+      {{~/if~}};
+    {{~/if}}
+
     {{/each}}
 
     {{#if (areRequiredKeysPresent properties)}}
@@ -50,7 +65,7 @@ export function decode{{typeName}}(rawInput: unknown): {{typeName}} | null {
       ...rawInput,
       {{/if}}
       {{#each properties}}
-      {{{jsonKey @key}}}: decoded{{{variableName @key}}},
+      {{{jsonKey @key}}}: decoded{{{variableName @key}}}{{#unless @last}},{{/unless}}
       {{/each}}
     };
   }

package/dist/templates/typescript-with-decoders/types-file-syntax.hbs

@@ -1,7 +1,7 @@
 {{#each (getReferencedTypeModules referencedTypes writtenAt)}}
 import { {{#each this.referencedTypes}}type {{this}}, decode{{this}}{{#unless @last}}, {{/unless}} {{/each}} } from '{{this.moduleRelativePath}}';
 {{/each}}
-import { isJSON, {{#each primitives}}decode{{{toPascalCase this}}}{{#unless @last}}, {{/unless}}{{/each}} } from 'type-decoder';
+import { isJSON, {{#each primitives}}decode{{{toPascalCase this}}}, _decode{{{toPascalCase this}}} {{#unless @last}}, {{/unless}}{{/each}} } from 'type-decoder';
 
 {{{typesContent}}}
 

package/dist/types/index.d.ts

@@ -73,6 +73,7 @@ type TypeName = string;
 export type Types = Record<TypeName, TypeInfo>;
 export type TypeInfo = TypeDescriptors & {
     required: string[] | null;
+    optional: string[] | null;
     type: TypeDataType | null;
     format: string | null;
     items: TypeInfo | null;
@@ -110,6 +111,7 @@ export type ObjectTemplateInputProperty = TypeDescriptors & {
     referenced: boolean;
     primitiveType: string;
     composerType: string | null;
+    optional: boolean;
 };
 export type AdditionalPropertiesTemplateInput = {
     keyType: string;

package/package.json

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