@takeshape/schema 11.40.0 → 11.41.0

package/dist/layers/layers.js

@@ -1,324 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.collectReferencedShapeNames = collectReferencedShapeNames;
-exports.flattenSchema = flattenSchema;
-exports.getAllRefs = getAllRefs;
-exports.getAllRefsInQueries = getAllRefsInQueries;
-exports.getAllRefsInQuery = getAllRefsInQuery;
-exports.getAllRefsInShapes = getAllRefsInShapes;
-exports.isObjectSchemaV4_0_0 = isObjectSchemaV4_0_0;
-var _minimatch = _interopRequireDefault(require("minimatch"));
-var _util = require("@takeshape/util");
-var _uniq = _interopRequireDefault(require("lodash/uniq"));
-var _set = _interopRequireDefault(require("lodash/set"));
-var _refs = require("../refs");
-var _refs2 = require("./refs");
-var _typeUtils = require("./type-utils");
-var _visitor = require("./visitor");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-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 ((0, _minimatch.default)(`${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
-function isObjectSchemaV4_0_0(maybeObjectSchema) {
-  return maybeObjectSchema.type === 'object' && (0, _util.isRecord)(maybeObjectSchema.properties);
-}
-function mergeShape(a, b) {
-  if (b.override === 'extend') {
-    if (isObjectSchemaV4_0_0(a.schema) && isObjectSchemaV4_0_0(b.schema)) {
-      const combinedRequired = (0, _uniq.default)((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.
- */
-function getAllRefsInShapes(shapes, predicate) {
-  const items = [];
-  const shapeVisitor = (schema, schemaPath) => {
-    if (schema['@args'] && typeof schema['@args'] === 'object') {
-      (0, _visitor.visitSchemaProperties)(schema['@args'], schemaPath.concat(['@args']), (argSchema, argPath) => {
-        addRef(items, (0, _refs2.getRefOrItemsRef)(argSchema, argPath), predicate);
-      });
-    }
-    addRef(items, (0, _refs2.getArgsReferenceWithPath)(schema, schemaPath), predicate);
-    const newPath = schema.items ? schemaPath.concat('items') : schemaPath;
-    const newSchema = schema.items ?? schema;
-    if ((0, _typeUtils.isRefSchema)(newSchema)) {
-      addRef(items, (0, _refs2.getRefOrItemsRef)(newSchema, newPath), predicate);
-    } else if ((0, _typeUtils.isObjectSchema)(newSchema) || (0, _typeUtils.isAllOfSchema)(newSchema) || (0, _typeUtils.isOneOfSchema)(newSchema)) {
-      (0, _visitor.visitSchemaProperties)(newSchema, newPath, shapeVisitor);
-    }
-  };
-  for (const [shapeName, shape] of Object.entries(shapes)) {
-    (0, _visitor.visitSchemaProperties)(shape.schema, ['shapes', shapeName, 'schema'], shapeVisitor);
-  }
-  return items;
-}
-
-/**
- * Get all refs
- */
-function getAllRefsInQuery(shapes, queryPath, query, predicate) {
-  const refItems = [];
-  const propertyVisitor = (propSchema, propSchemaPath) => {
-    addRef(refItems, (0, _refs2.getRefOrItemsRef)(propSchema, propSchemaPath), predicate);
-  };
-  if (query.args && typeof query.args === 'string') {
-    addRef(refItems, (0, _refs2.getArgsReferenceWithPath)(query, queryPath), predicate);
-  }
-  if (query.args && typeof query.args === 'object') {
-    (0, _visitor.visitSchemaProperties)((0, _refs2.dereferenceSchema)(shapes, query.args), queryPath, propertyVisitor);
-  }
-  if (query.shape) {
-    const refItem = (0, _refs2.parseReturnShape)(query.shape).ref;
-    if (refItem) {
-      addRef(refItems, {
-        ...refItem,
-        path: queryPath.concat(['shape'])
-      }, predicate);
-    }
-  }
-  return refItems;
-}
-/**
- * Collect refs from `queries` or `mutations`.
- */
-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
- */
-function getAllRefs(projectSchema, predicate) {
-  return [...getAllRefsInShapes(projectSchema.shapes, predicate), ...getAllRefsInQueries(projectSchema, 'queries', predicate), ...getAllRefsInQueries(projectSchema, 'mutations', predicate)];
-}
-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 = (0, _refs2.getArgsReferenceWithPath)(schema);
-    if (argsRefItem) {
-      refSet.add((0, _refs2.refItemToString)(addLayerId(argsRefItem)));
-    }
-    const refItem = (0, _refs2.getRefOrItemsRef)(schema);
-    if (refItem) {
-      refSet.add((0, _refs2.refItemToString)(addLayerId(refItem)));
-    }
-  };
-  return collect;
-}
-function collectServiceRefs(flattenedSchema, getLayer) {
-  const refs = new Set(getAllRefs(flattenedSchema, refItem => refItem.layerId !== 'local').map(_refs2.refItemToString));
-  if (refs.size) {
-    for (const ref of refs) {
-      const [layerId, shapeName] = (0, _refs2.splitAtRef)(ref);
-      if (layerId !== 'local') {
-        const layer = getLayer(layerId);
-        const shape = layer?.shapes?.[shapeName];
-        if (shape) {
-          (0, _visitor.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 = (0, _util.deepClone)(query);
-  const propertyVisitor = (propSchema, propSchemaPath) => {
-    const ref = (propSchema.items ?? propSchema)['@ref'];
-    if (ref) {
-      const [argsLayerId, shapeName] = (0, _refs2.splitAtRef)(ref);
-      if (argsLayerId === 'local' && !localShapes[shapeName]) {
-        const path = propSchemaPath.concat(propSchema.items ? ['items', '@ref'] : ['@ref']);
-        (0, _set.default)(newQuery, path, `${layerId}:${shapeName}`);
-      }
-    }
-  };
-  if (query.args) {
-    if (typeof query.args === 'string') {
-      const [argsLayerId, shapeName] = (0, _refs2.splitAtRef)((0, _refs.parseTemplateShape)(query.args).shapeName);
-      if (argsLayerId === 'local' && !localShapes[shapeName]) {
-        newQuery.args = `${layerId}:${shapeName}`;
-      }
-    } else {
-      (0, _visitor.visitSchemaProperties)(query.args, ['args'], propertyVisitor);
-    }
-  }
-  if (typeof query.shape === 'string') {
-    const [argsLayerId, shapeName] = (0, _refs2.splitAtRef)((0, _refs.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] = (0, _refs2.splitAtRef)(ref);
-      if (argsLayerId === 'local' && !localShapes[shapeName]) {
-        (0, _set.default)(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);
-  }
-}
-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(_util.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] = (0, _refs2.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

@@ -1,104 +0,0 @@
-/// <reference types="lodash" />
-import type { Maybe } from '@takeshape/util';
-import type { PropertySchemaV4_0_0, QueryJSONV4_0_0, ShapeMapV4_0_0, ShapeJSONV4_0_0, ReturnShapeV4_0_0 } from '../project-schema';
-import type { SchemaPath } from '../types';
-/**
- * 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;
-//# sourceMappingURL=refs.d.ts.map

package/dist/layers/refs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"refs.d.ts","sourceRoot":"","sources":["../../../src/layers/refs.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAM3C,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,eAAe,EACf,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGzC;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,UAAU,CAAC;CAClB,GAAG,OAAO,CAAC;AAEZ;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAIrE;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,CAE1G;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAW1D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAQxE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,SAAS,EAAE,oBAAoB,GAAG,KAAK,CAAC,OAAO,CAAC,CAKtE;AAED,wBAAgB,cAAc,CAAC,SAAS,EAAE,oBAAoB,EAAE,UAAU,GAAE,UAAe,GAAG,KAAK,CAAC,eAAe,CAAC,CASnH;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAEpE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,oBAAoB,EAAE,UAAU,GAAE,UAAe,GAAG,KAAK,CAAC,eAAe,CAAC,CAUrH;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAExD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,GAAG,KAAK,CAAC,eAAe,CAAC,CAE/F;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,iBAAkB,oBAAoB,gBAAgB,oBAAoB,wFAC3C,CAAC;AAE7D;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAoB,GAAG,oBAAoB,CAW3G;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,aAAa,EAAE,oBAAoB,GAAG,OAAO,CAcnE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAoB,GAAG,OAAO,CAcrG;AAED,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,oBAAoB,GAAG,eAAe,EAClD,UAAU,GAAE,UAAe,GAC1B,KAAK,CAAC,eAAe,CAAC,CAYxB;AAQD,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,cAAc,EACtB,kBAAkB,EAAE,oBAAoB,EACxC,UAAU,GAAE,UAAe,GAC1B,oBAAoB,CAkCtB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,GAAG,iBAAiB,CAqB5E"}