@takeshape/schema 8.20.0 → 8.23.0

package/es/enum.js

@@ -1,4 +1,4 @@
-export function isEnumSchema(schema) {
+export function isEnumLikeSchema(schema) {
   if (schema.enum) {
     return true;
   }

package/es/get-is-leaf.js

@@ -3,13 +3,13 @@ import { getKey, isBuiltinType } from './schema-util';
 import { followRef, getRefShapeName } from './refs';
 const scalarTags = new Set(['draftjs']);
 
-function isLeafTypeV3(projectSchema, contentSchema) {
-  const type = getType(contentSchema);
+function isLeafTypeV3(projectSchema, propertySchema) {
+  const type = getType(propertySchema);
   return Boolean( // Must have key
-  getKey(contentSchema) && ( // If is not a structure, then is a leaf
+  getKey(propertySchema) && ( // If is not a structure, then is a leaf
   !['object', 'array'].includes(type) || // If is relationship, then is a leaf
-  contentSchema['@relationship'] || contentSchema['@tag'] && scalarTags.has(contentSchema['@tag']) || // If is array, then should not be a synchronized structure
-  type === 'array' && !contentSchema['@syncLocaleStructure'] || isBuiltinType(projectSchema, contentSchema)));
+  propertySchema['@relationship'] || propertySchema['@tag'] && scalarTags.has(propertySchema['@tag']) || // If is array, then should not be a synchronized structure
+  type === 'array' && !propertySchema['@syncLocaleStructure'] || isBuiltinType(projectSchema, propertySchema)));
 }
 
 export function getIsLeaf(projectSchema, shapeSchema) {

package/es/layers/type-utils.js

@@ -2,7 +2,7 @@ import { isObject } from '@takeshape/util';
 import isPlainObject from 'lodash/isPlainObject';
 import isString from 'lodash/isString';
 import isArray from 'lodash/isArray';
-import { latestMetaSchemaJson } from '../schemas';
+import { latestSchemaJson } from '../schemas';
 
 /** Resolver Type Utils **/
 
@@ -23,7 +23,7 @@ const {
     restResolver,
     awsLambdaResolver
   }
-} = latestMetaSchemaJson;
+} = latestSchemaJson;
 export function isTakeshapeResolver(resolver) {
   return takeshapeResolver.properties.name.enum.includes(resolver.name);
 }

package/es/migration.js

@@ -4,7 +4,8 @@ import pick from 'lodash/pick';
 import { pascalCase, deepClone, visit } from '@takeshape/util';
 import { arraySchemaKeys, getShapeQueriesAndMutations, multipleRelationshipSchemaKeys, objectSchemaKeys, scalarSchemaKeys, schemaMetadataKeys } from './schema-util';
 import { updateServiceConfigV3ToV3_1 } from './services';
-import { isServiceAuthentication, isProjectSchemaV1, isProjectSchemaV3, isLatestProjectSchema, isProjectSchemaV3_1, isProjectSchemaV3_2, isProjectSchemaV3_3, isProjectSchemaV3_4, isProjectSchemaV3_5, isProjectSchemaV3_5_1, isProjectSchemaV3_6, isProjectSchemaV3_7, isProjectSchemaV3_8 } from './types/utils';
+import { isServiceAuthentication, isProjectSchemaV1, isProjectSchemaV3, isLatestProjectSchema, isProjectSchemaV3_1, isProjectSchemaV3_2, isProjectSchemaV3_3, isProjectSchemaV3_4, isProjectSchemaV3_5, isProjectSchemaV3_5_1, isProjectSchemaV3_6, isProjectSchemaV3_7, isProjectSchemaV3_8, isProjectSchemaV3_9 } from './types/utils';
+import mapValues from 'lodash/mapValues';
 export const listTypePrefix = 'PaginatedList';
 const annotationMap = {
   l10n: '@l10n',
@@ -443,6 +444,59 @@ export function migrateToV3_9_0(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 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');
@@ -492,6 +546,10 @@ export async function migrateToLatestProjectSchema(context, projectSchema) {
     projectSchema = migrateToV3_9_0(projectSchema);
   }
 
+  if (isProjectSchemaV3_9(projectSchema)) {
+    projectSchema = migrateToV3_10(projectSchema);
+  }
+
   return projectSchema;
 }
 export function normalizeSchemaVersion(version) {

package/es/project-schema/index.js

@@ -1,6 +1,7 @@
 // This file is generated by "pnpm json2ts"
 export * from './latest';
 export * from './v4.0.0';
+export * from './v3.10.0';
 export * from './v3.9.0';
 export * from './v3.8.0';
 export * from './v3.7.0';

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

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

package/es/refs.js

@@ -127,7 +127,7 @@ export function refToRefItem(context, $ref, template) {
   };
 }
 /**
- * Given a content schema and project schema, finds a `@ref` or `$ref` and
+ * Given a property schema and project schema, finds a `@ref` or `$ref` and
  * returns a `RefItem` suitable for loading a referenced schema...
  */
 
@@ -240,38 +240,38 @@ export function anyRefToShapeSchemaPath(context, refSchema) {
 
 export const omitRefAndExtend = (targetSchema, sourceSchema) => assign(omit(['@ref', '$ref'], targetSchema), sourceSchema);
 /**
- * If there is a $ref, this will insert a content schema from the top level
+ * If there is a $ref, this will insert a property schema from the top level
  * in place of the reference.
  */
 
-export function followRef(context, contentSchema) {
-  const refItem = getRef(context, contentSchema);
+export function followRef(context, schema) {
+  const refItem = getRef(context, schema);
 
   if (refItem) {
     const referencedSchema = refItemToShapeSchema(context, refItem);
 
     if (referencedSchema) {
-      return omitRefAndExtend(contentSchema, referencedSchema);
+      return omitRefAndExtend(schema, referencedSchema);
     }
   }
 
-  return contentSchema;
+  return schema;
 }
 /**
  * Returns whether a schema has refs.
  */
 
-export function hasRef(contentSchema) {
-  if (isRefSchema(contentSchema) || isRefSchemaLegacy(contentSchema)) {
+export function hasRef(schema) {
+  if (isRefSchema(schema) || isRefSchemaLegacy(schema)) {
     return true;
   }
 
-  if (isAllOfSchema(contentSchema)) {
-    return Boolean(contentSchema.allOf.find(hasRef));
+  if (isAllOfSchema(schema)) {
+    return Boolean(schema.allOf.find(hasRef));
   }
 
-  if (isOneOfSchema(contentSchema)) {
-    return Boolean(contentSchema.oneOf.find(hasRef));
+  if (isOneOfSchema(schema)) {
+    return Boolean(schema.oneOf.find(hasRef));
   }
 
   return false;
@@ -280,17 +280,17 @@ export function hasRef(contentSchema) {
  * Returns whether a schema has refs which can be followed.
  */
 
-export function hasResolvableRef(context, contentSchema) {
-  if (isRefSchema(contentSchema) || isRefSchemaLegacy(contentSchema)) {
-    return Boolean(refItemToShapeSchema(context, getRef(context, contentSchema)));
+export function hasResolvableRef(context, schema) {
+  if (isRefSchema(schema) || isRefSchemaLegacy(schema)) {
+    return Boolean(refItemToShapeSchema(context, getRef(context, schema)));
   }
 
-  if (isAllOfSchema(contentSchema)) {
-    return Boolean(contentSchema.allOf.find(s => hasResolvableRef(context, s)));
+  if (isAllOfSchema(schema)) {
+    return Boolean(schema.allOf.find(s => hasResolvableRef(context, s)));
   }
 
-  if (isOneOfSchema(contentSchema)) {
-    return Boolean(contentSchema.oneOf.find(s => hasResolvableRef(context, s)));
+  if (isOneOfSchema(schema)) {
+    return Boolean(schema.oneOf.find(s => hasResolvableRef(context, s)));
   }
 
   return false;

package/es/schema-util.js

@@ -18,7 +18,7 @@ import { CURRENT_API_VERSION, CURRENT_SCHEMA_VERSION } from './versions';
 import { workflowsEnabled } from './api-version';
 import { builtInShapes, builtInForms } from './builtin-schema';
 import { createTemplateShapeName, parseReturnShape } from './template-shapes';
-import { getArgsType, isBasicResolver, isObjectSchema, isAllOfSchema, isRefSchema, isOneOfSchema, isContentObjectSchema } from './types/utils';
+import { getArgsType, isBasicResolver, isObjectSchema, isAllOfSchema, isRefSchema, isOneOfSchema } from './types/utils';
 import { getStoredServiceConfig } from './services';
 import { followRef, getRef, getRefOrItemsRef, getRefShapeName, getRefWithPath, omitRefAndExtend, refExpressionToRefItem, refItemToShape, refItemToShapeName, refItemToShapeSchema } from './refs';
 import isEqual from 'lodash/isEqual';
@@ -545,7 +545,7 @@ export function getArgsShapeSchema(projectSchema, argsSchema) {
 
 const omitAllOfAndExtend = (targetSchema, sourceSchema) => assign(omit(['allOf'], targetSchema), sourceSchema);
 
-const createShapeToContentSchema = (projectSchema, definitions, definitionNames, useShapeIdDiscriminator = true) => {
+const createShapeToPropertySchema = (projectSchema, definitions, definitionNames, useShapeIdDiscriminator = true) => {
   const rewriteRefs = (shape, addDiscriminator = false) => {
     const handleSchema = (propSchema, addDiscriminator = false) => {
       // Unwrap array schema
@@ -593,6 +593,10 @@ const createShapeToContentSchema = (projectSchema, definitions, definitionNames,
       return shapeSchema;
     }
 
+    if (shapeSchema.enum) {
+      return shapeSchema;
+    }
+
     const shapeSchemaCopy = dereferenceObjectSchema(projectSchema, shapeSchema);
 
     if (useShapeIdDiscriminator) {
@@ -617,10 +621,10 @@ const createShapeToContentSchema = (projectSchema, definitions, definitionNames,
   return rewriteRefs;
 };
 
-export function shapeToContentSchema(projectSchema, shape) {
+export function shapeToPropertySchema(projectSchema, shape) {
   const definitions = {};
   const definitionNames = new Set();
-  const convert = createShapeToContentSchema(projectSchema, definitions, definitionNames);
+  const convert = createShapeToPropertySchema(projectSchema, definitions, definitionNames);
   return { ...convert(shape),
     definitions
   };
@@ -628,7 +632,7 @@ export function shapeToContentSchema(projectSchema, shape) {
 export function projectSchemaToJSONSchema(projectSchema) {
   const definitions = {};
   const definitionNames = new Set();
-  const convert = createShapeToContentSchema(projectSchema, definitions, definitionNames, false);
+  const convert = createShapeToPropertySchema(projectSchema, definitions, definitionNames, false);
 
   for (const shape of Object.values(projectSchema.shapes)) {
     definitions[shape.name] = convert(shape);
@@ -1048,7 +1052,7 @@ export function dereferenceObjectSchema(context, shapeOrFieldSchema, schemaPath
  */
 
 export const createSchemaPropertyList = curry((context, shapeOrFieldSchema) => {
-  const schema = isContentObjectSchema(shapeOrFieldSchema) ? dereferenceSchema(context, shapeOrFieldSchema) : shapeOrFieldSchema;
+  const schema = dereferenceSchema(context, shapeOrFieldSchema);
   const propertyIterator = new Map(isObjectSchema(schema) ? Object.entries(schema.properties) : undefined);
   const defaultOrderByIteratees = [n => n[0]];
   const defaultOrderByOrders = ['asc'];
@@ -1124,7 +1128,7 @@ export const createSchemaPropertyList = curry((context, shapeOrFieldSchema) => {
  */
 
 export const createSchemaPropertyAccessor = curry((context, shapeOrFieldSchema) => {
-  const schema = isContentObjectSchema(shapeOrFieldSchema) ? dereferenceSchema(context, shapeOrFieldSchema) : shapeOrFieldSchema;
+  const schema = dereferenceSchema(context, shapeOrFieldSchema);
   const propertyIterator = new Map(isObjectSchema(schema) ? Object.entries(schema.properties) : undefined);
 
   const _getValue = propertyName => {

package/es/schemas/index.js

@@ -1,31 +1,31 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.9.0';
+export const CURRENT_SCHEMA_VERSION = '3.10.0';
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.9.0.json';
-export { default as latestMetaSchemaJson } from './project-schema/meta-schema-v3.9.0.json';
+export { default as latestSchemaJson } from './project-schema/v3.10.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
+import projectSchemaV3_10_0 from './project-schema/v3.10.0.json';
 import projectSchemaV3_9_0 from './project-schema/v3.9.0.json';
-import projectSchemaV3_8_0 from './project-schema/v3.8.0.json';
-import projectSchemaV3_7_0 from './project-schema/v3.7.0.json';
-import projectSchemaV3_6_0 from './project-schema/v3.6.0.json';
-import projectSchemaV3_5_1 from './project-schema/v3.5.1.json';
-import projectSchemaV3_5_0 from './project-schema/v3.5.0.json';
-import projectSchemaV3_4_0 from './project-schema/v3.4.0.json';
-import projectSchemaV3_3_0 from './project-schema/v3.3.0.json';
-import projectSchemaV3_2_0 from './project-schema/v3.2.0.json';
-import projectSchemaV3_1_0 from './project-schema/v3.1.0.json';
-import projectSchemaV3_0_0 from './project-schema/v3.0.0.json';
-import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV3_9_0 from './project-schema/meta-schema-v3.9.0.json';
+import projectSchemaV3_8_0 from './project-schema/v3.8.0.json';
 import metaSchemaV3_8_0 from './project-schema/meta-schema-v3.8.0.json';
+import projectSchemaV3_7_0 from './project-schema/v3.7.0.json';
 import metaSchemaV3_7_0 from './project-schema/meta-schema-v3.7.0.json';
+import projectSchemaV3_6_0 from './project-schema/v3.6.0.json';
 import metaSchemaV3_6_0 from './project-schema/meta-schema-v3.6.0.json';
+import projectSchemaV3_5_1 from './project-schema/v3.5.1.json';
 import metaSchemaV3_5_1 from './project-schema/meta-schema-v3.5.1.json';
+import projectSchemaV3_5_0 from './project-schema/v3.5.0.json';
 import metaSchemaV3_5_0 from './project-schema/meta-schema-v3.5.0.json';
+import projectSchemaV3_4_0 from './project-schema/v3.4.0.json';
 import metaSchemaV3_4_0 from './project-schema/meta-schema-v3.4.0.json';
+import projectSchemaV3_3_0 from './project-schema/v3.3.0.json';
 import metaSchemaV3_3_0 from './project-schema/meta-schema-v3.3.0.json';
+import projectSchemaV3_2_0 from './project-schema/v3.2.0.json';
 import metaSchemaV3_2_0 from './project-schema/meta-schema-v3.2.0.json';
+import projectSchemaV3_1_0 from './project-schema/v3.1.0.json';
 import metaSchemaV3_1_0 from './project-schema/meta-schema-v3.1.0.json';
+import projectSchemaV3_0_0 from './project-schema/v3.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
+import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
-export const allProjectSchemas = [projectSchemaV4_0_0, projectSchemaV3_9_0, projectSchemaV3_8_0, projectSchemaV3_7_0, projectSchemaV3_6_0, projectSchemaV3_5_1, projectSchemaV3_5_0, projectSchemaV3_4_0, projectSchemaV3_3_0, projectSchemaV3_2_0, projectSchemaV3_1_0, projectSchemaV3_0_0, projectSchemaV1_0_0, metaSchemaV3_9_0, metaSchemaV3_8_0, metaSchemaV3_7_0, metaSchemaV3_6_0, metaSchemaV3_5_1, metaSchemaV3_5_0, metaSchemaV3_4_0, metaSchemaV3_3_0, metaSchemaV3_2_0, metaSchemaV3_1_0, metaSchemaV3_0_0, metaSchemaV1_0_0];
+export const allProjectSchemas = [projectSchemaV4_0_0, projectSchemaV3_10_0, projectSchemaV3_9_0, metaSchemaV3_9_0, projectSchemaV3_8_0, metaSchemaV3_8_0, projectSchemaV3_7_0, metaSchemaV3_7_0, projectSchemaV3_6_0, metaSchemaV3_6_0, projectSchemaV3_5_1, metaSchemaV3_5_1, projectSchemaV3_5_0, metaSchemaV3_5_0, projectSchemaV3_4_0, metaSchemaV3_4_0, projectSchemaV3_3_0, metaSchemaV3_3_0, projectSchemaV3_2_0, metaSchemaV3_2_0, projectSchemaV3_1_0, metaSchemaV3_1_0, projectSchemaV3_0_0, metaSchemaV3_0_0, projectSchemaV1_0_0, metaSchemaV1_0_0];

package/es/schemas/index.ts

@@ -1,57 +1,58 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.9.0';
+export const CURRENT_SCHEMA_VERSION = '3.10.0';
 export {default as anyProjectSchema} from './project-schema.json';
-export {default as latestSchemaJson} from './project-schema/v3.9.0.json';
-export {default as latestMetaSchemaJson} from './project-schema/meta-schema-v3.9.0.json';
+export {default as latestSchemaJson} from './project-schema/v3.10.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
+import projectSchemaV3_10_0 from './project-schema/v3.10.0.json';
 import projectSchemaV3_9_0 from './project-schema/v3.9.0.json';
-import projectSchemaV3_8_0 from './project-schema/v3.8.0.json';
-import projectSchemaV3_7_0 from './project-schema/v3.7.0.json';
-import projectSchemaV3_6_0 from './project-schema/v3.6.0.json';
-import projectSchemaV3_5_1 from './project-schema/v3.5.1.json';
-import projectSchemaV3_5_0 from './project-schema/v3.5.0.json';
-import projectSchemaV3_4_0 from './project-schema/v3.4.0.json';
-import projectSchemaV3_3_0 from './project-schema/v3.3.0.json';
-import projectSchemaV3_2_0 from './project-schema/v3.2.0.json';
-import projectSchemaV3_1_0 from './project-schema/v3.1.0.json';
-import projectSchemaV3_0_0 from './project-schema/v3.0.0.json';
-import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV3_9_0 from './project-schema/meta-schema-v3.9.0.json';
+import projectSchemaV3_8_0 from './project-schema/v3.8.0.json';
 import metaSchemaV3_8_0 from './project-schema/meta-schema-v3.8.0.json';
+import projectSchemaV3_7_0 from './project-schema/v3.7.0.json';
 import metaSchemaV3_7_0 from './project-schema/meta-schema-v3.7.0.json';
+import projectSchemaV3_6_0 from './project-schema/v3.6.0.json';
 import metaSchemaV3_6_0 from './project-schema/meta-schema-v3.6.0.json';
+import projectSchemaV3_5_1 from './project-schema/v3.5.1.json';
 import metaSchemaV3_5_1 from './project-schema/meta-schema-v3.5.1.json';
+import projectSchemaV3_5_0 from './project-schema/v3.5.0.json';
 import metaSchemaV3_5_0 from './project-schema/meta-schema-v3.5.0.json';
+import projectSchemaV3_4_0 from './project-schema/v3.4.0.json';
 import metaSchemaV3_4_0 from './project-schema/meta-schema-v3.4.0.json';
+import projectSchemaV3_3_0 from './project-schema/v3.3.0.json';
 import metaSchemaV3_3_0 from './project-schema/meta-schema-v3.3.0.json';
+import projectSchemaV3_2_0 from './project-schema/v3.2.0.json';
 import metaSchemaV3_2_0 from './project-schema/meta-schema-v3.2.0.json';
+import projectSchemaV3_1_0 from './project-schema/v3.1.0.json';
 import metaSchemaV3_1_0 from './project-schema/meta-schema-v3.1.0.json';
+import projectSchemaV3_0_0 from './project-schema/v3.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
+import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
 export const allProjectSchemas = [
   projectSchemaV4_0_0,
+  projectSchemaV3_10_0,
   projectSchemaV3_9_0,
-  projectSchemaV3_8_0,
-  projectSchemaV3_7_0,
-  projectSchemaV3_6_0,
-  projectSchemaV3_5_1,
-  projectSchemaV3_5_0,
-  projectSchemaV3_4_0,
-  projectSchemaV3_3_0,
-  projectSchemaV3_2_0,
-  projectSchemaV3_1_0,
-  projectSchemaV3_0_0,
-  projectSchemaV1_0_0,
   metaSchemaV3_9_0,
+  projectSchemaV3_8_0,
   metaSchemaV3_8_0,
+  projectSchemaV3_7_0,
   metaSchemaV3_7_0,
+  projectSchemaV3_6_0,
   metaSchemaV3_6_0,
+  projectSchemaV3_5_1,
   metaSchemaV3_5_1,
+  projectSchemaV3_5_0,
   metaSchemaV3_5_0,
+  projectSchemaV3_4_0,
   metaSchemaV3_4_0,
+  projectSchemaV3_3_0,
   metaSchemaV3_3_0,
+  projectSchemaV3_2_0,
   metaSchemaV3_2_0,
+  projectSchemaV3_1_0,
   metaSchemaV3_1_0,
+  projectSchemaV3_0_0,
   metaSchemaV3_0_0,
+  projectSchemaV1_0_0,
   metaSchemaV1_0_0
 ];