@goatlab/fluent 0.7.38 → 0.7.40

package/dist/core/Loopback/json-to-schema.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonToSchemaObject = jsonToSchemaObject;
+exports.jsonOrBooleanToJSON = jsonOrBooleanToJSON;
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+const mapValues_1 = require("./mapValues");
+const oas30_1 = require("openapi3-ts/oas30");
+/**
+ * Converts JSON Schemas into a SchemaObject
+ * @param json - JSON Schema to convert from
+ * @param visited - A map to keep track of mapped json schemas to handle
+ * circular references
+ */
+function jsonToSchemaObject(json, visited = new Map()) {
+    // A flag to check if a schema object is fully converted
+    const converted = 'x-loopback-converted';
+    const schema = visited.get(json);
+    if (schema != null && (0, oas30_1.isSchemaObject)(schema) && schema[converted] === false) {
+        return { $ref: `#/components/schemas/${json.title}` };
+    }
+    if (schema != null)
+        return schema;
+    const result = {
+        [converted]: false
+    };
+    visited.set(json, result);
+    const propsToIgnore = ['additionalItems', 'defaultProperties', 'typeof'];
+    for (const property in json) {
+        if (propsToIgnore.includes(property)) {
+            continue;
+        }
+        switch (property) {
+            case 'type': {
+                if (json.type === 'array' && !json.items) {
+                    throw new Error('"items" property must be present if "type" is an array');
+                }
+                result.type = Array.isArray(json.type) ? json.type[0] : json.type;
+                break;
+            }
+            case 'allOf': {
+                result.allOf = json.allOf?.map(item => (0, oas30_1.isSchemaObject)(item) ? jsonToSchemaObject(item, visited) : item);
+                break;
+            }
+            case 'anyOf': {
+                result.anyOf = json.anyOf?.map(item => (0, oas30_1.isSchemaObject)(item) ? jsonToSchemaObject(item, visited) : item);
+                break;
+            }
+            case 'oneOf': {
+                result.oneOf = json.oneOf?.map(item => (0, oas30_1.isSchemaObject)(item) ? jsonToSchemaObject(item, visited) : item);
+                break;
+            }
+            case 'definitions': {
+                result.definitions = (0, mapValues_1.default)(json.definitions, def => jsonToSchemaObject(jsonOrBooleanToJSON(def), visited));
+                break;
+            }
+            case 'properties': {
+                result.properties = (0, mapValues_1.default)(json.properties, item => jsonToSchemaObject(jsonOrBooleanToJSON(item), visited));
+                break;
+            }
+            case 'additionalProperties': {
+                if (typeof json.additionalProperties === 'boolean') {
+                    result.additionalProperties = json.additionalProperties;
+                }
+                else {
+                    result.additionalProperties = jsonToSchemaObject(json.additionalProperties, visited);
+                }
+                break;
+            }
+            case 'items': {
+                const items = Array.isArray(json.items) ? json.items[0] : json.items;
+                result.items = jsonToSchemaObject(jsonOrBooleanToJSON(items), visited);
+                break;
+            }
+            case '$ref': {
+                result.$ref = json.$ref.replace('#/definitions', '#/components/schemas');
+                break;
+            }
+            case 'examples': {
+                if (Array.isArray(json.examples)) {
+                    result.example = json.examples[0];
+                }
+                break;
+            }
+            default: {
+                result[property] = json[property];
+                break;
+            }
+        }
+    }
+    delete result[converted];
+    // Check if the description contains information about TypeScript type
+    const matched = result.description?.match(/^\(tsType: (.+), schemaOptions:/);
+    if (matched) {
+        result['x-typescript-type'] = matched[1];
+    }
+    return result;
+}
+/**
+ * Helper function used to interpret boolean values as JSON Schemas.
+ * See http://json-schema.org/draft-06/json-schema-release-notes.html
+ * @param jsonOrBool - converts boolean values into their representative JSON Schemas
+ * @returns A JSON Schema document representing the input value.
+ */
+function jsonOrBooleanToJSON(jsonOrBool) {
+    if (typeof jsonOrBool === 'object') {
+        return jsonOrBool;
+    }
+    return jsonOrBool ? {} : { not: {} };
+}
+//# sourceMappingURL=json-to-schema.js.map

package/dist/core/Loopback/json-to-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-to-schema.js","sourceRoot":"","sources":["../../../src/core/Loopback/json-to-schema.ts"],"names":[],"mappings":";;AAwCA,gDAwGC;AAQD,kDAKC;AA7JD,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;AAChE,2CAAmC;AACnC,6CAK0B;AAwB1B;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,IAAkB,EAClB,UAAuD,IAAI,GAAG,EAAE;IAEhE,wDAAwD;IACxD,MAAM,SAAS,GAAG,sBAAsB,CAAA;IACxC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAChC,IAAI,MAAM,IAAI,IAAI,IAAI,IAAA,sBAAc,EAAC,MAAM,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE,CAAC;QAC5E,OAAO,EAAE,IAAI,EAAE,wBAAwB,IAAI,CAAC,KAAK,EAAE,EAAE,CAAA;IACvD,CAAC;IACD,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,MAAM,CAAA;IAEjC,MAAM,MAAM,GAAiB;QAC3B,CAAC,SAAS,CAAC,EAAE,KAAK;KACnB,CAAA;IACD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACzB,MAAM,aAAa,GAAG,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAA;IACxE,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,SAAQ;QACV,CAAC;QACD,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;oBACzC,MAAM,IAAI,KAAK,CACb,wDAAwD,CACzD,CAAA;gBACH,CAAC;gBACD,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAA;gBACjE,MAAK;YACP,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CACpC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAChE,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CACpC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAChE,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CACpC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAChE,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,MAAM,CAAC,WAAW,GAAG,IAAA,mBAAS,EAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,CACrD,kBAAkB,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CACtD,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,MAAM,CAAC,UAAU,GAAG,IAAA,mBAAS,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CACpD,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CACvD,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,sBAAsB,CAAC,CAAC,CAAC;gBAC5B,IAAI,OAAO,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;oBACnD,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAA;gBACzD,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,oBAAoB,GAAG,kBAAkB,CAC9C,IAAI,CAAC,oBAAoC,EACzC,OAAO,CACR,CAAA;gBACH,CAAC;gBACD,MAAK;YACP,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;gBACpE,MAAM,CAAC,KAAK,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,KAAM,CAAC,EAAE,OAAO,CAAC,CAAA;gBACvE,MAAK;YACP,CAAC;YACD,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAK,CAAC,OAAO,CAC9B,eAAe,EACf,sBAAsB,CACvB,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACjC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBACnC,CAAC;gBACD,MAAK;YACP,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAA8B,CAAC,CAAA;gBACvD,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAA;IACxB,sEAAsE;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAA;IAC5E,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAC1C,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,UAAkC;IACpE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,UAAU,CAAA;IACnB,CAAC;IACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAA;AACtC,CAAC"}

package/dist/core/Loopback/metadata.d.ts

@@ -0,0 +1,16 @@
+import { InspectionOptions, MetadataAccessor, MetadataMap } from '@loopback/metadata';
+import { ModelDefinition, ModelDefinitionSyntax, PropertyDefinition } from './model';
+export declare const MODEL_KEY: MetadataAccessor<Partial<ModelDefinitionSyntax>, ClassDecorator>;
+export declare const MODEL_PROPERTIES_KEY: MetadataAccessor<PropertyDefinition, PropertyDecorator>;
+export declare const MODEL_WITH_PROPERTIES_KEY: MetadataAccessor<ModelDefinition, ClassDecorator>;
+export type PropertyMap = MetadataMap<Partial<PropertyDefinition>>;
+export declare class ModelMetadataHelper {
+    /**
+     * A utility function to simplify retrieving metadata from a target model and
+     * its properties.
+     * @param target - The class from which to retrieve metadata.
+     * @param options - An options object for the MetadataInspector to customize
+     * the output of the metadata retrieval functions.
+     */
+    static getModelMetadata(target: Function, options?: InspectionOptions): ModelDefinition | {};
+}

package/dist/core/Loopback/metadata.js

@@ -0,0 +1,49 @@
+"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.ModelMetadataHelper = exports.MODEL_WITH_PROPERTIES_KEY = exports.MODEL_PROPERTIES_KEY = exports.MODEL_KEY = void 0;
+const metadata_1 = require("@loopback/metadata");
+const model_1 = require("./model");
+const RELATIONS_KEY = 'loopback:relations';
+exports.MODEL_KEY = metadata_1.MetadataAccessor.create('loopback:model');
+exports.MODEL_PROPERTIES_KEY = metadata_1.MetadataAccessor.create('loopback:model-properties');
+exports.MODEL_WITH_PROPERTIES_KEY = metadata_1.MetadataAccessor.create('loopback:model-and-properties');
+class ModelMetadataHelper {
+    /**
+     * A utility function to simplify retrieving metadata from a target model and
+     * its properties.
+     * @param target - The class from which to retrieve metadata.
+     * @param options - An options object for the MetadataInspector to customize
+     * the output of the metadata retrieval functions.
+     */
+    static getModelMetadata(target, options) {
+        const classDef = metadata_1.MetadataInspector.getClassMetadata(exports.MODEL_WITH_PROPERTIES_KEY, target, 
+        // https://github.com/loopbackio/loopback-next/issues/4721
+        // The `target` can be a subclass for a base model
+        { ...options, ownMetadataOnly: true });
+        // Return the cached value, if it exists.
+        // XXX(kjdelisle): If we're going to support dynamic updates, then this
+        // will be problematic in the future, since it will never update.
+        if (classDef) {
+            return classDef;
+        }
+        const modelMeta = metadata_1.MetadataInspector.getClassMetadata(exports.MODEL_KEY, target, options);
+        if (!modelMeta) {
+            return {};
+        }
+        // sets the metadata to a dedicated key if cached value does not exist
+        // set ModelDefinition properties if they don't already exist
+        const meta = new model_1.ModelDefinition({ ...modelMeta });
+        // set properties lost from creating instance of ModelDefinition
+        Object.assign(meta, modelMeta);
+        meta.properties = Object.assign(meta.properties, metadata_1.MetadataInspector.getAllPropertyMetadata(exports.MODEL_PROPERTIES_KEY, target.prototype, options));
+        meta.relations = Object.assign(meta.relations, metadata_1.MetadataInspector.getAllPropertyMetadata(RELATIONS_KEY, target.prototype, options));
+        metadata_1.MetadataInspector.defineMetadata(exports.MODEL_WITH_PROPERTIES_KEY.key, meta, target);
+        return meta;
+    }
+}
+exports.ModelMetadataHelper = ModelMetadataHelper;
+//# sourceMappingURL=metadata.js.map

package/dist/core/Loopback/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/core/Loopback/metadata.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,iDAK2B;AAC3B,mCAKgB;AAEhB,MAAM,aAAa,GAAG,oBAAoB,CAAA;AAE7B,QAAA,SAAS,GAAG,2BAAgB,CAAC,MAAM,CAG9C,gBAAgB,CAAC,CAAA;AAEN,QAAA,oBAAoB,GAAG,2BAAgB,CAAC,MAAM,CAGzD,2BAA2B,CAAC,CAAA;AAEjB,QAAA,yBAAyB,GAAG,2BAAgB,CAAC,MAAM,CAG9D,+BAA+B,CAAC,CAAA;AAIlC,MAAa,mBAAmB;IAC9B;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CACrB,MAAgB,EAChB,OAA2B;QAE3B,MAAM,QAAQ,GAAG,4BAAiB,CAAC,gBAAgB,CACjD,iCAAyB,EACzB,MAAM;QACN,0DAA0D;QAC1D,kDAAkD;QAClD,EAAE,GAAG,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CACtC,CAAA;QACD,yCAAyC;QACzC,uEAAuE;QACvE,iEAAiE;QACjE,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,CAAA;QACjB,CAAC;QACD,MAAM,SAAS,GAAG,4BAAiB,CAAC,gBAAgB,CAClD,iBAAS,EACT,MAAM,EACN,OAAO,CACR,CAAA;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,EAAE,CAAA;QACX,CAAC;QACD,sEAAsE;QAEtE,6DAA6D;QAC7D,MAAM,IAAI,GAAG,IAAI,uBAAe,CAAC,EAAE,GAAG,SAAS,EAAE,CAAC,CAAA;QAElD,gEAAgE;QAChE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAE9B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAChB,IAAI,CAAC,UAAU,EAC5B,4BAAiB,CAAC,sBAAsB,CACtC,4BAAoB,EACpB,MAAM,CAAC,SAAS,EAChB,OAAO,CACR,CACF,CAAA;QAED,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CACL,IAAI,CAAC,SAAS,EACrC,4BAAiB,CAAC,sBAAsB,CACtC,aAAa,EACb,MAAM,CAAC,SAAS,EAChB,OAAO,CACR,CACF,CAAA;QAED,4BAAiB,CAAC,cAAc,CAC9B,iCAAyB,CAAC,GAAG,EAC7B,IAAI,EACJ,MAAM,CACP,CAAA;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAlED,kDAkEC"}

package/dist/core/Loopback/model.d.ts

@@ -0,0 +1,233 @@
+import { SchemaObject as JsonSchema } from 'openapi3-ts/oas30';
+import { AnyObject, DataObject, Options, PrototypeOf } from './common-types';
+import { BelongsToDefinition, HasManyDefinition, HasOneDefinition, RelationMetadata } from './relation.types';
+import { TypeResolver } from './type-resolver';
+import { Type } from './type';
+/**
+ * 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 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 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 type EntityData = DataObject<Entity>;
+export 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;