@takeshape/schema 8.86.3 → 8.87.3

package/es/migration/index.js

@@ -18,6 +18,7 @@ import migrateToV3_12_3 from './to/v3.12.3';
 import migrateToV3_13_0 from './to/v3.13.0';
 import migrateToV3_14_0 from './to/v3.14.0';
 import migrateToV3_15_0 from './to/v3.15.0';
+import migrateToV3_16_0 from './to/v3.16.0';
 export const migrateTo = {
   'v3.0.0': migrateToV3_0_0,
   'v3.1.0': migrateToV3_1_0,
@@ -38,7 +39,8 @@ export const migrateTo = {
   'v3.12.3': migrateToV3_12_3,
   'v3.13.0': migrateToV3_13_0,
   'v3.14.0': migrateToV3_14_0,
-  'v3.15.0': migrateToV3_15_0
+  'v3.15.0': migrateToV3_15_0,
+  'v3.16.0': migrateToV3_16_0
 };
 export * from './utils';
 export const listTypePrefix = 'PaginatedList';

package/es/migration/to/v3.16.0.js

@@ -0,0 +1,10 @@
+const migrate = async (_, projectSchema) => {
+  /**
+   * No migration needed all changes are backwards compatible.
+   */
+  return { ...projectSchema,
+    schemaVersion: '3.16.0'
+  };
+};
+
+export default migrate;

package/es/project-schema/index.js

@@ -21,6 +21,7 @@ export * from './v3.12.3';
 export * from './v3.13.0';
 export * from './v3.14.0';
 export * from './v3.15.0';
+export * from './v3.16.0';
 export * from './v4.0.0';
 
 // Schema type utilities
@@ -63,5 +64,6 @@ export const isProjectSchemaV3_12_3 = createVersionPredicate('3.12.3');
 export const isProjectSchemaV3_13_0 = createVersionPredicate('3.13.0');
 export const isProjectSchemaV3_14_0 = createVersionPredicate('3.14.0');
 export const isProjectSchemaV3_15_0 = createVersionPredicate('3.15.0');
-export const isLatestProjectSchema = createVersionPredicate('3.15.0');
+export const isProjectSchemaV3_16_0 = createVersionPredicate('3.16.0');
+export const isLatestProjectSchema = createVersionPredicate('3.16.0');
 export const isProjectSchemaV4_0_0 = createVersionPredicate('4.0.0');

package/es/project-schema/migrate.js

@@ -1,6 +1,6 @@
 // This file is generated by "pnpm json2ts"
 import { migrateTo } from '../migration';
-import { isProjectSchemaV1_0_0, isProjectSchemaV3_0_0, isProjectSchemaV3_1_0, isProjectSchemaV3_2_0, isProjectSchemaV3_3_0, isProjectSchemaV3_4_0, isProjectSchemaV3_5_0, isProjectSchemaV3_5_1, isProjectSchemaV3_6_0, isProjectSchemaV3_7_0, isProjectSchemaV3_8_0, isProjectSchemaV3_9_0, isProjectSchemaV3_10_0, isProjectSchemaV3_11_0, isProjectSchemaV3_12_0, isProjectSchemaV3_12_1, isProjectSchemaV3_12_2, isProjectSchemaV3_12_3, isProjectSchemaV3_13_0, isProjectSchemaV3_14_0, isProjectSchemaV4_0_0, isLatestProjectSchema } from './index'; // eslint-disable-next-line complexity
+import { isProjectSchemaV1_0_0, isProjectSchemaV3_0_0, isProjectSchemaV3_1_0, isProjectSchemaV3_2_0, isProjectSchemaV3_3_0, isProjectSchemaV3_4_0, isProjectSchemaV3_5_0, isProjectSchemaV3_5_1, isProjectSchemaV3_6_0, isProjectSchemaV3_7_0, isProjectSchemaV3_8_0, isProjectSchemaV3_9_0, isProjectSchemaV3_10_0, isProjectSchemaV3_11_0, isProjectSchemaV3_12_0, isProjectSchemaV3_12_1, isProjectSchemaV3_12_2, isProjectSchemaV3_12_3, isProjectSchemaV3_13_0, isProjectSchemaV3_14_0, isProjectSchemaV3_15_0, isProjectSchemaV4_0_0, isLatestProjectSchema } from './index'; // eslint-disable-next-line complexity
 
 export async function migrateToLatestProjectSchema(context, projectSchema) {
   if (isLatestProjectSchema(projectSchema)) {
@@ -87,6 +87,10 @@ export async function migrateToLatestProjectSchema(context, projectSchema) {
     projectSchema = await migrateTo['v3.15.0'](context, projectSchema);
   }
 
+  if (isProjectSchemaV3_15_0(projectSchema)) {
+    projectSchema = await migrateTo['v3.16.0'](context, projectSchema);
+  }
+
   if (isProjectSchemaV4_0_0(projectSchema)) {
     throw new Error('You are using an unreleased schema version. Migration is not possible');
   }

package/es/project-schema/v3.16.0.js

@@ -0,0 +1 @@
+export {};

package/es/schema-util.js

@@ -518,15 +518,26 @@ export function getArgsShapeSchema(context, argsSchema) {
   }
 }
 
-const createShapeToPropertySchema = (projectSchema, definitions, definitionNames, useShapeIdDiscriminator = true) => {
+const createShapeToPropertySchema = (projectSchema, definitions, definitionNames, {
+  useShapeIdDiscriminator
+}) => {
   const rewriteRefs = (shape, addDiscriminator = false) => {
     const handleSchema = (propSchema, addDiscriminator = false) => {
       // Unwrap array schema
       propSchema = propSchema.items ?? propSchema;
 
       if (isOneOfSchema(propSchema)) {
+        const isUnion = isUnionSchema(propSchema);
+
+        if (useShapeIdDiscriminator && isUnion) {
+          propSchema.discriminator = {
+            propertyName: '_shapeId'
+          };
+          propSchema.required = ['_shapeId'];
+        }
+
         propSchema.oneOf.forEach(schema => {
-          handleSchema(schema, true);
+          handleSchema(schema, isUnion);
         });
         return;
       } // Add workflow validation
@@ -553,7 +564,16 @@ const createShapeToPropertySchema = (projectSchema, definitions, definitionNames
 
           if (!definitionNames.has(shapeName)) {
             definitionNames.add(shapeName);
-            definitions[shapeName] = rewriteRefs(shape, addDiscriminator);
+            const rewritten = rewriteRefs(shape, addDiscriminator);
+
+            if (useShapeIdDiscriminator && isObjectSchema(rewritten)) {
+              rewritten.properties._shapeId = {
+                type: 'string',
+                enum: [shape.id]
+              };
+            }
+
+            definitions[shapeName] = rewritten;
           }
         }
       }
@@ -572,17 +592,8 @@ const createShapeToPropertySchema = (projectSchema, definitions, definitionNames
 
     const shapeSchemaCopy = dereferenceObjectSchema(projectSchema, shapeSchema);
 
-    if (useShapeIdDiscriminator) {
-      if (addDiscriminator && shapeSchemaCopy.properties) {
-        shapeSchemaCopy.properties._shapeId = {
-          type: 'string',
-          enum: [shape.id]
-        };
-      }
-
-      if (addDiscriminator && shape.title) {
-        shapeSchemaCopy.title = shape.title;
-      }
+    if (useShapeIdDiscriminator && addDiscriminator && shape.title) {
+      shapeSchemaCopy.title = shape.title;
     }
 
     Object.values(shapeSchemaCopy.properties).forEach(schema => {
@@ -597,7 +608,9 @@ const createShapeToPropertySchema = (projectSchema, definitions, definitionNames
 export function shapeToPropertySchema(projectSchema, shape) {
   const definitions = {};
   const definitionNames = new Set();
-  const convert = createShapeToPropertySchema(projectSchema, definitions, definitionNames);
+  const convert = createShapeToPropertySchema(projectSchema, definitions, definitionNames, {
+    useShapeIdDiscriminator: true
+  });
   return { ...convert(shape),
     definitions
   };
@@ -605,7 +618,9 @@ export function shapeToPropertySchema(projectSchema, shape) {
 export function projectSchemaToJSONSchema(projectSchema) {
   const definitions = {};
   const definitionNames = new Set();
-  const convert = createShapeToPropertySchema(projectSchema, definitions, definitionNames, false);
+  const convert = createShapeToPropertySchema(projectSchema, definitions, definitionNames, {
+    useShapeIdDiscriminator: false
+  });
 
   for (const shape of Object.values(projectSchema.shapes)) {
     definitions[shape.name] = convert(shape);
@@ -630,7 +645,7 @@ export function getShapeDependencies(projectSchema, shape, predicate) {
 
         if (refShape && !shapeNames.has(refShape.name)) {
           shapeNames.add(refShape.name);
-          findDependencies(dereferenceSchema(projectSchema, refShape.schema));
+          findDependencies(dereferenceSchema(projectSchema, refShape.schema, ['shapes', refShape.name]));
         }
       } else if (isObjectSchema(schema) || isAllOfSchema(schema) || isOneOfSchema(schema)) {
         visitSchemaProperties(schema, [], findDependencies);

package/es/schemas/index.js

@@ -1,7 +1,7 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.15.0';
+export const CURRENT_SCHEMA_VERSION = '3.16.0';
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.15.0.json';
+export { default as latestSchemaJson } from './project-schema/v3.16.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
 import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
@@ -35,5 +35,6 @@ import projectSchemaV3_12_3 from './project-schema/v3.12.3.json';
 import projectSchemaV3_13_0 from './project-schema/v3.13.0.json';
 import projectSchemaV3_14_0 from './project-schema/v3.14.0.json';
 import projectSchemaV3_15_0 from './project-schema/v3.15.0.json';
+import projectSchemaV3_16_0 from './project-schema/v3.16.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
-export const allProjectSchemas = [metaSchemaV1_0_0, projectSchemaV1_0_0, metaSchemaV3_0_0, projectSchemaV3_0_0, metaSchemaV3_1_0, projectSchemaV3_1_0, metaSchemaV3_2_0, projectSchemaV3_2_0, metaSchemaV3_3_0, projectSchemaV3_3_0, metaSchemaV3_4_0, projectSchemaV3_4_0, metaSchemaV3_5_0, projectSchemaV3_5_0, metaSchemaV3_5_1, projectSchemaV3_5_1, metaSchemaV3_6_0, projectSchemaV3_6_0, metaSchemaV3_7_0, projectSchemaV3_7_0, metaSchemaV3_8_0, projectSchemaV3_8_0, metaSchemaV3_9_0, projectSchemaV3_9_0, projectSchemaV3_10_0, projectSchemaV3_11_0, projectSchemaV3_12_0, projectSchemaV3_12_1, projectSchemaV3_12_2, projectSchemaV3_12_3, projectSchemaV3_13_0, projectSchemaV3_14_0, projectSchemaV3_15_0, projectSchemaV4_0_0];
+export const allProjectSchemas = [metaSchemaV1_0_0, projectSchemaV1_0_0, metaSchemaV3_0_0, projectSchemaV3_0_0, metaSchemaV3_1_0, projectSchemaV3_1_0, metaSchemaV3_2_0, projectSchemaV3_2_0, metaSchemaV3_3_0, projectSchemaV3_3_0, metaSchemaV3_4_0, projectSchemaV3_4_0, metaSchemaV3_5_0, projectSchemaV3_5_0, metaSchemaV3_5_1, projectSchemaV3_5_1, metaSchemaV3_6_0, projectSchemaV3_6_0, metaSchemaV3_7_0, projectSchemaV3_7_0, metaSchemaV3_8_0, projectSchemaV3_8_0, metaSchemaV3_9_0, projectSchemaV3_9_0, projectSchemaV3_10_0, projectSchemaV3_11_0, projectSchemaV3_12_0, projectSchemaV3_12_1, projectSchemaV3_12_2, projectSchemaV3_12_3, projectSchemaV3_13_0, projectSchemaV3_14_0, projectSchemaV3_15_0, projectSchemaV3_16_0, projectSchemaV4_0_0];

package/es/schemas/index.ts

@@ -1,7 +1,7 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.15.0';
+export const CURRENT_SCHEMA_VERSION = '3.16.0';
 export {default as anyProjectSchema} from './project-schema.json';
-export {default as latestSchemaJson} from './project-schema/v3.15.0.json';
+export {default as latestSchemaJson} from './project-schema/v3.16.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
 import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
@@ -35,6 +35,7 @@ import projectSchemaV3_12_3 from './project-schema/v3.12.3.json';
 import projectSchemaV3_13_0 from './project-schema/v3.13.0.json';
 import projectSchemaV3_14_0 from './project-schema/v3.14.0.json';
 import projectSchemaV3_15_0 from './project-schema/v3.15.0.json';
+import projectSchemaV3_16_0 from './project-schema/v3.16.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
 export const allProjectSchemas = [
   metaSchemaV1_0_0,
@@ -70,5 +71,6 @@ export const allProjectSchemas = [
   projectSchemaV3_13_0,
   projectSchemaV3_14_0,
   projectSchemaV3_15_0,
+  projectSchemaV3_16_0,
   projectSchemaV4_0_0
 ];

package/es/schemas/project-schema/latest.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://schema.takeshape.io/project-schema/v3.15.0#",
+  "$id": "https://schema.takeshape.io/project-schema/v3.16.0#",
   "title": "Project Schema",
   "definitions": {
     "schemaArray": {
@@ -1435,6 +1435,14 @@
         "allOf": {
           "$ref": "#/definitions/schemaArray"
         },
+        "discriminator": {
+          "type": "object",
+          "properties": {
+            "propertyName": {
+              "type": "string"
+            }
+          }
+        },
         "oneOf": {
           "$ref": "#/definitions/schemaArray"
         },
@@ -2269,7 +2277,7 @@
     },
     "schemaVersion": {
       "type": "string",
-      "enum": ["3.15.0"],
+      "enum": ["3.16.0"],
       "description": "The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format."
     },
     "projectId": {