@takeshape/schema 12.1.1 → 12.1.5

package/dist/layers/layers.js

@@ -0,0 +1,301 @@
+import { deepClone, isDefined, isRecord } from '@takeshape/util';
+import set from 'lodash/set.js';
+import uniq from 'lodash/uniq.js';
+import minimatch from 'minimatch';
+import { parseTemplateShape } from "../refs.js";
+import { dereferenceSchema, getArgsReferenceWithPath, getRefOrItemsRef, parseReturnShape, refItemToString, splitAtRef } from "./refs.js";
+import { isAllOfSchema, isObjectSchema, isOneOfSchema, isRefSchema } from "./type-utils.js";
+import { visitSchemaProperties } from "./visitor.js";
+const layerDefaults = {
+    namespace: '',
+    visibility: []
+};
+function filterMap(prefix, fields, filters) {
+    const result = {};
+    for (const [name, value] of Object.entries(fields)) {
+        for (const filter of filters) {
+            if (minimatch(`${prefix}.${name}`, filter)) {
+                result[name] = value;
+            }
+        }
+    }
+    return result;
+}
+function filterLayer(layerSchema, filters) {
+    return {
+        ...layerSchema,
+        queries: filterMap('queries', layerSchema.queries ?? {}, filters),
+        mutations: filterMap('mutations', layerSchema.mutations ?? {}, filters),
+        shapes: filterMap('shapes', layerSchema.shapes ?? {}, filters),
+        workflows: filterMap('workflows', layerSchema.workflows ?? {}, filters)
+    };
+}
+// TODO use non-versioned util eventually
+export function isObjectSchemaV4_0_0(maybeObjectSchema) {
+    return maybeObjectSchema.type === 'object' && isRecord(maybeObjectSchema.properties);
+}
+function mergeShape(a, b) {
+    if (b.override === 'extend') {
+        if (isObjectSchemaV4_0_0(a.schema) && isObjectSchemaV4_0_0(b.schema)) {
+            const combinedRequired = uniq((a.schema.required ?? []).concat(b.schema.required ?? []));
+            const combinedSchema = {
+                type: 'object',
+                properties: {
+                    ...a.schema.properties,
+                    ...b.schema.properties
+                }
+            };
+            if (combinedRequired.length) {
+                combinedSchema.required = combinedRequired;
+            }
+            return { ...a, ...b, schema: combinedSchema };
+        }
+    }
+    return b;
+}
+function assignShapes(flattenedShapes, layerShapes) {
+    for (const [shapeName, shape] of Object.entries(layerShapes)) {
+        flattenedShapes[shapeName] = flattenedShapes[shapeName] ? mergeShape(flattenedShapes[shapeName], shape) : shape;
+    }
+}
+function addRef(refs, ref, predicate) {
+    if (ref && (!predicate || predicate(ref))) {
+        refs.push(ref);
+    }
+}
+/**
+ * Walk through a `ProjectSchema` and collect all the `ref`s.
+ */
+export function getAllRefsInShapes(shapes, predicate) {
+    const items = [];
+    const shapeVisitor = (schema, schemaPath) => {
+        if (schema['@args'] && typeof schema['@args'] === 'object') {
+            visitSchemaProperties(schema['@args'], schemaPath.concat(['@args']), (argSchema, argPath) => {
+                addRef(items, getRefOrItemsRef(argSchema, argPath), predicate);
+            });
+        }
+        addRef(items, getArgsReferenceWithPath(schema, schemaPath), predicate);
+        const newPath = schema.items ? schemaPath.concat('items') : schemaPath;
+        const newSchema = schema.items ?? schema;
+        if (isRefSchema(newSchema)) {
+            addRef(items, getRefOrItemsRef(newSchema, newPath), predicate);
+        }
+        else if (isObjectSchema(newSchema) || isAllOfSchema(newSchema) || isOneOfSchema(newSchema)) {
+            visitSchemaProperties(newSchema, newPath, shapeVisitor);
+        }
+    };
+    for (const [shapeName, shape] of Object.entries(shapes)) {
+        visitSchemaProperties(shape.schema, ['shapes', shapeName, 'schema'], shapeVisitor);
+    }
+    return items;
+}
+/**
+ * Get all refs
+ */
+export function getAllRefsInQuery(shapes, queryPath, query, predicate) {
+    const refItems = [];
+    const propertyVisitor = (propSchema, propSchemaPath) => {
+        addRef(refItems, getRefOrItemsRef(propSchema, propSchemaPath), predicate);
+    };
+    if (query.args && typeof query.args === 'string') {
+        addRef(refItems, getArgsReferenceWithPath(query, queryPath), predicate);
+    }
+    if (query.args && typeof query.args === 'object') {
+        visitSchemaProperties(dereferenceSchema(shapes, query.args), queryPath, propertyVisitor);
+    }
+    if (query.shape) {
+        const refItem = parseReturnShape(query.shape).ref;
+        if (refItem) {
+            addRef(refItems, {
+                ...refItem,
+                path: queryPath.concat(['shape'])
+            }, predicate);
+        }
+    }
+    return refItems;
+}
+/**
+ * Collect refs from `queries` or `mutations`.
+ */
+export function getAllRefsInQueries(context, rootPropertyName, predicate) {
+    const refItems = [];
+    const rootPath = [rootPropertyName];
+    for (const [queryName, query] of Object.entries(context[rootPropertyName])) {
+        const queryPath = rootPath.concat([queryName]);
+        const queryRefs = getAllRefsInQuery(context.shapes, queryPath, query, predicate);
+        if (queryRefs.length) {
+            refItems.push(...queryRefs);
+        }
+    }
+    return refItems;
+}
+/**
+ * Get all refs in a ProjectSchema
+ * @param predicate return true to include the ref in
+ */
+export function getAllRefs(projectSchema, predicate) {
+    return [
+        ...getAllRefsInShapes(projectSchema.shapes, predicate),
+        ...getAllRefsInQueries(projectSchema, 'queries', predicate),
+        ...getAllRefsInQueries(projectSchema, 'mutations', predicate)
+    ];
+}
+export function collectReferencedShapeNames(layerId, refSet) {
+    const addLayerId = (ref) => ({ ...ref, layerId });
+    const collect = (schema) => {
+        const args = schema['@args'];
+        if (args && typeof args === 'object') {
+            Object.values(args.properties).forEach(collect);
+        }
+        const argsRefItem = getArgsReferenceWithPath(schema);
+        if (argsRefItem) {
+            refSet.add(refItemToString(addLayerId(argsRefItem)));
+        }
+        const refItem = getRefOrItemsRef(schema);
+        if (refItem) {
+            refSet.add(refItemToString(addLayerId(refItem)));
+        }
+    };
+    return collect;
+}
+function collectServiceRefs(flattenedSchema, getLayer) {
+    const refs = new Set(getAllRefs(flattenedSchema, (refItem) => refItem.layerId !== 'local').map(refItemToString));
+    if (refs.size) {
+        for (const ref of refs) {
+            const [layerId, shapeName] = splitAtRef(ref);
+            if (layerId !== 'local') {
+                const layer = getLayer(layerId);
+                const shape = layer?.shapes?.[shapeName];
+                if (shape) {
+                    visitSchemaProperties(shape.schema, ['schema'], collectReferencedShapeNames(layerId, refs));
+                }
+            }
+        }
+    }
+    return refs;
+}
+function ensureServiceLayer(flattenedSchema, layerId) {
+    flattenedSchema.serviceLayers ||= {};
+    let serviceLayer = flattenedSchema.serviceLayers[layerId];
+    if (!serviceLayer) {
+        serviceLayer = {
+            layerId,
+            schemaVersion: '4.0.0',
+            shapes: {},
+            queries: {},
+            mutations: {}
+        };
+        flattenedSchema.serviceLayers[layerId] = serviceLayer;
+    }
+    return serviceLayer;
+}
+function rewriteLayerId(localShapes, layerId, query) {
+    const newQuery = deepClone(query);
+    const propertyVisitor = (propSchema, propSchemaPath) => {
+        const ref = (propSchema.items ?? propSchema)['@ref'];
+        if (ref) {
+            const [argsLayerId, shapeName] = splitAtRef(ref);
+            if (argsLayerId === 'local' && !localShapes[shapeName]) {
+                const path = propSchemaPath.concat(propSchema.items ? ['items', '@ref'] : ['@ref']);
+                set(newQuery, path, `${layerId}:${shapeName}`);
+            }
+        }
+    };
+    if (query.args) {
+        if (typeof query.args === 'string') {
+            const [argsLayerId, shapeName] = splitAtRef(parseTemplateShape(query.args).shapeName);
+            if (argsLayerId === 'local' && !localShapes[shapeName]) {
+                newQuery.args = `${layerId}:${shapeName}`;
+            }
+        }
+        else {
+            visitSchemaProperties(query.args, ['args'], propertyVisitor);
+        }
+    }
+    if (typeof query.shape === 'string') {
+        const [argsLayerId, shapeName] = splitAtRef(parseTemplateShape(query.shape).shapeName);
+        if (argsLayerId === 'local' && !localShapes[shapeName]) {
+            newQuery.shape = `${layerId}:${shapeName}`;
+        }
+    }
+    else {
+        const ref = query.shape.items['@ref'];
+        if (ref) {
+            const [argsLayerId, shapeName] = splitAtRef(ref);
+            if (argsLayerId === 'local' && !localShapes[shapeName]) {
+                set(newQuery, ['shape', 'items', '@ref'], `${layerId}:${shapeName}`);
+            }
+        }
+    }
+    return newQuery;
+}
+function assignQueries(localShapes, queries, layerId, layerQueries) {
+    for (const [queryName, query] of Object.entries(layerQueries)) {
+        queries[queryName] = rewriteLayerId(localShapes, layerId, query);
+    }
+}
+export function flattenSchema(projectSchema, getLayer) {
+    const { layers, ...rest } = projectSchema;
+    const flattenedSchema = {
+        ...rest,
+        shapes: {},
+        queries: {},
+        mutations: {},
+        workflows: {},
+        forms: {}
+    };
+    const filteredLayers = layers
+        .reverse()
+        .map((layer) => {
+        const config = typeof layer === 'string' ? { ...layerDefaults, id: layer } : layer;
+        const layerSchema = getLayer(config.id);
+        if (!layerSchema) {
+            throw new Error(`Unable to flatten schema for project ${projectSchema.projectId}. Cannot get layer ${config.id}`);
+        }
+        return config.visibility?.length ? filterLayer(layerSchema, config.visibility) : undefined;
+    })
+        .filter(isDefined);
+    for (const filteredLayer of filteredLayers) {
+        const { layerId } = filteredLayer;
+        // Preserve original queries
+        if (projectSchema.services?.[layerId]) {
+            const serviceLayer = ensureServiceLayer(flattenedSchema, layerId);
+            if (serviceLayer.queries && filteredLayer.queries) {
+                Object.assign(serviceLayer.queries, filteredLayer.queries);
+            }
+            if (serviceLayer.mutations && filteredLayer.mutations) {
+                Object.assign(serviceLayer.mutations, filteredLayer.mutations);
+            }
+        }
+        if (filteredLayer.workflows) {
+            Object.assign(flattenedSchema.workflows, filteredLayer.workflows);
+        }
+        if (flattenedSchema.forms && filteredLayer.forms) {
+            Object.assign(flattenedSchema.forms, filteredLayer.forms);
+        }
+        if (filteredLayer.shapes) {
+            assignShapes(flattenedSchema.shapes, filteredLayer.shapes);
+        }
+    }
+    for (const filteredLayer of filteredLayers) {
+        if (filteredLayer.queries) {
+            assignQueries(flattenedSchema.shapes, flattenedSchema.queries, filteredLayer.layerId, filteredLayer.queries);
+        }
+        if (filteredLayer.mutations) {
+            assignQueries(flattenedSchema.shapes, flattenedSchema.mutations, filteredLayer.layerId, filteredLayer.mutations);
+        }
+    }
+    // Preserve original service schema shapes
+    for (const refStr of collectServiceRefs(flattenedSchema, getLayer)) {
+        const [layerId, shapeName] = splitAtRef(refStr);
+        if (layerId !== 'local') {
+            const shape = getLayer(layerId)?.shapes?.[shapeName];
+            if (shape) {
+                const serviceLayer = ensureServiceLayer(flattenedSchema, layerId);
+                serviceLayer.shapes ||= {};
+                serviceLayer.shapes[shapeName] = shape;
+            }
+        }
+    }
+    return flattenedSchema;
+}

package/dist/layers/refs.d.ts

@@ -0,0 +1,102 @@
+import type { Maybe } from '@takeshape/util';
+import type { PropertySchemaV4_0_0, QueryJSONV4_0_0, ReturnShapeV4_0_0, ShapeJSONV4_0_0, ShapeMapV4_0_0 } from '../project-schema/index.ts';
+import type { SchemaPath } from '../types/index.ts';
+/**
+ * This interface describes a parsed `@ref` or `$ref`.
+ * The intended usage is to convert a schema with a ref to a RefItem which can then
+ * be passed to the various rich utilities in this file.
+ */
+export type RefItem = {
+    typeName: string;
+    layerId: string;
+    template?: string;
+};
+/**
+ * Adds a schema path, needed when visiting a whole schema to report errors.
+ */
+export type RefItemWithPath = {
+    path: SchemaPath;
+} & RefItem;
+/**
+ * Safely turn a "template" shape reference (`@args`, `args`, `shape`) into a `RefItem`
+ *
+ * @param context A partial project schema
+ * @param refExpression
+ * A ref expression might include "template" name and refer to a local or remote
+ * shape, `Foo` or `CreateArgs<Foo>` or `CreateArgs<remote:Foo>`.*
+ */
+export declare function refExpressionToRefItem(refExpression: string): RefItem;
+/**
+ * Sugar for converting a `refExpression` directly into a shape, without the
+ * intermediate `refItem`.
+ *
+ * @param context A partial project schema
+ * @param refExpression
+ * A ref expression might include "template" name and refer to a local or remote
+ * shape, `Foo` or `CreateArgs<Foo>` or `CreateArgs<remote:Foo>`.
+ */
+export declare function refExpressionToShape(shapes: ShapeMapV4_0_0, refExpression: string): Maybe<ShapeJSONV4_0_0>;
+/**
+ * Provided a service name and a referenced type. Supports 2 or 3 part
+ * references, e.g., `shopify:my-store:ProductInput` or `my-store:ProductInput`.
+ *
+ * @returns
+ * A 2 member array, where 0 is the service name, 1 is the referenced type.
+ */
+export declare function splitAtRef(atRef: string): [string, string];
+/**
+ * Parses and returns a typeName, serviceKey, and potentially a namespace for
+ * the type.
+ */
+export declare function atRefToRefItem(atRef: string, template?: string): RefItem;
+/**
+ * Given a content schema and project schema, finds a `@ref` or `$ref` and
+ * returns a `RefItem` suitable for loading a referenced schema...
+ */
+export declare function getRef(refSchema: PropertySchemaV4_0_0): Maybe<RefItem>;
+export declare function getRefWithPath(refSchema: PropertySchemaV4_0_0, schemaPath?: SchemaPath): Maybe<RefItemWithPath>;
+/**
+ * Tests for a `@ref` or `$ref` property directly on the passed schema.
+ *
+ * @param schema Any schema that might could have a ref property.
+ */
+export declare function hasRefProperty(schema: PropertySchemaV4_0_0): boolean;
+/**
+ * From a schema with a ref, will return the top-level ref, and potentially
+ * a ref item from a nested `items` property.
+ */
+export declare function getRefOrItemsRef(refSchema: PropertySchemaV4_0_0, schemaPath?: SchemaPath): Maybe<RefItemWithPath>;
+/**
+ * Turns a `RefItem` into an `@ref`.
+ */
+export declare function refItemToString(refItem: RefItem): string;
+/**
+ * Get a Shape referenced by a `RefItem`.
+ */
+export declare function refItemToShape(shapes: ShapeMapV4_0_0, refItem: RefItem): Maybe<ShapeJSONV4_0_0>;
+/**
+ * Helper fn to omit `ref` props from the target schema, and then extend it with the source schema.
+ */
+export declare const omitRefAndExtend: (targetSchema: PropertySchemaV4_0_0, sourceSchema: PropertySchemaV4_0_0) => import("lodash").Omit<PropertySchemaV4_0_0, "@ref" | "$ref"> & PropertySchemaV4_0_0;
+/**
+ * If there is a $ref, this will insert a content schema from the top level
+ * in place of the reference.
+ */
+export declare function followRef(shapes: ShapeMapV4_0_0, contentSchema: PropertySchemaV4_0_0): PropertySchemaV4_0_0;
+/**
+ * Returns whether a schema has refs.
+ */
+export declare function hasRef(contentSchema: PropertySchemaV4_0_0): boolean;
+/**
+ * Returns whether a schema has refs which can be followed.
+ */
+export declare function hasResolvableRef(shapes: ShapeMapV4_0_0, contentSchema: PropertySchemaV4_0_0): boolean;
+export declare function getArgsReferenceWithPath(argsSchema: PropertySchemaV4_0_0 | QueryJSONV4_0_0, schemaPath?: SchemaPath): Maybe<RefItemWithPath>;
+export declare function dereferenceSchema(shapes: ShapeMapV4_0_0, shapeOrFieldSchema: PropertySchemaV4_0_0, schemaPath?: SchemaPath): PropertySchemaV4_0_0;
+export type ParsedReturnShape = {
+    isArray: boolean;
+    template?: string;
+    shapeName: string;
+    ref?: RefItem;
+};
+export declare function parseReturnShape(shape: ReturnShapeV4_0_0): ParsedReturnShape;

package/dist/layers/refs.js

@@ -0,0 +1,220 @@
+import { mergeWithArrayConcat } from '@takeshape/util';
+import assign from 'lodash/fp/assign.js';
+import omit from 'lodash/fp/omit.js';
+import isEmpty from 'lodash/isEmpty.js';
+import { parseTemplateShape } from "../refs.js";
+import { isAllOfSchema, isOneOfSchema, isRefSchema } from "./type-utils.js";
+/**
+ * Safely turn a "template" shape reference (`@args`, `args`, `shape`) into a `RefItem`
+ *
+ * @param context A partial project schema
+ * @param refExpression
+ * A ref expression might include "template" name and refer to a local or remote
+ * shape, `Foo` or `CreateArgs<Foo>` or `CreateArgs<remote:Foo>`.*
+ */
+export function refExpressionToRefItem(refExpression) {
+    const { shapeName, template } = parseTemplateShape(refExpression);
+    return atRefToRefItem(shapeName, template);
+}
+/**
+ * Sugar for converting a `refExpression` directly into a shape, without the
+ * intermediate `refItem`.
+ *
+ * @param context A partial project schema
+ * @param refExpression
+ * A ref expression might include "template" name and refer to a local or remote
+ * shape, `Foo` or `CreateArgs<Foo>` or `CreateArgs<remote:Foo>`.
+ */
+export function refExpressionToShape(shapes, refExpression) {
+    return refItemToShape(shapes, refExpressionToRefItem(refExpression));
+}
+/**
+ * Provided a service name and a referenced type. Supports 2 or 3 part
+ * references, e.g., `shopify:my-store:ProductInput` or `my-store:ProductInput`.
+ *
+ * @returns
+ * A 2 member array, where 0 is the service name, 1 is the referenced type.
+ */
+export function splitAtRef(atRef) {
+    const refParts = atRef.split(':');
+    if (refParts.length === 1) {
+        return ['local', atRef];
+    }
+    if (refParts.length === 2) {
+        return [refParts[0], refParts[1]];
+    }
+    throw new Error(`Invalid ref string ${atRef}`);
+}
+/**
+ * Parses and returns a typeName, serviceKey, and potentially a namespace for
+ * the type.
+ */
+export function atRefToRefItem(atRef, template) {
+    const [serviceKey, typeName] = splitAtRef(atRef);
+    return {
+        typeName,
+        layerId: serviceKey,
+        template
+    };
+}
+/**
+ * Given a content schema and project schema, finds a `@ref` or `$ref` and
+ * returns a `RefItem` suitable for loading a referenced schema...
+ */
+export function getRef(refSchema) {
+    if (refSchema['@ref']) {
+        // @ref: my-service:ShapeName
+        return atRefToRefItem(refSchema['@ref']);
+    }
+}
+export function getRefWithPath(refSchema, schemaPath = []) {
+    const refItem = getRef(refSchema);
+    if (refItem) {
+        return {
+            ...refItem,
+            path: schemaPath.concat(['@ref'])
+        };
+    }
+}
+/**
+ * Tests for a `@ref` or `$ref` property directly on the passed schema.
+ *
+ * @param schema Any schema that might could have a ref property.
+ */
+export function hasRefProperty(schema) {
+    return Boolean(schema['@ref'] ?? schema.$ref);
+}
+/**
+ * From a schema with a ref, will return the top-level ref, and potentially
+ * a ref item from a nested `items` property.
+ */
+export function getRefOrItemsRef(refSchema, schemaPath = []) {
+    const refItem = getRefWithPath(refSchema, schemaPath);
+    if (refItem) {
+        return refItem;
+    }
+    if (refSchema.items) {
+        return getRefOrItemsRef(refSchema.items, schemaPath.concat(['items']));
+    }
+}
+/**
+ * Turns a `RefItem` into an `@ref`.
+ */
+export function refItemToString(refItem) {
+    return `${refItem.layerId}:${refItem.typeName}`;
+}
+/**
+ * Get a Shape referenced by a `RefItem`.
+ */
+export function refItemToShape(shapes, refItem) {
+    return shapes[refItemToString(refItem)];
+}
+/**
+ * Helper fn to omit `ref` props from the target schema, and then extend it with the source schema.
+ */
+export const omitRefAndExtend = (targetSchema, sourceSchema) => assign(omit(['@ref', '$ref'], targetSchema), sourceSchema);
+/**
+ * If there is a $ref, this will insert a content schema from the top level
+ * in place of the reference.
+ */
+export function followRef(shapes, contentSchema) {
+    const refItem = getRef(contentSchema);
+    if (refItem) {
+        const referencedSchema = refItemToShape(shapes, refItem)?.schema;
+        if (referencedSchema) {
+            return omitRefAndExtend(contentSchema, referencedSchema);
+        }
+    }
+    return contentSchema;
+}
+/**
+ * Returns whether a schema has refs.
+ */
+export function hasRef(contentSchema) {
+    if (isRefSchema(contentSchema)) {
+        return true;
+    }
+    if (isAllOfSchema(contentSchema)) {
+        return Boolean(contentSchema.allOf.find(hasRef));
+    }
+    if (isOneOfSchema(contentSchema)) {
+        return Boolean(contentSchema.oneOf.find(hasRef));
+    }
+    return false;
+}
+/**
+ * Returns whether a schema has refs which can be followed.
+ */
+export function hasResolvableRef(shapes, contentSchema) {
+    if (isRefSchema(contentSchema)) {
+        return Boolean(refItemToShape(shapes, getRef(contentSchema)));
+    }
+    if (isAllOfSchema(contentSchema)) {
+        return Boolean(contentSchema.allOf.find((s) => hasResolvableRef(shapes, s)));
+    }
+    if (isOneOfSchema(contentSchema)) {
+        return Boolean(contentSchema.oneOf.find((s) => hasResolvableRef(shapes, s)));
+    }
+    return false;
+}
+export function getArgsReferenceWithPath(argsSchema, schemaPath = []) {
+    const isQuery = 'args' in argsSchema;
+    const args = isQuery ? argsSchema.args : argsSchema['@args'];
+    const refItem = typeof args === 'string' ? refExpressionToRefItem(args) : undefined;
+    if (refItem) {
+        return {
+            ...refItem,
+            path: schemaPath.concat([isQuery ? 'args' : '@args'])
+        };
+    }
+}
+/*
+ * Helper fn to omit `allOf` props from the target schema, and then extend it with the source schema.
+ */
+const omitAllOfAndExtend = (targetSchema, sourceSchema) => assign(omit(['allOf'], targetSchema), sourceSchema);
+export function dereferenceSchema(shapes, shapeOrFieldSchema, schemaPath = []) {
+    const resolveAll = (resolveSchema, resolvePath) => {
+        try {
+            if (isAllOfSchema(resolveSchema)) {
+                const allOfSchema = resolveSchema.allOf
+                    .map((stub, index) => resolveAll(stub, [...resolvePath, 'allOf', index]))
+                    .reduce((prev, curr) => mergeWithArrayConcat(prev, curr), {});
+                return isEmpty(allOfSchema) ? undefined : omitAllOfAndExtend(resolveSchema, allOfSchema);
+            }
+            if (isRefSchema(resolveSchema)) {
+                const refItem = getRefWithPath(resolveSchema);
+                if (!refItem) {
+                    throw new Error('ref could not be parsed');
+                }
+                const refSchema = refItemToShape(shapes, refItem);
+                if (refSchema) {
+                    return resolveAll(omitRefAndExtend(resolveSchema, refSchema), refItem.path);
+                }
+                return;
+            }
+            return resolveSchema;
+        }
+        catch (err) {
+            throw new Error(`error at '${resolvePath.join('.')}', ${err.message}`);
+        }
+    };
+    return resolveAll(shapeOrFieldSchema, schemaPath) ?? shapeOrFieldSchema;
+}
+export function parseReturnShape(shape) {
+    if (typeof shape === 'object') {
+        if (isRefSchema(shape.items)) {
+            const ref = getRef(shape.items);
+            if (!ref) {
+                throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid ref`);
+            }
+            return { isArray: true, ref, shapeName: refItemToString(ref) };
+        }
+        if (typeof shape.items.type !== 'string') {
+            throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid type`);
+        }
+        return { isArray: true, shapeName: shape.items.type };
+    }
+    const ref = refExpressionToRefItem(shape);
+    const shapeName = refItemToString(ref);
+    return { isArray: false, shapeName, ref, template: ref.template };
+}

package/dist/layers/type-utils.d.ts

@@ -0,0 +1,59 @@
+import type { AllOfSchemaV4_0_0, AwsLambdaResolverV4_0_0, BasicResolverV4_0_0, ComposeResolverV4_0_0, DirectiveConfigV4_0_0, DirectiveMappingArrayV4_0_0, DirectiveMappingMapV4_0_0, GraphqlResolverV4_0_0, ObjectSchemaV4_0_0, OneOfSchemaV4_0_0, ParameterOpMappingV4_0_0, ParameterOpNestedV4_0_0, ParameterOpOpV4_0_0, ParameterOpV4_0_0, ParameterOpValueV4_0_0, ParameterSerializeContentOptionsV4_0_0, ParameterSerializeOptionsV4_0_0, ParameterSerializeStyleOptionsV4_0_0, PropertySchemaV4_0_0, RefSchemaLegacyV4_0_0, RefSchemaV4_0_0, RestResolverV4_0_0, ReturnShapeArraySchemaV4_0_0, TakeshapeResolverV4_0_0, UtilResolverV4_0_0 } from '../project-schema/index.ts';
+/** Resolver Type Utils **/
+/**
+ * Only tests that the shape is right, not that the name is correct. That's a job for the validator.
+ */
+export declare function isBasicResolver(resolver: unknown): resolver is BasicResolverV4_0_0;
+export declare function isComposeResolver(resolver: unknown): resolver is ComposeResolverV4_0_0;
+export declare function isTakeshapeResolver(resolver: BasicResolverV4_0_0): resolver is TakeshapeResolverV4_0_0;
+export declare function isGraphqlResolver(resolver: BasicResolverV4_0_0): resolver is GraphqlResolverV4_0_0;
+export declare function isRestResolver(resolver: BasicResolverV4_0_0): resolver is RestResolverV4_0_0;
+export declare function isAwsLambdaResolver(resolver: BasicResolverV4_0_0): resolver is AwsLambdaResolverV4_0_0;
+export declare function isUtilResolver(resolver: BasicResolverV4_0_0): resolver is UtilResolverV4_0_0;
+/** Directive Mapping Utils **/
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveMappingMap
+ */
+export declare function isDirectiveMappingMap(maybeMap: DirectiveMappingMapV4_0_0 | DirectiveMappingArrayV4_0_0 | DirectiveConfigV4_0_0): maybeMap is DirectiveMappingMapV4_0_0;
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveMappingArray
+ */
+export declare function isDirectiveMappingArray(maybeArray: DirectiveMappingMapV4_0_0 | DirectiveMappingArrayV4_0_0 | DirectiveConfigV4_0_0): maybeArray is DirectiveMappingArrayV4_0_0;
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveConfig array
+ */
+export declare function isDirectiveConfig(maybeConfig: DirectiveMappingMapV4_0_0 | DirectiveMappingArrayV4_0_0 | DirectiveConfigV4_0_0): maybeConfig is DirectiveConfigV4_0_0;
+/**
+ * Determine whether a ParameterSerializeOption is a content type serializer
+ */
+export declare function isParameterSerializeContentOptions(maybeContent: ParameterSerializeOptionsV4_0_0): maybeContent is ParameterSerializeContentOptionsV4_0_0;
+/**
+ * Determine whether an unknown variable is a `ParameterOp`
+ */
+export declare function isParameterOp(maybeOp: unknown): maybeOp is ParameterOpV4_0_0;
+/**
+ * Determine whether a `ParameterOp` is a `ParameterOpNested`
+ */
+export declare function isParameterOpNested(maybeOp: ParameterOpV4_0_0): maybeOp is ParameterOpNestedV4_0_0;
+/**
+ * Determine whether a `ParameterOp` is a `ParameterOpMapping`
+ */
+export declare function isParameterOpMapping(maybeOp: ParameterOpV4_0_0): maybeOp is ParameterOpMappingV4_0_0;
+/**
+ * Determine whether a `ParameterOp` is a `ParameterOpMapping`
+ */
+export declare function isParameterOpValue(maybeOp: ParameterOpV4_0_0): maybeOp is ParameterOpValueV4_0_0;
+/**
+ * Determine whether a `ParameterOp` is a `ParameterOpOp`
+ */
+export declare function isParameterOpOp(maybeOp: ParameterOpV4_0_0): maybeOp is ParameterOpOpV4_0_0;
+/**
+ * Determine whether a ParameterSerializeOption is a style serializer
+ */
+export declare function isParameterSerializeStyleOptions(maybeStyle: ParameterSerializeOptionsV4_0_0): maybeStyle is ParameterSerializeStyleOptionsV4_0_0;
+/** Typeguards for different types of shape schemas **/
+export declare function isRefSchema(maybeRefSchema: PropertySchemaV4_0_0): maybeRefSchema is RefSchemaV4_0_0 | RefSchemaLegacyV4_0_0;
+export declare function isAllOfSchema(schema: PropertySchemaV4_0_0): schema is AllOfSchemaV4_0_0;
+export declare function isOneOfSchema(schema: PropertySchemaV4_0_0): schema is OneOfSchemaV4_0_0;
+export declare function isArraySchema(schema: PropertySchemaV4_0_0): schema is ReturnShapeArraySchemaV4_0_0;
+export declare function isObjectSchema(schema: PropertySchemaV4_0_0): schema is ObjectSchemaV4_0_0;