@takeshape/schema 8.87.2 → 8.89.2

package/es/builtin-schema.js

@@ -121,6 +121,29 @@ export const builtInShapes = {
       }
     }
   },
+  TSUser: {
+    id: 'TSUser',
+    name: 'TSUser',
+    title: 'TSUser',
+    schema: {
+      type: 'object',
+      properties: {
+        id: {
+          type: 'string'
+        },
+        email: {
+          type: 'string'
+        },
+        fullName: {
+          type: 'string'
+        },
+        avatarPath: {
+          type: 'string'
+        }
+      },
+      required: ['id', 'email', 'fullName']
+    }
+  },
   Asset: {
     id: 'ASSET',
     name: 'Asset',

package/es/migration/index.js

@@ -19,6 +19,7 @@ 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';
+import migrateToV3_17_0 from './to/v3.17.0';
 export const migrateTo = {
   'v3.0.0': migrateToV3_0_0,
   'v3.1.0': migrateToV3_1_0,
@@ -40,7 +41,8 @@ export const migrateTo = {
   'v3.13.0': migrateToV3_13_0,
   'v3.14.0': migrateToV3_14_0,
   'v3.15.0': migrateToV3_15_0,
-  'v3.16.0': migrateToV3_16_0
+  'v3.16.0': migrateToV3_16_0,
+  'v3.17.0': migrateToV3_17_0
 };
 export * from './utils';
 export const listTypePrefix = 'PaginatedList';

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

@@ -0,0 +1,27 @@
+import { visit } from '@takeshape/util';
+import get from 'lodash/get';
+import set from 'lodash/set';
+import omit from 'lodash/omit';
+
+const migrate = async (_, projectSchema) => {
+  visit(projectSchema, ['@user'], (_, path) => {
+    const parentPath = path.slice(0, -1);
+    const oldSchema = get(projectSchema, parentPath);
+    const newSchema = { ...omit(oldSchema, ['@user', 'type']),
+      '@ref': 'local:TSUser',
+      '@input': {
+        type: 'string'
+      },
+      '@resolver': {
+        name: 'takeshape:getUser',
+        service: 'takeshape:local'
+      }
+    };
+    set(projectSchema, parentPath, newSchema);
+  });
+  return { ...projectSchema,
+    schemaVersion: '3.17.0'
+  };
+};
+
+export default migrate;

package/es/project-schema/index.js

@@ -22,6 +22,7 @@ export * from './v3.13.0';
 export * from './v3.14.0';
 export * from './v3.15.0';
 export * from './v3.16.0';
+export * from './v3.17.0';
 export * from './v4.0.0';
 
 // Schema type utilities
@@ -65,5 +66,6 @@ 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 isProjectSchemaV3_16_0 = createVersionPredicate('3.16.0');
-export const isLatestProjectSchema = createVersionPredicate('3.16.0');
+export const isProjectSchemaV3_17_0 = createVersionPredicate('3.17.0');
+export const isLatestProjectSchema = createVersionPredicate('3.17.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, isProjectSchemaV3_15_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, isProjectSchemaV3_16_0, isProjectSchemaV4_0_0, isLatestProjectSchema } from './index'; // eslint-disable-next-line complexity
 
 export async function migrateToLatestProjectSchema(context, projectSchema) {
   if (isLatestProjectSchema(projectSchema)) {
@@ -91,6 +91,10 @@ export async function migrateToLatestProjectSchema(context, projectSchema) {
     projectSchema = await migrateTo['v3.16.0'](context, projectSchema);
   }
 
+  if (isProjectSchemaV3_16_0(projectSchema)) {
+    projectSchema = await migrateTo['v3.17.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.17.0.js

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

package/es/schema-util.js

@@ -66,8 +66,14 @@ const commonProperties = {
   },
   _createdBy: {
     title: 'Created By',
-    type: 'string',
-    '@user': true
+    '@ref': 'local:TSUser',
+    '@input': {
+      type: 'string'
+    },
+    '@resolver': {
+      name: 'takeshape:getUser',
+      service: 'takeshape:local'
+    }
   },
   _updatedAt: {
     title: 'Updated',
@@ -76,8 +82,14 @@ const commonProperties = {
   },
   _updatedBy: {
     title: 'Updated By',
-    type: 'string',
-    '@user': true
+    '@ref': 'local:TSUser',
+    '@input': {
+      type: 'string'
+    },
+    '@resolver': {
+      name: 'takeshape:getUser',
+      service: 'takeshape:local'
+    }
   },
   _schemaVersion: {
     title: 'Schema Version',
@@ -311,7 +323,7 @@ export function applyBuiltinPropertiesToShape(projectSchema, shape) {
   };
 } // Dependencies of these built-in shapes are automatically added by getBuiltinsUsed
 
-const requiredBuiltinShapes = ['Asset', 'TSRelationship', 'TsStaticSite'];
+const requiredBuiltinShapes = ['Asset', 'TSRelationship', 'TsStaticSite', 'TSUser'];
 /**
  * Get all built-in shapes that are depended on by the given project schema.
  * Required built-in shapes are always included.
@@ -564,7 +576,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;
           }
         }
       }
@@ -583,17 +604,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 => {

package/es/schemas/index.js

@@ -1,7 +1,7 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.16.0';
+export const CURRENT_SCHEMA_VERSION = '3.17.0';
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.16.0.json';
+export { default as latestSchemaJson } from './project-schema/v3.17.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';
@@ -36,5 +36,6 @@ 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 projectSchemaV3_17_0 from './project-schema/v3.17.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, projectSchemaV3_16_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, projectSchemaV3_17_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.16.0';
+export const CURRENT_SCHEMA_VERSION = '3.17.0';
 export {default as anyProjectSchema} from './project-schema.json';
-export {default as latestSchemaJson} from './project-schema/v3.16.0.json';
+export {default as latestSchemaJson} from './project-schema/v3.17.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';
@@ -36,6 +36,7 @@ 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 projectSchemaV3_17_0 from './project-schema/v3.17.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
 export const allProjectSchemas = [
   metaSchemaV1_0_0,
@@ -72,5 +73,6 @@ export const allProjectSchemas = [
   projectSchemaV3_14_0,
   projectSchemaV3_15_0,
   projectSchemaV3_16_0,
+  projectSchemaV3_17_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.16.0#",
+  "$id": "https://schema.takeshape.io/project-schema/v3.17.0#",
   "title": "Project Schema",
   "definitions": {
     "schemaArray": {
@@ -980,7 +980,8 @@
         },
         "shapeName": {
           "description": "A Shape name for the resolver to use.",
-          "type": "string"
+          "type": "string",
+          "minLength": 1
         },
         "args": {
           "description": "Mapping and serialization configuration for args.",
@@ -1009,7 +1010,7 @@
           "title": "InternalTakeshapeResolverName",
           "type": "string",
           "description": "Name of the resolver function.",
-          "enum": ["takeshape:getRelationship", "takeshape:taxonomySuggest", "takeshape:list", "takeshape:search"]
+          "enum": ["takeshape:getRelationship", "takeshape:taxonomySuggest", "takeshape:list", "takeshape:search", "takeshape:getUser"]
         },
         "service": {
           "type": "string",
@@ -1023,7 +1024,8 @@
         },
         "shapeName": {
           "description": "An optional Shape name for the resolver.",
-          "type": "string"
+          "type": "string",
+          "minLength": 1
         },
         "args": {
           "description": "Mapping and serialization configuration for args.",
@@ -1492,9 +1494,6 @@
         "@deprecationReason": {
           "type": "string"
         },
-        "@user": {
-          "type": "boolean"
-        },
         "@args": {
           "$ref": "#/definitions/args"
         },
@@ -2277,7 +2276,7 @@
     },
     "schemaVersion": {
       "type": "string",
-      "enum": ["3.16.0"],
+      "enum": ["3.17.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": {