@takeshape/schema 8.31.0 → 8.35.2

package/examples/latest/stripe-starter-resolved.json

@@ -395,7 +395,7 @@
       "namespace": "Stripe",
       "serviceType": "openapi",
       "authenticationType": "bearer",
-      "authentication": "supersecret",
+      "authentication": "abc",
       "options": {
         "endpoint": "https://api.stripe.com/",
         "spec": "https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json"
@@ -29312,5 +29312,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }

package/examples/latest/user-schema-no-required.json

@@ -169,5 +169,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/user-schema-with-defaults.json

@@ -194,5 +194,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-export type { ProjectSchemaUpdate, ProjectSchemaMigrationContext } from './migration';
+export type { ProjectSchemaUpdate, ProjectSchemaMigrationContext } from './migration/types';
+export type { User } from './user-schema';
 export * from './content-schema-transform';
 export * from './get-is-leaf';
 export * from './project-schema';
@@ -9,9 +10,8 @@ export * from './taxonomies';
 export * from './workflows';
 export * from './builtin-schema';
 export * from './auth-schemas';
-export type { User } from './user-schema';
 export * from './api-version';
-export { listTypePrefix, ensureLatest, normalizeSchemaVersion, getRelationshipSchema, migrateToLatestProjectSchema } from './migration';
+export * from './migration';
 export * from './validate';
 export { builtInShapes } from './builtin-schema';
 export * from './versions';

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAC,mBAAmB,EAAE,6BAA6B,EAAC,MAAM,aAAa,CAAC;AACpF,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAE/B,YAAY,EAAC,IAAI,EAAC,MAAM,eAAe,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,OAAO,EACL,cAAc,EACd,YAAY,EACZ,sBAAsB,EACtB,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,aAAa,CAAC;AACrB,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAC/C,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAC,mBAAmB,EAAE,6BAA6B,EAAC,MAAM,mBAAmB,CAAC;AAE1F,YAAY,EAAC,IAAI,EAAC,MAAM,eAAe,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAC/C,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}

package/lib/index.js

@@ -4,12 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
-  builtInShapes: true,
-  listTypePrefix: true,
-  ensureLatest: true,
-  normalizeSchemaVersion: true,
-  getRelationshipSchema: true,
-  migrateToLatestProjectSchema: true
+  builtInShapes: true
 };
 Object.defineProperty(exports, "builtInShapes", {
   enumerable: true,
@@ -17,36 +12,6 @@ Object.defineProperty(exports, "builtInShapes", {
     return _builtinSchema.builtInShapes;
   }
 });
-Object.defineProperty(exports, "ensureLatest", {
-  enumerable: true,
-  get: function () {
-    return _migration.ensureLatest;
-  }
-});
-Object.defineProperty(exports, "getRelationshipSchema", {
-  enumerable: true,
-  get: function () {
-    return _migration.getRelationshipSchema;
-  }
-});
-Object.defineProperty(exports, "listTypePrefix", {
-  enumerable: true,
-  get: function () {
-    return _migration.listTypePrefix;
-  }
-});
-Object.defineProperty(exports, "migrateToLatestProjectSchema", {
-  enumerable: true,
-  get: function () {
-    return _migration.migrateToLatestProjectSchema;
-  }
-});
-Object.defineProperty(exports, "normalizeSchemaVersion", {
-  enumerable: true,
-  get: function () {
-    return _migration.normalizeSchemaVersion;
-  }
-});
 
 var _contentSchemaTransform = require("./content-schema-transform");
 
@@ -204,6 +169,18 @@ Object.keys(_apiVersion).forEach(function (key) {
 
 var _migration = require("./migration");
 
+Object.keys(_migration).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _migration[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _migration[key];
+    }
+  });
+});
+
 var _validate = require("./validate");
 
 Object.keys(_validate).forEach(function (key) {

package/lib/migration/index.d.ts

@@ -0,0 +1,7 @@
+import type { ProjectSchema, AnyProjectSchema } from '../project-schema';
+import type { ProjectSchemaMigrationContext } from './types';
+export * from './utils';
+export declare const listTypePrefix = "PaginatedList";
+export declare function migrateToLatestProjectSchema(context: ProjectSchemaMigrationContext, projectSchema: AnyProjectSchema): Promise<ProjectSchema>;
+export declare function ensureLatest(context: ProjectSchemaMigrationContext, schema?: AnyProjectSchema): Promise<ProjectSchema | undefined>;
+//# sourceMappingURL=index.d.ts.map

package/lib/migration/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/migration/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AACvE,OAAO,KAAK,EAAC,6BAA6B,EAAC,MAAM,SAAS,CAAC;AA+B3D,cAAc,SAAS,CAAC;AAExB,eAAO,MAAM,cAAc,kBAAkB,CAAC;AAE9C,wBAAsB,4BAA4B,CAChD,OAAO,EAAE,6BAA6B,EACtC,aAAa,EAAE,gBAAgB,GAC9B,OAAO,CAAC,aAAa,CAAC,CA0DxB;AAED,wBAAsB,YAAY,CAChC,OAAO,EAAE,6BAA6B,EACtC,MAAM,CAAC,EAAE,gBAAgB,GACxB,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAMpC"}

package/lib/migration/index.js

@@ -0,0 +1,128 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  listTypePrefix: true,
+  migrateToLatestProjectSchema: true,
+  ensureLatest: true
+};
+exports.ensureLatest = ensureLatest;
+exports.listTypePrefix = void 0;
+exports.migrateToLatestProjectSchema = migrateToLatestProjectSchema;
+
+var _utils = require("../types/utils");
+
+var _v = _interopRequireDefault(require("./to/v3.0.0"));
+
+var _v2 = _interopRequireDefault(require("./to/v3.1.0"));
+
+var _v3 = _interopRequireDefault(require("./to/v3.2.0"));
+
+var _v4 = _interopRequireDefault(require("./to/v3.3.0"));
+
+var _v5 = _interopRequireDefault(require("./to/v3.4.0"));
+
+var _v6 = _interopRequireDefault(require("./to/v3.5.0"));
+
+var _v7 = _interopRequireDefault(require("./to/v3.5.1"));
+
+var _v8 = _interopRequireDefault(require("./to/v3.6.0"));
+
+var _v9 = _interopRequireDefault(require("./to/v3.7.0"));
+
+var _v10 = _interopRequireDefault(require("./to/v3.8.0"));
+
+var _v11 = _interopRequireDefault(require("./to/v3.9.0"));
+
+var _v12 = _interopRequireDefault(require("./to/v3.10.0"));
+
+var _v13 = _interopRequireDefault(require("./to/v3.11.0"));
+
+var _utils2 = require("./utils");
+
+Object.keys(_utils2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _utils2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _utils2[key];
+    }
+  });
+});
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const listTypePrefix = 'PaginatedList';
+exports.listTypePrefix = listTypePrefix;
+
+async function migrateToLatestProjectSchema(context, projectSchema) {
+  if (projectSchema.schemaVersion === '4.0.0') {
+    throw new Error('You are using an unreleased schema version. Migration is not possible');
+  }
+
+  if ((0, _utils.isProjectSchemaV1)(projectSchema)) {
+    projectSchema = (0, _v.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3)(projectSchema)) {
+    projectSchema = await (0, _v2.default)(context, projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_1)(projectSchema)) {
+    projectSchema = (0, _v3.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_2)(projectSchema)) {
+    projectSchema = await (0, _v4.default)(context, projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_3)(projectSchema)) {
+    projectSchema = (0, _v5.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_4)(projectSchema)) {
+    projectSchema = (0, _v6.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_5)(projectSchema)) {
+    projectSchema = (0, _v7.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_5_1)(projectSchema)) {
+    projectSchema = (0, _v8.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_6)(projectSchema)) {
+    projectSchema = (0, _v9.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_7)(projectSchema)) {
+    projectSchema = (0, _v10.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_8)(projectSchema)) {
+    projectSchema = (0, _v11.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_9)(projectSchema)) {
+    projectSchema = (0, _v12.default)(projectSchema);
+  }
+
+  if ((0, _utils.isProjectSchemaV3_10)(projectSchema)) {
+    projectSchema = (0, _v13.default)(context, projectSchema);
+  }
+
+  return projectSchema;
+}
+
+async function ensureLatest(context, schema) {
+  if (!schema || (0, _utils.isLatestProjectSchema)(schema)) {
+    return schema;
+  }
+
+  return migrateToLatestProjectSchema(context, schema);
+}

package/lib/migration/to/v3.0.0.d.ts

@@ -0,0 +1,4 @@
+import type { ProjectSchemaV1_0_0, ProjectSchemaV3_0_0 } from '../../project-schema';
+declare function migrateToV3_0_0(projectSchema: ProjectSchemaV1_0_0): ProjectSchemaV3_0_0;
+export default migrateToV3_0_0;
+//# sourceMappingURL=v3.0.0.d.ts.map

package/lib/migration/to/v3.0.0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v3.0.0.d.ts","sourceRoot":"","sources":["../../../../src/migration/to/v3.0.0.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,mBAAmB,EACnB,mBAAmB,EAQpB,MAAM,sBAAsB,CAAC;AAiN9B,iBAAS,eAAe,CAAC,aAAa,EAAE,mBAAmB,GAAG,mBAAmB,CAuBhF;AAED,eAAe,eAAe,CAAC"}

package/lib/migration/to/v3.0.0.js

@@ -0,0 +1,260 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _forEach = _interopRequireDefault(require("lodash/forEach"));
+
+var _pick = _interopRequireDefault(require("lodash/pick"));
+
+var _util = require("@takeshape/util");
+
+var _schemaUtil = require("../../schema-util");
+
+var _utils = require("../utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const annotationMap = {
+  l10n: '@l10n',
+  sensitive: '@sensitive',
+  syncLocaleStructure: '@syncLocaleStructure'
+};
+
+function isColor(schema) {
+  const {
+    type,
+    properties
+  } = schema;
+  return Boolean(type === 'object' && properties && properties.hsl && properties.hsv && properties.rgb && properties.hex);
+}
+
+function getModelType(contentType) {
+  if (contentType.single) {
+    return 'single';
+  }
+
+  if (contentType.taxonomy) {
+    return 'taxonomy';
+  }
+
+  return 'multiple';
+} // eslint-disable-next-line complexity
+
+
+function migrateToContentSchemaV3(params) {
+  const {
+    schema,
+    service,
+    name,
+    key,
+    setSource,
+    omitAllSources
+  } = params;
+  const {
+    type
+  } = schema;
+  const mapping = !omitAllSources && key && setSource !== false && name !== key ? `${service}.${key}` : undefined;
+  (0, _forEach.default)(schema, (value, key) => {
+    if (annotationMap[key]) {
+      const newAnnotation = annotationMap[key];
+      schema[newAnnotation] = value; // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+
+      delete schema[key];
+    }
+  });
+
+  if (type === 'string' || type === 'boolean' || type === 'number' || type === 'integer') {
+    return {
+      schema: { ...(0, _pick.default)(schema, _schemaUtil.scalarSchemaKeys),
+        '@mapping': mapping
+      }
+    };
+  }
+
+  const {
+    relationship
+  } = schema;
+
+  if (relationship) {
+    const {
+      contentTypeIds,
+      type: relationshipType,
+      relatedName
+    } = relationship;
+    return {
+      schema: { ...(0, _pick.default)(schema, relationshipType === 'multiple' ? _schemaUtil.multipleRelationshipSchemaKeys : _schemaUtil.schemaMetadataKeys),
+        '@mapping': mapping,
+        ...(0, _utils.getRelationshipSchema)({
+          shapeIds: contentTypeIds,
+          type: relationshipType ?? 'single',
+          // Type is optional on assets
+          relatedName
+        })
+      }
+    };
+  }
+
+  if (type === 'object' && schema.draftjs) {
+    return {
+      schema: { ...(0, _pick.default)(schema, _schemaUtil.scalarSchemaKeys),
+        '@mapping': mapping,
+        '@tag': 'draftjs'
+      }
+    };
+  }
+
+  if (isColor(schema)) {
+    return {
+      schema: { ...(0, _pick.default)(schema, _schemaUtil.scalarSchemaKeys),
+        $ref: '#/shapes/TSColor/schema',
+        '@mapping': mapping
+      }
+    };
+  }
+
+  if (type === 'object' && schema.properties) {
+    const properties = {};
+    const shapes = {};
+    const shapeTitle = [params.shapeTitle, (0, _util.pascalCase)(schema.title ?? params.name)].filter(Boolean).join(' ');
+    const shapeName = `${params.shapeName}${(0, _util.pascalCase)(params.name)}`;
+    const contentSourceId = `takeshape:local:${shapeName}`;
+    (0, _forEach.default)(schema.properties, (propSchema, name) => {
+      const {
+        schema: migratedPropSchema,
+        hoistedShapes
+      } = migrateToContentSchemaV3({ ...params,
+        shapeName,
+        shapeTitle,
+        depth: params.depth + 1,
+        schema: propSchema,
+        parentSchema: schema,
+        service: contentSourceId,
+        key: propSchema.key ?? name,
+        name,
+        setSource: true
+      });
+      properties[name] = migratedPropSchema;
+      Object.assign(shapes, hoistedShapes);
+    });
+
+    if (params.depth > 0) {
+      const {
+        title,
+        description,
+        ...rest
+      } = schema;
+      return {
+        schema: {
+          title,
+          description,
+          '@mapping': mapping,
+          $ref: `#/shapes/${shapeName}/schema`
+        },
+        hoistedShapes: { ...shapes,
+          [shapeName]: {
+            id: name === key ? shapeName : key,
+            name: shapeName,
+            title: shapeTitle,
+            schema: { ...(0, _pick.default)(rest, _schemaUtil.objectSchemaKeys),
+              type: 'object',
+              properties
+            }
+          }
+        }
+      };
+    }
+
+    return {
+      schema: { ...(0, _pick.default)(schema, _schemaUtil.objectSchemaKeys),
+        properties,
+        '@mapping': mapping
+      },
+      hoistedShapes: shapes
+    };
+  }
+
+  if (schema.type === 'array' && schema.items) {
+    const {
+      schema: itemSchema,
+      hoistedShapes
+    } = migrateToContentSchemaV3({ ...params,
+      schema: schema.items,
+      parentSchema: schema,
+      service: 'parent',
+      setSource: false
+    });
+    return {
+      schema: { ...(0, _pick.default)(schema, _schemaUtil.arraySchemaKeys),
+        items: itemSchema,
+        '@mapping': mapping
+      },
+      hoistedShapes
+    };
+  }
+
+  throw new Error(`Unknown schema type "${type}"`);
+}
+
+function contentTypeToShape(contentType, contentTypeId) {
+  const title = contentType.title ?? contentType.name;
+  const name = (0, _util.pascalCase)(contentType.name);
+  const contentSourceId = `takeshape:local:${name}`;
+  const {
+    schema,
+    hoistedShapes
+  } = migrateToContentSchemaV3({
+    shapeName: name,
+    shapeTitle: title,
+    schema: contentType.schema,
+    service: contentSourceId,
+    name: '',
+    key: '',
+    depth: 0
+  });
+  return {
+    [name]: {
+      id: contentTypeId,
+      name,
+      title,
+      model: {
+        type: getModelType(contentType)
+      },
+      workflow: contentType.workflow,
+      schema: schema
+    },
+    ...hoistedShapes
+  };
+}
+
+function migrateToV3_0_0(projectSchema) {
+  const {
+    contentTypes,
+    created,
+    updated,
+    ...rest
+  } = projectSchema;
+  const shapes = {};
+  const forms = {};
+  Object.keys(contentTypes).forEach(contentTypeId => {
+    const contentType = contentTypes[contentTypeId];
+    Object.assign(shapes, contentTypeToShape(contentType, contentTypeId));
+    forms[(0, _util.pascalCase)(contentType.name)] = contentType.forms;
+  }); // Use deepClone to drop undefined values, this improves compatibility with validation and testing
+  // Schemas are typically saved in Dynamo or JSON files which also remove undefined values
+  // Dropping them here is done for consistency's sake
+
+  return (0, _util.deepClone)({ ...rest,
+    ...(0, _schemaUtil.getShapeQueriesAndMutations)(Object.values(shapes)),
+    schemaVersion: '3',
+    created: (0, _utils.formatDate)(created),
+    updated: (0, _utils.formatDate)(updated),
+    shapes,
+    forms
+  });
+}
+
+var _default = migrateToV3_0_0;
+exports.default = _default;

package/lib/migration/to/v3.1.0.d.ts

@@ -0,0 +1,5 @@
+import type { ProjectSchemaV3_0_0, ProjectSchemaV3_1_0 } from '../../project-schema';
+import type { ProjectSchemaMigrationContext } from '../types';
+declare function migrateToV3_1(context: ProjectSchemaMigrationContext, projectSchema: ProjectSchemaV3_0_0): Promise<ProjectSchemaV3_1_0>;
+export default migrateToV3_1;
+//# sourceMappingURL=v3.1.0.d.ts.map

package/lib/migration/to/v3.1.0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v3.1.0.d.ts","sourceRoot":"","sources":["../../../../src/migration/to/v3.1.0.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EAIpB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,EAAC,6BAA6B,EAAC,MAAM,UAAU,CAAC;AAiM5D,iBAAe,aAAa,CAC1B,OAAO,EAAE,6BAA6B,EACtC,aAAa,EAAE,mBAAmB,GACjC,OAAO,CAAC,mBAAmB,CAAC,CAgC9B;AAED,eAAe,aAAa,CAAC"}