@takeshape/schema 11.40.0 → 11.41.0

package/dist/cjs/src/migration/to/v3.30.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.30.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.31.0.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("@takeshape/util");
+const set_js_1 = __importDefault(require("lodash/set.js"));
+const last_js_1 = __importDefault(require("lodash/last.js"));
+const isString_js_1 = __importDefault(require("lodash/isString.js"));
+const unset_js_1 = __importDefault(require("lodash/unset.js"));
+const TAKESHAPE_RESOLVERS = ['takeshape:getUser', 'takeshape:search', 'takeshape:queryApiIndex', 'util:wrap'];
+function getServicePath(path) {
+    const servicePath = [...path];
+    servicePath.splice(-1, 1, 'service');
+    return servicePath;
+}
+const migrate = async (_, projectSchema) => {
+    (0, util_1.visit)(projectSchema, ['@ref', '@mapping', 'name'], (value, path) => {
+        if ((0, isString_js_1.default)(value)) {
+            const name = (0, last_js_1.default)(path);
+            if (name === 'name' && value === 'debug:noop') {
+                (0, set_js_1.default)(projectSchema, path, 'util:noop');
+                (0, unset_js_1.default)(projectSchema, getServicePath(path));
+            }
+            else if (name === 'name' && value === 'util:wrap') {
+                (0, unset_js_1.default)(projectSchema, getServicePath(path));
+            }
+            else if (name === 'name' && value.startsWith('takeshape:')) {
+                const serviceName = TAKESHAPE_RESOLVERS.includes(value) ? 'takeshape' : 'shapedb';
+                (0, set_js_1.default)(projectSchema, getServicePath(path), serviceName);
+                (0, set_js_1.default)(projectSchema, path, value.replace('takeshape:', `${serviceName}:`));
+            }
+            else {
+                (0, set_js_1.default)(projectSchema, path, value.replace('takeshape:local', 'shapedb'));
+            }
+        }
+    });
+    return {
+        ...projectSchema,
+        schemaVersion: '3.31.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.32.0.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const refs_1 = require("../../refs");
+function migrateListQuery(listConfig) {
+    const { pagination, name, ...restConfig } = listConfig;
+    const result = { ...restConfig, query: name };
+    if (pagination) {
+        const { itemsToIndexPath, ...restPagination } = pagination;
+        result.pagination = { ...restPagination, itemsPath: itemsToIndexPath };
+    }
+    return result;
+}
+function queriesToLoaders(queries) {
+    if (queries.list) {
+        const loaders = {
+            list: Array.isArray(queries.list) ? queries.list.map(migrateListQuery) : migrateListQuery(queries.list)
+        };
+        if (queries.get) {
+            const { name, ...restGet } = queries.get;
+            loaders.get = { ...restGet, query: name };
+        }
+        return loaders;
+    }
+}
+function migrateTrigger(trigger) {
+    const { query, ...rest } = trigger;
+    return { ...rest, loader: query };
+}
+const migrate = async (_, projectSchema) => {
+    const updatedShapes = { ...projectSchema.shapes };
+    const { indexedShapes, ...rest } = projectSchema;
+    if (indexedShapes) {
+        for (const [name, config] of Object.entries(indexedShapes)) {
+            let shape = updatedShapes[name];
+            shape ||= {
+                name,
+                id: name,
+                title: name,
+                schema: { extends: [{ '@ref': (0, refs_1.normalizeRefExpression)(projectSchema, name) }] }
+            };
+            const loaders = queriesToLoaders(config.queries);
+            if (loaders) {
+                shape.loaders = loaders;
+            }
+            shape.cache = {
+                enabled: true,
+                fragment: config.query,
+                triggers: config.triggers.map(migrateTrigger)
+            };
+            updatedShapes[name] = shape;
+        }
+    }
+    return {
+        ...rest,
+        shapes: updatedShapes,
+        schemaVersion: '3.32.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.33.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.33.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.34.0.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrateInterfaceShapes = exports.normalizeForms = void 0;
+const util_1 = require("@takeshape/util");
+const upperFirst_js_1 = __importDefault(require("lodash/upperFirst.js"));
+const set_js_1 = __importDefault(require("lodash/fp/set.js"));
+const unset_js_1 = __importDefault(require("lodash/fp/unset.js"));
+const refs_1 = require("../../refs");
+const schema_util_1 = require("../../schema-util");
+const schemas_1 = require("../../schemas");
+const services_1 = require("../../services/services");
+const constants_1 = require("../../constants");
+// Inline utilities for posterity
+function refItemToShapeName(refItem) {
+    const { serviceNamespace, typeName } = refItem;
+    return serviceNamespace ? `${serviceNamespace}_${typeName}` : typeName;
+}
+// Map of form studio widgets and their replacements in the shape editor
+const widgetMigrations = {
+    object: 'shapeObject',
+    repeater: 'shapeArray'
+};
+function normalizeForms(projectSchema) {
+    const normalizedForms = {};
+    const { forms = {} } = projectSchema;
+    const storeSourceForm = (shapeName, formConfig, propName) => {
+        normalizedForms[shapeName] ||= { default: (0, util_1.deepClone)(formConfig) };
+        const propConfig = normalizedForms[shapeName].default.properties[propName];
+        delete propConfig.properties;
+        delete propConfig.order;
+        propConfig.widget = widgetMigrations[propConfig.widget] ?? propConfig.widget;
+    };
+    const normalizeNested = (shapeName, formConfig) => {
+        const shape = projectSchema.shapes[shapeName];
+        if (!shape || !formConfig.properties) {
+            return;
+        }
+        const propertyAccessor = (0, schema_util_1.createSchemaPropertyAccessor)(projectSchema, shape);
+        for (const propName of Object.keys(formConfig.properties)) {
+            const propConfig = formConfig.properties[propName];
+            const propSchema = propertyAccessor.getValue(propName);
+            if (propSchema) {
+                const ref = (0, refs_1.getRefOrItemsRef)(projectSchema, propSchema);
+                if (ref && propConfig.properties && propConfig.widget !== 'shopify') {
+                    const nestedShapeName = refItemToShapeName(ref);
+                    normalizedForms[nestedShapeName] = { default: (0, util_1.deepClone)(propConfig) };
+                    storeSourceForm(shapeName, formConfig, propName);
+                    normalizeNested(nestedShapeName, propConfig);
+                }
+            }
+        }
+    };
+    if (forms) {
+        for (const shapeName of Object.keys(forms)) {
+            normalizeNested(shapeName, forms[shapeName].default);
+            // copy forms with no changes
+            normalizedForms[shapeName] ||= forms[shapeName];
+        }
+    }
+    return normalizedForms;
+}
+exports.normalizeForms = normalizeForms;
+function migrateInterfaceShapes(projectSchema) {
+    let updatedProjectSchema = projectSchema;
+    for (const shape of Object.values(projectSchema.shapes)) {
+        if (!shape.model) {
+            continue;
+        }
+        // Set the schema version to the current to appease type check this line will eventually break as the schema diverges
+        const serviceObjectFields = (0, services_1.getServiceObjectFields)({ ...projectSchema, schemaVersion: schemas_1.CURRENT_SCHEMA_VERSION }, shape, 'shopify');
+        for (const field of serviceObjectFields) {
+            const { fieldName, service } = field;
+            const { serviceObjectType } = field.generators[constants_1.SERVICE_OBJECT_PATTERN_NAME];
+            const serviceShapeName = (0, upperFirst_js_1.default)(serviceObjectType);
+            const interfaceShapeName = `${serviceShapeName}Interface`;
+            updatedProjectSchema = (0, unset_js_1.default)(['shapes', interfaceShapeName], updatedProjectSchema);
+            if ('type' in shape.schema && shape.schema.type === 'object') {
+                const prop = shape.schema.properties[fieldName];
+                if (prop) {
+                    updatedProjectSchema = (0, set_js_1.default)(['shapes', shape.name, 'schema', 'properties', fieldName, '@input'], { '@ref': `${service}:${serviceShapeName}Input` }, updatedProjectSchema);
+                }
+            }
+            for (const [mutationName, mutation] of Object.entries(projectSchema.mutations)) {
+                if (!mutation || typeof mutation.args !== 'string') {
+                    continue;
+                }
+                for (const template of ['CreateArgs', 'UpdateArgs']) {
+                    // eslint-disable-next-line max-depth
+                    if (mutation.args === `${template}<${interfaceShapeName}>`) {
+                        updatedProjectSchema = (0, set_js_1.default)(['mutations', mutationName], { ...mutation, args: `${template}<${serviceShapeName}>` }, updatedProjectSchema);
+                    }
+                }
+            }
+        }
+    }
+    return updatedProjectSchema;
+}
+exports.migrateInterfaceShapes = migrateInterfaceShapes;
+const migrate = async (_, projectSchema) => {
+    let normalized = projectSchema;
+    try {
+        normalized = {
+            ...projectSchema,
+            forms: normalizeForms(projectSchema)
+        };
+    }
+    catch (e) {
+        // TODO remove console.log when a formal warning mechanism is added https://app.shortcut.com/takeshape/story/11533/return-warnings-from-schema-migration
+        // eslint-disable-next-line no-console
+        console.log(`v3.34.0 migration warning: Failed to normalize forms`, e.message);
+    }
+    try {
+        normalized = migrateInterfaceShapes(normalized);
+    }
+    catch (e) {
+        // eslint-disable-next-line no-console
+        console.log(`v3.34.0 migration warning: Failed to migrate interface shapes`, e.message);
+    }
+    return {
+        ...normalized,
+        schemaVersion: '3.34.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.35.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.35.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.36.0.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mapValues_js_1 = __importDefault(require("lodash/mapValues.js"));
+const migrate = async (_, projectSchema) => {
+    const result = {
+        ...projectSchema,
+        schemaVersion: '3.36.0'
+    };
+    result.services &&= (0, mapValues_js_1.default)(result.services, config => {
+        // Add transformVersion to OpenAPI services so we can preserve the legacy behavior
+        if (config.serviceType === 'openapi') {
+            return {
+                ...config,
+                options: {
+                    ...config.options,
+                    transformVersion: '1.0.0'
+                }
+            };
+        }
+        return config;
+    });
+    return result;
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.37.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.37.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.38.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.38.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.39.0.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("../../types");
+const migrate = async ({ decryptFn, encryptFn }, projectSchema) => {
+    /**
+     * Move unencrypted searchParams out of the authentication object.
+     */
+    Object.values(projectSchema.services ?? {}).forEach(serviceConfig => {
+        if (serviceConfig.authentication) {
+            const authentication = decryptFn(serviceConfig.authentication);
+            if ((0, types_1.isServiceAuthentication)(authentication) && (0, types_1.isSearchParamsAuthentication)(authentication)) {
+                if (serviceConfig.provider === 'judgeMe') {
+                    const shopDomain = authentication.params.find(param => param.name === 'shop_domain');
+                    if (shopDomain) {
+                        serviceConfig.options = {
+                            ...serviceConfig.options,
+                            searchParams: {
+                                shop_domain: shopDomain.value
+                            }
+                        };
+                        delete serviceConfig.options.shopDomain;
+                    }
+                    authentication.params = authentication.params.filter(param => param.name !== 'shop_domain');
+                }
+                if (serviceConfig.provider === 'reviewsIo') {
+                    const storeId = authentication.params.find(param => param.name === 'store');
+                    if (storeId) {
+                        serviceConfig.options = {
+                            ...serviceConfig.options,
+                            searchParams: {
+                                store: storeId.value
+                            }
+                        };
+                        delete serviceConfig.options.storeId;
+                    }
+                    authentication.params = authentication.params.filter(param => param.name !== 'store');
+                }
+                serviceConfig.authentication = encryptFn(authentication);
+            }
+        }
+    });
+    return {
+        ...projectSchema,
+        schemaVersion: '3.39.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.4.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.4.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.40.0.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mapValues_js_1 = __importDefault(require("lodash/mapValues.js"));
+const migrate = async (_, projectSchema) => {
+    const newShapes = (0, mapValues_js_1.default)(projectSchema.shapes, shape => {
+        // Set includeDeprecated to true for shapes to preserve behavior when indexing shapes by maxDepth
+        if (shape.cache?.fragment?.maxDepth !== undefined) {
+            const newShape = {
+                ...shape,
+                cache: {
+                    ...shape.cache,
+                    fragment: {
+                        ...shape.cache.fragment,
+                        includeDeprecated: true
+                    }
+                }
+            };
+            return newShape;
+        }
+        return shape;
+    });
+    return {
+        ...projectSchema,
+        shapes: newShapes,
+        schemaVersion: '3.40.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.41.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.41.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.42.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.42.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.43.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.43.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.44.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.44.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.45.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.45.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.46.0.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("@takeshape/util");
+// copied in case we update these in the latest version
+function isBasicResolver(resolver) {
+    return (0, util_1.isRecord)(resolver) && typeof resolver.name === 'string';
+}
+function isComposeResolver(resolver) {
+    return Boolean((0, util_1.isRecord)(resolver) &&
+        Array.isArray(resolver.compose) &&
+        resolver.compose.length &&
+        resolver.compose.every(isBasicResolver));
+}
+function renameResolver(resolver) {
+    // Replace ai:generateText with ai:chat unless history was disabled
+    if (resolver.name === 'ai:generateText' && (resolver.options?.history ?? true)) {
+        resolver.name = 'ai:chat';
+    }
+}
+const migrate = async (_, projectSchema) => {
+    /**
+     * Function will visit each resolver in the schema and mutate them.
+     */
+    (0, util_1.visit)(projectSchema, ['resolver', '@resolver'], maybeResolver => {
+        if (isComposeResolver(maybeResolver)) {
+            maybeResolver.compose.forEach(renameResolver);
+        }
+        else if (isBasicResolver(maybeResolver)) {
+            renameResolver(maybeResolver);
+        }
+    });
+    return {
+        ...projectSchema,
+        schemaVersion: '3.46.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.47.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.47.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.48.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.48.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.49.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.49.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.5.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.5.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.5.1.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.5.1'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.50.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.50.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.6.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.6.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.7.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.7.0'
+    };
+};
+exports.default = migrate;

package/dist/cjs/src/migration/to/v3.8.0.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migrate = async (_, projectSchema) => {
+    /**
+     * No migration needed all changes are backwards compatible.
+     */
+    return {
+        ...projectSchema,
+        schemaVersion: '3.8.0'
+    };
+};
+exports.default = migrate;