@takeshape/schema 11.52.0 → 11.56.1

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

@@ -1,331 +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.commonSearchArgs = exports.TSContentStructureInput = exports.termsProps = exports.localeProps = exports.commonSearchProps = exports.TSSearchSortInput = exports.DeleteResult = exports.DuplicateResult = exports.UpdateResult = exports.CreateResult = exports.SearchResults = exports.PaginatedList = exports.DeleteArgs = exports.DuplicateArgs = exports.UpdateArgs = exports.CreateArgs = exports.TSSearchArgs = exports.TSListArgs = exports.TSGetSingletonArgs = exports.TSGetArgs = void 0;
-exports.getPaginatedListShape = getPaginatedListShape;
-exports.getSearchResultsShape = getSearchResultsShape;
-exports.getIDQueryArgs = getIDQueryArgs;
-exports.getMutationArgs = getMutationArgs;
-exports.getMutationResultType = getMutationResultType;
-exports.getShapeListQueryArgs = getShapeListQueryArgs;
-const util_1 = require("@takeshape/util");
-const get_js_1 = __importDefault(require("lodash/get.js"));
-const keyBy_js_1 = __importDefault(require("lodash/keyBy.js"));
-const create_input_schema_1 = require("../create-input-schema");
-const migration_1 = require("../migration");
-const refs_1 = require("../refs");
-const schema_util_1 = require("../schema-util");
-const types_1 = require("../types");
-const merge_1 = require("../util/merge");
-const names_1 = require("./names");
-const types_2 = require("./types");
-const where_1 = require("./where");
-exports.TSGetArgs = getIDQueryArgs('TSGetArgs');
-exports.TSGetSingletonArgs = getIDQueryArgs('TSGetSingletonArgs');
-exports.TSListArgs = getShapeListQueryArgs('TSListArgs', true);
-exports.TSSearchArgs = getShapeListQueryArgs('TSSearchArgs', false);
-exports.CreateArgs = getMutationArgs('CreateArgs', types_2.TemplateVerbs.Create);
-exports.UpdateArgs = getMutationArgs('UpdateArgs', types_2.TemplateVerbs.Update);
-exports.DuplicateArgs = getMutationArgs('DuplicateArgs', types_2.TemplateVerbs.Duplicate);
-exports.DeleteArgs = getMutationArgs('DeleteArgs', types_2.TemplateVerbs.Delete);
-exports.PaginatedList = getPaginatedListShape;
-exports.SearchResults = getSearchResultsShape;
-exports.CreateResult = getMutationResultType(types_2.TemplateVerbs.Create);
-exports.UpdateResult = getMutationResultType(types_2.TemplateVerbs.Update);
-exports.DuplicateResult = getMutationResultType(types_2.TemplateVerbs.Duplicate);
-exports.DeleteResult = getMutationResultType(types_2.TemplateVerbs.Delete);
-exports.TSSearchSortInput = (0, schema_util_1.createShape)('TSSearchSortInput', {
-    type: 'object',
-    properties: {
-        field: { type: 'string' },
-        order: {
-            type: 'string',
-            description: '"asc" for ascending or "desc" for descending'
-        }
-    },
-    required: ['field', 'order']
-});
-exports.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:${exports.TSSearchSortInput.name}`
-        }
-    }
-};
-exports.localeProps = {
-    type: 'object',
-    properties: {
-        locale: { type: 'string' },
-        enableLocaleFallback: { type: 'boolean', default: true }
-    }
-};
-exports.termsProps = {
-    type: 'object',
-    properties: {
-        terms: { type: 'string' }
-    }
-};
-exports.TSContentStructureInput = (0, schema_util_1.createShape)('TSContentStructureInput', {
-    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.' });
-function getPaginatedListShape(context, shape) {
-    const shapeName = `${shape.name}${migration_1.listTypePrefix}`;
-    return {
-        shapeName,
-        dependencies: {
-            [shapeName]: (0, schema_util_1.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, schema_util_1.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:TSContentStructureInput'
-            }
-        }
-    }
-};
-const idSchema = {
-    type: 'object',
-    properties: {
-        _id: { type: 'string' }
-    },
-    required: ['_id']
-};
-function getIDQueryArgs(templateName) {
-    return (context, shape) => {
-        const schema = shape.model?.type !== 'single' ? (0, merge_1.mergeSchemaProperties)(idSchema, exports.localeProps) : exports.localeProps;
-        const shapeName = (0, refs_1.getFlattenedTemplateShapeName)(shape.name, templateName);
-        return {
-            shapeName,
-            dependencies: {
-                [shapeName]: (0, schema_util_1.createShape)(shapeName, schema)
-            }
-        };
-    };
-}
-function rewriteRefs(context, shapeSchema, rewriteShapeName) {
-    const newSchema = (0, util_1.deepClone)(shapeSchema);
-    (0, util_1.visit)(newSchema, ['$ref', '@ref'], (_, path) => {
-        const parentPath = path.slice(0, -1);
-        const value = (0, get_js_1.default)(newSchema, parentPath);
-        if ((value['@ref'] || value.$ref) && !parentPath.includes('@input') && !parentPath.includes('@output')) {
-            const refItem = (0, refs_1.getRef)(context, value);
-            if (refItem) {
-                value['@ref'] = refItem.isForeign
-                    ? (0, refs_1.refItemToAtRef)(refItem)
-                    : `local:${rewriteShapeName((0, refs_1.refItemToNamespacedShapeName)(refItem))}`;
-                if (value.$ref) {
-                    // biome-ignore lint/performance/noDelete: Property presence may matter here
-                    delete value.$ref;
-                }
-            }
-        }
-    });
-    return newSchema;
-}
-/**
- * Construct shapes for a mutation inputs, given source shape info.
- */
-function getMutationArgs(templateName, verb) {
-    const getShapeName = (0, names_1.getMutationInputShapeName)(verb);
-    const addLocale = verb === types_2.TemplateVerbs.Update || verb === types_2.TemplateVerbs.Duplicate;
-    const addStructure = verb === types_2.TemplateVerbs.Update;
-    const isUpdate = verb === types_2.TemplateVerbs.Update || verb === types_2.TemplateVerbs.Duplicate;
-    return ({ projectSchema }, shape) => {
-        const inputName = getShapeName(shape.name);
-        const isSingleton = shape.model && shape.model.type === 'single';
-        const shouldRequireId = !isSingleton &&
-            (verb === types_2.TemplateVerbs.Update || verb === types_2.TemplateVerbs.Delete || verb === types_2.TemplateVerbs.Duplicate);
-        let rewrittenSchema;
-        let inputShapeSchema;
-        if (verb !== types_2.TemplateVerbs.Delete) {
-            rewrittenSchema = (0, create_input_schema_1.createInputSchema)(shape.schema, { isUpdate });
-            inputShapeSchema = rewriteRefs(projectSchema, rewrittenSchema, names_1.getInputShapeName);
-        }
-        const inputShape = (0, schema_util_1.createShape)(inputName, (0, merge_1.mergeObjectSchemas)(shouldRequireId ? idSchema : undefined, inputShapeSchema), { description: `${verb} ${shape.name} input` });
-        const argsShapeName = (0, refs_1.getFlattenedTemplateShapeName)(shape.name, templateName);
-        const argsShape = (0, schema_util_1.createShape)(argsShapeName, (0, merge_1.mergeObjectSchemas)({
-            type: 'object',
-            properties: {
-                input: { '@ref': `local:${inputShape.name}` },
-                clientMutationId: { type: 'string' }
-            },
-            required: ['input']
-        }, addStructure ? contentStructureFields : undefined, addLocale ? exports.localeProps : undefined));
-        return {
-            shapeName: argsShapeName,
-            dependencies: {
-                [inputName]: inputShape,
-                [argsShapeName]: argsShape,
-                ...(verb !== types_2.TemplateVerbs.Delete &&
-                    (0, keyBy_js_1.default)((0, schema_util_1.getShapeDependencies)(projectSchema, 
-                    // get the shape dependencies of the shape with the @input swapped
-                    (0, schema_util_1.createShape)(inputShape.name, rewrittenSchema), (propSchema) => {
-                        if (propSchema['@resolver']) {
-                            return false;
-                        }
-                        const shapeName = (0, refs_1.getRefShapeName)(projectSchema, propSchema);
-                        if (shapeName) {
-                            return shapeName !== 'TSRelationship' && !projectSchema.shapes[(0, names_1.getInputShapeName)(shapeName)];
-                        }
-                        return true;
-                    })
-                        .map((shapeName) => {
-                        const shape = projectSchema.shapes[shapeName];
-                        if (!shape) {
-                            return;
-                        }
-                        // We only allow partial input at the top-level
-                        return (0, schema_util_1.createShape)((0, names_1.getInputShapeName)(shapeName), rewriteRefs(projectSchema, (0, create_input_schema_1.createInputSchema)(shape.schema), names_1.getInputShapeName));
-                    })
-                        .filter(util_1.isDefined), 'name')),
-                ...(addStructure ? { TSContentStructureInput: exports.TSContentStructureInput } : {})
-            }
-        };
-    };
-}
-function getMutationResultType(verb) {
-    return (context, shape) => {
-        const shapeName = (0, util_1.formatShapeName)([verb, shape.name, 'result'], {
-            shapeNameIndex: 1
-        });
-        const result = verb === types_2.TemplateVerbs.Delete ? { type: 'boolean' } : { '@ref': `local:${shape.name}` };
-        return {
-            shapeName,
-            dependencies: {
-                [shapeName]: (0, schema_util_1.createShape)(shapeName, {
-                    type: 'object',
-                    properties: {
-                        clientMutationId: { type: 'string' },
-                        result
-                    }
-                })
-            }
-        };
-    };
-}
-exports.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:${exports.TSSearchSortInput.name}`
-            }
-        }
-    }
-};
-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 { projectSchema } = context;
-        const isAllShapes = shape.name === 'TSSearchable';
-        const shapeName = isAllShapes ? templateName : (0, refs_1.getFlattenedTemplateShapeName)(shape.name, templateName);
-        const shapes = isAllShapes
-            ? Object.values(projectSchema.shapes).filter((s) => s.model !== undefined || (0, types_1.isCachedShape)(s))
-            : [shape];
-        const { schema, dependencies } = (0, where_1.getWhereSearchArg)(projectSchema, shapes);
-        return {
-            shapeName,
-            dependencies: {
-                ...dependencies,
-                TSSearchSortInput: exports.TSSearchSortInput,
-                [shapeName]: (0, schema_util_1.createShape)(shapeName, (0, merge_1.mergeObjectSchemas)(exports.commonSearchArgs, exports.localeProps, legacyArgs ? legacyListArgs : undefined, isAllShapes ? shapeFilterProps : undefined, schema))
-            }
-        };
-    };
-}

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

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateVerbs = void 0;
-var TemplateVerbs;
-(function (TemplateVerbs) {
-    TemplateVerbs["Create"] = "create";
-    TemplateVerbs["Update"] = "update";
-    TemplateVerbs["Duplicate"] = "duplicate";
-    TemplateVerbs["Delete"] = "delete";
-})(TemplateVerbs || (exports.TemplateVerbs = TemplateVerbs = {}));