@loopback/repository 4.0.0-alpha.6 → 4.0.0

package/dist/define-repository-class.js

@@ -0,0 +1,98 @@
+"use strict";
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineKeyValueRepositoryClass = exports.defineCrudRepositoryClass = exports.defineRepositoryClass = void 0;
+const tslib_1 = require("tslib");
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+const repositories_1 = require("./repositories");
+/**
+ * Create (define) a repository class for the given model.
+ *
+ * See also `defineCrudRepositoryClass` and `defineKeyValueRepositoryClass`
+ * for convenience wrappers providing repository class factory for the default
+ * CRUD and KeyValue implementations.
+ *
+ * **❗️IMPORTANT: The compiler (TypeScript 3.8) is not able to correctly infer
+ * generic arguments `M` and `R` from the class constructors provided in
+ * function arguments. You must always provide both M and R types explicitly.**
+ *
+ * @example
+ *
+ * ```ts
+ * const AddressRepository = defineRepositoryClass<
+ *   typeof Address,
+ *   DefaultEntityCrudRepository<
+ *    Address,
+ *    typeof Address.prototype.id,
+ *    AddressRelations
+ *   >,
+ * >(Address, DefaultCrudRepository);
+ * ```
+ *
+ * @param modelClass - A model class such as `Address`.
+ * @param baseRepositoryClass - Repository implementation to use as the base,
+ * e.g. `DefaultCrudRepository`.
+ *
+ * @typeParam M - Model class constructor (e.g. `typeof Address`)
+ * @typeParam R - Repository class (e.g. `DefaultCrudRepository<Address, number>`)
+ */
+function defineRepositoryClass(modelClass, baseRepositoryClass) {
+    const repoName = modelClass.name + 'Repository';
+    const defineNamedRepo = new Function('ModelCtor', 'BaseRepository', `return class ${repoName} extends BaseRepository {
+      constructor(dataSource) {
+        super(ModelCtor, dataSource);
+      }
+    };`);
+    const repo = defineNamedRepo(modelClass, baseRepositoryClass);
+    assert_1.default.equal(repo.name, repoName);
+    return repo;
+}
+exports.defineRepositoryClass = defineRepositoryClass;
+/**
+ * Create (define) an entity CRUD repository class for the given model.
+ * This function always uses `DefaultCrudRepository` as the base class,
+ * use `defineRepositoryClass` if you want to use your own base repository.
+ *
+ * @example
+ *
+ * ```ts
+ * const ProductRepository = defineCrudRepositoryClass<
+ *   Product,
+ *   typeof Product.prototype.id,
+ *   ProductRelations
+ * >(Product);
+ * ```
+ *
+ * @param entityClass - An entity class such as `Product`.
+ *
+ * @typeParam E - An entity class
+ * @typeParam IdType - ID type for the entity
+ * @typeParam Relations - Relations for the entity
+ */
+function defineCrudRepositoryClass(entityClass) {
+    return defineRepositoryClass(entityClass, repositories_1.DefaultCrudRepository);
+}
+exports.defineCrudRepositoryClass = defineCrudRepositoryClass;
+/**
+ * Create (define) a KeyValue repository class for the given entity.
+ * This function always uses `DefaultKeyValueRepository` as the base class,
+ * use `defineRepositoryClass` if you want to use your own base repository.
+ *
+ * @example
+ *
+ * ```ts
+ * const ProductKeyValueRepository = defineKeyValueRepositoryClass(Product);
+ * ```
+ *
+ * @param modelClass - An entity class such as `Product`.
+ *
+ * @typeParam M - Model class
+ */
+function defineKeyValueRepositoryClass(modelClass) {
+    return defineRepositoryClass(modelClass, repositories_1.DefaultKeyValueRepository);
+}
+exports.defineKeyValueRepositoryClass = defineKeyValueRepositoryClass;
+//# sourceMappingURL=define-repository-class.js.map

package/dist/define-repository-class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-repository-class.js","sourceRoot":"","sources":["../src/define-repository-class.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,iEAA4B;AAG5B,iDAKwB;AAoDxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,qBAAqB,CAInC,UAAa,EACb,mBAA8C;IAE9C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,GAAG,YAAY,CAAC;IAChD,MAAM,eAAe,GAAG,IAAI,QAAQ,CAClC,WAAW,EACX,gBAAgB,EAChB,gBAAgB,QAAQ;;;;OAIrB,CACJ,CAAC;IAEF,MAAM,IAAI,GAAG,eAAe,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;IAC9D,gBAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClC,OAAO,IAAI,CAAC;AACd,CAAC;AArBD,sDAqBC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,yBAAyB,CAKvC,WAA2C;IAE3C,OAAO,qBAAqB,CAAC,WAAW,EAAE,oCAAqB,CAAC,CAAC;AACnE,CAAC;AARD,8DAQC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,6BAA6B,CAC3C,UAAyC;IAEzC,OAAO,qBAAqB,CAAC,UAAU,EAAE,wCAAyB,CAAC,CAAC;AACtE,CAAC;AAJD,sEAIC"}

package/dist/errors/entity-not-found.error.d.ts

@@ -0,0 +1,8 @@
+import { Entity } from '../model';
+export declare class EntityNotFoundError<ID, Props extends object = {}> extends Error {
+    code: string;
+    entityName: string;
+    entityId: ID;
+    constructor(entityOrName: typeof Entity | string, entityId: ID, extraProperties?: Props);
+}
+export declare function isEntityNotFoundError(e: any): e is EntityNotFoundError<any>;

package/dist/errors/entity-not-found.error.js

@@ -0,0 +1,28 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEntityNotFoundError = exports.EntityNotFoundError = void 0;
+class EntityNotFoundError extends Error {
+    constructor(entityOrName, entityId, extraProperties) {
+        const entityName = typeof entityOrName === 'string'
+            ? entityOrName
+            : entityOrName.modelName || entityOrName.name;
+        const quotedId = JSON.stringify(entityId);
+        super(`Entity not found: ${entityName} with id ${quotedId}`);
+        Error.captureStackTrace(this, this.constructor);
+        this.code = 'ENTITY_NOT_FOUND';
+        this.entityName = entityName;
+        this.entityId = entityId;
+        Object.assign(this, extraProperties);
+    }
+}
+exports.EntityNotFoundError = EntityNotFoundError;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isEntityNotFoundError(e) {
+    return e instanceof EntityNotFoundError;
+}
+exports.isEntityNotFoundError = isEntityNotFoundError;
+//# sourceMappingURL=entity-not-found.error.js.map

package/dist/errors/entity-not-found.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-not-found.error.js","sourceRoot":"","sources":["../../src/errors/entity-not-found.error.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAIhE,MAAa,mBAAmD,SAAQ,KAAK;IAK3E,YACE,YAAoC,EACpC,QAAY,EACZ,eAAuB;QAEvB,MAAM,UAAU,GACd,OAAO,YAAY,KAAK,QAAQ;YAC9B,CAAC,CAAC,YAAY;YACd,CAAC,CAAC,YAAY,CAAC,SAAS,IAAI,YAAY,CAAC,IAAI,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAE1C,KAAK,CAAC,qBAAqB,UAAU,YAAY,QAAQ,EAAE,CAAC,CAAC;QAE7D,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAEhD,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACvC,CAAC;CACF;AA3BD,kDA2BC;AAED,8DAA8D;AAC9D,SAAgB,qBAAqB,CAAC,CAAM;IAC1C,OAAO,CAAC,YAAY,mBAAmB,CAAC;AAC1C,CAAC;AAFD,sDAEC"}

package/dist/errors/index.d.ts

@@ -0,0 +1,2 @@
+export * from './entity-not-found.error';
+export * from './invalid-relation.error';

package/dist/errors/index.js

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright IBM Corp. 2018. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./entity-not-found.error"), exports);
+(0, tslib_1.__exportStar)(require("./invalid-relation.error"), exports);
+//# sourceMappingURL=index.js.map

package/dist/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,wEAAyC;AACzC,wEAAyC"}

package/dist/errors/invalid-relation.error.d.ts

@@ -0,0 +1,10 @@
+import { RelationType, RelationMetadata } from '../relations';
+export declare class InvalidRelationError<Props extends object = {}> extends Error {
+    code: string;
+    reason: string;
+    relationName: string;
+    relationType: RelationType;
+    sourceModelName: string;
+    constructor(reason: string, relationMeta: RelationMetadata, extraProperties?: Props);
+}
+export declare function isInvalidRelationError(e: any): e is InvalidRelationError<any>;

package/dist/errors/invalid-relation.error.js

@@ -0,0 +1,28 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isInvalidRelationError = exports.InvalidRelationError = void 0;
+class InvalidRelationError extends Error {
+    constructor(reason, relationMeta, extraProperties) {
+        const { name, type, source } = relationMeta;
+        const model = (source === null || source === void 0 ? void 0 : source.modelName) || '<Unknown Model>';
+        const message = `Invalid ${type} definition for ${model}#${name}: ${reason}`;
+        super(message);
+        Error.captureStackTrace(this, this.constructor);
+        this.code = 'INVALID_RELATION_DEFINITION';
+        this.relationName = name;
+        this.relationType = type;
+        this.sourceModelName = model;
+        Object.assign(this, extraProperties);
+    }
+}
+exports.InvalidRelationError = InvalidRelationError;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isInvalidRelationError(e) {
+    return e instanceof InvalidRelationError;
+}
+exports.isInvalidRelationError = isInvalidRelationError;
+//# sourceMappingURL=invalid-relation.error.js.map

package/dist/errors/invalid-relation.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalid-relation.error.js","sourceRoot":"","sources":["../../src/errors/invalid-relation.error.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAIhE,MAAa,oBAAgD,SAAQ,KAAK;IAOxE,YACE,MAAc,EACd,YAA8B,EAC9B,eAAuB;QAEvB,MAAM,EAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAC,GAAG,YAAY,CAAC;QAC1C,MAAM,KAAK,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,KAAI,iBAAiB,CAAC;QACrD,MAAM,OAAO,GAAG,WAAW,IAAI,mBAAmB,KAAK,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QAC7E,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAEhD,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;QAC1C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAE7B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACvC,CAAC;CACF;AA1BD,oDA0BC;AAED,8DAA8D;AAC9D,SAAgB,sBAAsB,CAAC,CAAM;IAC3C,OAAO,CAAC,YAAY,oBAAoB,CAAC;AAC3C,CAAC;AAFD,wDAEC"}

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * A common set of interfaces for interacting with databases.
+ *
+ * This module provides data access facilities to various databases and services
+ * as well as the constructs for modeling and accessing those data.
+ *
+ * @packageDocumentation
+ */
+export * from '@loopback/filter';
+export { JSONSchema7 as JsonSchema } from 'json-schema';
+/**
+ * Export the DataSource to avoid TypeScript 4.2's complaint about
+ * RepositoryMixin as it references `juggler.DataSource`
+ */
+export { DataSource as JugglerDataSource } from 'loopback-datasource-juggler';
+export * from './common-types';
+export * from './connectors';
+export * from './datasource';
+export * from './decorators';
+export * from './define-model-class';
+export * from './define-repository-class';
+export * from './errors';
+export * from './keys';
+export * from './mixins';
+export * from './model';
+export * from './relations';
+export * from './repositories';
+export * from './transaction';
+export * from './type-resolver';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,39 @@
+"use strict";
+// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JugglerDataSource = void 0;
+const tslib_1 = require("tslib");
+/**
+ * A common set of interfaces for interacting with databases.
+ *
+ * This module provides data access facilities to various databases and services
+ * as well as the constructs for modeling and accessing those data.
+ *
+ * @packageDocumentation
+ */
+(0, tslib_1.__exportStar)(require("@loopback/filter"), exports);
+/**
+ * Export the DataSource to avoid TypeScript 4.2's complaint about
+ * RepositoryMixin as it references `juggler.DataSource`
+ */
+var loopback_datasource_juggler_1 = require("loopback-datasource-juggler");
+Object.defineProperty(exports, "JugglerDataSource", { enumerable: true, get: function () { return loopback_datasource_juggler_1.DataSource; } });
+(0, tslib_1.__exportStar)(require("./common-types"), exports);
+(0, tslib_1.__exportStar)(require("./connectors"), exports);
+(0, tslib_1.__exportStar)(require("./datasource"), exports);
+(0, tslib_1.__exportStar)(require("./decorators"), exports);
+(0, tslib_1.__exportStar)(require("./define-model-class"), exports);
+(0, tslib_1.__exportStar)(require("./define-repository-class"), exports);
+(0, tslib_1.__exportStar)(require("./errors"), exports);
+(0, tslib_1.__exportStar)(require("./keys"), exports);
+(0, tslib_1.__exportStar)(require("./mixins"), exports);
+(0, tslib_1.__exportStar)(require("./model"), exports);
+(0, tslib_1.__exportStar)(require("./relations"), exports);
+(0, tslib_1.__exportStar)(require("./repositories"), exports);
+(0, tslib_1.__exportStar)(require("./transaction"), exports);
+(0, tslib_1.__exportStar)(require("./type-resolver"), exports);
+(0, tslib_1.__exportStar)(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE;;;;;;;GAOG;AAEH,gEAAiC;AAEjC;;;GAGG;AACH,2EAA4E;AAApE,gIAAA,UAAU,OAAqB;AACvC,8DAA+B;AAC/B,4DAA6B;AAC7B,4DAA6B;AAC7B,4DAA6B;AAC7B,oEAAqC;AACrC,yEAA0C;AAC1C,wDAAyB;AACzB,sDAAuB;AACvB,wDAAyB;AACzB,uDAAwB;AACxB,2DAA4B;AAC5B,8DAA+B;AAC/B,6DAA8B;AAC9B,+DAAgC;AAChC,uDAAwB"}

package/dist/keys.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Binding tags for repository related bindings
+ */
+export declare namespace RepositoryTags {
+    /**
+     * Tag for model class bindings
+     */
+    const MODEL = "model";
+    /**
+     * Tag for repository bindings
+     */
+    const REPOSITORY = "repository";
+    /**
+     * Tag for datasource bindings
+     */
+    const DATASOURCE = "datasource";
+}
+/**
+ * Binding keys and namespaces for repository related bindings
+ */
+export declare namespace RepositoryBindings {
+    /**
+     * Namespace for model class bindings
+     */
+    const MODELS = "models";
+    /**
+     * Namespace for repository bindings
+     */
+    const REPOSITORIES = "repositories";
+    /**
+     * Namespace for datasource bindings
+     */
+    const DATASOURCES = "datasources";
+}

package/dist/keys.js

@@ -0,0 +1,44 @@
+"use strict";
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RepositoryBindings = exports.RepositoryTags = void 0;
+/**
+ * Binding tags for repository related bindings
+ */
+var RepositoryTags;
+(function (RepositoryTags) {
+    /**
+     * Tag for model class bindings
+     */
+    RepositoryTags.MODEL = 'model';
+    /**
+     * Tag for repository bindings
+     */
+    RepositoryTags.REPOSITORY = 'repository';
+    /**
+     * Tag for datasource bindings
+     */
+    RepositoryTags.DATASOURCE = 'datasource';
+})(RepositoryTags = exports.RepositoryTags || (exports.RepositoryTags = {}));
+/**
+ * Binding keys and namespaces for repository related bindings
+ */
+var RepositoryBindings;
+(function (RepositoryBindings) {
+    /**
+     * Namespace for model class bindings
+     */
+    RepositoryBindings.MODELS = 'models';
+    /**
+     * Namespace for repository bindings
+     */
+    RepositoryBindings.REPOSITORIES = 'repositories';
+    /**
+     * Namespace for datasource bindings
+     */
+    RepositoryBindings.DATASOURCES = 'datasources';
+})(RepositoryBindings = exports.RepositoryBindings || (exports.RepositoryBindings = {}));
+//# sourceMappingURL=keys.js.map

package/dist/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;GAEG;AACH,IAAiB,cAAc,CAa9B;AAbD,WAAiB,cAAc;IAC7B;;OAEG;IACU,oBAAK,GAAG,OAAO,CAAC;IAC7B;;OAEG;IACU,yBAAU,GAAG,YAAY,CAAC;IACvC;;OAEG;IACU,yBAAU,GAAG,YAAY,CAAC;AACzC,CAAC,EAbgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAa9B;AAED;;GAEG;AACH,IAAiB,kBAAkB,CAalC;AAbD,WAAiB,kBAAkB;IACjC;;OAEG;IACU,yBAAM,GAAG,QAAQ,CAAC;IAC/B;;OAEG;IACU,+BAAY,GAAG,cAAc,CAAC;IAC3C;;OAEG;IACU,8BAAW,GAAG,aAAa,CAAC;AAC3C,CAAC,EAbgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAalC"}

package/dist/mixins/index.d.ts

@@ -0,0 +1 @@
+export * from './repository.mixin';

package/dist/mixins/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./repository.mixin"), exports);
+//# sourceMappingURL=index.js.map

package/dist/mixins/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/mixins/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,kEAAmC"}