@takeshape/schema 11.40.0 → 11.41.0

package/dist/util/merge.js

@@ -1,307 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mergeDeepObjectSchemas = mergeDeepObjectSchemas;
-exports.mergeFormConfigs = mergeFormConfigs;
-exports.mergeFormProperties = mergeFormProperties;
-exports.mergeObjectSchemas = mergeObjectSchemas;
-exports.mergeProjectSchemas = mergeProjectSchemas;
-exports.mergeSchemaProperties = mergeSchemaProperties;
-exports.rebaseFormProperties = rebaseFormProperties;
-exports.rebaseSchemaProperties = rebaseSchemaProperties;
-var _util = require("@takeshape/util");
-var _union = _interopRequireDefault(require("lodash/union"));
-var _difference = _interopRequireDefault(require("lodash/difference"));
-var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
-var _unset = _interopRequireDefault(require("lodash/unset"));
-var _set = _interopRequireDefault(require("lodash/set"));
-var _last = _interopRequireDefault(require("lodash/last"));
-var _omit = _interopRequireDefault(require("lodash/omit"));
-var _pickBy = _interopRequireDefault(require("lodash/pickBy"));
-var _lodash = require("lodash");
-var _types = require("../types");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function mergeObjectSchemas(...args) {
-  return args.filter(_util.isDefined).reduce((parent, schemas) => mergeSchemaProperties(parent, schemas), {
-    type: 'object',
-    properties: {}
-  });
-}
-function mergeDeepObjectSchemas(...args) {
-  return args.filter(_util.isDefined).reduce((parent, schemas) => mergeSchemaProperties(parent, schemas, true), {
-    type: 'object',
-    properties: {}
-  });
-}
-function mergeSchemaProperties(parent, overrides, deep = false) {
-  const result = {
-    ...parent,
-    properties: deep ? (0, _lodash.assignWith)({}, parent.properties, overrides.properties, (objValue, srcValue) => {
-      // merge objects if possible
-      if (objValue !== undefined && srcValue !== undefined) {
-        if ((0, _types.isObjectSchema)(objValue) && (0, _types.isObjectSchema)(srcValue)) {
-          return mergeObjectSchemas(objValue, srcValue);
-        }
-        if (((0, _types.isObjectSchema)(objValue) || (0, _types.isRefSchema)(objValue)) && ((0, _types.isObjectSchema)(srcValue) || (0, _types.isRefSchema)(srcValue))) {
-          return {
-            allOf: [objValue, srcValue]
-          };
-        }
-      }
-    }) : {
-      ...parent.properties,
-      ...overrides.properties
-    }
-  };
-  const required = (0, _union.default)(parent.required, overrides.required);
-  if (required.length) {
-    result.required = required;
-  }
-  return result;
-}
-function rebaseSchemaProperties(base, parent, head) {
-  const {
-    properties: toProperties,
-    required: toRequired,
-    ...toOther
-  } = base;
-  const {
-    properties: baseProperties,
-    required: baseRequired,
-    ...baseOther
-  } = parent;
-  const {
-    properties: fromProperties,
-    required: fromRequired,
-    ...fromOther
-  } = head;
-  const newSchema = {
-    ...(0, _util.rebaseObject)(toOther, baseOther, fromOther),
-    type: 'object',
-    properties: (0, _util.rebaseObject)(toProperties, baseProperties, fromProperties)
-  };
-  const required = (0, _util.rebaseArray)(toRequired ?? [], baseRequired ?? [], fromRequired ?? []);
-  if (required.length) {
-    newSchema.required = required;
-  }
-  return newSchema;
-}
-function mergeFormProperties(parent, overrides) {
-  const result = {
-    ...parent,
-    properties: {
-      ...parent.properties,
-      ...overrides.properties
-    }
-  };
-  const order = (0, _union.default)(parent.order, overrides.order);
-  if (order.length) {
-    result.order = order;
-  }
-  return result;
-}
-function rebaseFormProperties(base, parent, head) {
-  const {
-    properties: toProperties,
-    order: toOrder,
-    ...toOther
-  } = base;
-  const {
-    properties: baseProperties,
-    order: baseOrder,
-    ...baseOther
-  } = parent;
-  const {
-    properties: fromProperties,
-    order: fromOrder,
-    ...fromOther
-  } = head;
-  const newForm = {
-    ...(0, _util.rebaseObject)(toOther, baseOther, fromOther),
-    properties: (0, _util.rebaseObject)(toProperties, baseProperties, fromProperties)
-  };
-  const order = (0, _util.rebaseArray)(toOrder ?? [], baseOrder ?? [], fromOrder ?? []);
-  if (order.length) {
-    newForm.order = order;
-  }
-  return newForm;
-}
-function mergeFormConfigs(...configs) {
-  return configs.reduce(mergeFormProperties, {
-    properties: {},
-    order: []
-  });
-}
-const mergeableSections = ['shapes', 'mutations', 'queries', 'forms', 'services'];
-const isMergeableSection = str => {
-  return mergeableSections.includes(str);
-};
-const pickUnmergeable = projectSchema => {
-  return (0, _pickBy.default)(projectSchema, (_value, key) => !isMergeableSection(key));
-};
-function compareSection(section, original, updated) {
-  const changes = [];
-  const originalKeys = Object.keys(original);
-  const updatedKeys = Object.keys(updated);
-  for (const removedKey of (0, _difference.default)(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 (!(0, _isEqual.default)(original[key], updated[key])) {
-      changes.push({
-        path: [section, key],
-        section,
-        op: 'update',
-        value
-      });
-    }
-  }
-  return changes;
-}
-function compareSections(parent, branch) {
-  return mergeableSections.flatMap(section => parent[section] ?? branch[section] ? compareSection(section, parent[section] ?? {}, branch[section] ?? {}) : []);
-}
-function findChangedShape(schema, change) {
-  return schema.shapes[change.path[1]];
-}
-function getChangedShape(schema, change) {
-  const shape = findChangedShape(schema, change);
-  (0, _util.assert)(shape, 'Expected shape not found');
-  return shape;
-}
-function rebaseShapeProperties(toShape, fromShape, baseShape) {
-  return baseShape ? (0, _util.rebaseObject)((0, _omit.default)(toShape, 'schema'), (0, _omit.default)(baseShape, 'schema'), (0, _omit.default)(fromShape, 'schema')) : {
-    ...toShape,
-    ...fromShape
-  };
-}
-
-// eslint-disable-next-line complexity
-function attemptToMerge(base, parent, head, change) {
-  const toShape = getChangedShape(base, change);
-  const fromShape = getChangedShape(head, change);
-  const toSchema = toShape.schema;
-  const fromSchema = fromShape.schema;
-  if ((0, _isEqual.default)(toSchema, fromSchema)) {
-    const baseShape = findChangedShape(parent, change);
-    return {
-      ...rebaseShapeProperties(toShape, fromShape, baseShape),
-      schema: toSchema
-    };
-  }
-  if ((0, _types.isObjectSchema)(toSchema) && (0, _types.isObjectSchema)(fromSchema)) {
-    const baseShape = findChangedShape(parent, change);
-    const baseSchema = baseShape?.schema;
-    return {
-      ...rebaseShapeProperties(toShape, fromShape, baseShape),
-      schema: change.op === 'update' && baseSchema && (0, _types.isObjectSchema)(baseSchema) ? rebaseSchemaProperties(toSchema, baseSchema, fromSchema) : mergeSchemaProperties(toSchema, fromSchema)
-    };
-  }
-  if ((0, _types.isExtendsSchema)(toSchema) && (0, _types.isExtendsSchema)(fromSchema) && toSchema.extends.length === fromSchema.extends.length) {
-    const fromExtends = fromSchema.extends;
-    const toObj = (0, _last.default)(toSchema.extends);
-    const fromObj = (0, _last.default)(fromSchema.extends);
-    if (toObj && (0, _types.isObjectSchema)(toObj) && fromObj && (0, _types.isObjectSchema)(fromObj) && toSchema.extends.slice(0, toSchema.extends.length - 1).every((item, i) => (0, _isEqual.default)(item, fromExtends[i]))) {
-      let mergedObjSchema;
-      const baseShape = findChangedShape(parent, change);
-      const baseSchema = baseShape?.schema;
-      if (change.op === 'update' && baseSchema && (0, _types.isExtendsSchema)(baseSchema)) {
-        const baseObj = (0, _last.default)(baseSchema.extends);
-        if (baseObj && (0, _types.isObjectSchema)(baseObj)) {
-          mergedObjSchema = rebaseSchemaProperties(toObj, baseObj, fromObj);
-        }
-      }
-      mergedObjSchema ||= mergeSchemaProperties(toObj, fromObj);
-      return {
-        ...rebaseShapeProperties(toShape, fromShape, baseShape),
-        schema: {
-          extends: [...toSchema.extends.slice(0, toSchema.extends.length - 1), mergedObjSchema]
-        }
-      };
-    }
-  }
-}
-function applyChange(base, parent, head, change) {
-  if (change.op === 'remove') {
-    (0, _unset.default)(base, change.path);
-  } else if (change.op === 'add') {
-    (0, _set.default)(base, change.path, change.value);
-  } else if (change.op === 'update') {
-    if (change.section === 'shapes') {
-      const mergedShape = attemptToMerge(base, parent, head, change);
-      if (mergedShape) {
-        (0, _set.default)(base, change.path, mergedShape);
-        return;
-      }
-    } else if (change.section === 'forms') {
-      const shapeName = change.path[1];
-      const toForm = base.forms?.[shapeName]?.default;
-      const fromForm = head.forms?.[shapeName]?.default;
-      if (toForm && fromForm) {
-        const baseForm = parent.forms?.[shapeName]?.default;
-        (0, _set.default)(base, change.path, {
-          default: baseForm ? rebaseFormProperties(toForm, baseForm, fromForm) : mergeFormConfigs(toForm, fromForm)
-        });
-        return;
-      }
-    }
-    (0, _set.default)(base, change.path, change.value);
-  }
-}
-function mergeProjectSchemas(base, parent, head) {
-  const changesTo = compareSections(parent, base);
-  const changesFrom = compareSections(parent, head);
-  const mergedSchema = (0, _util.deepClone)(base);
-  for (let change of changesFrom) {
-    const potentialConflict = changesTo.find(changeTo => (0, _isEqual.default)(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(base, parent, head, change);
-          // eslint-disable-next-line max-depth
-          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, parent, head, change);
-  }
-  Object.assign(mergedSchema, (0, _util.rebaseObject)(pickUnmergeable(base), pickUnmergeable(parent), pickUnmergeable(head)));
-  return {
-    error: undefined,
-    mergedSchema
-  };
-}

package/dist/util/patch-schema.d.ts

@@ -1,9 +0,0 @@
-import { type ProjectSchemaJSON } from '../project-schema';
-import { type ProjectSchemaUpdate } from '../migration/types';
-export declare function shallowMerge<T>(original: Record<string, T> | undefined, update: Record<string, T | null> | undefined): Record<string, T>;
-/**
- * Apply a schema update to a schema.
- * Resulting schema is not assumed to be valid and should be validated if appropriate.
- */
-export declare function patchSchema<T extends ProjectSchemaJSON>(projectSchema: T, update: ProjectSchemaUpdate): T;
-//# sourceMappingURL=patch-schema.d.ts.map

package/dist/util/patch-schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"patch-schema.d.ts","sourceRoot":"","sources":["../../../src/util/patch-schema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,KAAK,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAC,KAAK,mBAAmB,EAAC,MAAM,oBAAoB,CAAC;AAI5D,wBAAgB,YAAY,CAAC,CAAC,EAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,EACvC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,GAC3C,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAenB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,iBAAiB,EAAE,aAAa,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAmB,GAAG,CAAC,CAqBzG"}

package/dist/util/patch-schema.js

@@ -1,52 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.patchSchema = patchSchema;
-exports.shallowMerge = shallowMerge;
-var _forIn = _interopRequireDefault(require("lodash/forIn"));
-var _omit = _interopRequireDefault(require("lodash/omit"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const schemaUpdateMergedKeys = ['queries', 'mutations', 'shapes', 'workflows', 'forms', 'services'];
-function shallowMerge(original, update) {
-  const result = {
-    ...original
-  };
-  if (update) {
-    (0, _forIn.default)(update, (obj, key) => {
-      // Null is a sentinel value to indicate delete
-      if (obj === null) {
-        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-        delete result[key];
-      } else {
-        result[key] = obj;
-      }
-    });
-  }
-  return result;
-}
-
-/**
- * Apply a schema update to a schema.
- * Resulting schema is not assumed to be valid and should be validated if appropriate.
- */
-function patchSchema(projectSchema, update) {
-  // Patch old schema with update
-  const updatedSchema = {
-    ...projectSchema,
-    ...(0, _omit.default)(update, [...schemaUpdateMergedKeys, 'ai-experimental'])
-  };
-  for (const key of schemaUpdateMergedKeys) {
-    if (update[key]) {
-      updatedSchema[key] = shallowMerge(projectSchema[key], update[key]);
-    }
-  }
-  if (update['ai-experimental']?.agents) {
-    const ai = {
-      agents: shallowMerge(projectSchema['ai-experimental']?.agents, update['ai-experimental'].agents)
-    };
-    updatedSchema['ai-experimental'] = ai;
-  }
-  return updatedSchema;
-}

package/dist/validate.d.ts

@@ -1,71 +0,0 @@
-import type { ErrorObject } from 'ajv';
-import { type SchemaValidationErrorItem } from '@takeshape/errors';
-import { type Entitlements } from '@takeshape/util';
-import { type SetRequired } from 'type-fest';
-import type { AnyProjectSchemaJSON, ProjectSchemaJSON } from './project-schema';
-import type { ProjectSchemaImport, LayerState } from './types/types';
-import type { RoleImport, RoleInput } from './auth-schemas';
-export declare const builtInShapeNames: Set<string>;
-export type SchemaValidationResult = {
-    valid: true;
-    schema: AnyProjectSchemaJSON;
-    errors: undefined;
-} | {
-    valid: false;
-    schema: undefined;
-    errors: SchemaValidationErrorItem[];
-};
-export declare function formatError(error: ErrorObject): SchemaValidationErrorItem;
-export type Validation = {
-    version: string;
-    schemaId: string;
-    isVersion: (schemaVersion?: string) => boolean;
-    validate: (schema: unknown, options?: ValidateSyntaxOptions) => SchemaValidationResult;
-};
-export type ValidateSyntaxOptions = {
-    suppressErrorPaths?: string[];
-    resolveLayer?: ResolveLayer;
-};
-export type ResolveLayer = (layerId: string) => Promise<LayerState>;
-export type ValidateContext = {
-    resolveLayer?: ResolveLayer;
-    allowDisconnectedLayers?: boolean;
-    entitlements: Entitlements;
-} & ValidateSyntaxOptions;
-export type ValidateReferencesContext = SetRequired<ValidateContext, 'resolveLayer'>;
-export declare function validateSchemaSyntax(obj: unknown, options?: ValidateSyntaxOptions): SchemaValidationResult;
-/**
- * Validates a schema using a matching validation based on the `schemaVersion` property.
- */
-export declare function validateSchema(context: ValidateContext, obj: unknown): Promise<SchemaValidationResult>;
-export declare function ensureValidLatestSchemaSyntax(obj: unknown): ProjectSchemaJSON;
-/**
- * Validates and returns a `RoleInput`, which is a subset of the `Role`
- * type's properties suitable for importing.
- */
-export declare function validateRoleInput(maybeRoleInput: unknown): RoleInput;
-/**
- * Validates and returns a `RoleImport` array, which is a collection of `RoleInput`s.
- */
-export declare function ensureValidRoleImport(maybeRoles: unknown): RoleImport;
-export type ProjectSchemaImportValidationResult = {
-    valid: true;
-    schema: ProjectSchemaImport;
-    errors: undefined;
-} | {
-    valid: false;
-    schema: undefined;
-    errors: SchemaValidationErrorItem[];
-};
-/**
- * Only use when validating an imported schema! ignore fields optional when importing
- */
-export declare function validateProjectSchemaImport(maybeSchema: unknown): ProjectSchemaImportValidationResult;
-/**
- * Only use when validating an imported schema!
- *
- * New style validation for parity with the `validateRoleImport` fn. Returns
- * a valid, clean `ImportProjectSchema` or throws a `SchemaValidationError`.
- */
-export declare function ensureValidProjectSchemaImport(maybeSchema: unknown): ProjectSchemaImport;
-//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAmB,WAAW,EAAC,MAAM,KAAK,CAAC;AAGvD,OAAO,EAAwB,KAAK,yBAAyB,EAAC,MAAM,mBAAmB,CAAC;AAMxF,OAAO,EAEL,KAAK,YAAY,EAKlB,MAAM,iBAAiB,CAAC;AAUzB,OAAO,EAAC,KAAK,WAAW,EAAC,MAAM,WAAW,CAAC;AA6B3C,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EAelB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAC,mBAAmB,EAAE,UAAU,EAAc,MAAM,eAAe,CAAC;AAChF,OAAO,KAAK,EAAC,UAAU,EAAE,SAAS,EAAC,MAAM,gBAAgB,CAAC;AAM1D,eAAO,MAAM,iBAAiB,aAAiE,CAAC;AAmhChG,MAAM,MAAM,sBAAsB,GAC9B;IAAC,KAAK,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,oBAAoB,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAC,GAC9D;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,yBAAyB,EAAE,CAAA;CAAC,CAAC;AAE3E,wBAAgB,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,yBAAyB,CAuBzE;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,CAAC,aAAa,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;IAC/C,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,qBAAqB,KAAK,sBAAsB,CAAC;CACxF,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;AAEpE,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,YAAY,EAAE,YAAY,CAAC;CAC5B,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,yBAAyB,GAAG,WAAW,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;AAyHrF,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,GAAE,qBAA0B,GAAG,sBAAsB,CAW9G;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAgC5G;AAED,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,OAAO,GAAG,iBAAiB,CAgB7E;AAgBD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,OAAO,GAAG,SAAS,CAQpE;AAgBD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,CAQrE;AAED,MAAM,MAAM,mCAAmC,GAC3C;IAAC,KAAK,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,mBAAmB,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAC,GAC7D;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,yBAAyB,EAAE,CAAA;CAAC,CAAC;AAE3E;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,WAAW,EAAE,OAAO,GAAG,mCAAmC,CAIrG;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,WAAW,EAAE,OAAO,GAAG,mBAAmB,CAQxF"}