@takeshape/schema 9.47.0 → 9.49.0

package/dist/mocks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mocks.d.ts","sourceRoot":"","sources":["../../src/mocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAE,aAAa,EAAE,KAAK,EAAE,mBAAmB,EAAC,MAAM,kBAAkB,CAAC;AAC/F,OAAO,KAAK,EAAC,WAAW,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AAI3D;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,aAAa,CAAM,GAAG,aAAa,CAMtG;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,aAAa,CAAM,GAAG,aAAa,CAMlH;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,aAAa,CAiBrH;AAED,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,UAAU,EACtB,aAAa,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAC3C,mBAAmB,CAMrB;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAU/D"}
+{"version":3,"file":"mocks.d.ts","sourceRoot":"","sources":["../../src/mocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAE,aAAa,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,kBAAkB,CAAC;AACrG,OAAO,KAAK,EAAC,WAAW,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AAI3D;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,iBAAiB,CAAM,GAAG,iBAAiB,CAM9G;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC1C,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,OAAO,CAAC,iBAAiB,CAAM,GACtC,iBAAiB,CAMnB;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,aAAa,CAiBrH;AAED,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,UAAU,EACtB,aAAa,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACzC,iBAAiB,CAMnB;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,SAAS,GAAG,WAAW,CAUnE"}

package/dist/models/project-schema.d.ts

@@ -0,0 +1,36 @@
+import { ShapeJSON, ProjectSchemaJSON } from '../project-schema';
+import { RefItem, RefItemWithPath } from '../refs';
+import { SchemaWithRef } from '../types';
+import { ShapeModel } from './shape';
+import { QueryModel } from './query';
+import { ServiceConfig } from './service';
+/**
+ * Model object representing a ProjectSchema.
+ * Intended to help make it easier to find the right utils
+ * and avoid direct schema json access where a util would be preferred.
+ */
+export declare class ProjectSchema {
+    private readonly _projectSchemaJSON;
+    private _cache;
+    constructor(unfilteredProjectSchema: ProjectSchemaJSON);
+    get json(): ProjectSchemaJSON;
+    get projectId(): string;
+    get $schema(): string | undefined;
+    get author(): string | undefined;
+    getShapeByName(shapeName: string): ShapeModel | undefined;
+    getShapeById(shapeId: string): ShapeModel | undefined;
+    getShapeByRef(shapeRef: string): ShapeModel;
+    get shapes(): ShapeJSON[];
+    get refs(): RefItemWithPath[];
+    getQueryByName(queryName: string): QueryModel;
+    get queries(): QueryModel[];
+    getMutationByName(mutationName: string): QueryModel;
+    get mutations(): QueryModel[];
+    getServiceById(serviceId: string): ServiceConfig;
+    atRefToRefItem(atRef: string, template?: string): RefItem;
+    refItemToShape(refItem: RefItem): ShapeModel;
+    getRef(refSchema: SchemaWithRef): import("@takeshape/util").Maybe<RefItem>;
+    shapeNameToRef(shapeName: string): string;
+    shapeNameToRefItem(shapeName: string): RefItem;
+}
+//# sourceMappingURL=project-schema.d.ts.map

package/dist/models/project-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-schema.d.ts","sourceRoot":"","sources":["../../../src/models/project-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAE,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EACL,OAAO,EACP,eAAe,EAMhB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,OAAO,EAAC,UAAU,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,EAAC,UAAU,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,EAAC,aAAa,EAAC,MAAM,WAAW,CAAC;AASxC;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoB;IACvD,OAAO,CAAC,MAAM,CAA0B;gBAE5B,uBAAuB,EAAE,iBAAiB;IAMtD,IAAI,IAAI,sBAEP;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,OAAO,uBAEV;IAED,IAAI,MAAM,uBAET;IAED,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,YAAY,CAAC,OAAO,EAAE,MAAM;IAU5B,aAAa,CAAC,QAAQ,EAAE,MAAM;IAI9B,IAAI,MAAM,gBAKT;IAED,IAAI,IAAI,sBAGP;IAED,cAAc,CAAC,SAAS,EAAE,MAAM;IAIhC,IAAI,OAAO,iBAIV;IAED,iBAAiB,CAAC,YAAY,EAAE,MAAM;IAItC,IAAI,SAAS,iBAGZ;IAED,cAAc,CAAC,SAAS,EAAE,MAAM;IAIhC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAI/C,cAAc,CAAC,OAAO,EAAE,OAAO;IAI/B,MAAM,CAAC,SAAS,EAAE,aAAa;IAI/B,cAAc,CAAC,SAAS,EAAE,MAAM;IAIhC,kBAAkB,CAAC,SAAS,EAAE,MAAM;CAGrC"}

package/dist/models/project-schema.js

@@ -0,0 +1,132 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ProjectSchema = void 0;
+
+var _refs = require("../refs");
+
+var _schemaUtil = require("../schema-util");
+
+var _omit = _interopRequireDefault(require("lodash/omit"));
+
+var _shape = require("./shape");
+
+var _query = require("./query");
+
+var _service = require("./service");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Model object representing a ProjectSchema.
+ * Intended to help make it easier to find the right utils
+ * and avoid direct schema json access where a util would be preferred.
+ */
+class ProjectSchema {
+  _cache = {};
+
+  constructor(unfilteredProjectSchema) {
+    // You can pass a ProjectSchemaCompat in here, but we remove its values so they don't get passed through to getJSON.
+    // If you need to use this metadata it should be stored separately.
+    this._projectSchemaJSON = (0, _omit.default)(unfilteredProjectSchema, ['created', 'updated', 'version']);
+  }
+
+  get json() {
+    return this._projectSchemaJSON;
+  }
+
+  get projectId() {
+    return this.json.projectId;
+  }
+
+  get $schema() {
+    return this.json.$schema;
+  }
+
+  get author() {
+    return this.json.author;
+  }
+
+  getShapeByName(shapeName) {
+    const shapeJSON = (0, _schemaUtil.getShape)(this.json, shapeName);
+
+    if (!shapeJSON) {
+      return undefined;
+    }
+
+    const shapeRefItem = (0, _refs.shapeToRefItem)(this.json, shapeJSON);
+    return new _shape.ShapeModel(this, shapeRefItem);
+  }
+
+  getShapeById(shapeId) {
+    const shapeJSON = (0, _schemaUtil.getShapeById)(this.json, shapeId);
+
+    if (!shapeJSON) {
+      return undefined;
+    }
+
+    const shapeRefItem = (0, _refs.shapeToRefItem)(this.json, shapeJSON);
+    return new _shape.ShapeModel(this, shapeRefItem);
+  }
+
+  getShapeByRef(shapeRef) {
+    return new _shape.ShapeModel(this, shapeRef);
+  }
+
+  get shapes() {
+    this._cache.shapes = this._cache.shapes ?? Object.keys(this.json.shapes).map(name => new _shape.ShapeModel(this, (0, _refs.shapeNameToRef)(this.json, name)));
+    return this._cache.shapes;
+  }
+
+  get refs() {
+    this._cache.refs = this._cache.refs ?? (0, _schemaUtil.getAllRefs)(this.json);
+    return this._cache.refs;
+  }
+
+  getQueryByName(queryName) {
+    return new _query.QueryModel(this, 'query', queryName);
+  }
+
+  get queries() {
+    this._cache.queries = this._cache.queries ?? Object.keys(this.json.queries).map(name => new _query.QueryModel(this, 'query', name));
+    return this._cache.queries;
+  }
+
+  getMutationByName(mutationName) {
+    return new _query.QueryModel(this, 'mutation', mutationName);
+  }
+
+  get mutations() {
+    this._cache.mutations = Object.keys(this.json.mutations).map(name => new _query.QueryModel(this, 'mutation', name));
+    return this._cache.mutations;
+  }
+
+  getServiceById(serviceId) {
+    return new _service.ServiceConfig(this, serviceId);
+  }
+
+  atRefToRefItem(atRef, template) {
+    return (0, _refs.atRefToRefItem)(this.json, atRef, template);
+  }
+
+  refItemToShape(refItem) {
+    return new _shape.ShapeModel(this, refItem);
+  }
+
+  getRef(refSchema) {
+    return (0, _refs.getRef)(this.json, refSchema);
+  }
+
+  shapeNameToRef(shapeName) {
+    return (0, _refs.shapeNameToRef)(this.json, shapeName);
+  }
+
+  shapeNameToRefItem(shapeName) {
+    return (0, _refs.shapeNameToRefItem)(this.json, shapeName);
+  }
+
+}
+
+exports.ProjectSchema = ProjectSchema;

package/dist/models/query.d.ts

@@ -0,0 +1,18 @@
+import { QueryJSON } from '../project-schema';
+import { ProjectSchema } from './project-schema';
+/**
+ * Create a model object representing a query or mutation.
+ */
+export declare class QueryModel {
+    private readonly _queryType;
+    private readonly _queryName;
+    private readonly _rawQuery;
+    constructor(projectSchemaModel: ProjectSchema, _queryType: 'query' | 'mutation', _queryName: string);
+    get queryType(): "query" | "mutation";
+    get name(): string;
+    get json(): QueryJSON;
+    get description(): string | undefined;
+    get resolver(): import("../project-schema").Resolver;
+    get returnShape(): import("../project-schema").ReturnShape;
+}
+//# sourceMappingURL=query.d.ts.map

package/dist/models/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/models/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAE/C;;GAEG;AACH,qBAAa,UAAU;IAKnB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAL7B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAGpC,kBAAkB,EAAE,aAAa,EAChB,UAAU,EAAE,OAAO,GAAG,UAAU,EAChC,UAAU,EAAE,MAAM;IAKrC,IAAI,SAAS,yBAEZ;IAED,IAAI,IAAI,WAEP;IAED,IAAI,IAAI,cAEP;IAED,IAAI,WAAW,uBAEd;IAED,IAAI,QAAQ,yCAEX;IAED,IAAI,WAAW,4CAEd;CACF"}

package/dist/models/query.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.QueryModel = void 0;
+
+/**
+ * Create a model object representing a query or mutation.
+ */
+class QueryModel {
+  constructor(projectSchemaModel, _queryType, _queryName) {
+    this._queryType = _queryType;
+    this._queryName = _queryName;
+    this._rawQuery = projectSchemaModel.json[_queryType === 'query' ? 'queries' : 'mutations'][_queryName];
+  }
+
+  get queryType() {
+    return this._queryType;
+  }
+
+  get name() {
+    return this._queryName;
+  }
+
+  get json() {
+    return this._rawQuery;
+  }
+
+  get description() {
+    return this.json.description;
+  }
+
+  get resolver() {
+    return this.json.resolver;
+  }
+
+  get returnShape() {
+    return this.json.shape;
+  }
+
+}
+
+exports.QueryModel = QueryModel;

package/dist/models/service.d.ts

@@ -0,0 +1,13 @@
+import { ServiceConfigJSON } from '../project-schema';
+import { ProjectSchema } from './project-schema';
+/**
+ * Create a model object representing a service configuration.
+ */
+export declare class ServiceConfig {
+    private readonly _serviceId;
+    private readonly _storedServiceConfig;
+    constructor(projectSchemaModel: ProjectSchema, _serviceId: string);
+    get id(): string;
+    get json(): ServiceConfigJSON;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/models/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../src/models/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAE/C;;GAEG;AACH,qBAAa,aAAa;IAGuB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAF1E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAoB;gBAE7C,kBAAkB,EAAE,aAAa,EAAmB,UAAU,EAAE,MAAM;IAQlF,IAAI,EAAE,WAEL;IAED,IAAI,IAAI,sBAEP;CACF"}

package/dist/models/service.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ServiceConfig = void 0;
+
+/**
+ * Create a model object representing a service configuration.
+ */
+class ServiceConfig {
+  constructor(projectSchemaModel, _serviceId) {
+    var _projectSchemaModel$j;
+
+    this._serviceId = _serviceId;
+
+    if (!((_projectSchemaModel$j = projectSchemaModel.json.services) !== null && _projectSchemaModel$j !== void 0 && _projectSchemaModel$j[_serviceId])) {
+      throw new Error(`Could not create service model for ${_serviceId}`);
+    }
+
+    this._storedServiceConfig = projectSchemaModel.json.services[_serviceId];
+  }
+
+  get id() {
+    return this._serviceId;
+  }
+
+  get json() {
+    return this._storedServiceConfig;
+  }
+
+}
+
+exports.ServiceConfig = ServiceConfig;

package/dist/models/shape.d.ts

@@ -0,0 +1,42 @@
+import { ShapeJSON } from '../project-schema';
+import { ProjectSchema } from './project-schema';
+import { RefItem } from '../refs';
+/**
+ * Create a shape model from either a ref item or a ref string such as `rick:Character`
+ */
+export declare class ShapeModel {
+    private readonly _projectSchemaModel;
+    private readonly _rawShape;
+    private readonly _shapeRefItem;
+    private readonly _shapeAtRef;
+    constructor(_projectSchemaModel: ProjectSchema, refArg: RefItem | string);
+    get json(): ShapeJSON;
+    get id(): string;
+    get name(): string;
+    get title(): string;
+    get description(): string | undefined;
+    get schema(): import("../project-schema").ShapeSchema;
+    get schemaPropertyList(): {
+        _propertyIterator: Map<string, import("../project-schema").PropertySchema>;
+        orderBy: (iteratees?: ((n: import("..").SchemaPropertyNode) => string)[], orders?: ("asc" | "desc")[]) => any;
+        sortWith: (comparator?: ((a: import("..").SchemaPropertyNode, b: import("..").SchemaPropertyNode) => number) | undefined) => any;
+        sortByNamesWithList: (comparatorArray?: string[] | undefined) => any;
+        filterBy: (predicate: (n: import("..").SchemaPropertyNode) => boolean) => any;
+        forEach: (iteratee: (n: import("..").SchemaPropertyNode) => void) => any;
+        getNodes: () => import("..").SchemaPropertyNode[];
+        getObject: () => Record<string, import("../project-schema").PropertySchema>;
+        getNames: () => string[];
+        getValues: () => import("../project-schema").PropertySchema[];
+    };
+    get schemaPropertyAccessor(): import("../schema-util").SchemaPropertyAccessor;
+    get refString(): string;
+    get refItem(): RefItem;
+    get serviceId(): string;
+    get modelType(): import("../project-schema").ModelType | undefined;
+    get interfaces(): string[] | undefined;
+    get isModel(): boolean;
+    get isCached(): boolean;
+    get isAsset(): boolean;
+    get isInterfaceShape(): boolean;
+}
+//# sourceMappingURL=shape.d.ts.map

package/dist/models/shape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shape.d.ts","sourceRoot":"","sources":["../../../src/models/shape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAC,OAAO,EAAiB,MAAM,SAAS,CAAC;AAUhD;;GAEG;AACH,qBAAa,UAAU;IAIT,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IAHhD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;gBACR,mBAAmB,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM;IAsBzF,IAAI,IAAI,cAEP;IAED,IAAI,EAAE,WAEL;IAED,IAAI,IAAI,WAEP;IAED,IAAI,KAAK,WAER;IAED,IAAI,WAAW,uBAEd;IAED,IAAI,MAAM,4CAET;IAED,IAAI,kBAAkB;;;;;;;;;;;MAErB;IAED,IAAI,sBAAsB,oDAEzB;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,OAAO,YAEV;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,SAAS,sDAEZ;IAED,IAAI,UAAU,yBAEb;IAED,IAAI,OAAO,YAEV;IAED,IAAI,QAAQ,YAEX;IAED,IAAI,OAAO,YAEV;IAED,IAAI,gBAAgB,YAEnB;CACF"}

package/dist/models/shape.js

@@ -0,0 +1,116 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ShapeModel = void 0;
+
+var _refs = require("../refs");
+
+var _schemaUtil = require("../schema-util");
+
+var _interfaces = require("../interfaces");
+
+/**
+ * Create a shape model from either a ref item or a ref string such as `rick:Character`
+ */
+class ShapeModel {
+  constructor(_projectSchemaModel, refArg) {
+    this._projectSchemaModel = _projectSchemaModel;
+
+    if (typeof refArg === 'string') {
+      const rawShape = (0, _schemaUtil.getShapeByRef)(_projectSchemaModel.json, refArg);
+
+      if (!rawShape) {
+        throw new Error(`Error creating shape model: ${refArg} is not in project schema`);
+      }
+
+      this._rawShape = rawShape;
+      this._shapeRefItem = _projectSchemaModel.atRefToRefItem(refArg);
+      this._shapeAtRef = refArg;
+    } else {
+      const rawShape = (0, _refs.refItemToShape)(_projectSchemaModel.json, refArg);
+
+      if (!rawShape) {
+        throw new Error(`Error creating shape model: ref item argument could not be resolved to a shape`);
+      }
+
+      this._rawShape = rawShape;
+      this._shapeRefItem = refArg;
+      this._shapeAtRef = `${refArg.serviceKey}:${refArg.typeName}`;
+    }
+  }
+
+  get json() {
+    return this._rawShape;
+  }
+
+  get id() {
+    return this._rawShape.id;
+  }
+
+  get name() {
+    return this._rawShape.name;
+  }
+
+  get title() {
+    return this._rawShape.title;
+  }
+
+  get description() {
+    return this._rawShape.description;
+  }
+
+  get schema() {
+    return this._rawShape.schema;
+  }
+
+  get schemaPropertyList() {
+    return (0, _schemaUtil.createSchemaPropertyList)(this._projectSchemaModel.json, this._rawShape);
+  }
+
+  get schemaPropertyAccessor() {
+    return (0, _schemaUtil.createSchemaPropertyAccessor)(this._projectSchemaModel.json, this._rawShape);
+  }
+
+  get refString() {
+    return this._shapeAtRef;
+  }
+
+  get refItem() {
+    return this._shapeRefItem;
+  }
+
+  get serviceId() {
+    return this._shapeRefItem.serviceKey;
+  }
+
+  get modelType() {
+    var _this$_rawShape$model;
+
+    return (_this$_rawShape$model = this._rawShape.model) === null || _this$_rawShape$model === void 0 ? void 0 : _this$_rawShape$model.type;
+  }
+
+  get interfaces() {
+    return this._rawShape.interfaces;
+  }
+
+  get isModel() {
+    return (0, _schemaUtil.isModelShape)(this._rawShape);
+  }
+
+  get isCached() {
+    return (0, _schemaUtil.isCachedShape)(this._rawShape);
+  }
+
+  get isAsset() {
+    return this._rawShape.id === 'ASSET';
+  }
+
+  get isInterfaceShape() {
+    return (0, _interfaces.isInterfaceShape)(this._rawShape);
+  }
+
+}
+
+exports.ShapeModel = ShapeModel;