@takeshape/schema 11.52.0 → 11.56.1

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

@@ -1,116 +0,0 @@
-import { deepClone } from "@takeshape/util";
-import set from "lodash/fp/set.js";
-import unset from "lodash/fp/unset.js";
-import upperFirst from "lodash/upperFirst.js";
-import { SERVICE_OBJECT_PATTERN_NAME } from "../../constants.js";
-import { getRefOrItemsRef } from "../../refs.js";
-import { createSchemaPropertyAccessor } from "../../schema-util.js";
-import { CURRENT_SCHEMA_VERSION } from "../../schemas/index.js";
-import { getServiceObjectFields } from "../../services/services.js";
-// 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"
-};
-export function normalizeForms(projectSchema) {
-    const normalizedForms = {};
-    const { forms = {} } = projectSchema;
-    const storeSourceForm = (shapeName, formConfig, propName) => {
-        normalizedForms[shapeName] ||= { default: deepClone(formConfig) };
-        const propConfig = normalizedForms[shapeName].default.properties[propName];
-        propConfig.properties = undefined;
-        propConfig.order = undefined;
-        propConfig.widget = widgetMigrations[propConfig.widget] ?? propConfig.widget;
-    };
-    const normalizeNested = (shapeName, formConfig) => {
-        const shape = projectSchema.shapes[shapeName];
-        if (!shape || !formConfig.properties) {
-            return;
-        }
-        const propertyAccessor = 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 = getRefOrItemsRef(projectSchema, propSchema);
-                if (ref && propConfig.properties && propConfig.widget !== "shopify") {
-                    const nestedShapeName = refItemToShapeName(ref);
-                    normalizedForms[nestedShapeName] = { default: 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;
-}
-export 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 = getServiceObjectFields({ ...projectSchema, schemaVersion: CURRENT_SCHEMA_VERSION }, shape, "shopify");
-        for (const field of serviceObjectFields) {
-            const { fieldName, service } = field;
-            const { serviceObjectType } = field.generators[SERVICE_OBJECT_PATTERN_NAME];
-            const serviceShapeName = upperFirst(serviceObjectType);
-            const interfaceShapeName = `${serviceShapeName}Interface`;
-            updatedProjectSchema = unset(["shapes", interfaceShapeName], updatedProjectSchema);
-            if ("type" in shape.schema && shape.schema.type === "object") {
-                const prop = shape.schema.properties[fieldName];
-                if (prop) {
-                    updatedProjectSchema = set(["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"]) {
-                    if (mutation.args === `${template}<${interfaceShapeName}>`) {
-                        updatedProjectSchema = set(["mutations", mutationName], { ...mutation, args: `${template}<${serviceShapeName}>` }, updatedProjectSchema);
-                    }
-                }
-            }
-        }
-    }
-    return updatedProjectSchema;
-}
-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
-        console.info("v3.34.0 migration warning: Failed to normalize forms", e.message);
-    }
-    try {
-        normalized = migrateInterfaceShapes(normalized);
-    }
-    catch (e) {
-        console.info("v3.34.0 migration warning: Failed to migrate interface shapes", e.message);
-    }
-    return {
-        ...normalized,
-        schemaVersion: "3.34.0"
-    };
-};
-export default migrate;

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

@@ -1,45 +0,0 @@
-import { isSearchParamsAuthentication, isServiceAuthentication } from "../../types/index.js";
-const migrate = async ({ decryptFn, encryptFn }, projectSchema) => {
-    /**
-     * Move unencrypted searchParams out of the authentication object.
-     */
-    for (const serviceConfig of Object.values(projectSchema.services ?? {})) {
-        if (serviceConfig.authentication) {
-            const authentication = decryptFn(serviceConfig.authentication);
-            if (isServiceAuthentication(authentication) && 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
-                            }
-                        };
-                        serviceConfig.options.shopDomain = undefined;
-                    }
-                    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
-                            }
-                        };
-                        serviceConfig.options.storeId = undefined;
-                    }
-                    authentication.params = authentication.params.filter((param) => param.name !== "store");
-                }
-                serviceConfig.authentication = encryptFn(authentication);
-            }
-        }
-    }
-    return {
-        ...projectSchema,
-        schemaVersion: "3.39.0"
-    };
-};
-export default migrate;

package/dist/esm/src/mocks.js

@@ -1,58 +0,0 @@
-import { pascalCase } from "@takeshape/util";
-import { applyDefaultsToSchema, emptySchema } from "./schema-util.js";
-/**
- * Like emptySchema, but for tests.
- */
-export function createMockSchema(projectId, schema = {}) {
-    return {
-        ...emptySchema(projectId),
-        ...schema,
-        projectId
-    };
-}
-/**
- * Capturing a common pattern used in tests. Creates an empty schema, with defaults.
- */
-export function createMockSchemaWithDefaults(projectId, schema = {}) {
-    return applyDefaultsToSchema({
-        ...emptySchema(projectId),
-        ...schema,
-        projectId
-    });
-}
-export function createMockServiceConfig(serviceKey, serviceConfig) {
-    return {
-        id: serviceKey,
-        title: pascalCase(serviceKey),
-        provider: "graphql",
-        serviceType: "graphql",
-        namespace: pascalCase(serviceKey),
-        authenticationType: "bearer",
-        authentication: {
-            type: "bearer",
-            token: "abc123"
-        },
-        options: {
-            endpoint: "https://example.test/graphql"
-        },
-        ...serviceConfig
-    };
-}
-export function createMockStoredServiceConfig(serviceKey, serviceConfig) {
-    return {
-        ...createMockServiceConfig(serviceKey),
-        authentication: "encrypted-abc123",
-        ...serviceConfig
-    };
-}
-export function addMockIndexingConfig(shape) {
-    return {
-        ...shape,
-        loaders: {
-            list: {
-                query: `Query.get${shape.name}List`
-            }
-        },
-        cache: { enabled: true }
-    };
-}

package/dist/esm/src/models/project-schema.js

@@ -1,92 +0,0 @@
-import omit from "lodash/omit.js";
-import { atRefToRefItem, getRef, normalizeRefExpression, refExpressionToRefItem, shapeToRefItem } from "../refs.js";
-import { getAllRefs } from "../schema-util.js";
-import { getShape, getShapeById } from "../util/shapes.js";
-import { QueryModel } from "./query.js";
-import { ServiceConfig } from "./service.js";
-import { ShapeModel } from "./shape.js";
-/**
- * Model object representing a ProjectSchema.
- * Intended to help make it easier to find the right utils
- * and avoid direct schema json access where a util would be preferred.
- */
-export class ProjectSchema {
-    _projectSchemaJSON;
-    _cache = {};
-    constructor(unfilteredProjectSchema) {
-        // You can pass a ProjectSchemaCompat in here, but we remove its values so they don't get passed through to getJSON.
-        // If you need to use this metadata it should be stored separately.
-        this._projectSchemaJSON = omit(unfilteredProjectSchema, ["created", "updated", "version"]);
-    }
-    get json() {
-        return this._projectSchemaJSON;
-    }
-    get projectId() {
-        return this.json.projectId;
-    }
-    get $schema() {
-        return this.json.$schema;
-    }
-    get author() {
-        return this.json.author;
-    }
-    getShapeByName(shapeName) {
-        const shapeJSON = getShape(this.json, shapeName);
-        if (!shapeJSON) {
-            return undefined;
-        }
-        const shapeRefItem = shapeToRefItem(this.json, shapeJSON);
-        return new ShapeModel(this, shapeRefItem);
-    }
-    getShapeById(shapeId) {
-        const shapeJSON = getShapeById(this.json, shapeId);
-        if (!shapeJSON) {
-            return undefined;
-        }
-        const shapeRefItem = shapeToRefItem(this.json, shapeJSON);
-        return new ShapeModel(this, shapeRefItem);
-    }
-    getShapeByRef(shapeRef) {
-        return new ShapeModel(this, shapeRef);
-    }
-    get shapes() {
-        this._cache.shapes ??= Object.keys(this.json.shapes).map((name) => new ShapeModel(this, normalizeRefExpression(this.json, name)));
-        return this._cache.shapes;
-    }
-    get refs() {
-        this._cache.refs ??= getAllRefs(this.json);
-        return this._cache.refs;
-    }
-    getQueryByName(queryName) {
-        return new QueryModel(this, "query", queryName);
-    }
-    get queries() {
-        this._cache.queries ??= Object.keys(this.json.queries).map((name) => new QueryModel(this, "query", name));
-        return this._cache.queries;
-    }
-    getMutationByName(mutationName) {
-        return new QueryModel(this, "mutation", mutationName);
-    }
-    get mutations() {
-        this._cache.mutations = Object.keys(this.json.mutations).map((name) => new QueryModel(this, "mutation", name));
-        return this._cache.mutations;
-    }
-    getServiceById(serviceId) {
-        return new ServiceConfig(this, serviceId);
-    }
-    atRefToRefItem(atRef, template) {
-        return atRefToRefItem(this.json, atRef, template);
-    }
-    refItemToShape(refItem) {
-        return new ShapeModel(this, refItem);
-    }
-    getRef(refSchema) {
-        return getRef(this.json, refSchema);
-    }
-    normalizeRefExpression(refExpression) {
-        return normalizeRefExpression(this.json, refExpression);
-    }
-    refExpressionToRefItem(refExpression) {
-        return refExpressionToRefItem(this.json, refExpression);
-    }
-}

package/dist/esm/src/models/shape.js

@@ -1,85 +0,0 @@
-import { isInterfaceShape } from "../interfaces.js";
-import { refItemToShape } from "../refs.js";
-import { createSchemaPropertyAccessor, createSchemaPropertyList, getShapeByRef } from "../schema-util.js";
-import { isCachedShape, isModelShape } from "../types/index.js";
-/**
- * Create a shape model from either a ref item or a ref string such as `rick:Character`
- */
-export class ShapeModel {
-    _projectSchemaModel;
-    _rawShape;
-    _shapeRefItem;
-    _shapeAtRef;
-    constructor(_projectSchemaModel, refArg) {
-        this._projectSchemaModel = _projectSchemaModel;
-        if (typeof refArg === "string") {
-            const rawShape = getShapeByRef(_projectSchemaModel.json, refArg);
-            if (!rawShape) {
-                throw new Error(`Error creating shape model: ${refArg} is not in project schema`);
-            }
-            this._rawShape = rawShape;
-            this._shapeRefItem = _projectSchemaModel.atRefToRefItem(refArg);
-            this._shapeAtRef = refArg;
-        }
-        else {
-            const rawShape = refItemToShape(_projectSchemaModel.json, refArg);
-            if (!rawShape) {
-                throw new Error("Error creating shape model: ref item argument could not be resolved to a shape");
-            }
-            this._rawShape = rawShape;
-            this._shapeRefItem = refArg;
-            this._shapeAtRef = `${refArg.serviceKey}:${refArg.typeName}`;
-        }
-    }
-    get json() {
-        return this._rawShape;
-    }
-    get id() {
-        return this._rawShape.id;
-    }
-    get name() {
-        return this._rawShape.name;
-    }
-    get title() {
-        return this._rawShape.title;
-    }
-    get description() {
-        return this._rawShape.description;
-    }
-    get schema() {
-        return this._rawShape.schema;
-    }
-    get schemaPropertyList() {
-        return createSchemaPropertyList(this._projectSchemaModel.json, this._rawShape);
-    }
-    get schemaPropertyAccessor() {
-        return createSchemaPropertyAccessor(this._projectSchemaModel.json, this._rawShape);
-    }
-    get refString() {
-        return this._shapeAtRef;
-    }
-    get refItem() {
-        return this._shapeRefItem;
-    }
-    get serviceId() {
-        return this._shapeRefItem.serviceKey;
-    }
-    get modelType() {
-        return this._rawShape.model?.type;
-    }
-    get interfaces() {
-        return this._rawShape.interfaces;
-    }
-    get isModel() {
-        return isModelShape(this._rawShape);
-    }
-    get isCached() {
-        return isCachedShape(this._rawShape);
-    }
-    get isAsset() {
-        return this._rawShape.id === "ASSET";
-    }
-    get isInterfaceShape() {
-        return isInterfaceShape(this._rawShape);
-    }
-}

package/dist/esm/src/project-schema/index.js

@@ -1,138 +0,0 @@
-// This file is generated by "pnpm json2ts"
-export * from "./latest.js";
-export * from "./v1.0.0.js";
-export * from "./v3.0.0.js";
-export * from "./v3.1.0.js";
-export * from "./v3.2.0.js";
-export * from "./v3.3.0.js";
-export * from "./v3.4.0.js";
-export * from "./v3.5.0.js";
-export * from "./v3.5.1.js";
-export * from "./v3.6.0.js";
-export * from "./v3.7.0.js";
-export * from "./v3.8.0.js";
-export * from "./v3.9.0.js";
-export * from "./v3.10.0.js";
-export * from "./v3.11.0.js";
-export * from "./v3.12.0.js";
-export * from "./v3.12.1.js";
-export * from "./v3.12.2.js";
-export * from "./v3.12.3.js";
-export * from "./v3.13.0.js";
-export * from "./v3.14.0.js";
-export * from "./v3.15.0.js";
-export * from "./v3.16.0.js";
-export * from "./v3.17.0.js";
-export * from "./v3.17.1.js";
-export * from "./v3.18.0.js";
-export * from "./v3.18.1.js";
-export * from "./v3.18.2.js";
-export * from "./v3.19.0.js";
-export * from "./v3.20.0.js";
-export * from "./v3.21.0.js";
-export * from "./v3.22.0.js";
-export * from "./v3.23.0.js";
-export * from "./v3.24.0.js";
-export * from "./v3.25.0.js";
-export * from "./v3.26.0.js";
-export * from "./v3.27.0.js";
-export * from "./v3.28.0.js";
-export * from "./v3.29.0.js";
-export * from "./v3.30.0.js";
-export * from "./v3.31.0.js";
-export * from "./v3.32.0.js";
-export * from "./v3.33.0.js";
-export * from "./v3.34.0.js";
-export * from "./v3.35.0.js";
-export * from "./v3.36.0.js";
-export * from "./v3.37.0.js";
-export * from "./v3.38.0.js";
-export * from "./v3.39.0.js";
-export * from "./v3.40.0.js";
-export * from "./v3.41.0.js";
-export * from "./v3.42.0.js";
-export * from "./v3.43.0.js";
-export * from "./v3.44.0.js";
-export * from "./v3.45.0.js";
-export * from "./v3.46.0.js";
-export * from "./v3.47.0.js";
-export * from "./v3.48.0.js";
-export * from "./v3.49.0.js";
-export * from "./v3.50.0.js";
-export * from "./v3.51.0.js";
-export * from "./v4.0.0.js";
-// Schema type utilities
-function createVersionPredicate(expectedVersion) {
-    return (projectSchema) => {
-        let { schemaVersion } = projectSchema;
-        if (!schemaVersion || schemaVersion === "1") {
-            schemaVersion = "1.0.0";
-        }
-        if (schemaVersion === "3") {
-            schemaVersion = "3.0.0";
-        }
-        return Boolean(expectedVersion && schemaVersion && expectedVersion === schemaVersion);
-    };
-}
-export const isProjectSchemaJSONV1_0_0 = createVersionPredicate("1.0.0");
-export const isProjectSchemaJSONV3_0_0 = createVersionPredicate("3.0.0");
-export const isProjectSchemaJSONV3_1_0 = createVersionPredicate("3.1.0");
-export const isProjectSchemaJSONV3_2_0 = createVersionPredicate("3.2.0");
-export const isProjectSchemaJSONV3_3_0 = createVersionPredicate("3.3.0");
-export const isProjectSchemaJSONV3_4_0 = createVersionPredicate("3.4.0");
-export const isProjectSchemaJSONV3_5_0 = createVersionPredicate("3.5.0");
-export const isProjectSchemaJSONV3_5_1 = createVersionPredicate("3.5.1");
-export const isProjectSchemaJSONV3_6_0 = createVersionPredicate("3.6.0");
-export const isProjectSchemaJSONV3_7_0 = createVersionPredicate("3.7.0");
-export const isProjectSchemaJSONV3_8_0 = createVersionPredicate("3.8.0");
-export const isProjectSchemaJSONV3_9_0 = createVersionPredicate("3.9.0");
-export const isProjectSchemaJSONV3_10_0 = createVersionPredicate("3.10.0");
-export const isProjectSchemaJSONV3_11_0 = createVersionPredicate("3.11.0");
-export const isProjectSchemaJSONV3_12_0 = createVersionPredicate("3.12.0");
-export const isProjectSchemaJSONV3_12_1 = createVersionPredicate("3.12.1");
-export const isProjectSchemaJSONV3_12_2 = createVersionPredicate("3.12.2");
-export const isProjectSchemaJSONV3_12_3 = createVersionPredicate("3.12.3");
-export const isProjectSchemaJSONV3_13_0 = createVersionPredicate("3.13.0");
-export const isProjectSchemaJSONV3_14_0 = createVersionPredicate("3.14.0");
-export const isProjectSchemaJSONV3_15_0 = createVersionPredicate("3.15.0");
-export const isProjectSchemaJSONV3_16_0 = createVersionPredicate("3.16.0");
-export const isProjectSchemaJSONV3_17_0 = createVersionPredicate("3.17.0");
-export const isProjectSchemaJSONV3_17_1 = createVersionPredicate("3.17.1");
-export const isProjectSchemaJSONV3_18_0 = createVersionPredicate("3.18.0");
-export const isProjectSchemaJSONV3_18_1 = createVersionPredicate("3.18.1");
-export const isProjectSchemaJSONV3_18_2 = createVersionPredicate("3.18.2");
-export const isProjectSchemaJSONV3_19_0 = createVersionPredicate("3.19.0");
-export const isProjectSchemaJSONV3_20_0 = createVersionPredicate("3.20.0");
-export const isProjectSchemaJSONV3_21_0 = createVersionPredicate("3.21.0");
-export const isProjectSchemaJSONV3_22_0 = createVersionPredicate("3.22.0");
-export const isProjectSchemaJSONV3_23_0 = createVersionPredicate("3.23.0");
-export const isProjectSchemaJSONV3_24_0 = createVersionPredicate("3.24.0");
-export const isProjectSchemaJSONV3_25_0 = createVersionPredicate("3.25.0");
-export const isProjectSchemaJSONV3_26_0 = createVersionPredicate("3.26.0");
-export const isProjectSchemaJSONV3_27_0 = createVersionPredicate("3.27.0");
-export const isProjectSchemaJSONV3_28_0 = createVersionPredicate("3.28.0");
-export const isProjectSchemaJSONV3_29_0 = createVersionPredicate("3.29.0");
-export const isProjectSchemaJSONV3_30_0 = createVersionPredicate("3.30.0");
-export const isProjectSchemaJSONV3_31_0 = createVersionPredicate("3.31.0");
-export const isProjectSchemaJSONV3_32_0 = createVersionPredicate("3.32.0");
-export const isProjectSchemaJSONV3_33_0 = createVersionPredicate("3.33.0");
-export const isProjectSchemaJSONV3_34_0 = createVersionPredicate("3.34.0");
-export const isProjectSchemaJSONV3_35_0 = createVersionPredicate("3.35.0");
-export const isProjectSchemaJSONV3_36_0 = createVersionPredicate("3.36.0");
-export const isProjectSchemaJSONV3_37_0 = createVersionPredicate("3.37.0");
-export const isProjectSchemaJSONV3_38_0 = createVersionPredicate("3.38.0");
-export const isProjectSchemaJSONV3_39_0 = createVersionPredicate("3.39.0");
-export const isProjectSchemaJSONV3_40_0 = createVersionPredicate("3.40.0");
-export const isProjectSchemaJSONV3_41_0 = createVersionPredicate("3.41.0");
-export const isProjectSchemaJSONV3_42_0 = createVersionPredicate("3.42.0");
-export const isProjectSchemaJSONV3_43_0 = createVersionPredicate("3.43.0");
-export const isProjectSchemaJSONV3_44_0 = createVersionPredicate("3.44.0");
-export const isProjectSchemaJSONV3_45_0 = createVersionPredicate("3.45.0");
-export const isProjectSchemaJSONV3_46_0 = createVersionPredicate("3.46.0");
-export const isProjectSchemaJSONV3_47_0 = createVersionPredicate("3.47.0");
-export const isProjectSchemaJSONV3_48_0 = createVersionPredicate("3.48.0");
-export const isProjectSchemaJSONV3_49_0 = createVersionPredicate("3.49.0");
-export const isProjectSchemaJSONV3_50_0 = createVersionPredicate("3.50.0");
-export const isProjectSchemaJSONV3_51_0 = createVersionPredicate("3.51.0");
-export const isLatestProjectSchemaJSON = createVersionPredicate("3.51.0");
-export const isProjectSchemaJSONV4_0_0 = createVersionPredicate("4.0.0");