@takeshape/schema 11.72.0 → 11.74.1

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

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

package/dist/__tests__/enum.test.js

@@ -1,36 +0,0 @@
-import { expect, test } from 'vitest';
-import { isEnumLikeSchema } from "../enum.js";
-test('isEnumSchema', () => {
-    expect(isEnumLikeSchema({ enum: ['a', 'b', 'c'] })).toBe(true);
-    expect(isEnumLikeSchema({
-        oneOf: [
-            {
-                title: 'A',
-                enum: ['a']
-            },
-            {
-                title: 'B',
-                const: 'b'
-            },
-            {
-                title: 'C',
-                enum: ['c']
-            }
-        ]
-    })).toBe(true);
-    expect(isEnumLikeSchema({
-        oneOf: [
-            {
-                type: 'string'
-            },
-            {
-                title: 'B',
-                const: 'b'
-            },
-            {
-                title: 'C',
-                enum: ['c']
-            }
-        ]
-    })).toBe(false);
-});

package/dist/__tests__/flatten-templates.test.d.ts

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

package/dist/__tests__/flatten-templates.test.js

@@ -1,40 +0,0 @@
-import { DEFAULT_ENTITLEMENTS } from '@takeshape/util';
-import { expect, test } from 'vitest';
-import betzinoJson from '@/examples/latest/betzino.json';
-import shapeBooksSchemaJson from '@/examples/latest/shape-books.json';
-import { flattenTemplates } from "../flatten-templates.js";
-import { applyDefaultsToSchema, getAllRefs } from "../schema-util.js";
-import { validateSchema } from "../validate/validate.js";
-test('flattenTemplates', async () => {
-    const flattened = flattenTemplates(shapeBooksSchemaJson);
-    const { errors } = await validateSchema({
-        entitlements: DEFAULT_ENTITLEMENTS
-    }, flattened);
-    expect(errors).toEqual(undefined);
-    // All templates have been replaced with shapes
-    const templateRefs = getAllRefs(flattened, (ref) => Boolean(ref.template));
-    expect(templateRefs.length).toBe(0);
-});
-test('flattenTemplates - betzino', async () => {
-    const projectSchema = applyDefaultsToSchema(betzinoJson);
-    const flattened = flattenTemplates(projectSchema);
-    const { errors } = await validateSchema({
-        entitlements: DEFAULT_ENTITLEMENTS
-    }, flattened);
-    expect(errors).toEqual(undefined);
-    // Verify that refs are rewritten to those of input shapes
-    expect(flattened.shapes.UpdateLayoutInput).toBeTruthy();
-    const updateLayoutInputSchema = flattened.shapes.UpdateLayoutInput.schema;
-    expect(updateLayoutInputSchema.properties.items.items).toEqual({
-        '@ref': 'local:LayoutItemsInput'
-    });
-    // Verify that TSRelationship doesn't get rewritten as an input shape
-    expect(flattened.shapes.LayoutItemsInput).toBeTruthy();
-    const layoutItemsInputSchema = flattened.shapes.LayoutItemsInput.schema;
-    expect(layoutItemsInputSchema.properties.components.items).toEqual({
-        '@ref': 'local:TSRelationship'
-    });
-    // All templates have been replaced with shapes
-    const templateRefs = getAllRefs(flattened, (ref) => Boolean(ref.template));
-    expect(templateRefs.length).toBe(0);
-});

package/dist/__tests__/get-is-leaf.test.d.ts

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

package/dist/__tests__/get-is-leaf.test.js

@@ -1,50 +0,0 @@
-import { expect, test } from 'vitest';
-import petOneOfSchemaJson from '@/examples/latest/pet-oneof-array.json';
-import shapeBooksSchemaJson from '@/examples/latest/shape-books.json';
-import userSchemaJson from '@/examples/latest/user-schema-with-defaults.json';
-import { getIsLeaf } from "../get-is-leaf.js";
-import { applyDefaultsToSchema } from "../schema-util.js";
-const userSchema = applyDefaultsToSchema(userSchemaJson);
-const petOneOfSchema = applyDefaultsToSchema(petOneOfSchemaJson);
-const shapeBooksSchema = applyDefaultsToSchema(shapeBooksSchemaJson);
-test('getIsLeaf - Post', () => {
-    const bodyKey = 'rybsZhDU-';
-    const featureImageKey = 'BybUznPIW';
-    const titleKey = 'BkJDGhw8W';
-    const isLeaf = getIsLeaf(shapeBooksSchema, shapeBooksSchema.shapes.Post.schema);
-    expect(isLeaf(titleKey)).toBe(true);
-    expect(isLeaf(featureImageKey)).toBe(true);
-    expect(isLeaf(bodyKey)).toBe(true);
-    expect(isLeaf(`${bodyKey}:es-mx`)).toBe(true);
-});
-test('getIsLeaf - Homepage', () => {
-    const heroKey = 'ry4VnCD8W';
-    const titleKey = 'BJfmu0OIZ';
-    const heroImageKey = 'H1vBnAv8-';
-    const isLeaf = getIsLeaf(shapeBooksSchema, shapeBooksSchema.shapes.Homepage.schema);
-    expect(isLeaf(heroKey)).toBe(false);
-    expect(isLeaf(titleKey)).toBe(true);
-    expect(isLeaf(heroImageKey)).toBe(true);
-});
-test('getIsLeaf - User', () => {
-    const isLeaf = getIsLeaf(userSchema, userSchema.shapes.User.schema);
-    expect(isLeaf('emailId')).toBe(true);
-    expect(isLeaf('locationsId')).toBe(false);
-    expect(isLeaf('latId')).toBe(true);
-    expect(isLeaf('lonId')).toBe(true);
-});
-test('getIsLeaf - oneOf', () => {
-    const petStoreKey = 'aaa3LRPxC';
-    const catNameKey = 'tbWPT2kvU';
-    const catBreedKey = 'XuyPh7IHw';
-    const dogNameKey = 'i7S3LRPxC';
-    const dogRankKey = 'yOvol-ZPg';
-    const dogIsBestFriendKey = 'bbbbb-ZPg';
-    const isLeaf = getIsLeaf(petOneOfSchema, petOneOfSchema.shapes.PetStore.schema);
-    expect(isLeaf(petStoreKey)).toBe(true);
-    expect(isLeaf(catNameKey)).toBe(true);
-    expect(isLeaf(catBreedKey)).toBe(true);
-    expect(isLeaf(dogNameKey)).toBe(true);
-    expect(isLeaf(dogRankKey)).toBe(true);
-    expect(isLeaf(dogIsBestFriendKey)).toBe(true);
-});

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

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

package/dist/__tests__/interfaces.test.js

@@ -1,219 +0,0 @@
-import { describe, expect, test } from 'vitest';
-import { getImplementationShapeMap, getImplementationShapeNameMap, getImplementingShapes, getPossibleShapeNames, interfaceToUnion, isInterfaceRef, isInterfaceShape, pruneUnusedInterfaces } from "../interfaces.js";
-import { createMockSchema } from "../mocks.js";
-import { createShape } from "../schema-util.js";
-const Node = createShape('Node', {
-    type: 'object',
-    properties: { id: { type: 'string', '@tag': 'id' } },
-    required: ['id']
-}, { type: 'interface' });
-const petStoreSchema = createMockSchema('project-id', {
-    queries: {
-        getPetstore: {
-            resolver: {
-                name: 'graphql:query',
-                service: 'petco',
-                fieldName: 'getPetstore'
-            },
-            shape: 'Petco_PetStore'
-        },
-        search: {
-            resolver: {
-                name: 'graphql:query',
-                service: 'petco',
-                fieldName: 'search'
-            },
-            shape: 'Petco_SearchResponse'
-        }
-    },
-    services: {
-        petco: {
-            id: 'petco',
-            title: 'Petco',
-            serviceType: 'graphql',
-            provider: 'petco',
-            authenticationType: 'none',
-            namespace: 'Petco'
-        }
-    },
-    shapes: {
-        Node,
-        Petco_SearchResponse: createShape('Petco_SearchResponse', {
-            type: 'object',
-            properties: {
-                results: {
-                    type: 'array',
-                    items: {
-                        '@ref': 'petco:FuzzyFriend'
-                    },
-                    '@mapping': 'petco:SearchResponse.results'
-                },
-                total: {
-                    type: 'number',
-                    '@mapping': 'petco:SearchResponse.total'
-                }
-            },
-            required: ['results', 'total']
-        }),
-        Petco_FuzzyFriend: createShape('Petco_FuzzyFriend', {
-            type: 'object',
-            properties: {
-                name: {
-                    type: 'string',
-                    '@mapping': 'petco:FuzzyFriend.name'
-                }
-            },
-            required: ['name']
-        }, { type: 'interface' }),
-        Petco_Undead: createShape('Petco_Undead', {
-            type: 'object',
-            properties: {
-                lives: {
-                    type: 'integer',
-                    '@mapping': 'petco:Petco_Undead.lives'
-                }
-            },
-            required: ['name']
-        }, { type: 'interface' }),
-        Petco_Dog: createShape('Petco_Dog', {
-            type: 'object',
-            properties: {
-                id: {
-                    type: 'string',
-                    '@tag': 'id',
-                    '@mapping': 'petco:Cat.id'
-                },
-                name: {
-                    type: 'string',
-                    '@mapping': 'petco:Dog.name'
-                },
-                isBestFriend: {
-                    type: 'boolean',
-                    default: true,
-                    '@mapping': 'petco:Dog.isBestFriend'
-                },
-                catPal: {
-                    '@ref': 'petco:Cat',
-                    '@mapping': 'petco:Dog.catPal'
-                }
-            },
-            required: ['id', 'name']
-        }, { interfaces: ['Node', 'Petco_FuzzyFriend', 'Bogucci'] }),
-        Petco_Cat: createShape('Petco_Cat', {
-            type: 'object',
-            properties: {
-                id: {
-                    type: 'string',
-                    '@tag': 'id',
-                    '@mapping': 'petco:Cat.id'
-                },
-                name: {
-                    type: 'string',
-                    '@mapping': 'petco:Cat.name'
-                },
-                lives: {
-                    type: 'integer',
-                    default: 9,
-                    '@mapping': 'petco:Cat.lives'
-                }
-            },
-            required: ['name']
-        }, { interfaces: ['Node', 'Petco_FuzzyFriend', 'Petco_Undead'] })
-    }
-});
-describe('isInterfaceShape', () => {
-    test('undefined', () => {
-        expect(isInterfaceShape()).toBe(false);
-    });
-    test('an actual interface shape', () => {
-        expect(isInterfaceShape(Node)).toBe(true);
-    });
-});
-describe('isInterfaceRef', () => {
-    const { Petco_Dog, Petco_SearchResponse } = petStoreSchema.shapes;
-    test('no', () => {
-        expect(isInterfaceRef(petStoreSchema, Petco_Dog.schema.properties.catPal)).toBe(false);
-    });
-    test('yes', () => {
-        expect(isInterfaceRef(petStoreSchema, Petco_SearchResponse.schema.properties.results.items)).toBe(true);
-    });
-});
-describe('getImplementationShapeNameMap', () => {
-    test('it works', () => {
-        const map = getImplementationShapeNameMap(petStoreSchema.shapes);
-        expect(map).toEqual({
-            Bogucci: new Set(['Petco_Dog']),
-            Node: new Set(['Petco_Dog', 'Petco_Cat']),
-            Petco_FuzzyFriend: new Set(['Petco_Dog', 'Petco_Cat']),
-            Petco_Undead: new Set(['Petco_Cat'])
-        });
-    });
-});
-describe('getImplementationShapeMap', () => {
-    test('it works', () => {
-        const map = getImplementationShapeMap(petStoreSchema.shapes);
-        const { Petco_Dog, Petco_Cat } = petStoreSchema.shapes;
-        expect(map).toEqual({
-            Bogucci: new Set([Petco_Dog]),
-            Node: new Set([Petco_Dog, Petco_Cat]),
-            Petco_FuzzyFriend: new Set([Petco_Dog, Petco_Cat]),
-            Petco_Undead: new Set([Petco_Cat])
-        });
-    });
-});
-describe('pruneUnusedInterfaces', () => {
-    test('it works', () => {
-        const pruned = pruneUnusedInterfaces(petStoreSchema, petStoreSchema.shapes);
-        expect(pruned.Petco_Dog.interfaces).toEqual(['Node', 'Petco_FuzzyFriend']);
-    });
-    test('handles interfaces being refs', () => {
-        const pruned = pruneUnusedInterfaces(petStoreSchema, {
-            ...petStoreSchema.shapes,
-            Petco_Dog: {
-                ...petStoreSchema.shapes.Petco_Dog,
-                interfaces: ['local:Node', 'petco:FuzzyFriend', 'local:Bogucci']
-            }
-        });
-        expect(pruned.Petco_Dog.interfaces).toEqual(['local:Node', 'petco:FuzzyFriend']);
-    });
-});
-describe('getImplementingShapes', () => {
-    test('it works', () => {
-        const shapes = new Set(getImplementingShapes(petStoreSchema, {
-            typeName: 'FuzzyFriend',
-            serviceKey: 'petco',
-            isForeign: true,
-            isValidService: true
-        }));
-        const { Petco_Dog, Petco_Cat } = petStoreSchema.shapes;
-        expect(shapes).toEqual(new Set([Petco_Dog, Petco_Cat]));
-    });
-});
-describe('interfaceToUnion', () => {
-    test('it works', () => {
-        expect(interfaceToUnion(petStoreSchema, {
-            typeName: 'FuzzyFriend',
-            serviceKey: 'petco',
-            isForeign: true,
-            isValidService: true
-        })).toEqual({
-            oneOf: [{ '@ref': 'petco:Dog' }, { '@ref': 'petco:Cat' }]
-        });
-    });
-});
-describe('getPossibleShapeNames', () => {
-    test('normal shape', () => {
-        expect(getPossibleShapeNames(petStoreSchema, petStoreSchema.shapes.Petco_Cat)).toEqual(['Petco_Cat']);
-    });
-    test('union', () => {
-        expect(getPossibleShapeNames(petStoreSchema, createShape('Woo', {
-            oneOf: [{ '@ref': 'petco:Dog' }, { '@ref': 'petco:Cat' }]
-        }))).toEqual(['Petco_Dog', 'Petco_Cat']);
-    });
-    test('interface', () => {
-        expect(getPossibleShapeNames(petStoreSchema, petStoreSchema.shapes.Petco_FuzzyFriend)).toEqual([
-            'Petco_Dog',
-            'Petco_Cat'
-        ]);
-    });
-});

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

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

package/dist/__tests__/migration.test.js

@@ -1,34 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { expect, test } from 'vitest';
-import { ensureLatest } from "../project-schema/migrate.js";
-const examplesPath = path.join(__dirname, '../../examples');
-const readSchema = (filePath) => JSON.parse(fs.readFileSync(path.join(examplesPath, filePath), 'utf-8'));
-const migrationContext = {
-    encryptFn() {
-        return 'abc';
-    },
-    decryptFn() {
-        return { token: 'xyz' };
-    },
-    async generateDataKeyFn() {
-        return 'supersecret';
-    }
-};
-test('ensureLatest - v1', async () => {
-    const projectSchema = readSchema('source/shape-books.json');
-    const projectSchemaLatest = readSchema('latest/shape-books.json');
-    const actual = await ensureLatest(migrationContext, projectSchema);
-    expect(actual).toEqual(projectSchemaLatest);
-});
-test('ensureLatest - v3', async () => {
-    const projectSchemaV3 = readSchema('source/shopify-lookbook.json');
-    const projectSchemaLatest = readSchema('latest/shopify-lookbook.json');
-    const actual = await ensureLatest(migrationContext, projectSchemaV3);
-    expect(actual).toEqual(projectSchemaLatest);
-});
-test('ensureLatest - pass-through', async () => {
-    const projectSchemaLatest = readSchema('latest/shape-books.json');
-    const actual = await ensureLatest(migrationContext, projectSchemaLatest);
-    expect(actual).toBe(projectSchemaLatest);
-});

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

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

package/dist/__tests__/mocks.test.js

@@ -1,24 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { createMockSchema, createMockSchemaWithDefaults } from "../mocks.js";
-import { ensureValidLatestSchemaSyntax } from "../validate/validate.js";
-describe('createMockSchema', () => {
-    it('creates a schema that validates', () => {
-        const projectId = 'project-id';
-        const mockSchema = createMockSchema(projectId);
-        const projectSchema = ensureValidLatestSchemaSyntax(mockSchema);
-        expect(projectSchema).toEqual(mockSchema);
-        expect(projectSchema.projectId).toEqual(projectId);
-    });
-});
-describe('createMockSchemaWithDefaults', () => {
-    it('creates a schema that validates', () => {
-        const projectId = 'project-id';
-        const mockSchema = createMockSchemaWithDefaults(projectId);
-        const projectSchema = ensureValidLatestSchemaSyntax(mockSchema);
-        expect(projectSchema).toEqual(mockSchema);
-        expect(projectSchema.projectId).toEqual(projectId);
-        expect(Object.keys(projectSchema.queries).length).toEqual(4);
-        expect(Object.keys(projectSchema.mutations).length).toEqual(8);
-        expect(Object.keys(projectSchema.shapes).length).toEqual(6);
-    });
-});

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

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