@takeshape/schema 8.159.10 → 8.164.0

package/dist/util/find-shape-at-path.d.ts

@@ -0,0 +1,12 @@
+import { ProjectSchema, PropertySchema, Shape } from '../project-schema';
+/**
+ *
+ * @param projectSchema
+ * @param schema
+ * @param queryPath
+ *
+ * @example
+ * findShapeAtPath(projectSchema, projectSchema.shapes.Shopify_ProductConnection, ['edges', 'node']) // finds Shopify_Product
+ */
+export declare function findShapeAtPath(projectSchema: ProjectSchema, schema: PropertySchema, queryPath: string[]): Shape | undefined;
+//# sourceMappingURL=find-shape-at-path.d.ts.map

package/dist/util/find-shape-at-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-shape-at-path.d.ts","sourceRoot":"","sources":["../../../src/util/find-shape-at-path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,cAAc,EAAE,KAAK,EAAC,MAAM,mBAAmB,CAAC;AAIvE;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,EAAE,GAClB,KAAK,GAAG,SAAS,CAuBnB"}

package/dist/util/find-shape-at-path.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.findShapeAtPath = findShapeAtPath;
+
+var _types = require("../types");
+
+var _refs = require("../refs");
+
+/**
+ *
+ * @param projectSchema
+ * @param schema
+ * @param queryPath
+ *
+ * @example
+ * findShapeAtPath(projectSchema, projectSchema.shapes.Shopify_ProductConnection, ['edges', 'node']) // finds Shopify_Product
+ */
+function findShapeAtPath(projectSchema, schema, queryPath) {
+  const [prop, ...rest] = queryPath;
+
+  if ((0, _types.isRefSchema)(schema)) {
+    if (queryPath.length === 0) {
+      const refItem = (0, _refs.getRef)(projectSchema, schema);
+      return refItem && (0, _refs.refItemToShape)(projectSchema, refItem);
+    }
+
+    return findShapeAtPath(projectSchema, (0, _refs.followRef)(projectSchema, schema), queryPath);
+  }
+
+  if ((0, _types.isArraySchema)(schema)) {
+    return findShapeAtPath(projectSchema, schema.items, queryPath);
+  }
+
+  if ((0, _types.isObjectSchema)(schema)) {
+    const propSchema = schema.properties[prop];
+
+    if (propSchema) {
+      return findShapeAtPath(projectSchema, propSchema, rest);
+    }
+  }
+
+  return undefined;
+}

package/dist/util/get-conflicting-properties.d.ts

@@ -0,0 +1,7 @@
+import { Shape } from '../project-schema';
+import { ServicesShapesContext } from '../refs';
+/**
+ * Given a list of shapes find the conflicting props
+ */
+export declare function getConflictingProperties(context: ServicesShapesContext, shapes: Shape[]): Set<string>;
+//# sourceMappingURL=get-conflicting-properties.d.ts.map

package/dist/util/get-conflicting-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-conflicting-properties.d.ts","sourceRoot":"","sources":["../../../src/util/get-conflicting-properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,EAAC,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAA6D,qBAAqB,EAAC,MAAM,SAAS,CAAC;AAsB1G;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,qBAAqB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,CAoCrG"}

package/dist/util/get-conflicting-properties.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getConflictingProperties = getConflictingProperties;
+
+var _refs = require("../refs");
+
+var _util = require("@takeshape/util");
+
+var _types = require("../types");
+
+/**
+ * Normalize ref, oneOf and array schemas and get a list of @ref expressions
+ */
+function getRefStrings(context, propertySchema) {
+  const schema = propertySchema.items ?? propertySchema;
+  const schemas = schema.oneOf ? schema.oneOf : [schema];
+  return schemas.map(propertySchema => {
+    const ref = (0, _refs.getRef)(context, propertySchema);
+    return ref ? (0, _refs.refItemToAtRef)(ref) : undefined;
+  }).filter(_util.isDefined);
+}
+
+function isRefEqual(context, a, b) {
+  return (0, _util.setIsEqual)(getRefStrings(context, a), getRefStrings(context, b));
+}
+/**
+ * Given a list of shapes find the conflicting props
+ */
+
+
+function getConflictingProperties(context, shapes) {
+  const conflicts = new Set();
+  const allProps = {};
+
+  for (const shape of Object.values(shapes)) {
+    const schema = (0, _refs.dereferenceSchema)(context, shape.schema, ['shapes', shape.name]);
+
+    if (!(0, _types.isObjectSchema)(schema)) {
+      continue;
+    }
+
+    const required = new Set(schema.required ?? []);
+
+    for (const [name, prop] of Object.entries(schema.properties)) {
+      // skip props that we know already have  conflict
+      if (conflicts.has(name)) {
+        continue;
+      }
+
+      const isRequired = required.has(name);
+
+      if (allProps[name]) {
+        if ( // same type
+        allProps[name][0].type !== prop.type || // same refs
+        !isRefEqual(context, allProps[name][0], prop) || // same nullability
+        isRequired !== allProps[name][1]) {
+          conflicts.add(name);
+        }
+      } else {
+        allProps[name] = [prop, isRequired];
+      }
+    }
+  }
+
+  return conflicts;
+}

package/dist/util/get-return-shape.d.ts

@@ -0,0 +1,3 @@
+import { ProjectSchema, PropertySchema, Query, Shape } from '../project-schema';
+export declare function getReturnShape(projectSchema: ProjectSchema, propOrQuery: PropertySchema | Query): Shape;
+//# sourceMappingURL=get-return-shape.d.ts.map

package/dist/util/get-return-shape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-return-shape.d.ts","sourceRoot":"","sources":["../../../src/util/get-return-shape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAC,MAAM,mBAAmB,CAAC;AA2B9E,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,GAAG,KAAK,GAAG,KAAK,CAQvG"}

package/dist/util/get-return-shape.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getReturnShape = getReturnShape;
+
+var _refs = require("../refs");
+
+function isQuery(propOrQuery) {
+  return 'shape' in propOrQuery && 'resolver' in propOrQuery;
+}
+
+function getReturnShapeHelper(projectSchema, propOrQuery) {
+  let shape;
+
+  if (isQuery(propOrQuery)) {
+    const {
+      shapeName
+    } = (0, _refs.parseReturnShape)(projectSchema, propOrQuery.shape);
+    shape = projectSchema.shapes[shapeName];
+  } else {
+    const ref = (0, _refs.getRef)(projectSchema, propOrQuery);
+
+    if (ref) {
+      shape = (0, _refs.refItemToShape)(projectSchema, ref);
+    }
+  }
+
+  if (!shape) {
+    throw new Error(`Unable to find return shape for ${JSON.stringify(propOrQuery)}`);
+  }
+
+  return shape;
+}
+
+const cache = new WeakMap();
+
+function getReturnShape(projectSchema, propOrQuery) {
+  let result = cache.get(propOrQuery);
+
+  if (!result) {
+    result = getReturnShapeHelper(projectSchema, propOrQuery);
+    cache.set(propOrQuery, result);
+  }
+
+  return result;
+}

package/dist/util/has-arg.d.ts

@@ -0,0 +1,3 @@
+import { ProjectSchema, PropertySchema, Query } from '../project-schema';
+export declare function hasArg(projectSchema: ProjectSchema, prop: PropertySchema | Query, argName: string): boolean;
+//# sourceMappingURL=has-arg.d.ts.map

package/dist/util/has-arg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-arg.d.ts","sourceRoot":"","sources":["../../../src/util/has-arg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,cAAc,EAAE,KAAK,EAAC,MAAM,mBAAmB,CAAC;AAGvE,wBAAgB,MAAM,CAAC,aAAa,EAAE,aAAa,EAAE,IAAI,EAAE,cAAc,GAAG,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAU3G"}

package/dist/util/has-arg.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.hasArg = hasArg;
+
+var _schemaUtil = require("../schema-util");
+
+function hasArg(projectSchema, prop, argName) {
+  var _projectSchema$shapes;
+
+  const args = 'args' in prop ? prop.args : prop['@args'];
+
+  if (!args) {
+    return false;
+  }
+
+  const schema = typeof args === 'string' ? (_projectSchema$shapes = projectSchema.shapes[args]) === null || _projectSchema$shapes === void 0 ? void 0 : _projectSchema$shapes.schema : args;
+  const schemaPropertyAccessor = (0, _schemaUtil.createSchemaPropertyAccessor)(projectSchema, schema);
+  return Boolean(schemaPropertyAccessor.getValue(argName));
+}

package/dist/util/index.d.ts

@@ -1,5 +1,9 @@
 export * from './api-indexing';
 export * from './detect-cycles';
+export * from './find-shape-at-path';
+export * from './get-conflicting-properties';
+export * from './get-return-shape';
+export * from './has-arg';
 export * from './merge';
 export * from './form-config';
 //# sourceMappingURL=index.d.ts.map

package/dist/util/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/util/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/util/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}

package/dist/util/index.js

@@ -30,6 +30,58 @@ Object.keys(_detectCycles).forEach(function (key) {
   });
 });
 
+var _findShapeAtPath = require("./find-shape-at-path");
+
+Object.keys(_findShapeAtPath).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _findShapeAtPath[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _findShapeAtPath[key];
+    }
+  });
+});
+
+var _getConflictingProperties = require("./get-conflicting-properties");
+
+Object.keys(_getConflictingProperties).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _getConflictingProperties[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _getConflictingProperties[key];
+    }
+  });
+});
+
+var _getReturnShape = require("./get-return-shape");
+
+Object.keys(_getReturnShape).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _getReturnShape[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _getReturnShape[key];
+    }
+  });
+});
+
+var _hasArg = require("./has-arg");
+
+Object.keys(_hasArg).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _hasArg[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _hasArg[key];
+    }
+  });
+});
+
 var _merge = require("./merge");
 
 Object.keys(_merge).forEach(function (key) {

package/es/util/find-shape-at-path.js

@@ -0,0 +1,38 @@
+import { isArraySchema, isObjectSchema, isRefSchema } from '../types';
+import { followRef, getRef, refItemToShape } from '../refs';
+/**
+ *
+ * @param projectSchema
+ * @param schema
+ * @param queryPath
+ *
+ * @example
+ * findShapeAtPath(projectSchema, projectSchema.shapes.Shopify_ProductConnection, ['edges', 'node']) // finds Shopify_Product
+ */
+
+export function findShapeAtPath(projectSchema, schema, queryPath) {
+  const [prop, ...rest] = queryPath;
+
+  if (isRefSchema(schema)) {
+    if (queryPath.length === 0) {
+      const refItem = getRef(projectSchema, schema);
+      return refItem && refItemToShape(projectSchema, refItem);
+    }
+
+    return findShapeAtPath(projectSchema, followRef(projectSchema, schema), queryPath);
+  }
+
+  if (isArraySchema(schema)) {
+    return findShapeAtPath(projectSchema, schema.items, queryPath);
+  }
+
+  if (isObjectSchema(schema)) {
+    const propSchema = schema.properties[prop];
+
+    if (propSchema) {
+      return findShapeAtPath(projectSchema, propSchema, rest);
+    }
+  }
+
+  return undefined;
+}

package/es/util/get-conflicting-properties.js

@@ -0,0 +1,60 @@
+import { dereferenceSchema, getRef, refItemToAtRef } from '../refs';
+import { isDefined, setIsEqual } from '@takeshape/util';
+import { isObjectSchema } from '../types';
+/**
+ * Normalize ref, oneOf and array schemas and get a list of @ref expressions
+ */
+
+function getRefStrings(context, propertySchema) {
+  const schema = propertySchema.items ?? propertySchema;
+  const schemas = schema.oneOf ? schema.oneOf : [schema];
+  return schemas.map(propertySchema => {
+    const ref = getRef(context, propertySchema);
+    return ref ? refItemToAtRef(ref) : undefined;
+  }).filter(isDefined);
+}
+
+function isRefEqual(context, a, b) {
+  return setIsEqual(getRefStrings(context, a), getRefStrings(context, b));
+}
+/**
+ * Given a list of shapes find the conflicting props
+ */
+
+
+export function getConflictingProperties(context, shapes) {
+  const conflicts = new Set();
+  const allProps = {};
+
+  for (const shape of Object.values(shapes)) {
+    const schema = dereferenceSchema(context, shape.schema, ['shapes', shape.name]);
+
+    if (!isObjectSchema(schema)) {
+      continue;
+    }
+
+    const required = new Set(schema.required ?? []);
+
+    for (const [name, prop] of Object.entries(schema.properties)) {
+      // skip props that we know already have  conflict
+      if (conflicts.has(name)) {
+        continue;
+      }
+
+      const isRequired = required.has(name);
+
+      if (allProps[name]) {
+        if ( // same type
+        allProps[name][0].type !== prop.type || // same refs
+        !isRefEqual(context, allProps[name][0], prop) || // same nullability
+        isRequired !== allProps[name][1]) {
+          conflicts.add(name);
+        }
+      } else {
+        allProps[name] = [prop, isRequired];
+      }
+    }
+  }
+
+  return conflicts;
+}

package/es/util/get-return-shape.js

@@ -0,0 +1,40 @@
+import { getRef, parseReturnShape, refItemToShape } from '../refs';
+
+function isQuery(propOrQuery) {
+  return 'shape' in propOrQuery && 'resolver' in propOrQuery;
+}
+
+function getReturnShapeHelper(projectSchema, propOrQuery) {
+  let shape;
+
+  if (isQuery(propOrQuery)) {
+    const {
+      shapeName
+    } = parseReturnShape(projectSchema, propOrQuery.shape);
+    shape = projectSchema.shapes[shapeName];
+  } else {
+    const ref = getRef(projectSchema, propOrQuery);
+
+    if (ref) {
+      shape = refItemToShape(projectSchema, ref);
+    }
+  }
+
+  if (!shape) {
+    throw new Error(`Unable to find return shape for ${JSON.stringify(propOrQuery)}`);
+  }
+
+  return shape;
+}
+
+const cache = new WeakMap();
+export function getReturnShape(projectSchema, propOrQuery) {
+  let result = cache.get(propOrQuery);
+
+  if (!result) {
+    result = getReturnShapeHelper(projectSchema, propOrQuery);
+    cache.set(propOrQuery, result);
+  }
+
+  return result;
+}

package/es/util/has-arg.js

@@ -0,0 +1,14 @@
+import { createSchemaPropertyAccessor } from '../schema-util';
+export function hasArg(projectSchema, prop, argName) {
+  var _projectSchema$shapes;
+
+  const args = 'args' in prop ? prop.args : prop['@args'];
+
+  if (!args) {
+    return false;
+  }
+
+  const schema = typeof args === 'string' ? (_projectSchema$shapes = projectSchema.shapes[args]) === null || _projectSchema$shapes === void 0 ? void 0 : _projectSchema$shapes.schema : args;
+  const schemaPropertyAccessor = createSchemaPropertyAccessor(projectSchema, schema);
+  return Boolean(schemaPropertyAccessor.getValue(argName));
+}

package/es/util/index.js

@@ -1,4 +1,8 @@
 export * from './api-indexing';
 export * from './detect-cycles';
+export * from './find-shape-at-path';
+export * from './get-conflicting-properties';
+export * from './get-return-shape';
+export * from './has-arg';
 export * from './merge';
 export * from './form-config';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/schema",
-  "version": "8.159.10",
+  "version": "8.164.0",
   "description": "TakeShape Schema",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -21,9 +21,9 @@
     "examples"
   ],
   "dependencies": {
-    "@takeshape/errors": "8.159.10",
-    "@takeshape/json-schema": "8.159.10",
-    "@takeshape/util": "8.159.10",
+    "@takeshape/errors": "8.164.0",
+    "@takeshape/json-schema": "8.164.0",
+    "@takeshape/util": "8.164.0",
     "ajv": "^8.10.0",
     "ajv-formats": "^2.1.1",
     "blueimp-md5": "^2.10.0",