@takeshape/schema 8.145.0 → 8.149.0

package/es/relationships.js

@@ -1,47 +1,243 @@
-export function getRelationshipSchema(relationship) {
-  const itemSchema = {
-    $ref: '#/shapes/TSRelationship/schema'
+import { isDefined } from '@takeshape/util';
+import { isPropertySchemaWithRelationship } from './types';
+import { getShapeById, isModelShape } from './schema-util';
+import { getRefShapeName, followRef } from './refs';
+import { isUnionSchema } from './unions';
+import { builtInShapes } from './builtin-schema';
+import find from 'lodash/find';
+/**
+ * Turn a LegacyRelationship into a partial PropertySchemaWithRelationship.
+ */
+
+export function getRelationshipSchema(projectSchema, legacyRelationship) {
+  const propertySchema = {
+    '@args': 'TSRelationshipArgs',
+    '@resolver': {
+      name: 'takeshape:getRelated',
+      service: 'takeshape:local',
+      options: {
+        nullable: true
+      }
+    }
+  };
+  const shapeRefs = legacyRelationship.shapeIds.map(shapeId => {
+    const shape = getShapeById(projectSchema, shapeId) ?? find(builtInShapes, shape => shape.id === shapeId);
+    return shape && {
+      '@ref': `local:${shape.name}`
+    };
+  }).filter(isDefined);
+
+  if (!shapeRefs.length) {
+    throw new Error(`Invalid empty relationship ${JSON.stringify(legacyRelationship)}`);
+  }
+
+  const shapeRefsSchema = shapeRefs.length === 1 ? shapeRefs[0] : {
+    oneOf: shapeRefs
   };
 
-  if (relationship.type === 'multiple') {
-    return {
+  if (legacyRelationship.type === 'multiple') {
+    return { ...propertySchema,
       type: 'array',
-      items: itemSchema,
-      '@relationship': relationship
+      items: shapeRefsSchema,
+      '@input': {
+        type: 'array',
+        items: {
+          '@ref': 'local:TSRelationship'
+        }
+      }
     };
   }
 
-  return { ...itemSchema,
-    '@relationship': relationship
+  return { ...propertySchema,
+    ...shapeRefsSchema,
+    '@input': {
+      '@ref': 'local:TSRelationship'
+    }
+  };
+}
+/**
+ * Get a list of refs given a property schema with a relationship resolver.
+ */
+
+export function getRelationshipShapeRefs(propertySchema) {
+  let refs = [];
+  const schema = propertySchema.items ?? propertySchema;
+
+  if (schema.oneOf) {
+    refs = schema.oneOf.map(schema => schema['@ref']).filter(isDefined);
+  } else if (schema['@ref']) {
+    refs = [schema['@ref']];
+  }
+
+  return refs;
+}
+/**
+ * Get a list of shapes given a property schema with a relationship resolver.
+ */
+
+export function getRelationshipShapes(shapes, refs) {
+  return refs.map(ref => {
+    const shapeName = ref.split(':')[1];
+    const shape = shapes[shapeName];
+    return shape ? shape : undefined;
+  }).filter(isDefined);
+}
+/**
+ * Get a list of shape ids given a property schema with a relationship resolver.
+ */
+
+export function getRelationshipShapeIds(shapes, refs) {
+  return refs.map(ref => {
+    const shapeName = ref.split(':')[1];
+    const shape = shapes[shapeName];
+    return shape ? shape.id : undefined;
+  }).filter(isDefined);
+}
+/**
+ * Turn a Relationship into a LegacyRelationship object.
+ */
+
+export function getLegacyRelationship(projectSchema, relationship) {
+  return {
+    type: relationship.isMultiple ? 'multiple' : 'single',
+    shapeIds: getRelationshipShapeIds(projectSchema.shapes, relationship.refs)
+  };
+}
+/**
+ * Get relationship details from a PropertySchema.
+ */
+
+export function getRelationship(propertySchema) {
+  var _propertySchema$Back, _propertySchema$Back2;
+
+  propertySchema = propertySchema['@output'] ?? propertySchema;
+
+  if (!isPropertySchemaWithRelationship(propertySchema)) {
+    return;
+  }
+
+  const isMultiple = propertySchema.type === 'array';
+  const hasBackreference = Boolean((_propertySchema$Back = propertySchema['@backreference']) === null || _propertySchema$Back === void 0 ? void 0 : _propertySchema$Back.enabled);
+  const backreferenceName = (_propertySchema$Back2 = propertySchema['@backreference']) === null || _propertySchema$Back2 === void 0 ? void 0 : _propertySchema$Back2.name;
+  const refs = getRelationshipShapeRefs(propertySchema);
+  return {
+    isMultiple,
+    refs,
+    hasBackreference,
+    backreferenceName
   };
-} // TODO: Code below will likely cause a conflict with @relationship PR...
+}
+
+function addRelationship(relationships, id, env) {
+  if (!relationships[id]) {
+    relationships[id] = [];
+  }
+
+  relationships[id].push(env);
+}
+
+export function findExistingRelationships(projectSchema, shapes) {
+  const relationships = {};
+  const shapeArray = Object.values(shapes);
+  const shapesSeen = new Set();
+  const shapeIds = new Set(shapeArray.map(shape => shape.id));
+
+  const findRelationships = (schema, path, parentShapeName) => {
+    const relationship = getRelationship(schema);
 
+    if (relationship) {
+      var _schema$Backreferenc;
+
+      const relatedShapeIds = getRelationshipShapeIds(shapes, relationship.refs);
+      const relatedName = (_schema$Backreferenc = schema['@backreference']) === null || _schema$Backreferenc === void 0 ? void 0 : _schema$Backreferenc.name;
+
+      for (const shapeId of relatedShapeIds) {
+        if (shapeIds.has(shapeId)) {
+          var _schema$Backreferenc2;
+
+          addRelationship(relationships, shapeId, {
+            relatedName,
+            path: path.slice(1),
+            shapeId: path[0],
+            hasBackreference: Boolean((_schema$Backreferenc2 = schema['@backreference']) === null || _schema$Backreferenc2 === void 0 ? void 0 : _schema$Backreferenc2.enabled),
+            schema,
+            shapeName: parentShapeName
+          });
+        }
+      }
+    }
+
+    const shapeName = getRefShapeName(projectSchema, schema);
+
+    if (shapeName && !shapes[shapeName]) {
+      return;
+    }
+
+    const prop = shapeName ? followRef(projectSchema, schema) : schema;
+
+    if (shapeName) {
+      // Skip shapes we have already seen to avoid cycles
+      if (shapesSeen.has(shapeName)) {
+        return;
+      }
+
+      shapesSeen.add(shapeName);
+    }
+
+    if (!relationship) {
+      if (prop.properties) {
+        for (const name of Object.keys(prop.properties)) {
+          findRelationships(prop.properties[name], path.concat(name), shapeName ?? parentShapeName);
+        }
+      } else if (prop.items) {
+        findRelationships(prop.items, path, shapeName ?? parentShapeName);
+      } else if (isUnionSchema(prop)) {
+        for (const child of prop.oneOf) {
+          findRelationships(child, path, shapeName ?? parentShapeName);
+        }
+      }
+    }
+  };
+
+  for (const shape of shapeArray) {
+    if (isModelShape(shape)) {
+      const {
+        schema,
+        id,
+        name
+      } = shape;
+      findRelationships(schema, [id], name);
+    }
+  }
+
+  return relationships;
+}
 /**
  * Test whether two PropertySchemas have equal realtionships
  */
 
 export function isEqualRelationship(a, b) {
-  var _a$Relationship, _b$Relationship;
+  const relationshipA = getRelationship(a);
+  const relationshipB = getRelationship(b); // non-relationships are considered equal in that they are both equal that regard
 
-  // non-relationships are considered equal in that they are both equal that regard
-  if (!a['@relationship'] && !b['@relationship']) {
+  if (!relationshipA && !relationshipB) {
     return true;
   }
 
-  const idsA = (_a$Relationship = a['@relationship']) === null || _a$Relationship === void 0 ? void 0 : _a$Relationship.shapeIds;
+  const refsA = relationshipA === null || relationshipA === void 0 ? void 0 : relationshipA.refs;
 
-  if (!idsA) {
+  if (!refsA) {
     return false;
   }
 
-  const idsB = (_b$Relationship = b['@relationship']) === null || _b$Relationship === void 0 ? void 0 : _b$Relationship.shapeIds;
+  const refsB = relationshipB === null || relationshipB === void 0 ? void 0 : relationshipB.refs;
 
-  if (!idsB || idsA.length !== idsB.length) {
+  if (!refsB || refsA.length !== refsB.length) {
     return false;
   }
 
-  const idSet = new Set(idsA);
-  return idsB.every(id => idSet.has(id));
+  const refSet = new Set(refsA);
+  return refsB.every(ref => refSet.has(ref));
 }
 /**
  * Test whether an array of PropertySchemas have unequal relationships

package/es/rewrite.js

@@ -45,8 +45,16 @@ export function rewriteSchema(schema, options) {
       }
 
       if (options.replaceInput && isRecord(value['@input'])) {
-        return { ...value['@input'],
-          '@mapping': value['@mapping']
+        const {
+          '@input': input,
+          '@mapping': mapping,
+          title,
+          ...output
+        } = value;
+        return { ...input,
+          title,
+          '@mapping': mapping,
+          '@output': output
         };
       }
     }

package/es/schema-util.js

@@ -2,21 +2,21 @@ import find from 'lodash/find';
 import mapValues from 'lodash/mapValues';
 import omitBy from 'lodash/omitBy';
 import pickBy from 'lodash/pickBy';
-import get from 'lodash/get';
 import keyBy from 'lodash/keyBy';
 import isObject from 'lodash/isObject';
 import curry from 'lodash/fp/curry';
 import orderBy from 'lodash/fp/orderBy';
 import uniq from 'lodash/uniq';
-import { deepClone, isDefined } from '@takeshape/util';
+import { deepClone, isDefined, visit } from '@takeshape/util';
 import { defaultWorkflow, getStatusField } from './workflows';
 import { CURRENT_API_VERSION, CURRENT_SCHEMA_VERSION } from './versions';
 import { workflowsEnabled } from './api-version';
 import { builtInShapes, builtInForms } from './builtin-schema';
-import { getArgsType, isBasicResolver, isObjectSchema, isAllOfSchema, isRefSchema, isOneOfSchema, isExtendsSchema } from './types/utils';
+import { getArgsType, isBasicResolver, isObjectSchema, isAllOfSchema, isOneOfSchema, isExtendsSchema, isArraySchema } from './types/utils';
 import { getStoredServiceConfig } from './services';
-import { createTemplateShapeName, dereferenceObjectSchema, dereferenceSchema, followRef, getRef, getRefOrItemsRef, getRefShapeName, parseReturnShape, refExpressionToRefItem, refItemToShape, refItemToShapeName, refItemToShapeSchema } from './refs';
+import { createTemplateShapeName, dereferenceObjectSchema, dereferenceSchema, getRef, getRefOrItemsRef, getRefShapeName, parseReturnShape, refExpressionToRefItem, refItemToShape, refItemToShapeName, refItemToShapeSchema, atRefToRefItem, refToRefItem, parseTemplateShape, isRefItemWithPath } from './refs';
 import isEqual from 'lodash/isEqual';
+import isString from 'lodash/isString';
 import { isUnionSchema } from './unions';
 import { mergeFormProperties, mergeSchemaProperties } from './util/merge';
 export const SERVICE_OBJECT_PATTERN_NAME = 'pattern:service-object';
@@ -41,7 +41,7 @@ export const objectSchemaKeys = [...commonSchemaKeys, 'properties', 'required'];
 export const arraySchemaKeys = [...commonSchemaKeys, 'items', 'additionalItems', 'maxItems', 'minItems', 'uniqueItems'];
 export const multipleRelationshipSchemaKeys = [...schemaMetadataKeys, 'maxItems', 'minItems']; // All properties except properties, items, additionalItems
 
-export const nonStructuralSchemaKeys = [...scalarSchemaKeys, '@relationship', '@backreference', 'required', 'maxItems', 'minItems', 'uniqueItems'];
+export const nonStructuralSchemaKeys = [...scalarSchemaKeys, '@resolver', '@input', '@output', '@backreference', '@args', 'required', 'maxItems', 'minItems', 'uniqueItems'];
 export function getServiceIdFieldName(serviceFieldName) {
   return `${serviceFieldName}Id`;
 }
@@ -413,94 +413,6 @@ export function applyDefaultsToSchema(projectSchema) {
     })
   };
 }
-
-function addRelationship(relationships, id, env) {
-  if (!relationships[id]) {
-    relationships[id] = [];
-  }
-
-  relationships[id].push(env);
-}
-/**
- * Finds all relationships in the schema and returns an object indexed by shape.id that lists all of the shapes
- * properties that reference it
- */
-
-
-export function findExistingRelationships(projectSchema, shapes) {
-  const relationships = {};
-  const shapeArray = Object.values(shapes);
-  const shapesSeen = new Set();
-  const shapeIds = new Set(shapeArray.map(shape => shape.id));
-
-  const findRelationships = (schema, path, parentShapeName) => {
-    if (schema['@relationship']) {
-      var _schema$Backreferenc;
-
-      const {
-        shapeIds: relatedShapeIds
-      } = schema['@relationship'];
-      const relatedName = (_schema$Backreferenc = schema['@backreference']) === null || _schema$Backreferenc === void 0 ? void 0 : _schema$Backreferenc.name;
-
-      for (const shapeId of relatedShapeIds) {
-        if (shapeIds.has(shapeId)) {
-          var _schema$Backreferenc2;
-
-          addRelationship(relationships, shapeId, {
-            relatedName,
-            path: path.slice(1),
-            shapeId: path[0],
-            hasBackreference: Boolean((_schema$Backreferenc2 = schema['@backreference']) === null || _schema$Backreferenc2 === void 0 ? void 0 : _schema$Backreferenc2.enabled),
-            schema,
-            shapeName: parentShapeName
-          });
-        }
-      }
-    }
-
-    const shapeName = getRefShapeName(projectSchema, schema);
-
-    if (shapeName && !shapes[shapeName]) {
-      return;
-    }
-
-    const prop = shapeName ? followRef(projectSchema, schema) : schema;
-
-    if (shapeName) {
-      // Skip shapes we have already seen to avoid cycles
-      if (shapesSeen.has(shapeName)) {
-        return;
-      }
-
-      shapesSeen.add(shapeName);
-    }
-
-    if (prop.properties) {
-      for (const name of Object.keys(prop.properties)) {
-        findRelationships(prop.properties[name], path.concat(name), shapeName ?? parentShapeName);
-      }
-    } else if (prop.items) {
-      findRelationships(prop.items, path, shapeName ?? parentShapeName);
-    } else if (isUnionSchema(prop)) {
-      for (const child of prop.oneOf) {
-        findRelationships(child, path, shapeName ?? parentShapeName);
-      }
-    }
-  };
-
-  for (const shape of shapeArray) {
-    if (isModelShape(shape)) {
-      const {
-        schema,
-        id,
-        name
-      } = shape;
-      findRelationships(schema, [id], name);
-    }
-  }
-
-  return relationships;
-}
 export function stringifyQuerySource(providerId, serviceId) {
   return `${providerId}:${serviceId}`;
 }
@@ -741,7 +653,9 @@ function visitSchemaPropertiesHelper(entries, path, callback) {
 }
 
 export function visitSchemaProperties(schema, path, callback) {
-  if (isObjectSchema(schema)) {
+  if (isArraySchema(schema)) {
+    visitSchemaPropertiesHelper(Object.entries(schema.items), [...path, 'items'], callback);
+  } else if (isObjectSchema(schema)) {
     visitSchemaPropertiesHelper(Object.entries(schema.properties), [...path, 'properties'], callback);
   } else if (isExtendsSchema(schema)) {
     visitSchemaPropertiesHelper(Object.entries(schema.extends), [...path, 'extends'], callback);
@@ -771,29 +685,41 @@ function addRef(refs, ref, predicate) {
 
 export function getAllRefsInShapes(projectSchema, predicate) {
   const items = [];
-
-  const shapeVisitor = (schema, schemaPath) => {
-    if (schema['@args'] && typeof schema['@args'] === 'object') {
-      visitSchemaProperties(schema['@args'], schemaPath.concat(['@args']), (argSchema, argPath) => {
-        addRef(items, getRefOrItemsRef(projectSchema, argSchema, argPath), predicate);
-      });
+  const refPropNames = ['$ref', '@ref', '@args', 'args'];
+  visit(projectSchema.shapes, refPropNames, (ref, refPath) => {
+    // The client sometimes generates invalid schemas, like refs that are
+    // undefined. Treat ref as unknown and toss those out.
+    // See the `useShapeEditor > can deal with renames test`
+    if (!isString(ref)) {
+      return;
     }
 
-    addRef(items, getArgsReferenceWithPath(projectSchema, schema, schemaPath), predicate);
-    const newPath = schema.items ? schemaPath.concat('items') : schemaPath;
-    const newSchema = schema.items ?? schema;
+    const propName = refPath[refPath.length - 1];
+    const path = ['shapes', ...refPath];
+    let refItem = {};
 
-    if (isRefSchema(newSchema)) {
-      addRef(items, getRefOrItemsRef(projectSchema, newSchema, newPath), predicate);
-    } else if (isObjectSchema(newSchema) || isAllOfSchema(newSchema) || isOneOfSchema(newSchema)) {
-      visitSchemaProperties(newSchema, newPath, shapeVisitor);
+    if (propName === '@ref') {
+      const {
+        shapeName,
+        template
+      } = parseTemplateShape(ref);
+      refItem = { ...atRefToRefItem(projectSchema, shapeName, template),
+        path
+      };
+    } else if (propName === '$ref') {
+      refItem = { ...refToRefItem(projectSchema, ref),
+        path
+      };
+    } else if (propName === '@args' || propName === 'args') {
+      refItem = { ...refExpressionToRefItem(projectSchema, ref),
+        path
+      };
     }
-  };
-
-  for (const [shapeName, shape] of Object.entries(projectSchema.shapes)) {
-    visitSchemaProperties(shape.schema, ['shapes', shapeName, 'schema'], shapeVisitor);
-  }
 
+    if (isRefItemWithPath(refItem)) {
+      addRef(items, refItem, predicate);
+    }
+  });
   return items;
 }
 /**
@@ -1187,13 +1113,6 @@ export const ensureQuery = (projectSchema, shapeName, resolver) => ensureQueryHe
  */
 
 export const ensureMutation = (projectSchema, shapeName, resolver) => ensureQueryHelper(projectSchema, shapeName, resolver, 'mutation');
-/**
- * Find the form config for a given shape name and the form key.
- */
-
-export function findShapeFormConfig(projectSchema, shapeName, formName) {
-  return get(projectSchema, ['forms', shapeName, formName]);
-}
 
 /**
  * Find the query in the schema that corresponds to the given shape and resolver.

package/es/schemas/index.js

@@ -1,7 +1,7 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.17.1';
+export const CURRENT_SCHEMA_VERSION = '3.18.0';
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.17.1.json';
+export { default as latestSchemaJson } from './project-schema/v3.18.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';
@@ -38,5 +38,6 @@ 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 projectSchemaV3_17_1 from './project-schema/v3.17.1.json';
+import projectSchemaV3_18_0 from './project-schema/v3.18.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, projectSchemaV3_17_0, projectSchemaV3_17_1, 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, projectSchemaV3_17_1, projectSchemaV3_18_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.17.1';
+export const CURRENT_SCHEMA_VERSION = '3.18.0';
 export {default as anyProjectSchema} from './project-schema.json';
-export {default as latestSchemaJson} from './project-schema/v3.17.1.json';
+export {default as latestSchemaJson} from './project-schema/v3.18.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';
@@ -38,6 +38,7 @@ 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 projectSchemaV3_17_1 from './project-schema/v3.17.1.json';
+import projectSchemaV3_18_0 from './project-schema/v3.18.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
 export const allProjectSchemas = [
   metaSchemaV1_0_0,
@@ -76,5 +77,6 @@ export const allProjectSchemas = [
   projectSchemaV3_16_0,
   projectSchemaV3_17_0,
   projectSchemaV3_17_1,
+  projectSchemaV3_18_0,
   projectSchemaV4_0_0
 ];