Fixed hydration for value type arrays and added support for yaml input in the tooling

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

Author: JBBianchi

tools/1_download-schemas.ts

@@ -17,7 +17,8 @@ import $RefParser from '@apidevtools/json-schema-ref-parser';
 import { promises as fsPromises } from 'fs';
 import * as path from 'path';
 import { URL } from 'url';
-import { schemaDir, reset, schemaUrl } from './utils';
+import { schemaDir, reset, jsonSchemaUrl, yamlSchemaUrl } from './utils';
+import * as yaml from 'js-yaml';
 
 const { writeFile, mkdir } = fsPromises;
 
@@ -29,21 +30,27 @@ const { writeFile, mkdir } = fsPromises;
  */
 const download = async (schemaUrl: URL, destDir: string): Promise<void> => {
   try {
-    await reset(destDir);
     const fileName = path.basename(schemaUrl.pathname);
+    const isJson = fileName.endsWith('.json');
     const urlBase = schemaUrl.href.replace(fileName, '');
     const $refParser = new $RefParser();
     await $refParser.resolve(schemaUrl.href);
     const externalSchemas = $refParser.$refs
       .paths()
       .filter((p, index, arr) => arr.indexOf(p) === index && p !== schemaUrl.href);
-    await writeFile(path.resolve(destDir, fileName), JSON.stringify($refParser.schema, null, 2));
+    await writeFile(
+      path.resolve(destDir, fileName),
+      isJson ? JSON.stringify($refParser.schema, null, 2) : yaml.dump($refParser.schema),
+    );
     externalSchemas.forEach(async (externalSchemaUrl: string) => {
       const externalSchema = $refParser.$refs.get(externalSchemaUrl);
       if (externalSchema) {
         const externalSchemaFileName = externalSchemaUrl.replace(urlBase, '');
         await mkdir(path.resolve(destDir, path.dirname(externalSchemaFileName)), { recursive: true });
-        await writeFile(path.resolve(destDir, externalSchemaFileName), JSON.stringify(externalSchema, null, 2));
+        await writeFile(
+          path.resolve(destDir, externalSchemaFileName),
+          isJson ? JSON.stringify(externalSchema, null, 2) : yaml.dump(externalSchema),
+        );
       }
     });
     return Promise.resolve();
@@ -52,4 +59,8 @@ const download = async (schemaUrl: URL, destDir: string): Promise<void> => {
   }
 };
 
-download(schemaUrl, schemaDir).then(console.log.bind(console)).catch(console.error.bind(console));
+reset(schemaDir)
+  .then(() => download(yamlSchemaUrl, schemaDir))
+  .then(() => download(jsonSchemaUrl, schemaDir))
+  .then(console.log.bind(console))
+  .catch(console.error.bind(console));

tools/2_generate-definitions.ts

@@ -19,6 +19,7 @@ import { promises as fsPromises } from 'fs';
 import * as path from 'path';
 import { fileHeader, inFileDisclaimer } from './consts';
 import { definitionsDir, isObject, reset, schemaDir, toPascalCase } from './utils';
+import * as yaml from 'js-yaml';
 
 const { writeFile, readFile } = fsPromises;
 
@@ -60,6 +61,7 @@ const metadataProperties = ['title', 'description', 'default', 'type'];
  * Embellishes the provided schema to increase its compatibility with json-schema-to-typescript, the resulting schema should keep the validation properties as the input one (phase 1)
  * - adds missing type:object properties // not necessary ?
  * - adds missing titles to objects
+ * - removes extra titles on value types
  * @param schema The schema to embellish
  * @param path The current path of the schema relative to the original schema
  * @param parentTitle The title of the parent object, if any
@@ -74,7 +76,7 @@ function prepareSchema(schema: any, path: string[] = ['#'], parentTitle: string
   }
   const newSchema = JSON.parse(JSON.stringify(schema));
   const parent = path.slice(-1)[0];
-  const schemaKeys = Object.keys(newSchema);
+  let schemaKeys = Object.keys(newSchema);
   const isItemWithAdditionalProperties =
     parent === 'additionalProperties' && path.slice(-2)[0] === 'items' && newSchema.properties; // only "useful" for SwitchTask.Switch.Cases
   if (!structuralObjectProperties.includes(parent) || isItemWithAdditionalProperties) {
@@ -86,6 +88,16 @@ function prepareSchema(schema: any, path: string[] = ['#'], parentTitle: string
     if (newSchema.title) {
       parentTitle = newSchema.title;
     }
+    if (
+      newSchema.title &&
+      newSchema.type &&
+      newSchema.type !== 'object' &&
+      newSchema.type !== 'array' &&
+      newSchema.title != 'RuntimeExpression' // RuntimeExpression is a string but used as its own type, we want to keep its title to build a JSON pointer later
+    ) {
+      delete newSchema.title;
+      schemaKeys = schemaKeys.filter((key) => key === 'title');
+    }
     if (
       !newSchema.title &&
       (!newSchema.type || newSchema.type === 'object' || newSchema.type === 'array') && // only naming object or array types
@@ -169,8 +181,16 @@ function mutateSchema(schema: any, path: string[] = ['#']): any {
  */
 async function generate(srcFile: string, destFile: string): Promise<void> {
   const options: Partial<Options> = {
-    customName: (schema: JSONSchema, keyNameFromDefinition: string | undefined) =>
-      schema.$id?.includes('serverlessworkflow.io') ? 'Workflow' : keyNameFromDefinition,
+    customName: (schema: JSONSchema, keyNameFromDefinition: string | undefined) => {
+      if (schema.$id?.includes('serverlessworkflow.io')) {
+        return 'Workflow';
+      }
+      if (keyNameFromDefinition === 'oauth2Token') {
+        // seems to ignore the title from this object, so forcing it...
+        return schema.title;
+      }
+      return keyNameFromDefinition;
+    },
     bannerComment: `${fileHeader}
 ${inFileDisclaimer}
   
@@ -181,8 +201,11 @@ ${inFileDisclaimer}
     //unreachableDefinitions: true,
   };
   const schemaText = await readFile(srcFile, { encoding: 'utf-8' });
-  let schema = prepareSchema(JSON.parse(schemaText));
-  await writeFile(srcFile.replace('workflow', '__internal_workflow'), JSON.stringify(schema, null, 2));
+  let schema = prepareSchema(yaml.load(schemaText));
+  await writeFile(
+    srcFile.replace('workflow', '__internal_workflow').replace('.yaml', '.json'),
+    JSON.stringify(schema, null, 2).replace('workflow.yaml', 'workflow.json'),
+  );
   schema = mutateSchema(schema);
   //await writeFile(srcFile.replace('workflow', '__mutated_workflow'), JSON.stringify(schema, null, 2));
   const declarations = await compile(schema, 'Workflow', options);
@@ -192,7 +215,7 @@ ${inFileDisclaimer}
   await writeFile(path.resolve(destDir, 'index.ts'), `${fileHeader}export * as Specification from './specification';`);
 }
 
-const srcFile = path.resolve(schemaDir, 'workflow.json');
+const srcFile = path.resolve(schemaDir, 'workflow.yaml');
 const destFile = path.resolve(definitionsDir, 'specification.ts');
 
 generate(srcFile, destFile).then(console.log.bind(console)).catch(console.error.bind(console));

tools/3_generate-validation-pointers.ts

@@ -20,6 +20,7 @@ import { fileHeader, inFileDisclaimer } from './consts';
 import { definitionsDir, isObject, reset, schemaDir, vallidationDir } from './utils';
 import { JSONSchema } from 'json-schema-to-typescript';
 import { getExportedDeclarations } from './reflection';
+import * as yaml from 'js-yaml';
 
 const { writeFile, readFile } = fsPromises;
 
@@ -66,8 +67,8 @@ async function generate(schemaFile: string, definitionFile: string, destFile: st
   const declarations = Array.from(getExportedDeclarations(definitions).keys())
     .filter((name) => name !== 'Workflow')
     .sort((a, b) => a.localeCompare(b));
-  const schema = JSON.parse(schemaTxt) as JSONSchema;
-  const baseUri = schema.$id + '#';
+  const schema = yaml.load(schemaTxt) as JSONSchema;
+  const baseUri = schema.$id.replace('.yaml', '.json') + '#';
   const jsonPointers = [
     ['Workflow', baseUri],
     ...declarations.map((name) => [name, getJsonPointer(schema, name, baseUri)]),

tools/4_generate-classes.ts

@@ -171,7 +171,7 @@ function getArrayLikeClassDeclaration(name: string, arrayTypeName: string, type:
 ${inFileDisclaimer}
 
 ${hydrationResult.imports.map((type) => `import { _${type} } from './${toKebabCase(normalizeKnownAllCaps(type))}';`)}
-import { Specification } from '../definitions';
+${hydrationResult.imports.length ? `import { Specification } from '../definitions';` : ''}
 import { ArrayHydrator } from '../../hydrator';
 import { getLifecycleHooks } from '../../lifecycle-hooks';
 import { validate } from '../../validation';

tools/reflection.ts

@@ -282,7 +282,9 @@ export function getArrayHydration(type: Type): HydrationResult {
   const arrayType = type.getArrayElementType() || getUnderlyingTypes(type)[0];
   const lines: string[] = ['if (model?.length) {', 'this.splice(0, this.length);'];
   const imports: string[] = [];
-  if (!arrayType.isAnonymous()) {
+  if (isValueType(arrayType)) {
+    lines.push(`model.forEach(item => this.push(item));`);
+  } else if (!arrayType.isAnonymous()) {
     const typeName = getTypeName(arrayType);
     imports.push(typeName);
     lines.push(`model.forEach(item => this.push(new _${typeName}(item)));`);

tools/utils.ts

@@ -95,6 +95,9 @@ const argv = yargs(process.argv.slice(2))
   })
   .parseSync();
 /** The URL to download the schema from */
-export const schemaUrl: URL = new URL(
+export const yamlSchemaUrl: URL = new URL(
+  argv.url || `https://serverlessworkflow.io/schemas/${schemaVersion}/workflow.yaml`,
+);
+export const jsonSchemaUrl: URL = new URL(
   argv.url || `https://serverlessworkflow.io/schemas/${schemaVersion}/workflow.json`,
 );