@takeshape/schema 8.35.1 → 8.35.2

package/es/migration.js

@@ -1,677 +0,0 @@
-import pReduce from 'p-reduce';
-import forEach from 'lodash/forEach';
-import pick from 'lodash/pick';
-import mapValues from 'lodash/mapValues';
-import isObject from 'lodash/isObject';
-import fromPairs from 'lodash/fromPairs';
-import { pascalCase, deepClone, visit } from '@takeshape/util';
-import { arraySchemaKeys, getShapeQueriesAndMutations, multipleRelationshipSchemaKeys, objectSchemaKeys, scalarSchemaKeys, schemaMetadataKeys } from './schema-util';
-import { updateServiceConfigV3ToV3_1 } from './migration-utils';
-import { isProjectSchemaV1, isProjectSchemaV3, isLatestProjectSchema, isProjectSchemaV3_1, isProjectSchemaV3_2, isProjectSchemaV3_3, isProjectSchemaV3_4, isProjectSchemaV3_5, isProjectSchemaV3_5_1, isProjectSchemaV3_6, isProjectSchemaV3_7, isProjectSchemaV3_8, isProjectSchemaV3_9, isProjectSchemaV3_10 } from './types/utils';
-export const listTypePrefix = 'PaginatedList';
-const annotationMap = {
-  l10n: '@l10n',
-  sensitive: '@sensitive',
-  syncLocaleStructure: '@syncLocaleStructure'
-};
-export 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
-
-
-export 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;
-  forEach(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: { ...pick(schema, scalarSchemaKeys),
-        '@mapping': mapping
-      }
-    };
-  }
-
-  const {
-    relationship
-  } = schema;
-
-  if (relationship) {
-    const {
-      contentTypeIds,
-      type: relationshipType,
-      relatedName
-    } = relationship;
-    return {
-      schema: { ...pick(schema, relationshipType === 'multiple' ? multipleRelationshipSchemaKeys : schemaMetadataKeys),
-        '@mapping': mapping,
-        ...getRelationshipSchema({
-          shapeIds: contentTypeIds,
-          type: relationshipType ?? 'single',
-          // Type is optional on assets
-          relatedName
-        })
-      }
-    };
-  }
-
-  if (type === 'object' && schema.draftjs) {
-    return {
-      schema: { ...pick(schema, scalarSchemaKeys),
-        '@mapping': mapping,
-        '@tag': 'draftjs'
-      }
-    };
-  }
-
-  if (isColor(schema)) {
-    return {
-      schema: { ...pick(schema, scalarSchemaKeys),
-        $ref: '#/shapes/TSColor/schema',
-        '@mapping': mapping
-      }
-    };
-  }
-
-  if (type === 'object' && schema.properties) {
-    const properties = {};
-    const shapes = {};
-    const shapeTitle = [params.shapeTitle, pascalCase(schema.title ?? params.name)].filter(Boolean).join(' ');
-    const shapeName = `${params.shapeName}${pascalCase(params.name)}`;
-    const contentSourceId = `takeshape:local:${shapeName}`;
-    forEach(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: { ...pick(rest, objectSchemaKeys),
-              type: 'object',
-              properties
-            }
-          }
-        }
-      };
-    }
-
-    return {
-      schema: { ...pick(schema, 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: { ...pick(schema, 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';
-}
-
-export function contentTypeToShape(contentType, contentTypeId) {
-  const title = contentType.title ?? contentType.name;
-  const name = 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 formatDate(timestamp) {
-  return (timestamp ? new Date(timestamp) : new Date()).toISOString();
-}
-
-export 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[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 deepClone({ ...rest,
-    ...getShapeQueriesAndMutations(Object.values(shapes)),
-    schemaVersion: '3',
-    created: formatDate(created),
-    updated: formatDate(updated),
-    shapes,
-    forms
-  });
-}
-export 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 pReduce(Object.entries(projectSchema.services), async (serviceMap, [serviceKey, serviceConfig]) => {
-      const auth = serviceConfig.auth && decryptFn(serviceConfig.auth);
-      const updatedServiceConfig = updateServiceConfigV3ToV3_1({ ...serviceConfig,
-        auth
-      }, serviceKey);
-      const authentication = updatedServiceConfig === null || updatedServiceConfig === void 0 ? void 0 : updatedServiceConfig.authentication;
-      serviceMap[serviceKey] = { ...updatedServiceConfig,
-        authentication: authentication && isObject(authentication) ? encryptFn(authentication) : authentication
-      };
-      return serviceMap;
-    }, {});
-  }
-
-  return deepClone({ ...projectSchema,
-    services,
-    schemaVersion: '3.1.0'
-  });
-}
-export function migrateToV3_2(projectSchema) {
-  /**
-   * No migration needed all changes are backwards compatible.
-   */
-  return { ...projectSchema,
-    schemaVersion: '3.2.0'
-  };
-}
-export 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
-  };
-}
-export function migrateToV3_4(projectSchema) {
-  /**
-   * No migration needed all changes are backwards compatible.
-   */
-  return { ...projectSchema,
-    schemaVersion: '3.4.0'
-  };
-}
-export function migrateToV3_5(projectSchema) {
-  /**
-   * No migration needed all changes are backwards compatible.
-   */
-  return { ...projectSchema,
-    schemaVersion: '3.5.0'
-  };
-}
-export function migrateToV3_5_1(projectSchema) {
-  /**
-   * No migration needed all changes are backwards compatible.
-   */
-  return { ...projectSchema,
-    schemaVersion: '3.5.1'
-  };
-}
-export function migrateToV3_6(projectSchema) {
-  /**
-   * No migration needed all changes are backwards compatible.
-   */
-  return { ...projectSchema,
-    schemaVersion: '3.6.0'
-  };
-}
-export function migrateToV3_7(projectSchema) {
-  /**
-   * No migration needed all changes are backwards compatible.
-   */
-  return { ...projectSchema,
-    schemaVersion: '3.7.0'
-  };
-}
-export function migrateToV3_8(projectSchema) {
-  /**
-   * No migration needed all changes are backwards compatible.
-   */
-  return { ...projectSchema,
-    schemaVersion: '3.8.0'
-  };
-}
-export function migrateToV3_9_0(projectSchema) {
-  /**
-   * Resolver props that are guaranteed in this version, and dependent on the
-   * resolver type. Ensure they exist.
-   */
-  const ensureResolverOptions = resolver => {
-    if (resolver.name.startsWith('takeshape')) {
-      if (!resolver.shapeName) {
-        var _resolver$options, _resolver$options2, _resolver$options3, _resolver$options4;
-
-        resolver.shapeName = ((_resolver$options = resolver.options) === null || _resolver$options === void 0 ? void 0 : _resolver$options.model) ?? ((_resolver$options2 = resolver.options) === null || _resolver$options2 === void 0 ? void 0 : _resolver$options2.indexedShape) ?? '';
-        (_resolver$options3 = resolver.options) === null || _resolver$options3 === void 0 ? true : delete _resolver$options3.model;
-        (_resolver$options4 = resolver.options) === null || _resolver$options4 === void 0 ? true : delete _resolver$options4.indexedShape;
-      }
-    }
-
-    if (resolver.name.startsWith('graphql')) {
-      if (!resolver.fieldName) {
-        var _resolver$options5, _resolver$options6;
-
-        resolver.fieldName = ((_resolver$options5 = resolver.options) === null || _resolver$options5 === void 0 ? void 0 : _resolver$options5.fieldName) ?? '';
-        (_resolver$options6 = resolver.options) === null || _resolver$options6 === void 0 ? true : delete _resolver$options6.fieldName;
-      }
-    }
-
-    if (resolver.name.startsWith('awsLambda')) {
-      if (!resolver.functionName) {
-        var _resolver$options7, _resolver$options8;
-
-        resolver.functionName = ((_resolver$options7 = resolver.options) === null || _resolver$options7 === void 0 ? void 0 : _resolver$options7.functionName) ?? '';
-        (_resolver$options8 = resolver.options) === null || _resolver$options8 === void 0 ? true : delete _resolver$options8.functionName;
-      }
-    }
-
-    if (resolver.name.startsWith('rest')) {
-      if (!resolver.path) {
-        var _resolver$options11;
-
-        if (resolver.pathParams) {
-          var _resolver$options9;
-
-          resolver.path = { ...resolver.pathParams,
-            serialize: { ...resolver.pathParams.serialize,
-              template: (_resolver$options9 = resolver.options) === null || _resolver$options9 === void 0 ? void 0 : _resolver$options9.path
-            }
-          };
-        } else {
-          var _resolver$options10;
-
-          resolver.path = ((_resolver$options10 = resolver.options) === null || _resolver$options10 === void 0 ? void 0 : _resolver$options10.path) ?? '';
-        }
-
-        (_resolver$options11 = resolver.options) === null || _resolver$options11 === void 0 ? true : delete _resolver$options11.path;
-      }
-    }
-    /**
-     * `resolver.name` was previously validated with app code and v3.9.0
-     * enumerates the previous validation, making this assertion safe.
-     */
-
-
-    return resolver;
-  };
-  /**
-   * Function will visit each resolver in the schema and mutate them.
-   */
-
-
-  visit(projectSchema, ['resolver', '@resolver'], resolver => {
-    if (resolver.compose) {
-      resolver.compose.forEach(ensureResolverOptions);
-    } else {
-      ensureResolverOptions(resolver);
-    }
-  });
-  return { ...projectSchema,
-    schemaVersion: '3.9.0'
-  };
-}
-
-function migrateQueryToV3_10(query, queryName) {
-  const {
-    args,
-    shape
-  } = query;
-
-  if (typeof args === 'object' && ('oneOf' in args || 'allOf' in args || '$ref' in args || '@ref' in args)) {
-    // As of 11/15/2021 no production schemas contained queries with these args
-    throw new Error(`Query "${queryName}" contains an unsupported arg schema ${JSON.stringify(args)}. Please contact support`);
-  }
-
-  if (typeof shape === 'object' && !shape.items['@ref']) {
-    // As of 11/15/2021 no production schemas contained queries with array return shapes that are not @refs
-    throw new Error(`Query "${queryName}" contains an unsupported shape schema ${JSON.stringify(shape)}. Please contact support`);
-  }
-
-  return query;
-}
-
-function migrateShapeToV3_10(shape) {
-  const {
-    schema,
-    ...rest
-  } = shape; // As of 11/15/2021 no production schemas contained shapes with array schemas
-
-  if ('type' in schema && schema.type === 'array') {
-    throw new Error(`Shape ${shape.name} uses an unsupported array schema. Please contact support`);
-  }
-
-  const newSchema = '$ref' in schema || '@ref' in schema ? {
-    allOf: [schema]
-  } : schema;
-  return { ...rest,
-    schema: newSchema
-  };
-}
-
-export function migrateToV3_10(projectSchema) {
-  const {
-    queries,
-    mutations,
-    shapes,
-    schemaVersion,
-    ...rest
-  } = projectSchema;
-  return { ...rest,
-    queries: mapValues(queries, migrateQueryToV3_10),
-    mutations: mapValues(mutations, migrateQueryToV3_10),
-    shapes: mapValues(shapes, migrateShapeToV3_10),
-    schemaVersion: '3.10.0'
-  };
-}
-export function migrateToV3_11_0({
-  decryptFn,
-  encryptFn
-}, projectSchema) {
-  const migratedServices = [];
-
-  for (const [serviceKey, serviceConfig] of Object.entries(projectSchema.services ?? {})) {
-    const {
-      authenticationType,
-      authentication
-    } = serviceConfig; // Migrate authentication, ensuring now required properties
-
-    if (authentication && authenticationType !== 'unknown' && authenticationType !== 'none') {
-      const decrypted = decryptFn(authentication);
-
-      if (!decrypted) {
-        throw new Error(`Service "${serviceKey}" authentication could not be decrypted. Please contact support.`);
-      }
-
-      let migrated;
-
-      if (authenticationType === 'searchParams') {
-        migrated = {
-          params: decrypted,
-          type: authenticationType
-        };
-      }
-
-      if (authenticationType === 'basic') {
-        migrated = {
-          username: '',
-          password: '',
-          ...decrypted,
-          type: authenticationType
-        };
-      }
-
-      if (authenticationType === 'bearer') {
-        migrated = {
-          token: '',
-          ...decrypted,
-          type: authenticationType
-        };
-      }
-
-      if (authenticationType === 'oauth2Bearer') {
-        migrated = {
-          token: '',
-          ...decrypted,
-          type: authenticationType
-        };
-      }
-
-      if (authenticationType === 'oauth2') {
-        migrated = {
-          grantType: 'clientCredentials',
-          clientId: '',
-          ...decrypted,
-          type: authenticationType
-        };
-      }
-
-      if (authenticationType === 'aws') {
-        migrated = {
-          awsAccessKeyId: '',
-          awsSecretAccessKey: '',
-          ...decrypted,
-          type: authenticationType
-        };
-      }
-
-      if (authenticationType === 'custom') {
-        migrated = { ...decrypted,
-          type: authenticationType
-        };
-      }
-
-      if (migrated) {
-        const migratedServiceConfig = { ...serviceConfig,
-          authentication: encryptFn(migrated)
-        };
-        migratedServices.push([serviceKey, migratedServiceConfig]);
-      } else {
-        migratedServices.push([serviceKey, serviceConfig]);
-      }
-    } else {
-      migratedServices.push([serviceKey, serviceConfig]);
-    }
-  }
-
-  return { ...projectSchema,
-    services: fromPairs(migratedServices),
-    schemaVersion: '3.11.0'
-  };
-}
-export 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 (isProjectSchemaV1(projectSchema)) {
-    projectSchema = migrateToV3(projectSchema);
-  }
-
-  if (isProjectSchemaV3(projectSchema)) {
-    projectSchema = await migrateToV3_1(context, projectSchema);
-  }
-
-  if (isProjectSchemaV3_1(projectSchema)) {
-    projectSchema = migrateToV3_2(projectSchema);
-  }
-
-  if (isProjectSchemaV3_2(projectSchema)) {
-    projectSchema = await migrateToV3_3(context, projectSchema);
-  }
-
-  if (isProjectSchemaV3_3(projectSchema)) {
-    projectSchema = migrateToV3_4(projectSchema);
-  }
-
-  if (isProjectSchemaV3_4(projectSchema)) {
-    projectSchema = migrateToV3_5(projectSchema);
-  }
-
-  if (isProjectSchemaV3_5(projectSchema)) {
-    projectSchema = migrateToV3_5_1(projectSchema);
-  }
-
-  if (isProjectSchemaV3_5_1(projectSchema)) {
-    projectSchema = migrateToV3_6(projectSchema);
-  }
-
-  if (isProjectSchemaV3_6(projectSchema)) {
-    projectSchema = migrateToV3_7(projectSchema);
-  }
-
-  if (isProjectSchemaV3_7(projectSchema)) {
-    projectSchema = migrateToV3_8(projectSchema);
-  }
-
-  if (isProjectSchemaV3_8(projectSchema)) {
-    projectSchema = migrateToV3_9_0(projectSchema);
-  }
-
-  if (isProjectSchemaV3_9(projectSchema)) {
-    projectSchema = migrateToV3_10(projectSchema);
-  }
-
-  if (isProjectSchemaV3_10(projectSchema)) {
-    projectSchema = migrateToV3_11_0(context, projectSchema);
-  }
-
-  return projectSchema;
-}
-export function normalizeSchemaVersion(version) {
-  return version === undefined ? '1' : version;
-}
-export function isV1Like(schema) {
-  return Boolean(schema.schemaVersion === '1' || schema.schemaVersion === undefined);
-}
-export function isV1(schema) {
-  return Boolean(isV1Like(schema));
-}
-export function isV3Like(schema) {
-  return schema.schemaVersion === '3';
-}
-export function isV3(schema) {
-  return isV3Like(schema);
-}
-export async function ensureLatest(context, schema) {
-  if (!schema || isLatestProjectSchema(schema)) {
-    return schema;
-  }
-
-  return migrateToLatestProjectSchema(context, schema);
-}

package/lib/migration-utils.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file is a stop-gap for this story: https://app.shortcut.com/takeshape/story/7140/reorganize-schema-migration-ts-into-a-directory
- */
-import type { ServiceKey } from './types/types';
-import type { StoredServiceConfigV3_1_0, ServiceConfigV3_1_0 } from './project-schema';
-/**
- * `graphql:my-key` `my-key`
- */
-export declare function parseV3ServiceStr(service: string): {
-    provider?: string;
-    id: string;
-};
-/**
- * Ensures a consistent service config, inluding updating the service
- * authentication object.
- */
-export declare function updateServiceConfigV3ToV3_1(serviceConfig: Record<string, unknown>, serviceKey: ServiceKey): StoredServiceConfigV3_1_0 | ServiceConfigV3_1_0;
-//# sourceMappingURL=migration-utils.d.ts.map

package/lib/migration-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"migration-utils.d.ts","sourceRoot":"","sources":["../../src/migration-utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAC,UAAU,EAA2B,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,EAAC,yBAAyB,EAAE,mBAAmB,EAA8B,MAAM,kBAAkB,CAAC;AAQlH;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAGlF;AAED;;;GAGG;AAEH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACtC,UAAU,EAAE,UAAU,GACrB,yBAAyB,GAAG,mBAAmB,CAkGjD"}