@takeshape/schema 8.256.0 → 8.260.1

package/es/schemas/project-schema.json

@@ -99,6 +99,9 @@
     {
       "$ref": "https://schema.takeshape.io/project-schema/v3.23.0#"
     },
+    {
+      "$ref": "https://schema.takeshape.io/project-schema/v3.24.0#"
+    },
     {
       "$ref": "https://schema.takeshape.io/project-schema/v4.0.0#"
     }

package/es/types/types.js

@@ -3,7 +3,7 @@
  * only type used in most runtime code. Updating this to a new version should
  * trigger type errors that clue you in to code that needs review.
  */
-export const projectSchemaImportOptionalProps = ['projectId', 'created', 'updated', 'dataKey', 'version', 'locales', 'defaultLocale', 'author'];
+export const projectSchemaImportOptionalProps = ['projectId', 'dataKey', 'locales', 'defaultLocale', 'author'];
 
 /**
  * Types of refs

package/es/util/merge.js

@@ -1,5 +1,13 @@
-import { isDefined } from '@takeshape/util';
+import { deepClone, isDefined, rebaseArray, rebaseObject } from '@takeshape/util';
 import union from 'lodash/union';
+import difference from 'lodash/difference';
+import isEqual from 'lodash/isEqual';
+import unset from 'lodash/unset';
+import set from 'lodash/set';
+import last from 'lodash/last';
+import omit from 'lodash/omit';
+import { isExtendsSchema, isObjectSchema } from '../types';
+import invariant from 'tiny-invariant';
 export function mergeObjectSchemas(...args) {
   return args.filter(isDefined).reduce(mergeSchemaProperties, {
     type: 'object',
@@ -20,6 +28,34 @@ export function mergeSchemaProperties(base, overrides) {
 
   return result;
 }
+export function rebaseSchemaProperties(to, base, from) {
+  const {
+    properties: toProperties,
+    required: toRequired,
+    ...toOther
+  } = to;
+  const {
+    properties: baseProperties,
+    required: baseRequired,
+    ...baseOther
+  } = base;
+  const {
+    properties: fromProperties,
+    required: fromRequired,
+    ...fromOther
+  } = from;
+  const newSchema = { ...rebaseObject(toOther, baseOther, fromOther),
+    type: 'object',
+    properties: rebaseObject(toProperties, baseProperties, fromProperties)
+  };
+  const required = rebaseArray(toRequired ?? [], baseRequired ?? [], fromRequired ?? []);
+
+  if (required.length) {
+    newSchema.required = required;
+  }
+
+  return newSchema;
+}
 export function mergeFormProperties(base, overrides) {
   const result = { ...base,
     properties: { ...base.properties,
@@ -34,9 +70,216 @@ export function mergeFormProperties(base, overrides) {
 
   return result;
 }
+export function rebaseFormProperties(to, base, from) {
+  const {
+    properties: toProperties,
+    order: toOrder,
+    ...toOther
+  } = to;
+  const {
+    properties: baseProperties,
+    order: baseOrder,
+    ...baseOther
+  } = base;
+  const {
+    properties: fromProperties,
+    order: fromOrder,
+    ...fromOther
+  } = from;
+  const newForm = { ...rebaseObject(toOther, baseOther, fromOther),
+    properties: rebaseObject(toProperties, baseProperties, fromProperties)
+  };
+  const order = rebaseArray(toOrder ?? [], baseOrder ?? [], fromOrder ?? []);
+
+  if (order.length) {
+    newForm.order = order;
+  }
+
+  return newForm;
+}
 export function mergeFormConfigs(...configs) {
   return configs.reduce(mergeFormProperties, {
     properties: {},
     order: []
   });
+}
+const mergeableSections = ['shapes', 'mutations', 'queries', 'forms', 'services'];
+
+function compareSection(section, original, updated) {
+  const changes = [];
+  const originalKeys = Object.keys(original);
+  const updatedKeys = Object.keys(updated);
+
+  for (const removedKey of difference(originalKeys, updatedKeys)) {
+    changes.push({
+      path: [section, removedKey],
+      section,
+      op: 'remove'
+    });
+  }
+
+  for (const [key, value] of Object.entries(updated)) {
+    if (!original[key]) {
+      changes.push({
+        path: [section, key],
+        section,
+        op: 'add',
+        value
+      });
+    } else if (!isEqual(original[key], updated[key])) {
+      changes.push({
+        path: [section, key],
+        section,
+        op: 'update',
+        value
+      });
+    }
+  }
+
+  return changes;
+}
+
+function compareSections(base, branch) {
+  return mergeableSections.flatMap(section => base[section] || branch[section] ? compareSection(section, base[section] ?? {}, branch[section] ?? {}) : []);
+}
+
+function findChangedShape(schema, change) {
+  return schema.shapes[change.path[1]];
+}
+
+function getChangedShape(schema, change) {
+  const shape = findChangedShape(schema, change);
+  invariant(shape, 'Expected shape not found');
+  return shape;
+}
+
+function attemptToMerge(to, base, from, change) {
+  const toShape = getChangedShape(to, change);
+  const fromShape = getChangedShape(from, change);
+  const toSchema = toShape.schema;
+  const fromSchema = fromShape.schema;
+
+  if (isObjectSchema(toSchema) && isObjectSchema(fromSchema)) {
+    const baseShape = findChangedShape(base, change);
+    const baseSchema = baseShape === null || baseShape === void 0 ? void 0 : baseShape.schema;
+    return { ...(baseShape ? rebaseObject(omit(toShape, 'schema'), omit(baseShape, 'schema'), omit(fromShape, 'schema')) : { ...toShape,
+        ...fromShape
+      }),
+      schema: change.op === 'update' && baseSchema && isObjectSchema(baseSchema) ? rebaseSchemaProperties(toSchema, baseSchema, fromSchema) : mergeSchemaProperties(toSchema, fromSchema)
+    };
+  }
+
+  if (isExtendsSchema(toSchema) && isExtendsSchema(fromSchema) && toSchema.extends.length === fromSchema.extends.length) {
+    const fromExtends = fromSchema.extends;
+    const toObj = last(toSchema.extends);
+    const fromObj = last(fromSchema.extends);
+
+    if (toObj && isObjectSchema(toObj) && fromObj && isObjectSchema(fromObj) && toSchema.extends.slice(0, toSchema.extends.length - 1).every((item, i) => isEqual(item, fromExtends[i]))) {
+      var _findChangedShape;
+
+      let mergedObjSchema;
+      const baseSchema = (_findChangedShape = findChangedShape(base, change)) === null || _findChangedShape === void 0 ? void 0 : _findChangedShape.schema;
+
+      if (change.op === 'update' && baseSchema && isExtendsSchema(baseSchema)) {
+        const baseObj = last(baseSchema.extends);
+
+        if (baseObj && isObjectSchema(baseObj)) {
+          mergedObjSchema = rebaseSchemaProperties(toObj, baseObj, fromObj);
+        }
+      }
+
+      if (!mergedObjSchema) {
+        mergedObjSchema = mergeSchemaProperties(toObj, fromObj);
+      }
+
+      return { ...fromShape,
+        schema: {
+          extends: [...toSchema.extends.slice(0, toSchema.extends.length - 1), mergedObjSchema]
+        }
+      };
+    }
+  }
+}
+
+function applyChange(to, base, from, change) {
+  if (change.op === 'remove') {
+    unset(to, change.path);
+  } else if (change.op === 'add') {
+    set(to, change.path, change.value);
+  } else if (change.op === 'update') {
+    if (change.section === 'shapes') {
+      const mergedShape = attemptToMerge(to, base, from, change);
+
+      if (mergedShape) {
+        set(to, change.path, mergedShape);
+        return;
+      }
+    } else if (change.section === 'forms') {
+      var _to$forms, _to$forms$shapeName, _from$forms, _from$forms$shapeName;
+
+      const shapeName = change.path[1];
+      const toForm = (_to$forms = to.forms) === null || _to$forms === void 0 ? void 0 : (_to$forms$shapeName = _to$forms[shapeName]) === null || _to$forms$shapeName === void 0 ? void 0 : _to$forms$shapeName.default;
+      const fromForm = (_from$forms = from.forms) === null || _from$forms === void 0 ? void 0 : (_from$forms$shapeName = _from$forms[shapeName]) === null || _from$forms$shapeName === void 0 ? void 0 : _from$forms$shapeName.default;
+
+      if (toForm && fromForm) {
+        var _base$forms, _base$forms$shapeName;
+
+        const baseForm = (_base$forms = base.forms) === null || _base$forms === void 0 ? void 0 : (_base$forms$shapeName = _base$forms[shapeName]) === null || _base$forms$shapeName === void 0 ? void 0 : _base$forms$shapeName.default;
+        set(to, change.path, {
+          default: baseForm ? rebaseFormProperties(toForm, baseForm, fromForm) : mergeFormConfigs(toForm, fromForm)
+        });
+        return;
+      }
+    }
+
+    set(to, change.path, change.value);
+  }
+}
+
+export function mergeProjectSchemas(to, base, from) {
+  const changesTo = compareSections(base, to);
+  const changesFrom = compareSections(base, from);
+  const mergedSchema = deepClone(to);
+
+  for (let change of changesFrom) {
+    const potentialConflict = changesTo.find(changeTo => isEqual(changeTo.path, change.path));
+
+    if (potentialConflict) {
+      if (potentialConflict.op === 'remove' && change.op !== 'remove') {
+        return {
+          error: `Attempting to ${change.op} ${change.path.join('.')} which has already been removed`,
+          mergedSchema: undefined
+        };
+      }
+
+      if (potentialConflict.op === 'add' && change.op === 'add' || potentialConflict.op === 'update' && change.op === 'update') {
+        if (change.section === 'shapes') {
+          const mergedValue = attemptToMerge(to, base, from, change);
+
+          if (!mergedValue) {
+            return {
+              error: `Unable to merge ${change.path.join('.')} schemas conflict`,
+              mergedSchema: undefined
+            };
+          }
+
+          change = { ...change,
+            op: 'add',
+            value: mergedValue
+          };
+        } else if (change.section === 'forms') {
+          change = { ...change,
+            op: 'update'
+          };
+        }
+      }
+    }
+
+    applyChange(mergedSchema, base, from, change);
+  }
+
+  return {
+    error: undefined,
+    mergedSchema
+  };
 }

package/es/util/patch-schema.js

@@ -24,12 +24,10 @@ export function shallowMerge(original, update) {
  * Resulting schema is not assumed to be valid and should be validated if appropriate.
  */
 
-export function patchSchema(projectSchema, update, incrementVersion = true) {
-  const version = update.version ?? projectSchema.version; // Patch old schema with update
-
+export function patchSchema(projectSchema, update) {
+  // Patch old schema with update
   const updatedSchema = { ...projectSchema,
-    ...omit(update, schemaUpdateMergedKeys),
-    version: incrementVersion ? version + 1 : version
+    ...omit(update, schemaUpdateMergedKeys)
   };
 
   for (const key of schemaUpdateMergedKeys) {

package/es/workflows.js

@@ -20,7 +20,12 @@ export function getWorkflow(projectSchema, shapeId) {
   var _getShapeById;
 
   const workflow = (_getShapeById = getShapeById(projectSchema, shapeId)) === null || _getShapeById === void 0 ? void 0 : _getShapeById.workflow;
-  return projectSchema.workflows[workflow ?? 'default'];
+
+  if (workflow) {
+    return projectSchema.workflows[workflow] ?? defaultWorkflow;
+  }
+
+  return defaultWorkflow;
 }
 export function statusFallback(workflow, enabled) {
   return workflow.steps.find(workflow => workflow.live === enabled) ?? workflow.steps[0];

package/examples/latest/betzino.json

@@ -7,9 +7,6 @@
   ],
   "workflows": {},
   "projectId": "7c8c0ccf-7e4f-4dc8-89c1-8604d028f7ba",
-  "version": 80,
-  "created": "2019-06-20T12:58:43.119Z",
-  "updated": "2021-12-21T18:07:43.962Z",
   "forms": {
     "ProfileForm": {
       "default": {
@@ -52529,6 +52526,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/blog-schema.json

@@ -6,12 +6,9 @@
     "en",
     "es"
   ],
-  "version": 1,
   "apiVersion": "2",
   "author": "<userId>",
   "workflows": {},
-  "created": "2016-06-21T15:16:19.051Z",
-  "updated": "2016-06-21T15:16:19.051Z",
   "forms": {
     "Homepage": {
       "default": {
@@ -403,6 +400,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/brewery-schema.json

@@ -1,6 +1,5 @@
 {
   "$schema": "http://takeshape.io/schemas/project-schema#",
-  "version": 1,
   "author": "<userId>",
   "apiVersion": "2",
   "projectId": "project-id",
@@ -9,8 +8,6 @@
     "en-us"
   ],
   "workflows": {},
-  "created": "2016-06-21T15:16:19.051Z",
-  "updated": "2016-06-21T15:16:19.051Z",
   "forms": {
     "Brewery": {
       "default": {
@@ -386,6 +383,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/complex-project-schema.json

@@ -4,13 +4,10 @@
     "en"
   ],
   "projectId": "427aa129-8807-4e88-ac87-447419838d1b",
-  "version": 57,
   "$schema": "http://takeshape.io/schemas/project-schema#",
   "author": "<userId>",
   "apiVersion": "2",
   "workflows": {},
-  "created": "2019-05-08T11:35:24.053Z",
-  "updated": "2019-05-09T21:54:37.425Z",
   "forms": {
     "Purpose": {
       "default": {
@@ -4189,6 +4186,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/complex-schema.json

@@ -2,7 +2,6 @@
   "dataKey": "supersecret",
   "workflows": {},
   "projectId": "f1679577-e89a-449b-9313-e2edac0a5bf0",
-  "version": 578,
   "defaultLocale": "en",
   "locales": [
     "en",
@@ -17,9 +16,7 @@
   "apiVersion": "1",
   "queries": {},
   "mutations": {},
-  "schemaVersion": "3.23.0",
-  "created": "2019-06-20T12:58:43.119Z",
-  "updated": "2020-04-29T10:10:28.182Z",
+  "schemaVersion": "3.24.0",
   "shapes": {
     "DocumentUploadForm": {
       "id": "HJPFlRKkr",

package/examples/latest/fabric-ecommerce.json

@@ -1,9 +1,6 @@
 {
   "projectId": "4c54da75-a240-4e50-8343-bd1e8eafcdbb",
   "dataKey": "secret",
-  "version": 16,
-  "created": "2021-09-22T21:40:56.849Z",
-  "updated": "2021-09-24T18:42:24.966Z",
   "defaultLocale": "en-us",
   "locales": [
     "en-us"
@@ -10509,5 +10506,5 @@
       }
     }
   },
-  "schemaVersion": "3.23.0"
+  "schemaVersion": "3.24.0"
 }

package/examples/latest/frank-and-fred-schema.json

@@ -1,7 +1,6 @@
 {
   "workflows": {},
   "projectId": "f1679577-e89a-449b-9313-e2edac0a5bf0",
-  "version": 578,
   "defaultLocale": "en",
   "locales": [
     "en",
@@ -14,8 +13,6 @@
     "pt-br"
   ],
   "apiVersion": "1",
-  "created": "2019-06-20T12:58:43.119Z",
-  "updated": "2020-04-29T10:10:28.182Z",
   "forms": {
     "DocumentUploadForm": {
       "default": {
@@ -23255,6 +23252,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/klirr-schema.json

@@ -2,7 +2,6 @@
   "dataKey": "supersecret",
   "workflows": {},
   "projectId": "190a2592-08ff-466f-bb4a-78eb9bcb69c6",
-  "version": 172,
   "defaultLocale": "en",
   "locales": [
     "en",
@@ -10,8 +9,6 @@
     "fi"
   ],
   "apiVersion": "2",
-  "created": "2019-06-20T12:58:43.119Z",
-  "updated": "2021-01-30T20:32:32.017Z",
   "forms": {
     "ProfileForm": {
       "default": {
@@ -34790,6 +34787,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/massive-schema.json

@@ -1,14 +1,11 @@
 {
   "workflows": {},
   "projectId": "fd194db7-7b25-4b5a-8cc7-da7f31fab475",
-  "version": 463,
   "defaultLocale": "en",
   "locales": [
     "en"
   ],
   "apiVersion": "1",
-  "created": "2017-02-23T01:14:12.093Z",
-  "updated": "2020-03-17T14:30:03.886Z",
   "forms": {
     "ResourceNavigation": {
       "default": {
@@ -7841,6 +7838,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/mill-components-schema.json

@@ -1,14 +1,11 @@
 {
   "workflows": {},
   "projectId": "0ffaf7c3-289e-4df3-a6aa-4c513d356c76",
-  "version": 39,
   "defaultLocale": "en",
   "locales": [
     "en"
   ],
   "apiVersion": "2",
-  "created": "2019-10-10T21:52:02.940Z",
-  "updated": "2021-10-03T13:50:40.571Z",
   "forms": {
     "Notification": {
       "default": {
@@ -1888,6 +1885,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/one-earth.json

@@ -2,14 +2,11 @@
   "dataKey": "supersecret",
   "workflows": {},
   "projectId": "86ce9525-f5f2-4e97-81ba-54e8ce933da7",
-  "version": 530,
   "defaultLocale": "en",
   "locales": [
     "en"
   ],
   "apiVersion": "1",
-  "created": "2018-11-01T21:30:46.180Z",
-  "updated": "2020-10-14T19:24:11.935Z",
   "forms": {
     "Science": {
       "default": {
@@ -14220,6 +14217,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/pet-oneof-array.json

@@ -1,9 +1,6 @@
 {
   "apiVersion": "2",
   "projectId": "ac06e342-afe2-40f8-864b-1345d3fed493",
-  "version": 31,
-  "created": "2021-07-01T18:24:33.290Z",
-  "updated": "2021-07-12T22:07:46.153Z",
   "defaultLocale": "en-us",
   "locales": [
     "en-us"
@@ -392,6 +389,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/post-schema.json

@@ -5,12 +5,9 @@
     "en",
     "es"
   ],
-  "version": 1,
   "apiVersion": "2",
   "author": "<userId>",
   "workflows": {},
-  "created": "2016-06-21T15:16:19.051Z",
-  "updated": "2016-06-21T15:16:19.051Z",
   "forms": {
     "Post": {
       "default": {
@@ -230,6 +227,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/pruned-shopify-product-schema.json

@@ -1,9 +1,6 @@
 {
   "apiVersion": "2",
   "projectId": "a895a9e2-4627-424d-8f0c-145fd84ed1de",
-  "version": 8,
-  "created": "2021-02-04T15:45:32.300Z",
-  "updated": "2021-09-23T18:41:15.899Z",
   "defaultLocale": "en-us",
   "locales": [
     "en-us"
@@ -9760,5 +9757,5 @@
       }
     }
   },
-  "schemaVersion": "3.23.0"
+  "schemaVersion": "3.24.0"
 }

package/examples/latest/real-world-schema.json

@@ -1,6 +1,5 @@
 {
   "$schema": "http://takeshape.io/schemas/project-schema#",
-  "version": 1,
   "author": "<userId>",
   "apiVersion": "2",
   "projectId": "project-id",
@@ -9,8 +8,6 @@
     "en-us"
   ],
   "workflows": {},
-  "created": "2016-06-21T15:16:19.051Z",
-  "updated": "2016-06-21T15:16:19.051Z",
   "forms": {
     "Beer": {
       "default": {
@@ -1045,6 +1042,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }

package/examples/latest/recursive-repeater-schema.json

@@ -1,6 +1,5 @@
 {
   "$schema": "http://takeshape.io/schemas/project-schema#",
-  "version": 1,
   "author": "<userId>",
   "apiVersion": "2",
   "projectId": "project-id",
@@ -9,8 +8,6 @@
     "en-us"
   ],
   "workflows": {},
-  "created": "2016-06-21T15:16:19.051Z",
-  "updated": "2016-06-21T15:16:19.051Z",
   "forms": {
     "Post": {
       "default": {
@@ -146,6 +143,6 @@
       }
     }
   },
-  "schemaVersion": "3.23.0",
+  "schemaVersion": "3.24.0",
   "services": {}
 }