@takeshape/schema 11.52.0 → 11.55.0

package/dist/cjs/src/template-shapes/where.js

@@ -1,414 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.boolOpDescriptionMap = exports.booleanOperators = exports.comparatorDescriptions = exports.fieldTypeComparison = exports.exceededRelationshipDepth = exports.MAX_RELATIONSHIP_DEPTH = void 0;
-exports.getFieldTypeComparison = getFieldTypeComparison;
-exports.getFields = getFields;
-exports.getPropertyComparisonType = getPropertyComparisonType;
-exports.getWhereShape = getWhereShape;
-exports.getWhereSearchArg = getWhereSearchArg;
-const util_1 = require("@takeshape/util");
-const blueimp_md5_1 = __importDefault(require("blueimp-md5"));
-const isFunction_js_1 = __importDefault(require("lodash/isFunction.js"));
-const uniqBy_js_1 = __importDefault(require("lodash/uniqBy.js"));
-const unset_js_1 = __importDefault(require("lodash/unset.js"));
-const api_version_1 = require("../api-version");
-const refs_1 = require("../refs");
-const relationships_1 = require("../relationships");
-const schema_util_1 = require("../schema-util");
-const utils_1 = require("../types/utils");
-const unions_1 = require("../unions");
-exports.MAX_RELATIONSHIP_DEPTH = 1;
-const exceededRelationshipDepth = (depth = 0) => depth >= exports.MAX_RELATIONSHIP_DEPTH;
-exports.exceededRelationshipDepth = exceededRelationshipDepth;
-class ShapeCache {
-    thunks = new Map();
-    unresolved = new Set();
-    has(shapeName) {
-        return this.thunks.has(shapeName);
-    }
-    set(shapeName, thunk) {
-        this.thunks.set(shapeName, thunk);
-        if ((0, isFunction_js_1.default)(thunk)) {
-            this.unresolved.add(shapeName);
-        }
-    }
-    resolveAll() {
-        while (this.unresolved.size) {
-            const shapeName = this.unresolved.values().next().value;
-            if (shapeName) {
-                const thunk = this.thunks.get(shapeName);
-                if ((0, isFunction_js_1.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;
-    }
-}
-exports.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.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.booleanOperators = ['AND', 'OR', 'NOT'];
-exports.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.'
-};
-function getConflictingProperties(projectSchema, shapes) {
-    const conflicts = new Set();
-    const allProps = {};
-    for (const shape of Object.values(shapes)) {
-        for (const [name, prop] of (0, schema_util_1.createSchemaPropertyList)(projectSchema, shape).getNodes()) {
-            if (name in allProps && (allProps[name].type !== prop.type || !(0, relationships_1.isEqualRelationship)(allProps[name], prop))) {
-                conflicts.add(name);
-            }
-        }
-        if ((0, utils_1.isObjectSchema)(shape.schema)) {
-            Object.assign(allProps, shape.schema.properties);
-        }
-    }
-    return conflicts;
-}
-function getFieldTypeComparison(fieldType) {
-    const comparison = exports.fieldTypeComparison[fieldType];
-    if (!comparison) {
-        return undefined;
-    }
-    const { comparators, type } = comparison;
-    const result = {};
-    for (const op of comparators) {
-        const description = exports.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_1.hasRefProperty)(prop) && !(0, relationships_1.getRelationship)(prop));
-}
-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_1.followRef)(projectSchema, prop);
-        if (followed.enum) {
-            return 'string';
-        }
-        return 'object';
-    }
-    return prop.type;
-}
-function truncateNames(names) {
-    // For unions of many types hash the names this reduces shape name size while still allowing reuse
-    return names.length > 80 ? (0, blueimp_md5_1.default)(names) : names;
-}
-/**
- * Get a formatted string of related shape names from a property schema with a
- * relationship resolver
- */
-function getRelationshipShapeName(refs) {
-    return refs
-        .map((ref) => {
-        const shapeName = ref.split(':')[1];
-        return (0, util_1.formatShapeName)(shapeName);
-    })
-        .sort()
-        .join('');
-}
-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';
-    }
-    const relationship = (0, relationships_1.getRelationship)(prop);
-    if (relationship) {
-        const relationshipName = getRelationshipShapeName(relationship.refs);
-        if (!relationshipName) {
-            throw new Error(`Relationship property "${prop.title ?? ''}" is missing related shapes`);
-        }
-        const shapeNames = truncateNames(relationshipName);
-        return `TSWhere${shapeNames}Relationship`;
-    }
-    if ((0, unions_1.isUnionSchema)(prop)) {
-        if (prop.oneOf.length > 1) {
-            const shapeNames = truncateNames(joinShapeNames((0, unions_1.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 >= exports.MAX_RELATIONSHIP_DEPTH ? 'Shallow' : ''}Where`;
-        const fieldName = `${conflictingProperties?.has(name) ? '_' : ''}${(0, util_1.formatShapeName)(name)}`;
-        const refItem = (0, refs_1.getRefOrItemsRef)(projectSchema, prop);
-        const suffix = refItem ? (0, refs_1.refItemToNamespacedShapeName)(refItem) : `${shapeName}${fieldName}`;
-        return `${prefix}${suffix}`;
-    }
-    return `TSWhere${(0, util_1.pascalCase)(type)}`;
-}
-function skipField({ name, prop, workflowsEnabled, exceededRelationshipDepth, isIndexedShape }) {
-    const isRelationship = (0, utils_1.isPropertySchemaWithRelationship)(prop);
-    return Boolean(prop['@sensitive'] ??
-        (Boolean(prop['@resolver'] && !isIndexedShape && !isRelationship) ||
-            Boolean(isRelationship && exceededRelationshipDepth) ||
-            Boolean((name === '_enabled' || name === '_enabledAt') && workflowsEnabled)));
-}
-function getFields(typeName, shapes, context) {
-    const { relationshipDepth, booleanOperators, projectSchema } = context;
-    const result = {};
-    const tooDeep = (0, exports.exceededRelationshipDepth)(relationshipDepth);
-    const conflictingProperties = shapes.length ? getConflictingProperties(projectSchema, shapes) : undefined;
-    const fieldContext = { ...context, conflictingProperties };
-    for (const shape of shapes) {
-        const nodes = (0, schema_util_1.createSchemaPropertyList)(projectSchema, shape)
-            .filterBy(([name, prop]) => !skipField({
-            name,
-            prop,
-            workflowsEnabled: (0, api_version_1.workflowsEnabled)(projectSchema.apiVersion),
-            isIndexedShape: (0, utils_1.isCachedShape)(shape),
-            exceededRelationshipDepth: (0, exports.exceededRelationshipDepth)(relationshipDepth)
-        }))
-            .getNodes();
-        for (const [name, property] of nodes) {
-            Object.assign(result, getPropertyComparisonType(name, property, shape.name, fieldContext));
-        }
-    }
-    return tooDeep || booleanOperators === false ? result : Object.assign(result, getBooleanOperatorTypes(typeName));
-}
-function getBooleanOperatorTypes(typeName) {
-    const result = {};
-    for (const op of exports.booleanOperators) {
-        const refSchema = { '@ref': `local:${typeName}` };
-        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,
-        workflowsEnabled: (0, api_version_1.workflowsEnabled)(projectSchema.apiVersion),
-        isIndexedShape: (0, utils_1.isCachedShape)(projectSchema.shapes[shapeName]),
-        exceededRelationshipDepth: (0, exports.exceededRelationshipDepth)(relationshipDepth)
-    })) {
-        return undefined;
-    }
-    const fieldType = getPropType(projectSchema, name, prop) ?? 'string';
-    const typeName = getTypeName(name, prop, shapeName, context);
-    const relationship = (0, relationships_1.getRelationship)(prop);
-    if ((0, refs_1.hasRefProperty)(prop.items ?? prop)) {
-        if (!(0, refs_1.hasResolvableRef)(projectSchema, prop.items ?? prop)) {
-            return undefined;
-        }
-        if (prop.items) {
-            prop = { ...prop, items: (0, refs_1.followRef)(projectSchema, prop.items) };
-        }
-        else {
-            prop = (0, refs_1.followRef)(projectSchema, prop);
-        }
-    }
-    if (!shapeCache.has(typeName) && !projectSchema.shapes[typeName]) {
-        shapeCache.set(typeName, () => {
-            let props;
-            const propOrItems = prop.items ?? prop;
-            if (isId(name)) {
-                props = getFieldTypeComparison('id');
-            }
-            else if (relationship) {
-                const shapes = (0, relationships_1.getRelationshipShapes)(projectSchema.shapes, relationship.refs);
-                props = getFields(typeName, shapes, {
-                    ...context,
-                    relationshipDepth: relationshipDepth + 1
-                });
-            }
-            else if ((0, unions_1.isUnionSchema)(propOrItems)) {
-                const shapes = (0, unions_1.enumerateOneOfKeys)(projectSchema, propOrItems.oneOf).map((option) => projectSchema.shapes[option.shapeName]);
-                props = getFields(typeName, shapes, {
-                    ...context,
-                    booleanOperators: false
-                });
-            }
-            else if (fieldType === 'object' || (fieldType === 'array' && prop.items?.type === 'object')) {
-                const properties = prop.items?.properties ?? prop.properties;
-                if (properties) {
-                    props ??= {};
-                    const fieldContext = {
-                        ...context,
-                        conflictingProperties: undefined // non-union objects have no conflicts
-                    };
-                    for (const propName of Object.keys(properties)) {
-                        Object.assign(props, getPropertyComparisonType(propName, properties[propName], shapeName, fieldContext));
-                    }
-                }
-            }
-            else {
-                // Treat non-object arrays as their base type
-                let type;
-                if (typeof prop.items?.type === 'string') {
-                    type = prop.items.type;
-                }
-                else {
-                    type = fieldType;
-                }
-                props = getFieldTypeComparison(type);
-            }
-            return (0, schema_util_1.createShape)(typeName, {
-                type: 'object',
-                properties: props ?? {}
-            });
-        });
-    }
-    if (shapeCache.has(typeName) || projectSchema.shapes[typeName]) {
-        const fieldName = `${conflictingProperties?.has(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, utils_1.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, schema_util_1.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_js_1.default)(shapes, shapeName);
-                for (const path of refSummary[shapeName] ?? []) {
-                    (0, unset_js_1.default)(shapes, path);
-                }
-            }
-            toPrune = findEmpty(shapes);
-        }
-    }
-    return shapes;
-}
-function getReferencedShape(context) {
-    return (prop) => {
-        const ref = (0, refs_1.getRef)(context, prop);
-        return ref && (0, refs_1.refItemToShape)(context, ref);
-    };
-}
-/**
- * Expand union shapes
- */
-function expandUnionShapes(projectSchema, shapes) {
-    return (0, uniqBy_js_1.default)(shapes.flatMap((shape) => (0, unions_1.isUnionSchema)(shape.schema) ? shape.schema.oneOf.map(getReferencedShape(projectSchema)).filter(util_1.isDefined) : shape), 'name');
-}
-function getWhereShape(projectSchema, selectedShapes) {
-    const shapeName = selectedShapes.length === 1 ? `TSWhere${(0, util_1.pascalCase)(selectedShapes[0].name)}Input` : 'TSWhereInput';
-    if (projectSchema.shapes[shapeName]) {
-        return { shapeName, dependencies: {} };
-    }
-    const expandedShapes = expandUnionShapes(projectSchema, selectedShapes);
-    const isManyContentTypes = expandedShapes.length > 1;
-    const shapeCache = new ShapeCache();
-    const fields = getFields(shapeName, expandedShapes, {
-        projectSchema,
-        shapeCache,
-        relationshipDepth: 0
-    });
-    return {
-        shapeName,
-        dependencies: pruneEmpty({
-            [shapeName]: (0, schema_util_1.createShape)(shapeName, {
-                type: 'object',
-                properties: {
-                    ...fields,
-                    ...(isManyContentTypes && getBooleanOperatorTypes(shapeName))
-                }
-            }),
-            ...shapeCache.resolveAll()
-        })
-    };
-}
-function getWhereSearchArg(projectSchema, selectedShapes) {
-    const { shapeName, dependencies } = getWhereShape(projectSchema, selectedShapes);
-    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/dist/cjs/src/types/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./utils"), exports);
-__exportStar(require("./transforms"), exports);

package/dist/cjs/src/types/transforms.js

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

package/dist/cjs/src/types/types.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArgsType = exports.RefType = exports.legacyProjectSchemaImportOptionalProps = exports.projectSchemaImportOptionalProps = void 0;
-exports.projectSchemaImportOptionalProps = ['projectId', 'locales', 'defaultLocale', 'author'];
-exports.legacyProjectSchemaImportOptionalProps = ['created', 'updated', 'version', 'dataKey'];
-/**
- * Types of refs
- */
-var RefType;
-(function (RefType) {
-    RefType["@ref"] = "@ref";
-    RefType["$ref"] = "$ref";
-})(RefType || (exports.RefType = RefType = {}));
-/**
- * Types of args
- */
-var ArgsType;
-(function (ArgsType) {
-    ArgsType["@args"] = "@args";
-    ArgsType["args"] = "args";
-})(ArgsType || (exports.ArgsType = ArgsType = {}));