@takeshape/schema 8.35.2 → 8.38.0

package/lib/template-shapes/where.js

@@ -0,0 +1,534 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fieldTypeComparison = exports.exceededRelationshipDepth = exports.comparatorDescriptions = exports.booleanOperators = exports.boolOpDescriptionMap = exports.MAX_RELATIONSHIP_DEPTH = void 0;
+exports.getFieldTypeComparison = getFieldTypeComparison;
+exports.getFields = getFields;
+exports.getPropertyComparisonType = getPropertyComparisonType;
+exports.getWhereSearchArg = getWhereSearchArg;
+exports.getWhereShape = getWhereShape;
+
+var _util = require("@takeshape/util");
+
+var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _unset = _interopRequireDefault(require("lodash/unset"));
+
+var _isFunction = _interopRequireDefault(require("lodash/isFunction"));
+
+var _schemaUtil = require("../schema-util");
+
+var _apiVersion = require("../api-version");
+
+var _refs = require("../refs");
+
+var _unions = require("../unions");
+
+var _types = require("../types");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+const MAX_RELATIONSHIP_DEPTH = 1;
+exports.MAX_RELATIONSHIP_DEPTH = MAX_RELATIONSHIP_DEPTH;
+
+const exceededRelationshipDepth = (depth = 0) => depth >= MAX_RELATIONSHIP_DEPTH;
+
+exports.exceededRelationshipDepth = exceededRelationshipDepth;
+
+class ShapeCache {
+  constructor() {
+    _defineProperty(this, "thunks", new Map());
+
+    _defineProperty(this, "unresolved", new Set());
+  }
+
+  has(shapeName) {
+    return this.thunks.has(shapeName);
+  }
+
+  set(shapeName, thunk) {
+    this.thunks.set(shapeName, thunk);
+
+    if ((0, _isFunction.default)(thunk)) {
+      this.unresolved.add(shapeName);
+    }
+  }
+
+  resolveAll() {
+    while (this.unresolved.size) {
+      const shapeName = this.unresolved.values().next().value;
+      const thunk = this.thunks.get(shapeName);
+
+      if ((0, _isFunction.default)(thunk)) {
+        this.thunks.set(shapeName, thunk());
+        this.unresolved.delete(shapeName);
+      }
+    }
+
+    const result = {};
+
+    for (const [shapeName, shape] of this.thunks) {
+      result[shapeName] = shape;
+    }
+
+    return result;
+  }
+
+}
+
+const fieldTypeComparison = {
+  id: {
+    comparators: ['eq', 'in'],
+    type: 'string'
+  },
+  boolean: {
+    comparators: ['eq'],
+    type: 'boolean'
+  },
+  string: {
+    comparators: ['eq', 'in', 'match', 'regexp'],
+    type: 'string'
+  },
+  date: {
+    comparators: ['eq', 'lt', 'lte', 'gt', 'gte'],
+    type: 'string'
+  },
+  number: {
+    comparators: ['eq', 'lt', 'lte', 'gt', 'gte', 'in'],
+    type: 'number'
+  },
+  integer: {
+    comparators: ['eq', 'lt', 'lte', 'gt', 'gte', 'in'],
+    type: 'integer'
+  },
+  workflow: {
+    comparators: ['eq', 'lt', 'lte', 'gt', 'gte', 'in'],
+    type: 'string'
+  },
+  draftjs: {
+    comparators: ['match'],
+    type: 'string'
+  },
+  mdx: {
+    comparators: ['match'],
+    type: 'string'
+  }
+};
+exports.fieldTypeComparison = fieldTypeComparison;
+const comparatorDescriptions = {
+  eq: 'Exact match',
+  gt: 'Greater than',
+  gte: 'Greater than or equal',
+  lt: 'Less than',
+  lte: 'Less than or equal',
+  in: 'Array of possible exact match values.',
+  match: 'Full text searching with fuzzy matching.',
+  regexp: 'Regular expression string matching. Use of * wildcards could degrade performance.'
+};
+exports.comparatorDescriptions = comparatorDescriptions;
+const booleanOperators = ['AND', 'OR', 'NOT'];
+exports.booleanOperators = booleanOperators;
+const boolOpDescriptionMap = {
+  AND: 'AND takes an array of conditions that must appear in the matching results. Nested boolean operators can be used to create complex filters.',
+  OR: 'OR takes an array of conditions that should appear in the matching results. Nested boolean operators can be used to create complex filters.',
+  NOT: 'NOT takes a single condition that must not appear in the matching results.'
+};
+exports.boolOpDescriptionMap = boolOpDescriptionMap;
+
+const getConflictingProperties = (projectSchema, shapes) => {
+  let conflicts = [];
+  const allProps = {};
+
+  for (const shape of Object.values(shapes)) {
+    const shapeConflicts = (0, _schemaUtil.createSchemaPropertyList)(projectSchema, shape.schema).filterBy(([name, prop]) => name in allProps && (allProps[name].type !== prop.type || !(0, _isEqual.default)((0, _get.default)(allProps, [name, '@relationship', 'shapeIds']), (0, _get.default)(prop, ['@relationship', 'shapeIds'])))).getNames();
+    conflicts = conflicts.concat(shapeConflicts);
+
+    if ((0, _types.isObjectSchema)(shape.schema)) {
+      Object.assign(allProps, shape.schema.properties);
+    }
+  }
+
+  return conflicts;
+};
+
+function getFieldTypeComparison(fieldType) {
+  const comparison = fieldTypeComparison[fieldType];
+
+  if (!comparison) {
+    return undefined;
+  }
+
+  const {
+    comparators,
+    type
+  } = comparison;
+  const result = {};
+
+  for (const op of comparators) {
+    const description = comparatorDescriptions[op];
+    result[op] = op === 'in' ? {
+      type: 'array',
+      items: {
+        type
+      },
+      description
+    } : {
+      description,
+      type
+    };
+  }
+
+  return result;
+}
+
+function isId(name) {
+  return name === '_id' || name === '_contentTypeId' || name === '_shapeId';
+}
+
+function isNonRelationshipRef(prop) {
+  return Boolean((0, _refs.hasRefProperty)(prop) && !prop['@relationship']);
+}
+
+function getPropType(projectSchema, name, prop) {
+  if (prop['@workflow']) {
+    return 'workflow';
+  }
+
+  if (prop['@tag'] === 'draftjs') {
+    return 'draftjs';
+  }
+
+  if (prop['@tag'] === 'mdx') {
+    return 'mdx';
+  }
+
+  if (prop.format === 'date-time') {
+    return 'date';
+  }
+
+  if (isId(name)) {
+    return 'id';
+  }
+
+  if (isNonRelationshipRef(prop)) {
+    const followed = (0, _refs.followRef)(projectSchema, prop);
+
+    if (followed.enum) {
+      return 'string';
+    }
+
+    return 'object';
+  }
+
+  return prop.type;
+}
+
+function getRelatedShapeNames(prop, projectSchema) {
+  var _prop$Relationship;
+
+  const names = (_prop$Relationship = prop['@relationship']) === null || _prop$Relationship === void 0 ? void 0 : _prop$Relationship.shapeIds.map(id => {
+    const shape = (0, _schemaUtil.getShapeById)(projectSchema, id);
+    return (0, _util.pascalCase)(shape ? shape.name : '');
+  }).sort().join('');
+
+  if (!names) {
+    throw new Error(`Relationship property ${prop.title} is missing related shapes`);
+  }
+
+  return names;
+}
+
+function joinShapeNames(shapes) {
+  return shapes.sort().join('');
+}
+
+function getTypeName(name, prop, shapeName, context) {
+  const {
+    projectSchema,
+    relationshipDepth,
+    conflictingProperties
+  } = context;
+  let type = getPropType(projectSchema, name, prop);
+
+  if (isId(name)) {
+    return `TSWhereID`;
+  }
+
+  if (prop['@relationship']) {
+    const shapeNames = getRelatedShapeNames(prop, projectSchema);
+    return `TSWhere${shapeNames}Relationship`;
+  }
+
+  if ((0, _unions.isUnionSchema)(prop)) {
+    if (prop.oneOf.length > 1) {
+      const shapeNames = joinShapeNames((0, _unions.enumerateOneOfKeys)(projectSchema, prop.oneOf).map(child => child.shapeName));
+      return `TSWhere${shapeNames}Union`;
+    }
+
+    type = 'object';
+    prop = prop.oneOf[0];
+  }
+
+  if (type === 'object' || type === 'array') {
+    const prefix = `TS${relationshipDepth >= MAX_RELATIONSHIP_DEPTH ? 'Shallow' : ''}Where`;
+    const fieldName = `${conflictingProperties.includes(name) ? '_' : ''}${(0, _util.pascalCase)(name)}`;
+    const refItem = (0, _refs.getRefOrItemsRef)(projectSchema, prop);
+    const suffix = refItem ? (0, _refs.refItemToShapeName)(refItem) : `${shapeName}${fieldName}`;
+    return `${prefix}${suffix}`;
+  }
+
+  return `TSWhere${(0, _util.pascalCase)(type)}`;
+}
+
+function skipField(name, prop, projectSchema, exceededRelationshipDepth) {
+  return Boolean(prop['@user'] || prop['@sensitive'] || prop['@resolver'] || prop['@relationship'] && exceededRelationshipDepth || (name === '_enabled' || name === '_enabledAt') && (0, _apiVersion.workflowsEnabled)(projectSchema.apiVersion));
+}
+
+function getFields(typeName, shapes, context) {
+  const {
+    shapeCache,
+    relationshipDepth,
+    booleanOperators,
+    projectSchema
+  } = context;
+  const result = {};
+  const tooDeep = exceededRelationshipDepth(relationshipDepth);
+
+  for (const shape of shapes) {
+    const nodes = (0, _schemaUtil.createSchemaPropertyList)(projectSchema, shape.schema).filterBy(([name, property]) => !skipField(name, property, projectSchema, tooDeep)).getNodes();
+
+    for (const [name, property] of nodes) {
+      Object.assign(result, getPropertyComparisonType(name, property, shape.name, context));
+    }
+  }
+
+  return tooDeep || booleanOperators === false ? result : Object.assign(result, getBooleanOperatorTypes(result, typeName, shapeCache));
+}
+
+function getBooleanOperatorTypes(fields, typeName, shapeCache) {
+  const result = {};
+
+  for (const op of booleanOperators) {
+    const name = `${typeName}${(0, _util.pascalCase)(op)}Operator`;
+
+    if (!shapeCache.has(name)) {
+      shapeCache.set(name, () => (0, _schemaUtil.createShape)(name, {
+        type: 'object',
+        properties: { ...fields,
+          ...(op !== 'NOT' && getBooleanOperatorTypes(fields, typeName, shapeCache))
+        }
+      }, {
+        description: boolOpDescriptionMap[op]
+      }));
+    }
+
+    const refSchema = {
+      '@ref': `local:${name}`
+    };
+    result[op] = op === 'NOT' ? refSchema : {
+      type: 'array',
+      items: refSchema
+    };
+  }
+
+  return result;
+}
+
+function getPropertyComparisonType(name, prop, shapeName, context) {
+  const {
+    shapeCache,
+    projectSchema,
+    relationshipDepth,
+    conflictingProperties
+  } = context;
+
+  if (skipField(name, prop, projectSchema, exceededRelationshipDepth(relationshipDepth))) {
+    return undefined;
+  }
+
+  const fieldType = getPropType(projectSchema, name, prop) ?? 'string';
+  const typeName = getTypeName(name, prop, shapeName, context);
+
+  if ((0, _refs.hasRefProperty)(prop.items ?? prop)) {
+    if (!(0, _refs.hasResolvableRef)(projectSchema, prop.items ?? prop)) {
+      return undefined;
+    }
+
+    if (prop.items) {
+      prop = { ...prop,
+        items: (0, _refs.followRef)(projectSchema, prop.items)
+      };
+    } else {
+      prop = (0, _refs.followRef)(projectSchema, prop);
+    }
+  }
+
+  if (!shapeCache.has(typeName)) {
+    shapeCache.set(typeName, () => {
+      var _prop$items;
+
+      let props;
+      const propOrItems = prop.items ?? prop;
+
+      if (isId(name)) {
+        props = getFieldTypeComparison('id');
+      } else if (prop['@relationship']) {
+        const shapes = prop['@relationship'].shapeIds.map(id => (0, _schemaUtil.getShapeById)(projectSchema, id)).filter(_util.isDefined);
+        props = getFields(typeName, shapes, { ...context,
+          conflictingProperties: getConflictingProperties(context.projectSchema, shapes),
+          relationshipDepth: relationshipDepth + 1
+        });
+      } else if ((0, _unions.isUnionSchema)(propOrItems)) {
+        const shapes = (0, _unions.enumerateOneOfKeys)(projectSchema, propOrItems.oneOf).map(option => projectSchema.shapes[option.shapeName]);
+        props = getFields(typeName, shapes, { ...context,
+          conflictingProperties: getConflictingProperties(context.projectSchema, shapes),
+          relationshipDepth,
+          booleanOperators: false
+        });
+      } else if (fieldType === 'object' || fieldType === 'array' && ((_prop$items = prop.items) === null || _prop$items === void 0 ? void 0 : _prop$items.type) === 'object') {
+        var _prop$items2;
+
+        const properties = ((_prop$items2 = prop.items) === null || _prop$items2 === void 0 ? void 0 : _prop$items2.properties) ?? prop.properties;
+
+        if (properties) {
+          for (const propName of Object.keys(properties)) {
+            props = { ...props,
+              ...getPropertyComparisonType(propName, properties[propName], shapeName, context)
+            };
+          }
+        }
+      } else {
+        var _prop$items3;
+
+        // Treat non-object arrays as their base type
+        let type;
+
+        if (typeof ((_prop$items3 = prop.items) === null || _prop$items3 === void 0 ? void 0 : _prop$items3.type) === 'string') {
+          type = prop.items.type;
+        } else {
+          type = fieldType;
+        }
+
+        props = getFieldTypeComparison(type);
+      }
+
+      return (0, _schemaUtil.createShape)(typeName, {
+        type: 'object',
+        properties: props ?? {}
+      });
+    });
+  }
+
+  if (shapeCache.has(typeName)) {
+    const fieldName = `${conflictingProperties.includes(name) ? `${shapeName}_` : ''}${name}`;
+    return {
+      [fieldName]: {
+        '@ref': `local:${typeName}`
+      }
+    };
+  }
+}
+
+function findEmpty(shapes) {
+  const empty = new Set();
+
+  for (const [shapeName, shape] of Object.entries(shapes)) {
+    if ((0, _types.isObjectSchema)(shape.schema) && Object.keys(shape.schema.properties).length === 0) {
+      empty.add(shapeName);
+    }
+  }
+
+  return empty;
+}
+
+function getRefSummary(shapes) {
+  const result = {};
+
+  for (const ref of (0, _schemaUtil.getAllRefsInShapes)({
+    shapes,
+    services: {}
+  })) {
+    const path = ref.path.slice(1, ref.path.length - 1);
+
+    if (result[ref.typeName]) {
+      result[ref.typeName].push(path);
+    } else {
+      result[ref.typeName] = [path];
+    }
+  }
+
+  return result;
+}
+
+function pruneEmpty(shapes) {
+  let toPrune = findEmpty(shapes);
+
+  if (toPrune.size) {
+    const refSummary = getRefSummary(shapes);
+
+    while (toPrune.size) {
+      for (const shapeName of toPrune) {
+        (0, _unset.default)(shapes, shapeName);
+
+        for (const path of refSummary[shapeName] ?? []) {
+          (0, _unset.default)(shapes, path);
+        }
+      }
+
+      toPrune = findEmpty(shapes);
+    }
+  }
+
+  return shapes;
+}
+
+function getWhereShape(projectSchema, shapes) {
+  const isManyContentTypes = shapes.length > 1;
+  const shapeName = isManyContentTypes ? 'TSWhereInput' : `TSWhere${(0, _util.pascalCase)(shapes[0].name)}Input`;
+  const shapeCache = new ShapeCache();
+  const conflictingProperties = getConflictingProperties(projectSchema, shapes);
+  const fields = getFields(shapeName, shapes, {
+    projectSchema,
+    shapeCache,
+    conflictingProperties,
+    relationshipDepth: 0
+  });
+  return {
+    shapeName,
+    dependencies: pruneEmpty({
+      [shapeName]: (0, _schemaUtil.createShape)(shapeName, {
+        type: 'object',
+        properties: { ...fields,
+          ...(isManyContentTypes && getBooleanOperatorTypes(fields, shapeName, shapeCache))
+        }
+      }),
+      ...shapeCache.resolveAll()
+    })
+  };
+}
+
+function getWhereSearchArg(projectSchema, shapes) {
+  const {
+    shapeName,
+    dependencies
+  } = getWhereShape(projectSchema, shapes.filter(s => s.model !== undefined || (0, _schemaUtil.isIndexedRemoteShape)(projectSchema, s)));
+  const schema = {
+    type: 'object',
+    properties: {
+      where: {
+        '@ref': `local:${shapeName}`,
+        description: 'The where clause uses the boolean AND, OR, and NOT parameters to construct complex filters based on the values of your fields. It applies an implicit AND to all the top-level keys. To avoid this, use a single OR or NOT key as the only top-level key.'
+      }
+    }
+  };
+  return {
+    schema,
+    dependencies
+  };
+}

package/lib/validate.js

@@ -271,7 +271,7 @@ function validateQueryConfig(projectSchema, validReturnShapes, query, operation,
   const {
     template,
     shapeName
-  } = (0, _templateShapes.parseReturnShape)(projectSchema, query.shape);
+  } = (0, _refs.parseReturnShape)(projectSchema, query.shape);
 
   if (template && !(0, _templateShapes.isValidTemplate)(template)) {
     errors.push({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/schema",
-  "version": "8.35.2",
+  "version": "8.38.0",
   "description": "TakeShape Schema",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -21,9 +21,9 @@
     "examples"
   ],
   "dependencies": {
-    "@takeshape/errors": "8.35.2",
-    "@takeshape/json-schema": "8.35.2",
-    "@takeshape/util": "8.35.2",
+    "@takeshape/errors": "8.38.0",
+    "@takeshape/json-schema": "8.38.0",
+    "@takeshape/util": "8.38.0",
     "ajv": "^7.0.4",
     "ajv-formats": "^1.5.1",
     "lodash": "^4.17.20",

package/es/template-shapes.js

@@ -1,79 +0,0 @@
-import { isRefSchema } from './types/utils';
-import { getRef, refExpressionToRefItem, refItemToShapeName } from './refs';
-export const knownTemplateShapes = new Set(['TSGetArgs', 'TSGetSingletonArgs', 'PaginatedList', 'TSListArgs', 'CreateArgs', 'UpdateArgs', 'DuplicateArgs', 'DeleteArgs', 'CreateResult', 'UpdateResult', 'DuplicateResult', 'DeleteResult']);
-/**
- * Check if a string is a known template such as `PaginatedList`
- */
-
-export function isValidTemplate(template) {
-  return knownTemplateShapes.has(template);
-}
-/**
- * Parse a template like `PaginatedList<Post>` and return both the template and the shape name.
- */
-
-export function parseTemplateShape(shape) {
-  const parts = shape.split('<');
-
-  if (parts.length > 1 && isValidTemplate(parts[0])) {
-    return {
-      shapeName: parts[1].replace(/(<|>)/, ''),
-      template: parts[0]
-    };
-  }
-
-  return {
-    shapeName: parts[0],
-    template: undefined
-  };
-}
-export function parseReturnShape(projectSchema, shape) {
-  if (typeof shape === 'object') {
-    if (isRefSchema(shape.items)) {
-      const ref = getRef(projectSchema, shape.items);
-
-      if (!ref) {
-        throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid ref`);
-      }
-
-      return {
-        isArray: true,
-        ref,
-        shapeName: refItemToShapeName(ref)
-      };
-    }
-
-    if (typeof shape.items.type !== 'string') {
-      throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid type`);
-    }
-
-    return {
-      isArray: true,
-      shapeName: shape.items.type
-    };
-  }
-
-  const ref = refExpressionToRefItem(projectSchema, shape);
-  const shapeName = refItemToShapeName(ref);
-  return {
-    isArray: false,
-    shapeName,
-    ref,
-    template: ref.template
-  };
-}
-/**
- * Create a template string like `PaginatedList<Post>` from a template and shape name.
- */
-
-export function createTemplateShapeName(template, shapeName) {
-  return `${template}<${shapeName}>`;
-}
-/**
- * If the string is a template like `PaginatedList<Post>`, return the shape name,
- * in this case `Post`. Otherwise return the input.
- */
-
-export const untemplate = input => {
-  return parseTemplateShape(input).shapeName;
-};

package/lib/template-shapes.d.ts

@@ -1,32 +0,0 @@
-import type { ReturnShape } from './project-schema';
-import type { ProjectSchemaV3X } from './types/types';
-import { RefItem } from './refs';
-export declare const knownTemplateShapes: Set<string>;
-/**
- * Check if a string is a known template such as `PaginatedList`
- */
-export declare function isValidTemplate(template: string): boolean;
-/**
- * Parse a template like `PaginatedList<Post>` and return both the template and the shape name.
- */
-export declare function parseTemplateShape(shape: string): {
-    template: string | undefined;
-    shapeName: string;
-};
-export interface ParsedReturnShape {
-    isArray: boolean;
-    template?: string;
-    shapeName: string;
-    ref?: RefItem;
-}
-export declare function parseReturnShape(projectSchema: ProjectSchemaV3X, shape: ReturnShape): ParsedReturnShape;
-/**
- * Create a template string like `PaginatedList<Post>` from a template and shape name.
- */
-export declare function createTemplateShapeName(template: string, shapeName: string): string;
-/**
- * If the string is a template like `PaginatedList<Post>`, return the shape name,
- * in this case `Post`. Otherwise return the input.
- */
-export declare const untemplate: (input: string) => string;
-//# sourceMappingURL=template-shapes.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"template-shapes.d.ts","sourceRoot":"","sources":["../../src/template-shapes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,eAAe,CAAC;AAEpD,OAAO,EAAiC,OAAO,EAAqB,MAAM,QAAQ,CAAC;AAEnF,eAAO,MAAM,mBAAmB,aAa9B,CAAC;AAEH;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG;IAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,CAOnG;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,EAAE,KAAK,EAAE,WAAW,GAAG,iBAAiB,CAqBvG;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEnF;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,UAAW,MAAM,WAEvC,CAAC"}