@takeshape/schema 7.194.0

package/lib/unions.js

@@ -0,0 +1,167 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.enumerateOneOfKeys = enumerateOneOfKeys;
+exports.isUnionSchema = isUnionSchema;
+exports.oneOfToObject = oneOfToObject;
+exports.transformOneOf = transformOneOf;
+exports.wrapOneOfObjects = exports.unwrapOneOfObjects = exports.createWrapTransform = exports.createUnwrapTransform = void 0;
+
+var _refs = require("./refs");
+
+var _util = require("@takeshape/util");
+
+var _omit = _interopRequireDefault(require("lodash/omit"));
+
+var _contentSchemaTransform = require("./content-schema-transform");
+
+var _types = require("./types");
+
+var _errors = require("@takeshape/errors");
+
+var _schemaUtil = require("./schema-util");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function enumerateOneOfKeys(projectSchema, oneOf) {
+  const result = [];
+
+  for (const child of oneOf) {
+    const refItem = (0, _refs.getRef)(projectSchema, child);
+
+    if (refItem) {
+      const shapeName = (0, _refs.refItemToShapeName)(refItem);
+
+      if (projectSchema.shapes[shapeName]) {
+        const shapeId = projectSchema.shapes[shapeName].id;
+        result.push({
+          propName: (0, _util.camelCase)(refItem.typeName),
+          propSchema: child,
+          shapeName,
+          shapeId
+        });
+      }
+    }
+  }
+
+  return result;
+}
+
+function getOneOf(schema) {
+  if (!schema.oneOf) {
+    throw new Error(`Expected ${JSON.stringify(schema)} to be a oneOf schema`);
+  }
+
+  return schema.oneOf;
+}
+
+function isUnionSchema(schema) {
+  var _schema$oneOf;
+
+  return Boolean((_schema$oneOf = schema.oneOf) === null || _schema$oneOf === void 0 ? void 0 : _schema$oneOf.every(_types.isRefSchema));
+}
+
+function oneOfToObject(projectSchema, schema) {
+  const properties = {};
+
+  for (const {
+    propName,
+    propSchema: child
+  } of enumerateOneOfKeys(projectSchema, getOneOf(schema))) {
+    properties[propName] = child;
+  }
+
+  return { ...(0, _omit.default)(schema, 'oneOf'),
+    type: 'object',
+    properties
+  };
+}
+
+function formatKeys(keys) {
+  return keys.map(k => `"${k}"`).join(', ');
+}
+
+// eslint-disable-next-line max-params
+const createUnwrapTransform = projectSchema => (obj, schema, name, shape, next) => {
+  if ((0, _util.isObject)(obj)) {
+    const oneOfKeys = enumerateOneOfKeys(projectSchema, getOneOf(schema));
+    const objectKeys = Object.keys(obj);
+
+    if (objectKeys.length !== 1) {
+      const propNames = oneOfKeys.map(k => k.propName);
+      throw new _errors.BadDataError(`Object should only specify one of the following keys: ${formatKeys(propNames)}, but found keys: ${formatKeys(objectKeys)}`);
+    }
+
+    for (const {
+      propName,
+      shapeId,
+      propSchema
+    } of oneOfKeys) {
+      const propValue = obj[propName];
+
+      if ((0, _util.isObject)(propValue)) {
+        const transformedPropValue = next(propValue, propSchema, name);
+
+        if ((0, _util.isObject)(transformedPropValue)) {
+          return { ...transformedPropValue,
+            _shapeId: shapeId
+          };
+        }
+      }
+    }
+  }
+}; // eslint-disable-next-line max-params
+
+
+exports.createUnwrapTransform = createUnwrapTransform;
+
+const createWrapTransform = projectSchema => (obj, schema, name, shape, next) => {
+  if ((0, _util.isObject)(obj) && typeof obj._shapeId === 'string') {
+    const shape = (0, _schemaUtil.getShapeById)(projectSchema, obj._shapeId);
+
+    if (shape) {
+      return {
+        [(0, _util.camelCase)(shape.name)]: next((0, _omit.default)(obj, '_shapeId'), shape.schema, name)
+      };
+    }
+  }
+};
+
+exports.createWrapTransform = createWrapTransform;
+
+function transformOneOf(process) {
+  return (projectSchema, schema, obj) => {
+    const transform = (0, _contentSchemaTransform.getContentTransform)({
+      sourceKeyTransform: _contentSchemaTransform.toName,
+      keyTransform: _contentSchemaTransform.toName,
+      passThrough: true,
+      projectSchema,
+      transforms: {
+        '*': [{
+          filter: isUnionSchema,
+          process: process(projectSchema)
+        }]
+      }
+    });
+    return transform(schema, obj);
+  };
+}
+/**
+ * Unwrap oneOf objects in "GraphQL oneOf" style wrapper objects
+ * See https://github.com/graphql/graphql-spec/pull/825 for more on "GraphQL oneOf"
+ * Opposite of `wrapOneOfObjects`
+ */
+
+
+const unwrapOneOfObjects = transformOneOf(createUnwrapTransform);
+/**
+ * Wrap oneOf objects in "GraphQL oneOf" style wrapper objects
+ * See https://github.com/graphql/graphql-spec/pull/825 for more on "GraphQL oneOf"
+ * Opposite of `unwrapOneOfObjects`
+ */
+
+exports.unwrapOneOfObjects = unwrapOneOfObjects;
+const wrapOneOfObjects = transformOneOf(createWrapTransform);
+exports.wrapOneOfObjects = wrapOneOfObjects;

package/lib/user-schema.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export interface User {
+    id: string;
+    email: string;
+    fullName: string;
+    created: number;
+    updated: number;
+    firstTime: boolean;
+    avatarPath?: string;
+    intercomHash?: string;
+    googleUserId?: string;
+    comcastId?: string;
+    token?: string;
+    policies?: AccessPolicyDocument[];
+    preferences?: {
+        [k: string]: any;
+    };
+}
+export interface AccessPolicyDocument {
+    Version: string;
+    Statement: {
+        Effect?: 'Allow' | 'Deny';
+        Sid?: string;
+        Action?: string[];
+        NotAction?: string[];
+        Resource?: string[];
+        NotResource?: string[];
+        Principal?: {
+            AWS?: string[];
+            Service?: string[];
+        };
+        Condition?: {};
+    }[];
+}
+//# sourceMappingURL=user-schema.d.ts.map

package/lib/user-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-schema.d.ts","sourceRoot":"","sources":["../../src/user-schema.ts"],"names":[],"mappings":"AACA;;;;GAIG;AAEH,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAClC,WAAW,CAAC,EAAE;QACZ,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;KAClB,CAAC;CACH;AACD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE;QACT,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;QAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,SAAS,CAAC,EAAE;YACV,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;YACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;SACpB,CAAC;QACF,SAAS,CAAC,EAAE,EAAE,CAAC;KAChB,EAAE,CAAC;CACL"}

package/lib/user-schema.js

@@ -0,0 +1 @@
+"use strict";

package/lib/util/detect-cycles.d.ts

@@ -0,0 +1,6 @@
+import { ProjectSchema, ContentSchema } from '../project-schema';
+/**
+ * Use a basic depth-first search to dertermine whether a schema contains a cycle
+ */
+export declare function hasCycle(projectSchema: ProjectSchema, schema: ContentSchema, shapesSeen?: Set<string>): boolean;
+//# sourceMappingURL=detect-cycles.d.ts.map

package/lib/util/detect-cycles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect-cycles.d.ts","sourceRoot":"","sources":["../../../src/util/detect-cycles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,aAAa,EAAC,MAAM,mBAAmB,CAAC;AAS/D;;GAEG;AACH,wBAAgB,QAAQ,CACtB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,aAAa,EACrB,UAAU,GAAE,GAAG,CAAC,MAAM,CAAa,GAClC,OAAO,CAoCT"}

package/lib/util/detect-cycles.js

@@ -0,0 +1,61 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.hasCycle = hasCycle;
+
+var _refs = require("../refs");
+
+function immutableSetAdd(set, str) {
+  const result = new Set(set);
+  result.add(str);
+  return result;
+}
+/**
+ * Use a basic depth-first search to dertermine whether a schema contains a cycle
+ */
+
+
+function hasCycle(projectSchema, schema, shapesSeen = new Set()) {
+  var _ref, _schema$oneOf;
+
+  const refItem = (0, _refs.getRef)(projectSchema, schema);
+
+  if (refItem) {
+    const refShape = (0, _refs.refItemToShape)(projectSchema, refItem); // If we have a refItem, but no shape, this is a dangling ref and has no cycles
+
+    if (!refShape) {
+      return false;
+    }
+
+    if (shapesSeen.has(refShape.name)) {
+      return true;
+    }
+
+    return hasCycle(projectSchema, refShape.schema, immutableSetAdd(shapesSeen, refShape.name));
+  }
+
+  const combo = (_ref = (_schema$oneOf = schema.oneOf) !== null && _schema$oneOf !== void 0 ? _schema$oneOf : schema.allOf) !== null && _ref !== void 0 ? _ref : schema.anyOf;
+
+  if (combo) {
+    return combo.some(childSchema => hasCycle(projectSchema, childSchema, shapesSeen));
+  }
+
+  if (schema.items) {
+    return hasCycle(projectSchema, schema.items, shapesSeen);
+  }
+
+  const {
+    properties
+  } = schema;
+
+  if (properties) {
+    return Object.keys(properties).some(name => {
+      const propSchema = properties[name];
+      return hasCycle(projectSchema, propSchema, shapesSeen);
+    });
+  }
+
+  return false;
+}

package/lib/util/index.d.ts

@@ -0,0 +1,2 @@
+export * from './detect-cycles';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/util/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/lib/util/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _detectCycles = require("./detect-cycles");
+
+Object.keys(_detectCycles).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _detectCycles[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _detectCycles[key];
+    }
+  });
+});

package/lib/validate.d.ts

@@ -0,0 +1,49 @@
+import type { RoleImport, RoleInput } from './auth-schemas';
+import type { AnyProjectSchema, ProjectSchema, ProjectSchemaV3_0_0 } from './project-schema';
+import { SchemaValidationErrorItem } from '@takeshape/errors';
+import Ajv, { ErrorObject } from 'ajv';
+export declare function addProjectSchemasToAjv(ajv: Ajv): Ajv;
+export declare type SchemaValidationResult = {
+    valid: true;
+    schema: AnyProjectSchema;
+    errors: undefined;
+} | {
+    valid: false;
+    schema: undefined;
+    errors: SchemaValidationErrorItem[];
+};
+export declare function formatError(error: ErrorObject): SchemaValidationErrorItem;
+export interface Validation {
+    version: string;
+    schemaId: string;
+    isVersion: (schemaVersion?: string) => Boolean;
+    validate: (schema: unknown, options?: ValidateOptions) => SchemaValidationResult;
+}
+export interface ValidateOptions {
+    additionalShapeNames?: string[];
+    additionalModelShapeIds?: string[];
+}
+/**
+ * Validates a schema using a matching validation based on the `schemaVersion` property.
+ */
+export declare function validateSchema(obj: unknown, options?: ValidateOptions): SchemaValidationResult;
+export declare function ensureValidV3Schema(obj: unknown): ProjectSchemaV3_0_0;
+export declare function ensureValidLatestSchema(obj: unknown): ProjectSchema;
+/**
+ * Validates and returns a `RoleInput`, which is a subset of the `Role`
+ * type's properties suitable for importing.
+ */
+export declare function validateRoleInput(maybeRoleInput: unknown): RoleInput;
+/**
+ * Validates and returns a `RoleImport` array, which is a collection of `RoleInput`s.
+ */
+export declare function validateRoleImport(maybeRoles: unknown): RoleImport;
+/**
+ * Only use when validating an imported schema!
+ *
+ * New style validation for parity with the `validateRoleImport` fn. Returns
+ * a valid, and potentially cleaned `AnyProjectSchema` or throws a
+ * `SchemaValidationError`.
+ */
+export declare function validateProjectSchemaImport(maybeSchema: unknown): AnyProjectSchema;
+//# sourceMappingURL=validate.d.ts.map

package/lib/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/validate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,UAAU,EAAE,SAAS,EAAC,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAEV,gBAAgB,EAChB,aAAa,EAEb,mBAAmB,EAcpB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAwB,yBAAyB,EAAC,MAAM,mBAAmB,CAAC;AAOnF,OAAO,GAAG,EAAE,EAAC,WAAW,EAAC,MAAM,KAAK,CAAC;AA0YrC,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CA6BpD;AAED,oBAAY,sBAAsB,GAC9B;IAAC,KAAK,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAC,GAC1D;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,yBAAyB,EAAE,CAAA;CAAC,CAAC;AAI3E,wBAAgB,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,yBAAyB,CAmBzE;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,CAAC,aAAa,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;IAC/C,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,eAAe,KAAK,sBAAsB,CAAC;CAClF;AACD,MAAM,WAAW,eAAe;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;CACpC;AA2ID;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,sBAAsB,CAqB9F;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,mBAAmB,CAgBrE;AAED,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,aAAa,CAgBnE;AAgBD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,OAAO,GAAG,SAAS,CAQpE;AAgBD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,CAQlE;AAqBD;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,WAAW,EAAE,OAAO,GAAG,gBAAgB,CASlF"}