@takeshape/schema 8.36.2 → 8.38.2

package/lib/template-shapes/templates.js

@@ -0,0 +1,427 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.commonSearchProps = exports.commonSearchArgs = exports.UpdateResult = exports.UpdateArgs = exports.TSSearchSortInput = exports.TSSearchArgs = exports.TSListArgs = exports.TSGetSingletonArgs = exports.TSGetArgs = exports.SearchResults = exports.PaginatedList = exports.DuplicateResult = exports.DuplicateArgs = exports.DeleteResult = exports.DeleteArgs = exports.CreateResult = exports.CreateArgs = exports.ContentStructureInput = void 0;
+exports.getIDQueryArgs = getIDQueryArgs;
+exports.getMutationArgs = getMutationArgs;
+exports.getMutationResultType = getMutationResultType;
+exports.getPaginatedListShape = getPaginatedListShape;
+exports.getSearchResultsShape = getSearchResultsShape;
+exports.getShapeListQueryArgs = getShapeListQueryArgs;
+exports.termsProps = exports.localeProps = void 0;
+
+var _migration = require("../migration");
+
+var _util = require("@takeshape/util");
+
+var _keyBy = _interopRequireDefault(require("lodash/keyBy"));
+
+var _schemaUtil = require("../schema-util");
+
+var _refs = require("../refs");
+
+var _where = require("./where");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const CREATE = 'create';
+const UPDATE = 'update';
+const DELETE = 'delete';
+const DUPLICATE = 'duplicate';
+const TSGetArgs = getIDQueryArgs('TSGetArgs');
+exports.TSGetArgs = TSGetArgs;
+const TSGetSingletonArgs = getIDQueryArgs('TSGetSingletonArgs');
+exports.TSGetSingletonArgs = TSGetSingletonArgs;
+const TSListArgs = getShapeListQueryArgs('TSListArgs', true);
+exports.TSListArgs = TSListArgs;
+const TSSearchArgs = getShapeListQueryArgs('TSSearchArgs', false);
+exports.TSSearchArgs = TSSearchArgs;
+const CreateArgs = getMutationArgs('CreateArgs', CREATE);
+exports.CreateArgs = CreateArgs;
+const UpdateArgs = getMutationArgs('UpdateArgs', UPDATE);
+exports.UpdateArgs = UpdateArgs;
+const DuplicateArgs = getMutationArgs('DuplicateArgs', DUPLICATE);
+exports.DuplicateArgs = DuplicateArgs;
+const DeleteArgs = getMutationArgs('DeleteArgs', DELETE);
+exports.DeleteArgs = DeleteArgs;
+const PaginatedList = getPaginatedListShape;
+exports.PaginatedList = PaginatedList;
+const SearchResults = getSearchResultsShape;
+exports.SearchResults = SearchResults;
+const CreateResult = getMutationResultType(CREATE);
+exports.CreateResult = CreateResult;
+const UpdateResult = getMutationResultType(UPDATE);
+exports.UpdateResult = UpdateResult;
+const DuplicateResult = getMutationResultType(DUPLICATE);
+exports.DuplicateResult = DuplicateResult;
+const DeleteResult = getMutationResultType(DELETE);
+exports.DeleteResult = DeleteResult;
+const TSSearchSortInput = (0, _schemaUtil.createShape)('TSSearchSortInput', {
+  type: 'object',
+  properties: {
+    field: {
+      type: 'string'
+    },
+    order: {
+      type: 'string',
+      description: '"asc" for ascending or "desc" for descending'
+    }
+  },
+  required: ['field', 'order']
+});
+exports.TSSearchSortInput = TSSearchSortInput;
+const commonSearchProps = {
+  terms: {
+    type: 'string'
+  },
+  from: {
+    type: 'integer',
+    description: 'The offset from the first result you want to fetch.'
+  },
+  size: {
+    type: 'integer',
+    description: 'The maximum number of items to return.'
+  },
+  filter: {
+    type: 'object',
+    description: 'An elasticsearch style filter. Overrides onlyEnabled.'
+  },
+  sort: {
+    type: 'array',
+    description: 'An list of fields to sort by.',
+    items: {
+      '@ref': `local:${TSSearchSortInput.name}`
+    }
+  }
+};
+exports.commonSearchProps = commonSearchProps;
+const localeProps = {
+  type: 'object',
+  properties: {
+    locale: {
+      type: 'string'
+    },
+    enableLocaleFallback: {
+      type: 'boolean',
+      default: true
+    }
+  }
+};
+exports.localeProps = localeProps;
+const termsProps = {
+  type: 'object',
+  properties: {
+    terms: {
+      type: 'string'
+    }
+  }
+};
+exports.termsProps = termsProps;
+const ContentStructureInput = (0, _schemaUtil.createShape)('ContentStructureInput', {
+  type: 'object',
+  properties: {
+    path: {
+      type: 'string',
+      description: 'A deep path to the array being updated (e.g. a.b[1].c).'
+    },
+    structure: {
+      type: 'array',
+      description: 'An array where the indices represent the to index, and the values represent the from index.' + 'For example to transform ["a","b","c","d"] into ["c","a"], this value would be [2,0].',
+      items: {
+        type: 'integer'
+      }
+    }
+  },
+  required: ['path']
+}, {
+  description: 'Describes a structural update to an array of data.'
+});
+exports.ContentStructureInput = ContentStructureInput;
+
+function getPaginatedListShape(context, shape) {
+  const shapeName = `${shape.name}${_migration.listTypePrefix}`;
+  return {
+    shapeName,
+    dependencies: {
+      [shapeName]: (0, _schemaUtil.createShape)(shapeName, {
+        type: 'object',
+        properties: {
+          items: {
+            type: 'array',
+            items: {
+              '@ref': `local:${shape.name}`
+            }
+          },
+          total: {
+            type: 'integer'
+          }
+        },
+        required: ['items', 'total']
+      })
+    }
+  };
+}
+
+function getSearchResultsShape(context, shape) {
+  const shapeName = `${shape.name}SearchResults`;
+  return {
+    shapeName,
+    dependencies: {
+      [shapeName]: (0, _schemaUtil.createShape)(shapeName, {
+        type: 'object',
+        properties: {
+          results: {
+            type: 'array',
+            items: {
+              '@ref': `local:${shape.name}`
+            }
+          },
+          total: {
+            type: 'integer'
+          }
+        },
+        required: ['results', 'total']
+      }, {
+        description: `${shape.name} search results`
+      })
+    }
+  };
+}
+
+const contentStructureFields = {
+  type: 'object',
+  properties: {
+    structure: {
+      type: 'array',
+      items: {
+        '@ref': 'local:ContentStructureInput'
+      }
+    }
+  }
+};
+const idSchema = {
+  type: 'object',
+  properties: {
+    _id: {
+      type: 'string'
+    }
+  },
+  required: ['_id']
+};
+
+function rewriteSchema(shapeSchema) {
+  return JSON.parse(JSON.stringify(shapeSchema), (key, value) => {
+    var _value$required;
+
+    // Remove required
+    if (typeof value === 'object' && value.type === 'object' && (_value$required = value.required) !== null && _value$required !== void 0 && _value$required.length) {
+      delete value.required;
+    } // Remove default
+
+
+    if (typeof value === 'object' && value.type && value.default) {
+      delete value.default;
+    }
+
+    return value;
+  });
+}
+
+function getIDQueryArgs(templateName) {
+  return (context, shape) => {
+    var _shape$model;
+
+    const schema = ((_shape$model = shape.model) === null || _shape$model === void 0 ? void 0 : _shape$model.type) !== 'single' ? (0, _schemaUtil.mergeSchemaProperties)(idSchema, localeProps) : localeProps;
+    const shapeName = (0, _refs.getFlattenedTemplateShapeName)(shape.name, templateName);
+    return {
+      shapeName,
+      dependencies: {
+        [shapeName]: (0, _schemaUtil.createShape)(shapeName, schema)
+      }
+    };
+  };
+}
+
+function mergeObjectSchemas(...args) {
+  return args.filter(_util.isDefined).reduce(_schemaUtil.mergeSchemaProperties, {
+    type: 'object',
+    properties: {}
+  });
+}
+
+function getMutationArgs(templateName, verb) {
+  return ({
+    projectSchema
+  }, shape) => {
+    const addLocale = verb === UPDATE || verb === DUPLICATE;
+    const addStructure = verb === UPDATE;
+    const inputName = (0, _util.pascalCase)([verb, shape.name, 'input']);
+    const isSingleton = shape.model && shape.model.type === 'single';
+    const requireId = !isSingleton && (verb === UPDATE || verb === DELETE || verb === DUPLICATE);
+    const isUpdate = verb === UPDATE || verb === DUPLICATE;
+    const inputShape = (0, _schemaUtil.createShape)(inputName, mergeObjectSchemas(requireId ? idSchema : undefined, verb !== DELETE ? isUpdate ? rewriteSchema(shape.schema) : shape.schema : undefined), {
+      description: `${verb} ${shape.name} input`
+    });
+    const argsShapeName = (0, _refs.getFlattenedTemplateShapeName)(shape.name, templateName);
+    const argsShape = (0, _schemaUtil.createShape)(argsShapeName, mergeObjectSchemas({
+      type: 'object',
+      properties: {
+        input: {
+          '@ref': `local:${inputShape.name}`
+        },
+        clientMutationId: {
+          type: 'string'
+        }
+      },
+      required: ['input']
+    }, addStructure ? contentStructureFields : undefined, addLocale ? localeProps : undefined));
+
+    const getInputShapeName = shapeName => isUpdate ? `${shapeName}PartialInput` : `${shapeName}Input`;
+
+    return {
+      shapeName: argsShapeName,
+      dependencies: {
+        [inputName]: inputShape,
+        [argsShapeName]: argsShape,
+        ...(verb !== DELETE && (0, _keyBy.default)((0, _schemaUtil.getShapeDependencies)(projectSchema, shape, propSchema => {
+          if (!propSchema['@resolver']) {
+            return false;
+          }
+
+          const shapeName = (0, _refs.getRefShapeName)(projectSchema, propSchema);
+
+          if (shapeName) {
+            return !projectSchema.shapes[getInputShapeName(shapeName)];
+          }
+
+          return true;
+        }).map(shapeName => {
+          const shape = projectSchema.shapes[shapeName];
+          const name = getInputShapeName(shapeName);
+          return { ...shape,
+            name,
+            id: name,
+            schema: isUpdate ? rewriteSchema(shape.schema) : shape.schema
+          };
+        }), 'name')),
+        ...(addStructure ? {
+          ContentStructureInput
+        } : {})
+      }
+    };
+  };
+}
+
+function getMutationResultType(verb) {
+  return (context, shape) => {
+    const shapeName = (0, _util.pascalCase)([verb, shape.name, 'result']);
+    const result = verb === DELETE ? {
+      type: 'boolean'
+    } : {
+      '@ref': `local:${shape.name}`
+    };
+    return {
+      shapeName,
+      dependencies: {
+        [shapeName]: (0, _schemaUtil.createShape)(shapeName, {
+          type: 'object',
+          properties: {
+            clientMutationId: {
+              type: 'string'
+            },
+            result
+          }
+        })
+      }
+    };
+  };
+}
+
+const commonSearchArgs = {
+  type: 'object',
+  properties: {
+    terms: {
+      type: 'string'
+    },
+    from: {
+      type: 'integer',
+      description: 'The offset from the first result you want to fetch.'
+    },
+    size: {
+      type: 'integer',
+      description: 'The maximum number of items to return.'
+    },
+    filter: {
+      type: 'object',
+      description: 'An elasticsearch style filter. Overrides onlyEnabled.'
+    },
+    sort: {
+      type: 'array',
+      description: 'An list of fields to sort by.',
+      items: {
+        '@ref': `local:${TSSearchSortInput.name}`
+      }
+    }
+  }
+};
+exports.commonSearchArgs = commonSearchArgs;
+const legacyListArgs = {
+  type: 'object',
+  properties: {
+    onlyEnabled: {
+      type: 'boolean',
+      default: true,
+      description: 'Filter out content that is not enabled. Defaults to true.'
+    }
+  }
+};
+const shapeFilterProps = {
+  type: 'object',
+  properties: {
+    shapeNames: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    shapeIds: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    contentTypeNames: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    contentTypeIds: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    }
+  }
+};
+
+function getShapeListQueryArgs(templateName, legacyArgs) {
+  return (context, shape) => {
+    const isAllShapes = shape.name === 'TSSearchable';
+    const shapeName = isAllShapes ? templateName : (0, _refs.getFlattenedTemplateShapeName)(shape.name, templateName);
+    const shapes = isAllShapes ? Object.values(context.projectSchema.shapes) : [shape];
+    const {
+      schema,
+      dependencies
+    } = (0, _where.getWhereSearchArg)(context.projectSchema, shapes);
+    return {
+      shapeName,
+      dependencies: { ...dependencies,
+        TSSearchSortInput,
+        [shapeName]: (0, _schemaUtil.createShape)(shapeName, mergeObjectSchemas(commonSearchArgs, localeProps, legacyArgs ? legacyListArgs : undefined, isAllShapes ? shapeFilterProps : undefined, schema))
+      }
+    };
+  };
+}

package/lib/template-shapes/types.d.ts

@@ -0,0 +1,10 @@
+import { ProjectSchema, Shape, ShapeMap } from '../project-schema';
+export interface ResolvedTemplate {
+    shapeName: string;
+    dependencies: ShapeMap;
+}
+export interface TemplateContext {
+    projectSchema: ProjectSchema;
+}
+export declare type TemplateShapeFactory = (context: TemplateContext, shape: Shape) => ResolvedTemplate;
+//# sourceMappingURL=types.d.ts.map

package/lib/template-shapes/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/template-shapes/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAEjE,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,QAAQ,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,oBAAY,oBAAoB,GAAG,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,KAAK,KAAK,gBAAgB,CAAC"}

package/lib/template-shapes/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/lib/template-shapes/where.d.ts

@@ -0,0 +1,39 @@
+import { Maybe } from '@takeshape/util';
+import type { PropertySchema, ProjectSchema, Shape } from '../project-schema';
+import { ObjectSchema, ShapeMap } from '../project-schema';
+import { ResolvedTemplate } from './types';
+export declare const MAX_RELATIONSHIP_DEPTH = 1;
+export declare const exceededRelationshipDepth: (depth?: number) => boolean;
+declare type ComparisonOperatorKey = 'eq' | 'lt' | 'lte' | 'gt' | 'gte' | 'in' | 'match' | 'regexp';
+declare type ShapeThunk = Shape | (() => Shape);
+declare class ShapeCache {
+    thunks: Map<string, ShapeThunk>;
+    unresolved: Set<string>;
+    has(shapeName: string): boolean;
+    set(shapeName: string, thunk: ShapeThunk): void;
+    resolveAll(): ShapeMap;
+}
+export declare const fieldTypeComparison: Record<string, {
+    comparators: ComparisonOperatorKey[];
+    type: 'string' | 'number' | 'integer' | 'boolean';
+}>;
+export declare const comparatorDescriptions: Record<string, string>;
+export declare const booleanOperators: string[];
+export declare const boolOpDescriptionMap: Record<string, string>;
+export declare function getFieldTypeComparison(fieldType: string): Maybe<Record<string, PropertySchema>>;
+export interface PropertyContext {
+    shapeCache: ShapeCache;
+    conflictingProperties: string[];
+    projectSchema: ProjectSchema;
+    relationshipDepth: number;
+    booleanOperators?: boolean;
+}
+export declare function getFields(typeName: string, shapes: Shape[], context: PropertyContext): Record<string, PropertySchema>;
+export declare function getPropertyComparisonType(name: string, prop: PropertySchema, shapeName: string, context: PropertyContext): Maybe<Record<string, PropertySchema>>;
+export declare function getWhereShape(projectSchema: ProjectSchema, shapes: Shape[]): ResolvedTemplate;
+export declare function getWhereSearchArg(projectSchema: ProjectSchema, shapes: Shape[]): {
+    schema: ObjectSchema;
+    dependencies: ShapeMap;
+};
+export {};
+//# sourceMappingURL=where.d.ts.map

package/lib/template-shapes/where.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"where.d.ts","sourceRoot":"","sources":["../../../src/template-shapes/where.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,KAAK,EAAY,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAC,cAAc,EAAE,aAAa,EAAE,KAAK,EAAC,MAAM,mBAAmB,CAAC;AAY5E,OAAO,EAAC,YAAY,EAAE,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAKzD,OAAO,EAAC,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAEzC,eAAO,MAAM,sBAAsB,IAAI,CAAC;AACxC,eAAO,MAAM,yBAAyB,sBAAgB,OAA0C,CAAC;AAEjG,aAAK,qBAAqB,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5F,aAAK,UAAU,GAAG,KAAK,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;AAExC,cAAM,UAAU;IACd,MAAM,0BAAiC;IACvC,UAAU,cAAqB;IAE/B,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI/B,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;IAO/C,UAAU,IAAI,QAAQ;CAiBvB;AAED,eAAO,MAAM,mBAAmB,EAAE,MAAM,CACtC,MAAM,EACN;IAAC,WAAW,EAAE,qBAAqB,EAAE,CAAC;IAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAA;CAAC,CAW1F,CAAC;AACF,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CASzD,CAAC;AAEF,eAAO,MAAM,gBAAgB,UAAuB,CAAC;AACrD,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAIvD,CAAC;AA0BF,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAc/F;AA+FD,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,UAAU,CAAC;IACvB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,aAAa,EAAE,aAAa,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAiBD,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAiBrH;AAiCD,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,eAAe,GACvB,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CA+EvC;AA+CD,wBAAgB,aAAa,CAAC,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,gBAAgB,CAyB7F;AAED,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,KAAK,EAAE,GACd;IAAC,MAAM,EAAE,YAAY,CAAC;IAAC,YAAY,EAAE,QAAQ,CAAA;CAAC,CAiBhD"}