@loopback/repository 4.0.0-alpha.9 → 4.0.0

package/dist/mixins/repository.mixin.js

@@ -0,0 +1,405 @@
+"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 });
+exports.createModelClassBinding = exports.RepositoryMixinDoc = exports.RepositoryMixin = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@loopback/core");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const keys_1 = require("../keys");
+const repositories_1 = require("../repositories");
+const debug = (0, debug_1.default)('loopback:repository:mixin');
+/* eslint-enable @typescript-eslint/no-unused-vars */
+/**
+ * A mixin class for Application that creates a .repository()
+ * function to register a repository automatically. Also overrides
+ * component function to allow it to register repositories automatically.
+ *
+ * @example
+ * ```ts
+ * class MyApplication extends RepositoryMixin(Application) {}
+ * ```
+ *
+ * Please note: the members in the mixin function are documented in a dummy class
+ * called <a href="#RepositoryMixinDoc">RepositoryMixinDoc</a>
+ *
+ * @param superClass - Application class
+ * @returns A new class that extends the super class with repository related
+ * methods
+ *
+ * @typeParam T - Type of the application class as the target for the mixin
+ *
+ */
+function RepositoryMixin(superClass) {
+    return class extends superClass {
+        /**
+         * Add a repository to this application.
+         *
+         * @param repoClass - The repository to add.
+         * @param nameOrOptions - Name or options for the binding
+         *
+         * @example
+         * ```ts
+         *
+         * class NoteRepo {
+         *   model: any;
+         *
+         *   constructor() {
+         *     const ds: juggler.DataSource = new juggler.DataSource({
+         *       name: 'db',
+         *       connector: 'memory',
+         *     });
+         *
+         *     this.model = ds.createModel(
+         *       'note',
+         *       {title: 'string', content: 'string'},
+         *       {}
+         *     );
+         *   }
+         * };
+         *
+         * app.repository(NoteRepo);
+         * ```
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        repository(repoClass, nameOrOptions) {
+            const binding = (0, core_1.createBindingFromClass)(repoClass, {
+                namespace: keys_1.RepositoryBindings.REPOSITORIES,
+                type: keys_1.RepositoryTags.REPOSITORY,
+                defaultScope: core_1.BindingScope.TRANSIENT,
+                ...toOptions(nameOrOptions),
+            }).tag(keys_1.RepositoryTags.REPOSITORY);
+            this.add(binding);
+            return binding;
+        }
+        /**
+         * Retrieve the repository instance from the given Repository class
+         *
+         * @param repo - The repository class to retrieve the instance of
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        async getRepository(repo) {
+            return this.get(`repositories.${repo.name}`);
+        }
+        /**
+         * Add the dataSource to this application.
+         *
+         * @param dataSource - The dataSource to add.
+         * @param nameOrOptions - The binding name or options of the datasource;
+         * defaults to dataSource.name
+         *
+         * @example
+         * ```ts
+         *
+         * const ds: juggler.DataSource = new juggler.DataSource({
+         *   name: 'db',
+         *   connector: 'memory',
+         * });
+         *
+         * app.dataSource(ds);
+         *
+         * // The datasource can be injected with
+         * constructor(@inject('datasources.db') dataSource: DataSourceType) {
+         *
+         * }
+         * ```
+         */
+        dataSource(dataSource, nameOrOptions) {
+            var _a;
+            const options = toOptions(nameOrOptions);
+            // We have an instance of
+            if (dataSource instanceof repositories_1.juggler.DataSource) {
+                const name = options.name || dataSource.name;
+                const namespace = (_a = options.namespace) !== null && _a !== void 0 ? _a : keys_1.RepositoryBindings.DATASOURCES;
+                const key = `${namespace}.${name}`;
+                return this.bind(key).to(dataSource).tag(keys_1.RepositoryTags.DATASOURCE);
+            }
+            else if (typeof dataSource === 'function') {
+                options.name = options.name || dataSource.dataSourceName;
+                const binding = (0, core_1.createBindingFromClass)(dataSource, {
+                    namespace: keys_1.RepositoryBindings.DATASOURCES,
+                    type: keys_1.RepositoryTags.DATASOURCE,
+                    defaultScope: core_1.BindingScope.SINGLETON,
+                    ...options,
+                });
+                this.add(binding);
+                return binding;
+            }
+            else {
+                throw new Error('not a valid DataSource.');
+            }
+        }
+        /**
+         * Register a model class as a binding in the target context
+         * @param modelClass - Model class
+         */
+        model(modelClass) {
+            const binding = createModelClassBinding(modelClass);
+            this.add(binding);
+            return binding;
+        }
+        /**
+         * Add a component to this application. Also mounts
+         * all the components repositories.
+         *
+         * @param component - The component to add.
+         * @param nameOrOptions - Name or options for the binding.
+         *
+         * @example
+         * ```ts
+         *
+         * export class ProductComponent {
+         *   controllers = [ProductController];
+         *   repositories = [ProductRepo, UserRepo];
+         *   providers = {
+         *     [AUTHENTICATION_STRATEGY]: AuthStrategy,
+         *     [AUTHORIZATION_ROLE]: Role,
+         *   };
+         * };
+         *
+         * app.component(ProductComponent);
+         * ```
+         */
+        // Unfortunately, TypeScript does not allow overriding methods inherited
+        // from mapped types. https://github.com/microsoft/TypeScript/issues/38496
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        component(componentCtor, nameOrOptions) {
+            const binding = super.component(componentCtor, nameOrOptions);
+            const instance = this.getSync(binding.key);
+            this.mountComponentRepositories(instance);
+            this.mountComponentModels(instance);
+            return binding;
+        }
+        /**
+         * Get an instance of a component and mount all it's
+         * repositories. This function is intended to be used internally
+         * by `component()`.
+         *
+         * NOTE: Calling `mountComponentRepositories` with a component class
+         * constructor is deprecated. You should instantiate the component
+         * yourself and provide the component instance instead.
+         *
+         * @param componentInstanceOrClass - The component to mount repositories of
+         * @internal
+         */
+        mountComponentRepositories(
+        // accept also component class to preserve backwards compatibility
+        // TODO(semver-major) Remove support for component class constructor
+        componentInstanceOrClass) {
+            const component = resolveComponentInstance(this);
+            if (component.repositories) {
+                for (const repo of component.repositories) {
+                    this.repository(repo);
+                }
+            }
+            // `Readonly<Application>` is a hack to remove protected members
+            // and thus allow `this` to be passed as a value for `ctx`
+            function resolveComponentInstance(ctx) {
+                if (typeof componentInstanceOrClass !== 'function')
+                    return componentInstanceOrClass;
+                const componentName = componentInstanceOrClass.name;
+                const componentKey = `${core_1.CoreBindings.COMPONENTS}.${componentName}`;
+                return ctx.getSync(componentKey);
+            }
+        }
+        /**
+         * Bind all model classes provided by a component.
+         * @param component
+         * @internal
+         */
+        mountComponentModels(component) {
+            if (!component.models)
+                return;
+            for (const m of component.models) {
+                this.model(m);
+            }
+        }
+        /**
+         * Update or recreate the database schema for all repositories.
+         *
+         * **WARNING**: By default, `migrateSchema()` will attempt to preserve data
+         * while updating the schema in your target database, but this is not
+         * guaranteed to be safe.
+         *
+         * Please check the documentation for your specific connector(s) for
+         * a detailed breakdown of behaviors for automigrate!
+         *
+         * @param options - Migration options, e.g. whether to update tables
+         * preserving data or rebuild everything from scratch.
+         */
+        async migrateSchema(options = {}) {
+            var _a;
+            const operation = options.existingSchema === 'drop' ? 'automigrate' : 'autoupdate';
+            // Instantiate all repositories to ensure models are registered & attached
+            // to their datasources
+            const repoBindings = this.findByTag('repository');
+            await Promise.all(repoBindings.map(b => this.get(b.key)));
+            // Look up all datasources and update/migrate schemas one by one
+            const dsBindings = this.findByTag(keys_1.RepositoryTags.DATASOURCE);
+            for (const b of dsBindings) {
+                const ds = await this.get(b.key);
+                const disableMigration = (_a = ds.settings.disableMigration) !== null && _a !== void 0 ? _a : false;
+                if (operation in ds &&
+                    typeof ds[operation] === 'function' &&
+                    !disableMigration) {
+                    debug('Migrating dataSource %s', b.key);
+                    await ds[operation](options.models);
+                }
+                else {
+                    debug('Skipping migration of dataSource %s', b.key);
+                }
+            }
+        }
+    };
+}
+exports.RepositoryMixin = RepositoryMixin;
+/**
+ * Normalize name or options to `BindingFromClassOptions`
+ * @param nameOrOptions - Name or options for binding from class
+ */
+function toOptions(nameOrOptions) {
+    if (typeof nameOrOptions === 'string') {
+        return { name: nameOrOptions };
+    }
+    return nameOrOptions !== null && nameOrOptions !== void 0 ? nameOrOptions : {};
+}
+/**
+ * A dummy class created to generate the tsdoc for the members in repository
+ * mixin. Please don't use it.
+ *
+ * The members are implemented in function
+ * <a href="#RepositoryMixin">RepositoryMixin</a>
+ */
+class RepositoryMixinDoc {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    constructor(...args) {
+        throw new Error('This is a dummy class created for apidoc!' + 'Please do not use it!');
+    }
+    /**
+     * Add a repository to this application.
+     *
+     * @param repo - The repository to add.
+     *
+     * @example
+     * ```ts
+     *
+     * class NoteRepo {
+     *   model: any;
+     *
+     *   constructor() {
+     *     const ds: juggler.DataSource = new juggler.DataSource({
+     *       name: 'db',
+     *       connector: 'memory',
+     *     });
+     *
+     *     this.model = ds.createModel(
+     *       'note',
+     *       {title: 'string', content: 'string'},
+     *       {}
+     *     );
+     *   }
+     * };
+     *
+     * app.repository(NoteRepo);
+     * ```
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    repository(repo) {
+        throw new Error();
+    }
+    /**
+     * Retrieve the repository instance from the given Repository class
+     *
+     * @param repo - The repository class to retrieve the instance of
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async getRepository(repo) {
+        return new repo();
+    }
+    /**
+     * Add the dataSource to this application.
+     *
+     * @param dataSource - The dataSource to add.
+     * @param name - The binding name of the datasource; defaults to dataSource.name
+     *
+     * @example
+     * ```ts
+     *
+     * const ds: juggler.DataSource = new juggler.DataSource({
+     *   name: 'db',
+     *   connector: 'memory',
+     * });
+     *
+     * app.dataSource(ds);
+     *
+     * // The datasource can be injected with
+     * constructor(@inject('datasources.db') dataSource: DataSourceType) {
+     *
+     * }
+     * ```
+     */
+    dataSource(dataSource, name) {
+        throw new Error();
+    }
+    /**
+     * Add a component to this application. Also mounts
+     * all the components repositories.
+     *
+     * @param component - The component to add.
+     *
+     * @example
+     * ```ts
+     *
+     * export class ProductComponent {
+     *   controllers = [ProductController];
+     *   repositories = [ProductRepo, UserRepo];
+     *   providers = {
+     *     [AUTHENTICATION_STRATEGY]: AuthStrategy,
+     *     [AUTHORIZATION_ROLE]: Role,
+     *   };
+     * };
+     *
+     * app.component(ProductComponent);
+     * ```
+     */
+    component(component) {
+        throw new Error();
+    }
+    /**
+     * Get an instance of a component and mount all it's
+     * repositories. This function is intended to be used internally
+     * by component()
+     *
+     * @param component - The component to mount repositories of
+     */
+    mountComponentRepository(component) { }
+    /**
+     * Update or recreate the database schema for all repositories.
+     *
+     * **WARNING**: By default, `migrateSchema()` will attempt to preserve data
+     * while updating the schema in your target database, but this is not
+     * guaranteed to be safe.
+     *
+     * Please check the documentation for your specific connector(s) for
+     * a detailed breakdown of behaviors for automigrate!
+     *
+     * @param options - Migration options, e.g. whether to update tables
+     * preserving data or rebuild everything from scratch.
+     */
+    async migrateSchema(options) { }
+}
+exports.RepositoryMixinDoc = RepositoryMixinDoc;
+/**
+ * Create a binding for the given model class
+ * @param modelClass - Model class
+ */
+function createModelClassBinding(modelClass) {
+    return core_1.Binding.bind(`${keys_1.RepositoryBindings.MODELS}.${modelClass.name}`)
+        .to(modelClass)
+        .tag(keys_1.RepositoryTags.MODEL);
+}
+exports.createModelClassBinding = createModelClassBinding;
+//# sourceMappingURL=repository.mixin.js.map

package/dist/mixins/repository.mixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.mixin.js","sourceRoot":"","sources":["../../src/mixins/repository.mixin.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAUwB;AACxB,+DAAiC;AAGjC,kCAA2D;AAE3D,kDAAoD;AAEpD,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,2BAA2B,CAAC,CAAC;AAOxD,qDAAqD;AAErD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,eAAe,CAC7B,UAAa;IAEb,OAAO,KAAM,SAAQ,UAAU;QAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BG;QACH,8DAA8D;QAC9D,UAAU,CACR,SAAmB,EACnB,aAAgD;YAEhD,MAAM,OAAO,GAAG,IAAA,6BAAsB,EAAC,SAAS,EAAE;gBAChD,SAAS,EAAE,yBAAkB,CAAC,YAAY;gBAC1C,IAAI,EAAE,qBAAc,CAAC,UAAU;gBAC/B,YAAY,EAAE,mBAAY,CAAC,SAAS;gBACpC,GAAG,SAAS,CAAC,aAAa,CAAC;aAC5B,CAAC,CAAC,GAAG,CAAC,qBAAc,CAAC,UAAU,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAClB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED;;;;WAIG;QACH,8DAA8D;QAC9D,KAAK,CAAC,aAAa,CAA4B,IAAc;YAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,UAAU,CACR,UAAwB,EACxB,aAAgD;;YAEhD,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;YACzC,yBAAyB;YACzB,IAAI,UAAU,YAAY,sBAAO,CAAC,UAAU,EAAE;gBAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC;gBAC7C,MAAM,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,yBAAkB,CAAC,WAAW,CAAC;gBACtE,MAAM,GAAG,GAAG,GAAG,SAAS,IAAI,IAAI,EAAE,CAAC;gBACnC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,qBAAc,CAAC,UAAU,CAAC,CAAC;aACrE;iBAAM,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE;gBAC3C,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU,CAAC,cAAc,CAAC;gBACzD,MAAM,OAAO,GAAG,IAAA,6BAAsB,EAAC,UAAU,EAAE;oBACjD,SAAS,EAAE,yBAAkB,CAAC,WAAW;oBACzC,IAAI,EAAE,qBAAc,CAAC,UAAU;oBAC/B,YAAY,EAAE,mBAAY,CAAC,SAAS;oBACpC,GAAG,OAAO;iBACX,CAAC,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAClB,OAAO,OAAO,CAAC;aAChB;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;aAC5C;QACH,CAAC;QAED;;;WAGG;QACH,KAAK,CAA2B,UAAa;YAC3C,MAAM,OAAO,GAAG,uBAAuB,CAAC,UAAU,CAAC,CAAC;YACpD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAClB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,wEAAwE;QACxE,0EAA0E;QAC1E,6DAA6D;QAC7D,aAAa;QACN,SAAS,CACd,aAA6B,EAC7B,aAAgD;YAEhD,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;YAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAA0B,OAAO,CAAC,GAAG,CAAC,CAAC;YACpE,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;YAC1C,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;YACpC,OAAO,OAAO,CAAC;QACjB,CAAC;QAED;;;;;;;;;;;WAWG;QACH,0BAA0B;QACxB,kEAAkE;QAClE,oEAAoE;QACpE,wBAA8D;YAE9D,MAAM,SAAS,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;YAEjD,IAAI,SAAS,CAAC,YAAY,EAAE;gBAC1B,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,YAAY,EAAE;oBACzC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;iBACvB;aACF;YAED,gEAAgE;YAChE,0DAA0D;YAC1D,SAAS,wBAAwB,CAAC,GAA0B;gBAC1D,IAAI,OAAO,wBAAwB,KAAK,UAAU;oBAChD,OAAO,wBAAwB,CAAC;gBAElC,MAAM,aAAa,GAAG,wBAAwB,CAAC,IAAI,CAAC;gBACpD,MAAM,YAAY,GAAG,GAAG,mBAAY,CAAC,UAAU,IAAI,aAAa,EAAE,CAAC;gBACnE,OAAO,GAAG,CAAC,OAAO,CAAsB,YAAY,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED;;;;WAIG;QACH,oBAAoB,CAAC,SAA8B;YACjD,IAAI,CAAC,SAAS,CAAC,MAAM;gBAAE,OAAO;YAC9B,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE;gBAChC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACf;QACH,CAAC;QAED;;;;;;;;;;;;WAYG;QACH,KAAK,CAAC,aAAa,CAAC,UAAkC,EAAE;;YACtD,MAAM,SAAS,GACb,OAAO,CAAC,cAAc,KAAK,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC;YAEnE,0EAA0E;YAC1E,uBAAuB;YACvB,MAAM,YAAY,GAChB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAC/B,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAE1D,gEAAgE;YAChE,MAAM,UAAU,GAAgC,IAAI,CAAC,SAAS,CAC5D,qBAAc,CAAC,UAAU,CAC1B,CAAC;YACF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE;gBAC1B,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAqB,CAAC,CAAC,GAAG,CAAC,CAAC;gBACrD,MAAM,gBAAgB,GAAG,MAAA,EAAE,CAAC,QAAQ,CAAC,gBAAgB,mCAAI,KAAK,CAAC;gBAE/D,IACE,SAAS,IAAI,EAAE;oBACf,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,UAAU;oBACnC,CAAC,gBAAgB,EACjB;oBACA,KAAK,CAAC,yBAAyB,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;oBACxC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;iBACrC;qBAAM;oBACL,KAAK,CAAC,qCAAqC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;iBACrD;aACF;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAvPD,0CAuPC;AAoBD;;;GAGG;AACH,SAAS,SAAS,CAAC,aAAgD;IACjE,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;QACrC,OAAO,EAAC,IAAI,EAAE,aAAa,EAAC,CAAC;KAC9B;IACD,OAAO,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAC;AAC7B,CAAC;AAuBD;;;;;;GAMG;AACH,MAAa,kBAAkB;IAC7B,8DAA8D;IAC9D,YAAY,GAAG,IAAW;QACxB,MAAM,IAAI,KAAK,CACb,2CAA2C,GAAG,uBAAuB,CACtE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,8DAA8D;IAC9D,UAAU,CAAC,IAA4B;QACrC,MAAM,IAAI,KAAK,EAAE,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,8DAA8D;IAC9D,KAAK,CAAC,aAAa,CAA4B,IAAc;QAC3D,OAAO,IAAI,IAAI,EAAO,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CACR,UAA0D,EAC1D,IAAa;QAEb,MAAM,IAAI,KAAK,EAAE,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,SAAS,CAAC,SAAoB;QACnC,MAAM,IAAI,KAAK,EAAE,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACH,wBAAwB,CAAC,SAAoB,IAAG,CAAC;IAEjD;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CAAC,OAAgC,IAAkB,CAAC;CACxE;AAhID,gDAgIC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CACrC,UAAa;IAEb,OAAO,cAAO,CAAC,IAAI,CAAI,GAAG,yBAAkB,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;SACtE,EAAE,CAAC,UAAU,CAAC;SACd,GAAG,CAAC,qBAAc,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAND,0DAMC"}

package/dist/model.d.ts

@@ -0,0 +1,232 @@
+import { AnyObject, DataObject, Options, PrototypeOf } from './common-types';
+import { BelongsToDefinition, HasManyDefinition, HasOneDefinition, JsonSchema, RelationMetadata } from './index';
+import { TypeResolver } from './type-resolver';
+import { Type } from './types';
+/**
+ * This module defines the key classes representing building blocks for Domain
+ * Driven Design.
+ * See https://en.wikipedia.org/wiki/Domain-driven_design#Building_blocks
+ */
+export interface JsonSchemaWithExtensions extends JsonSchema {
+    [attributes: string]: any;
+}
+export declare type PropertyType = string | Function | object | Type<any> | TypeResolver<Model>;
+/**
+ * Property definition for a model
+ */
+export interface PropertyDefinition {
+    type: PropertyType;
+    id?: boolean | number;
+    /**
+     * Used to hide this property from the response body,
+     * adding this property to the hiddenProperties array
+     */
+    hidden?: boolean;
+    json?: PropertyForm;
+    jsonSchema?: JsonSchemaWithExtensions;
+    store?: PropertyForm;
+    itemType?: PropertyType;
+    [attribute: string]: any;
+}
+/**
+ * Defining the settings for a model
+ * See https://loopback.io/doc/en/lb4/Model.html#supported-entries-of-model-definition
+ */
+export interface ModelSettings {
+    /**
+     * Description of the model
+     */
+    description?: string;
+    /**
+     * Prevent clients from setting the auto-generated ID value manually
+     */
+    forceId?: boolean;
+    /**
+     * Hides properties from response bodies
+     */
+    hiddenProperties?: string[];
+    /**
+     * Scope enables you to set a scope that will apply to every query made by the model's repository
+     */
+    scope?: object;
+    /**
+     * Specifies whether the model accepts only predefined properties or not
+     */
+    strict?: boolean | 'filter';
+    [name: string]: any;
+}
+/**
+ * See https://github.com/loopbackio/loopback-datasource-juggler/issues/432
+ */
+export interface PropertyForm {
+    in?: boolean;
+    out?: boolean;
+    name?: string;
+}
+/**
+ * A key-value map describing model relations.
+ * A relation name is used as the key, a relation definition is the value.
+ */
+export declare type RelationDefinitionMap = {
+    [relationName: string]: RelationMetadata;
+};
+/**
+ * DSL for building a model definition.
+ */
+export interface ModelDefinitionSyntax {
+    name: string;
+    properties?: {
+        [name: string]: PropertyDefinition | PropertyType;
+    };
+    settings?: ModelSettings;
+    relations?: RelationDefinitionMap;
+    jsonSchema?: JsonSchemaWithExtensions;
+    [attribute: string]: any;
+}
+/**
+ * Definition for a model
+ */
+export declare class ModelDefinition {
+    readonly name: string;
+    properties: {
+        [name: string]: PropertyDefinition;
+    };
+    settings: ModelSettings;
+    relations: RelationDefinitionMap;
+    [attribute: string]: any;
+    constructor(nameOrDef: string | ModelDefinitionSyntax);
+    /**
+     * Add a property
+     * @param name - Property definition or name (string)
+     * @param definitionOrType - Definition or property type
+     */
+    addProperty(name: string, definitionOrType: PropertyDefinition | PropertyType): this;
+    /**
+     * Add a setting
+     * @param name - Setting name
+     * @param value - Setting value
+     */
+    addSetting(name: string, value: any): this;
+    /**
+     * Define a new relation.
+     * @param definition - The definition of the new relation.
+     */
+    addRelation(definition: RelationMetadata): this;
+    /**
+     * Define a new belongsTo relation.
+     * @param name - The name of the belongsTo relation.
+     * @param definition - The definition of the belongsTo relation.
+     */
+    belongsTo(name: string, definition: Omit<BelongsToDefinition, 'name' | 'type' | 'targetsMany'>): this;
+    /**
+     * Define a new hasOne relation.
+     * @param name - The name of the hasOne relation.
+     * @param definition - The definition of the hasOne relation.
+     */
+    hasOne(name: string, definition: Omit<HasOneDefinition, 'name' | 'type' | 'targetsMany'>): this;
+    /**
+     * Define a new hasMany relation.
+     * @param name - The name of the hasMany relation.
+     * @param definition - The definition of the hasMany relation.
+     */
+    hasMany(name: string, definition: Omit<HasManyDefinition, 'name' | 'type' | 'targetsMany'>): this;
+    /**
+     * Get an array of names of ID properties, which are specified in
+     * the model settings or properties with `id` attribute.
+     *
+     * @example
+     * ```ts
+     * {
+     *   settings: {
+     *     id: ['id']
+     *   }
+     *   properties: {
+     *     id: {
+     *       type: 'string',
+     *       id: true
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    idProperties(): string[];
+}
+/**
+ * Base class for models
+ */
+export declare class Model {
+    static get modelName(): string;
+    static definition: ModelDefinition;
+    /**
+     * Serialize into a plain JSON object
+     */
+    toJSON(): Object;
+    /**
+     * Convert to a plain object as DTO
+     *
+     * If `ignoreUnknownProperty` is set to false, convert all properties in the
+     * model instance, otherwise only convert the ones defined in the model
+     * definitions.
+     *
+     * See function `asObject` for each property's conversion rules.
+     */
+    toObject(options?: Options): Object;
+    constructor(data?: DataObject<Model>);
+}
+export interface Persistable {
+}
+/**
+ * Base class for value objects - An object that contains attributes but has no
+ * conceptual identity. They should be treated as immutable.
+ */
+export declare abstract class ValueObject extends Model implements Persistable {
+}
+/**
+ * Base class for entities which have unique ids
+ */
+export declare class Entity extends Model implements Persistable {
+    /**
+     * Get the names of identity properties (primary keys).
+     */
+    static getIdProperties(): string[];
+    /**
+     * Get the identity value for a given entity instance or entity data object.
+     *
+     * @param entityOrData - The data object for which to determine the identity
+     * value.
+     */
+    static getIdOf(entityOrData: AnyObject): any;
+    /**
+     * Get the identity value. If the identity is a composite key, returns
+     * an object.
+     */
+    getId(): any;
+    /**
+     * Get the identity as an object, such as `{id: 1}` or
+     * `{schoolId: 1, studentId: 2}`
+     */
+    getIdObject(): Object;
+    /**
+     * Build the where object for the given id
+     * @param id - The id value
+     */
+    static buildWhereForId(id: any): any;
+}
+/**
+ * Domain events
+ */
+export declare class Event {
+    source: any;
+    type: string;
+}
+export declare type EntityData = DataObject<Entity>;
+export declare type EntityResolver<T extends Entity> = TypeResolver<T, typeof Entity>;
+/**
+ * Check model data for navigational properties linking to related models.
+ * Throw a descriptive error if any such property is found.
+ *
+ * @param modelClass Model constructor, e.g. `Product`.
+ * @param entityData  Model instance or a plain-data object,
+ * e.g. `{name: 'pen'}`.
+ */
+export declare function rejectNavigationalPropertiesInData<M extends typeof Entity>(modelClass: M, data: DataObject<PrototypeOf<M>>): void;