@takeshape/schema 11.73.0 → 11.76.0

package/dist/__tests__/workflows.test.d.ts

@@ -1,3 +0,0 @@
-import type { Workflow } from '../project-schema/index.ts';
-export declare const simpleWorkflow: Workflow;
-export declare const complexWorkflow: Workflow;

package/dist/__tests__/workflows.test.js

@@ -1,149 +0,0 @@
-import { expect, test } from 'vitest';
-import postSchemaJson from '@/examples/latest/post-schema.json';
-import { applyDefaultsToSchema } from "../schema-util.js";
-import { defaultWorkflow, findWorkflowStep, getLiveStepKeys, getStatusField, getWorkflow, getWorkflowStepKeys, statusFallback } from "../workflows.js";
-const postSchema = applyDefaultsToSchema(postSchemaJson);
-test('getStatusFieldV3', () => {
-    const shape = {
-        name: 'post',
-        workflow: 'default',
-        title: 'post',
-        id: 'post',
-        schema: {
-            type: 'object',
-            properties: {
-                title: { type: 'string' },
-                body: { type: 'string' }
-            },
-            required: ['title', 'body']
-        }
-    };
-    expect(getStatusField({ default: defaultWorkflow }, shape)).toEqual({
-        type: 'string',
-        '@workflow': 'default',
-        title: 'Status'
-    });
-});
-test('getWorkflow', () => {
-    expect(getWorkflow(postSchema, '<postContentTypeId>')).toEqual(defaultWorkflow);
-});
-export const simpleWorkflow = {
-    name: 'simple',
-    title: 'Simple',
-    steps: [
-        {
-            name: 'live',
-            title: 'Live',
-            key: 'ByAgr-BZ8',
-            color: '#5cd79b',
-            live: true
-        }
-    ]
-};
-export const complexWorkflow = {
-    name: 'complex',
-    title: 'Complex',
-    steps: [
-        {
-            name: 'draft',
-            title: 'Draft',
-            key: 'r1uCfi4ZL',
-            color: '#bdbdbd',
-            live: false
-        },
-        {
-            name: 'artPhoto',
-            title: 'Art/Photo',
-            key: 'rkhRGs4WL',
-            color: '#5cd79b',
-            live: false
-        },
-        {
-            name: 'legal',
-            title: 'Legal',
-            key: 'SJtxS-rWI',
-            color: '#5cd79b',
-            live: false
-        },
-        {
-            name: 'finalReview',
-            title: 'Final Review',
-            key: 'B1sxHZBZI',
-            color: '#5cd79b',
-            live: false
-        },
-        {
-            name: 'published',
-            title: 'Published',
-            key: 'Hk2xBZSbI',
-            color: '#5cd79b',
-            live: true
-        },
-        {
-            name: 'homepage',
-            title: 'Homepage',
-            key: 'SypgH-S-8',
-            color: '#5cd79b',
-            live: true
-        },
-        {
-            name: 'retired',
-            title: 'Retired',
-            key: 'ByAgr-BZ8',
-            color: '#5cd79b',
-            live: false
-        }
-    ]
-};
-test('findWorkflowStep', () => {
-    expect(findWorkflowStep(complexWorkflow, 'Hk2xBZSbI')).toEqual({
-        index: 4,
-        step: complexWorkflow.steps[4]
-    });
-    expect(findWorkflowStep(complexWorkflow, 'bogus')).toBe(undefined);
-});
-test('statusFallback', () => {
-    expect(statusFallback(defaultWorkflow, true)).toMatchObject({
-        name: 'enabled'
-    });
-    expect(statusFallback(defaultWorkflow, false)).toMatchObject({
-        name: 'disabled'
-    });
-    expect(statusFallback(simpleWorkflow, true)).toMatchObject({ name: 'live' });
-    expect(statusFallback(simpleWorkflow, false)).toMatchObject({ name: 'live' });
-    expect(statusFallback(complexWorkflow, true)).toMatchObject({
-        name: 'published'
-    });
-    expect(statusFallback(complexWorkflow, false)).toMatchObject({
-        name: 'draft'
-    });
-});
-const allKeys = complexWorkflow.steps.map((step) => step.key);
-test('getWorkflowStepKeys - gte', () => {
-    const filteredKeys = getWorkflowStepKeys(complexWorkflow, 'B1sxHZBZI', 'gte');
-    expect(filteredKeys).toEqual(allKeys.slice(3, 7));
-    expect(filteredKeys.includes('B1sxHZBZI')).toBe(true);
-});
-test('getWorkflowStepKeys - gt', () => {
-    expect(getWorkflowStepKeys(complexWorkflow, 'B1sxHZBZI', 'gt')).toEqual(allKeys.slice(4, 7));
-});
-test('getWorkflowStepKeys - lte', () => {
-    const filteredKeys = getWorkflowStepKeys(complexWorkflow, 'B1sxHZBZI', 'lte');
-    expect(filteredKeys).toEqual(allKeys.slice(0, 4));
-    expect(filteredKeys.includes('B1sxHZBZI')).toBe(true);
-});
-test('getWorkflowStepKeys - lt', () => {
-    expect(getWorkflowStepKeys(complexWorkflow, 'B1sxHZBZI', 'lt')).toEqual(allKeys.slice(0, 3));
-});
-test('getWorkflowStepKeys - eq', () => {
-    expect(getWorkflowStepKeys(complexWorkflow, 'B1sxHZBZI', 'eq')).toEqual(['B1sxHZBZI']);
-});
-test('getWorkflowStepKeys - in', () => {
-    expect(getWorkflowStepKeys(complexWorkflow, 'B1sxHZBZI', 'in')).toEqual(['B1sxHZBZI']);
-});
-test('getWorkflowStepKeys - step not found', () => {
-    expect(() => getWorkflowStepKeys(complexWorkflow, 'bogus', 'lt')).toThrowErrorMatchingInlineSnapshot(`[Error: Cannot find step "bogus" in workflow "Complex"]`);
-});
-test('getLiveStepKeys', () => {
-    expect(getLiveStepKeys(complexWorkflow)).toEqual(allKeys.slice(4, 6));
-});

package/dist/layers/__tests__/layers.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/layers/__tests__/layers.test.js

@@ -1,38 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { expect, test } from 'vitest';
-import { flattenSchema } from "../layers.js";
-function loadFile(fileName) {
-    return JSON.parse(fs.readFileSync(fileName, 'utf8'));
-}
-function getPath(...filePath) {
-    return path.join(__dirname, '..', '..', '..', 'examples', 'v4_0_0', ...filePath);
-}
-const layerCache = new Map();
-const getLayer = (exampleName) => (layerId) => {
-    const layerPath = getPath(exampleName, 'layers', `${layerId}.json`);
-    let layer = layerCache.get(layerPath);
-    if (!layer) {
-        layer = loadFile(layerPath);
-        layerCache.set(layerPath, layer);
-    }
-    return layer;
-};
-function getSchema(exampleName) {
-    return loadFile(getPath(exampleName, 'schema.json'));
-}
-function getFlattenedSchema(exampleName) {
-    return loadFile(getPath(exampleName, 'flattened-schema.json'));
-}
-test.skip('flattenSchema - rick-and-morty-notes', () => {
-    const exampleName = 'rick-and-morty-notes';
-    const schema = getSchema(exampleName);
-    const flattened = flattenSchema(schema, getLayer(exampleName));
-    expect(flattened).toEqual(getFlattenedSchema(exampleName));
-});
-test.skip('flattenSchema - shopify-lookbook', () => {
-    const exampleName = 'shopify-lookbook';
-    const schema = getSchema(exampleName);
-    const flattened = flattenSchema(schema, getLayer(exampleName));
-    expect(flattened).toEqual(getFlattenedSchema(exampleName));
-});

package/dist/migration/to/__tests__/v3.10.0.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/migration/to/__tests__/v3.10.0.test.js

@@ -1,90 +0,0 @@
-import { expect, test } from 'vitest';
-import migrateToV3_10 from "../v3.10.0.js";
-const context = {
-    encryptFn: () => '',
-    decryptFn: () => undefined,
-    generateDataKeyFn: async () => ''
-};
-function mockSchema(schema) {
-    const now = new Date().toISOString();
-    const projectId = 'project-id';
-    const dataKey = 'secret';
-    return {
-        projectId,
-        dataKey,
-        version: 1,
-        created: now,
-        updated: now,
-        defaultLocale: 'en-us',
-        locales: ['en-us'],
-        apiVersion: '2',
-        schemaVersion: '3.9.0',
-        queries: {},
-        mutations: {},
-        shapes: {},
-        workflows: {},
-        forms: {},
-        services: {
-            supaservice: {
-                id: 'supaservice',
-                provider: 'generic',
-                title: 'Supa Service',
-                serviceType: 'rest',
-                namespace: 'Supa',
-                authenticationType: 'none'
-            }
-        },
-        ...schema
-    };
-}
-test('migrateToV3_10', async () => {
-    const projectSchema = mockSchema({
-        queries: {
-            woo: {
-                shape: {
-                    type: 'array',
-                    items: {
-                        $ref: '#/shapes/Supa_Woo/schema'
-                    }
-                },
-                resolver: {
-                    name: 'rest:get',
-                    service: 'supaservice',
-                    path: '/',
-                    options: {}
-                }
-            }
-        }
-    });
-    const migrated = await migrateToV3_10(context, projectSchema);
-    expect(migrated.schemaVersion).toBe('3.10.0');
-    expect(migrated.queries.woo.shape).toEqual({
-        type: 'array',
-        items: { '@ref': 'supaservice:Woo' }
-    });
-});
-test('migrateToV3_10 - inline array object unsuported', async () => {
-    const projectSchema = mockSchema({
-        queries: {
-            woo: {
-                shape: {
-                    type: 'array',
-                    items: {
-                        type: 'object',
-                        properties: {
-                            title: { type: 'string' },
-                            inline: { type: 'boolean', default: true }
-                        }
-                    }
-                },
-                resolver: {
-                    name: 'rest:get',
-                    service: 'supaservice',
-                    path: '/',
-                    options: {}
-                }
-            }
-        }
-    });
-    await expect(migrateToV3_10(context, projectSchema)).rejects.toMatchInlineSnapshot(`[Error: Query "woo" contains an unsupported shape schema {"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"inline":{"type":"boolean","default":true}}}}. Please contact support]`);
-});

package/dist/migration/to/__tests__/v3.12.3.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/migration/to/__tests__/v3.12.3.test.js

@@ -1,103 +0,0 @@
-import { expect, test } from 'vitest';
-import migrateToV3_12_3 from "../v3.12.3.js";
-test('3.12.3 migration', async () => {
-    const context = {
-        encryptFn: () => '',
-        decryptFn: () => undefined,
-        generateDataKeyFn: async () => ''
-    };
-    const schema = {
-        schemaVersion: '3.12.2',
-        version: 2112,
-        apiVersion: '2',
-        projectId: 'project-id',
-        created: '2020-01-01T00:00:00.000Z',
-        updated: '2020-01-01T00:00:00.000Z',
-        dataKey: 'secret',
-        defaultLocale: 'en-us',
-        locales: ['en-us'],
-        mutations: {},
-        shapes: {},
-        workflows: {},
-        indexedShapes: {
-            Shopify_Product: {
-                queries: {
-                    all: {
-                        name: 'Shopify_products',
-                        interval: 5,
-                        ignoreFields: ['a', 'b', 'c'],
-                        pagination: {
-                            type: 'cursor',
-                            cursorArg: 'cursorArg',
-                            cursorPath: 'cursorPath',
-                            hasMorePath: 'hasMorePath',
-                            itemsPath: 'itemsPath',
-                            sizeArg: 'sizeArg',
-                            size: 100
-                        }
-                    },
-                    single: {
-                        name: 'Shopify_product',
-                        ignoreFields: ['c', 'd', 'e']
-                    }
-                }
-            }
-        },
-        queries: {
-            Shopify_product: {
-                resolver: {
-                    name: 'name',
-                    service: 'shopify'
-                }
-            },
-            Shopify_products: {
-                resolver: {
-                    name: 'name',
-                    service: 'shopify'
-                }
-            }
-        },
-        services: {
-            shopify: {
-                provider: 'shopify'
-            }
-        }
-    };
-    const migrated = await migrateToV3_12_3(context, schema);
-    expect(migrated).toMatchObject({
-        schemaVersion: '3.12.3',
-        indexedShapes: {
-            Shopify_Product: {
-                queries: {
-                    list: {
-                        name: 'Shopify_products',
-                        ignoreFields: ['a', 'b', 'c'],
-                        pagination: {
-                            type: 'cursor',
-                            cursorArg: 'cursorArg',
-                            cursorPath: 'cursorPath',
-                            hasMorePath: 'hasMorePath',
-                            itemsToIndexPath: 'itemsPath',
-                            pageSizeArg: 'sizeArg',
-                            pageSize: 100
-                        }
-                    },
-                    get: {
-                        name: 'Shopify_product',
-                        ignoreFields: ['c', 'd', 'e']
-                    }
-                },
-                triggers: [
-                    {
-                        type: 'webhook',
-                        query: 'get',
-                        service: 'shopify',
-                        events: ['products/create', 'products/update', 'products/delete']
-                    },
-                    { type: 'schedule', query: 'list', interval: 5 }
-                ]
-            }
-        }
-    });
-    expect(migrated.indexedShapes?.Shopify_Product.queries.list).not.toMatchObject({ interval: 5 });
-});

package/dist/migration/to/__tests__/v3.17.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/migration/to/__tests__/v3.17.test.js

@@ -1,71 +0,0 @@
-import { expect, test, vi } from 'vitest';
-import migrateToV3_17_0 from "../v3.17.0.js";
-test('migrateToV3_17_0', async () => {
-    const now = '2022-02-15T15:22:26.250Z';
-    const projectSchema = {
-        schemaVersion: '3.16.0',
-        projectId: 'project-id',
-        dataKey: 'secret',
-        version: 1,
-        created: now,
-        updated: now,
-        defaultLocale: 'en-us',
-        locales: ['en-us'],
-        apiVersion: '2',
-        queries: {},
-        mutations: {},
-        workflows: {},
-        forms: {},
-        shapes: {
-            Product: {
-                id: '-3U728po3',
-                name: 'Product',
-                title: 'Product',
-                workflow: 'default',
-                model: {
-                    type: 'multiple'
-                },
-                schema: {
-                    type: 'object',
-                    properties: {
-                        title: {
-                            type: 'string',
-                            minLength: 0,
-                            description: '',
-                            title: 'Title',
-                            '@mapping': 'takeshape:local:Product.AoPnfytzY'
-                        },
-                        _createdBy: {
-                            title: 'Created By',
-                            type: 'string',
-                            '@user': true
-                        }
-                    }
-                }
-            }
-        }
-    };
-    const migrated = await migrateToV3_17_0({
-        generateDataKeyFn: vi.fn(),
-        encryptFn: vi.fn(),
-        decryptFn: vi.fn()
-    }, projectSchema);
-    expect(migrated.shapes.Product.schema).toEqual({
-        type: 'object',
-        properties: {
-            title: {
-                type: 'string',
-                minLength: 0,
-                description: '',
-                title: 'Title',
-                '@mapping': 'takeshape:local:Product.AoPnfytzY'
-            },
-            _createdBy: {
-                title: 'Created By',
-                '@resolver': { name: 'takeshape:getUser', service: 'takeshape:local' },
-                '@input': { type: 'string' },
-                '@ref': 'local:TSUser'
-            }
-        }
-    });
-});

package/dist/migration/to/__tests__/v3.34.0.test.d.ts

@@ -1 +0,0 @@
-export {};