@takeshape/schema 7.194.0

package/lib/migration.js

@@ -0,0 +1,463 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getRelationshipSchema = getRelationshipSchema;
+exports.migrateToContentSchemaV3 = migrateToContentSchemaV3;
+exports.contentTypeToShape = contentTypeToShape;
+exports.migrateToV3 = migrateToV3;
+exports.migrateToV3_1 = migrateToV3_1;
+exports.migrateToV3_2 = migrateToV3_2;
+exports.migrateToV3_3 = migrateToV3_3;
+exports.migrateToV3_4 = migrateToV3_4;
+exports.migrateToV3_5 = migrateToV3_5;
+exports.migrateToV3_5_1 = migrateToV3_5_1;
+exports.migrateToV3_6 = migrateToV3_6;
+exports.migrateToLatestProjectSchema = migrateToLatestProjectSchema;
+exports.normalizeSchemaVersion = normalizeSchemaVersion;
+exports.isV1Like = isV1Like;
+exports.isV1 = isV1;
+exports.isV3Like = isV3Like;
+exports.isV3 = isV3;
+exports.ensureLatest = ensureLatest;
+exports.listTypePrefix = void 0;
+
+var _pReduce = _interopRequireDefault(require("p-reduce"));
+
+var _forEach = _interopRequireDefault(require("lodash/forEach"));
+
+var _pick = _interopRequireDefault(require("lodash/pick"));
+
+var _util = require("@takeshape/util");
+
+var _schemaUtil = require("./schema-util");
+
+var _services = require("./services");
+
+var _types = require("./types");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const listTypePrefix = 'PaginatedList';
+exports.listTypePrefix = listTypePrefix;
+const annotationMap = {
+  l10n: '@l10n',
+  sensitive: '@sensitive',
+  syncLocaleStructure: '@syncLocaleStructure'
+};
+
+function getRelationshipSchema(relationship) {
+  const itemSchema = {
+    $ref: '#/shapes/TSRelationship/schema'
+  };
+
+  if (relationship.type === 'multiple') {
+    return {
+      type: 'array',
+      items: itemSchema,
+      '@relationship': relationship
+    };
+  }
+
+  return { ...itemSchema,
+    '@relationship': relationship
+  };
+}
+
+function isColor(schema) {
+  const {
+    type,
+    properties
+  } = schema;
+  return Boolean(type === 'object' && properties && properties.hsl && properties.hsv && properties.rgb && properties.hex);
+} // 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,
+        ...getRelationshipSchema({
+          shapeIds: contentTypeIds,
+          type: relationshipType !== null && relationshipType !== void 0 ? 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) {
+    var _schema$title;
+
+    const properties = {};
+    let shapes = {};
+    const shapeTitle = [params.shapeTitle, (0, _util.upperCamel)((_schema$title = schema.title) !== null && _schema$title !== void 0 ? _schema$title : params.name)].filter(Boolean).join(' ');
+    const shapeName = `${params.shapeName}${(0, _util.upperCamel)(params.name)}`;
+    const contentSourceId = `takeshape:local:${shapeName}`;
+    (0, _forEach.default)(schema.properties, (propSchema, name) => {
+      var _propSchema$key;
+
+      const {
+        schema: migratedPropSchema,
+        hoistedShapes
+      } = migrateToContentSchemaV3({ ...params,
+        shapeName,
+        shapeTitle,
+        depth: params.depth + 1,
+        schema: propSchema,
+        parentSchema: schema,
+        service: contentSourceId,
+        key: (_propSchema$key = propSchema.key) !== null && _propSchema$key !== void 0 ? _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 getModelType(contentType) {
+  if (contentType.single) {
+    return 'single';
+  }
+
+  if (contentType.taxonomy) {
+    return 'taxonomy';
+  }
+
+  return 'multiple';
+}
+
+function contentTypeToShape(contentType, contentTypeId) {
+  var _contentType$title;
+
+  const title = (_contentType$title = contentType.title) !== null && _contentType$title !== void 0 ? _contentType$title : contentType.name;
+  const name = (0, _util.upperCamel)(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 formatDate(timestamp) {
+  return (timestamp ? new Date(timestamp) : new Date()).toISOString();
+}
+
+function migrateToV3(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.upperCamel)(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: formatDate(created),
+    updated: formatDate(updated),
+    shapes,
+    forms
+  });
+}
+
+async function migrateToV3_1(context, projectSchema) {
+  const {
+    encryptFn,
+    decryptFn
+  } = context;
+  let services;
+  /**
+   * Services can only be migrated if a dataKey is present, otherwise they will need to be discarded.
+   */
+
+  if (projectSchema.services) {
+    services = await (0, _pReduce.default)(Object.entries(projectSchema.services), async (serviceMap, [serviceKey, serviceConfig]) => {
+      const auth = serviceConfig.auth && decryptFn(serviceConfig.auth);
+      const updatedServiceConfig = (0, _services.updateServiceConfigV3ToV3_1)({ ...serviceConfig,
+        auth
+      }, serviceKey);
+      const authentication = updatedServiceConfig === null || updatedServiceConfig === void 0 ? void 0 : updatedServiceConfig.authentication;
+      serviceMap[serviceKey] = { ...updatedServiceConfig,
+        authentication: (0, _types.isServiceAuthentication)(authentication) ? encryptFn(authentication) : authentication
+      };
+      return serviceMap;
+    }, {});
+  }
+
+  return (0, _util.deepClone)({ ...projectSchema,
+    services,
+    schemaVersion: '3.1.0'
+  });
+}
+
+function migrateToV3_2(projectSchema) {
+  /**
+   * No migration needed all changes are backwards compatible.
+   */
+  return { ...projectSchema,
+    schemaVersion: '3.2.0'
+  };
+}
+
+async function migrateToV3_3(context, projectSchema) {
+  const {
+    generateDataKeyFn
+  } = context;
+  const dataKey = projectSchema.dataKey ? projectSchema.dataKey : await generateDataKeyFn();
+  /**
+   * Generate a dataKey if none is present.
+   */
+
+  return { ...projectSchema,
+    schemaVersion: '3.3.0',
+    dataKey
+  };
+}
+
+function migrateToV3_4(projectSchema) {
+  /**
+   * No migration needed all changes are backwards compatible.
+   */
+  return { ...projectSchema,
+    schemaVersion: '3.4.0'
+  };
+}
+
+function migrateToV3_5(projectSchema) {
+  /**
+   * No migration needed all changes are backwards compatible.
+   */
+  return { ...projectSchema,
+    schemaVersion: '3.5.0'
+  };
+}
+
+function migrateToV3_5_1(projectSchema) {
+  /**
+   * No migration needed all changes are backwards compatible.
+   */
+  return { ...projectSchema,
+    schemaVersion: '3.5.1'
+  };
+}
+
+function migrateToV3_6(projectSchema) {
+  /**
+   * No migration needed all changes are backwards compatible.
+   */
+  return { ...projectSchema,
+    schemaVersion: '3.6.0'
+  };
+}
+
+async function migrateToLatestProjectSchema(context, projectSchema) {
+  if ((0, _types.isProjectSchemaV1)(projectSchema)) {
+    projectSchema = migrateToV3(projectSchema);
+  }
+
+  if ((0, _types.isProjectSchemaV3)(projectSchema)) {
+    projectSchema = await migrateToV3_1(context, projectSchema);
+  }
+
+  if ((0, _types.isProjectSchemaV3_1)(projectSchema)) {
+    projectSchema = migrateToV3_2(projectSchema);
+  }
+
+  if ((0, _types.isProjectSchemaV3_2)(projectSchema)) {
+    projectSchema = await migrateToV3_3(context, projectSchema);
+  }
+
+  if ((0, _types.isProjectSchemaV3_3)(projectSchema)) {
+    projectSchema = migrateToV3_4(projectSchema);
+  }
+
+  if ((0, _types.isProjectSchemaV3_4)(projectSchema)) {
+    projectSchema = migrateToV3_5(projectSchema);
+  }
+
+  if ((0, _types.isProjectSchemaV3_5)(projectSchema)) {
+    projectSchema = migrateToV3_5_1(projectSchema);
+  }
+
+  if ((0, _types.isProjectSchemaV3_5_1)(projectSchema)) {
+    projectSchema = migrateToV3_6(projectSchema);
+  }
+
+  return projectSchema;
+}
+
+function normalizeSchemaVersion(version) {
+  return version === undefined ? '1' : version;
+}
+
+function isV1Like(schema) {
+  return Boolean(schema.schemaVersion === '1' || schema.schemaVersion === undefined);
+}
+
+function isV1(schema) {
+  return Boolean(isV1Like(schema));
+}
+
+function isV3Like(schema) {
+  return schema.schemaVersion === '3';
+}
+
+function isV3(schema) {
+  return isV3Like(schema);
+}
+
+async function ensureLatest(context, schema) {
+  if (!schema || (0, _types.isLatestProjectSchema)(schema)) {
+    return schema;
+  }
+
+  return migrateToLatestProjectSchema(context, schema);
+}

package/lib/mocks.d.ts

@@ -0,0 +1,13 @@
+import type { ProjectSchema, ServiceConfig, StoredServiceConfig } from './project-schema';
+import type { ServiceKey } from './types';
+/**
+ * Like emptySchema, but setting a default `dataKey`. Only suitable for tests.
+ */
+export declare function createMockSchema(projectId: string, schema?: Partial<ProjectSchema>): ProjectSchema;
+/**
+ * Capturing a common pattern used in tests. Creates an empty schema, with a `dataKey` and defaults.
+ */
+export declare function createMockSchemaWithDefaults(projectId: string, schema?: Partial<ProjectSchema>): ProjectSchema;
+export declare function createMockServiceConfig(serviceKey: ServiceKey, serviceConfig?: Partial<ServiceConfig>): ServiceConfig;
+export declare function createMockStoredServiceConfig(serviceKey: ServiceKey, serviceConfig?: Partial<StoredServiceConfig>): StoredServiceConfig;
+//# sourceMappingURL=mocks.d.ts.map

package/lib/mocks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mocks.d.ts","sourceRoot":"","sources":["../../src/mocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAE,aAAa,EAAE,mBAAmB,EAAC,MAAM,kBAAkB,CAAC;AACxF,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,SAAS,CAAC;AAIxC;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,aAAa,CAAM,GAAG,aAAa,CAKtG;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,aAAa,CAAM,GAAG,aAAa,CAKlH;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,aAAa,CAgBrH;AAED,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,UAAU,EACtB,aAAa,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAC3C,mBAAmB,CAMrB"}

package/lib/mocks.js

@@ -0,0 +1,61 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createMockSchema = createMockSchema;
+exports.createMockSchemaWithDefaults = createMockSchemaWithDefaults;
+exports.createMockServiceConfig = createMockServiceConfig;
+exports.createMockStoredServiceConfig = createMockStoredServiceConfig;
+
+var _schemaUtil = require("./schema-util");
+
+var _util = require("@takeshape/util");
+
+/**
+ * Like emptySchema, but setting a default `dataKey`. Only suitable for tests.
+ */
+function createMockSchema(projectId, schema = {}) {
+  var _schema$dataKey;
+
+  return { ...(0, _schemaUtil.emptySchema)(projectId, (_schema$dataKey = schema.dataKey) !== null && _schema$dataKey !== void 0 ? _schema$dataKey : 'supersecret'),
+    ...schema
+  };
+}
+/**
+ * Capturing a common pattern used in tests. Creates an empty schema, with a `dataKey` and defaults.
+ */
+
+
+function createMockSchemaWithDefaults(projectId, schema = {}) {
+  var _schema$dataKey2;
+
+  return (0, _schemaUtil.applyDefaultsToSchema)({ ...(0, _schemaUtil.emptySchema)(projectId, (_schema$dataKey2 = schema.dataKey) !== null && _schema$dataKey2 !== void 0 ? _schema$dataKey2 : 'supersecret'),
+    ...schema
+  });
+}
+
+function createMockServiceConfig(serviceKey, serviceConfig) {
+  return {
+    id: serviceKey,
+    title: (0, _util.upperCamel)(serviceKey),
+    provider: 'generic',
+    serviceType: 'graphql',
+    namespace: (0, _util.upperCamel)(serviceKey),
+    authenticationType: 'bearer',
+    authentication: {
+      token: 'abc123'
+    },
+    options: {
+      endpoint: 'https://example.test/graphql'
+    },
+    ...serviceConfig
+  };
+}
+
+function createMockStoredServiceConfig(serviceKey, serviceConfig) {
+  return { ...createMockServiceConfig(serviceKey),
+    authentication: 'encrypted-abc123',
+    ...serviceConfig
+  };
+}

package/lib/patterns.d.ts

@@ -0,0 +1,13 @@
+export interface PatternMetadata {
+    name?: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    categories?: string[];
+}
+export interface Pattern {
+    id: string;
+    uri: string;
+    metadata: PatternMetadata;
+}
+//# sourceMappingURL=patterns.d.ts.map

package/lib/patterns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patterns.d.ts","sourceRoot":"","sources":["../../src/patterns.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,eAAe,CAAC;CAC3B"}

package/lib/patterns.js

@@ -0,0 +1 @@
+"use strict";

package/lib/project-schema/index.d.ts

@@ -0,0 +1,21 @@
+export * from './v3.6.0';
+export * from './v3.5.1';
+export * from './v3.5.0';
+export * from './v3.4.0';
+export * from './v3.3.0';
+export * from './v3.2.0';
+export * from './v3.1.0';
+export * from './v3.0.0';
+export * from './v1.0.0';
+import { ProjectSchema } from './v3.6.0';
+import { ProjectSchemaV3_5_1 } from './v3.5.1';
+import { ProjectSchemaV3_5_0 } from './v3.5.0';
+import { ProjectSchemaV3_4_0 } from './v3.4.0';
+import { ProjectSchemaV3_3_0 } from './v3.3.0';
+import { ProjectSchemaV3_2_0 } from './v3.2.0';
+import { ProjectSchemaV3_1_0 } from './v3.1.0';
+import { ProjectSchemaV3_0_0 } from './v3.0.0';
+import { ProjectSchemaV1_0_0 } from './v1.0.0';
+export declare type ProjectSchemaV3_6_0 = ProjectSchema;
+export declare type AnyProjectSchema = ProjectSchema | ProjectSchemaV3_5_1 | ProjectSchemaV3_5_0 | ProjectSchemaV3_4_0 | ProjectSchemaV3_3_0 | ProjectSchemaV3_2_0 | ProjectSchemaV3_1_0 | ProjectSchemaV3_0_0 | ProjectSchemaV1_0_0;
+//# sourceMappingURL=index.d.ts.map

package/lib/project-schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/project-schema/index.ts"],"names":[],"mappings":"AACA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AAC7C,oBAAY,mBAAmB,GAAG,aAAa,CAAC;AAChD,oBAAY,gBAAgB,GAAG,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC"}