functional-models 3.6.4 → 3.8.0

package/README.md

@@ -650,24 +650,3 @@ In this situation, the latinName for species is not passed in, but calculated fr
 A date property that automatically updates whenever the model instance is saved.
 
 [Documentation](https://monolithst.github.io/functional-models/functions/index.orm.properties.LastModifiedDateProperty.html)
-
-# MCP Development Server
-
-Functional Models has an MCP server for AI based development. It provides knowledge entries for the AI to have specific examples of how to work with and manipulate models in a system. This GREATLY increases the accuracy and understanding of AI working with these systems, making it really easy to add new features, refactor, and make the best use of features.
-
-## Quick Start
-
-You can setup the server by setting up Cursor (or similar) with this configuration.
-
-```json
-{
-  "mcpServers": {
-    "node-in-layers-core": {
-      "command": "npx",
-      "args": ["-y", "@functional-models/knowledge-mcp"]
-    }
-  }
-}
-```
-
-You can learn more about this here [Knowledge MCP](./knowledge-mcp/README.md)

package/orm/internal-libs.d.ts

@@ -0,0 +1,2 @@
+import { DatabaseKeyPropertyConfig, PrimaryKeyGenerator } from './types.js';
+export declare const getPrimaryKeyGenerator: <TValue extends string | number>(config?: DatabaseKeyPropertyConfig<TValue>) => PrimaryKeyGenerator;

package/orm/internal-libs.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrimaryKeyGenerator = void 0;
+const types_js_1 = require("../types.js");
+const utils_js_1 = require("../utils.js");
+const _getModelIdPropertyType = (config = {}) => {
+    return config.dataType || types_js_1.PropertyType.UniqueId;
+};
+const getPrimaryKeyGenerator = (config = {}) => {
+    const custom = config.primaryKeyGenerator;
+    if (custom) {
+        return custom;
+    }
+    const idType = _getModelIdPropertyType(config);
+    switch (idType) {
+        case types_js_1.PropertyType.Integer:
+            return () => Promise.resolve((0, utils_js_1.getRandomValues)()[0]);
+        default: {
+            return () => Promise.resolve((0, utils_js_1.createUuid)());
+        }
+    }
+};
+exports.getPrimaryKeyGenerator = getPrimaryKeyGenerator;
+//# sourceMappingURL=internal-libs.js.map

package/orm/internal-libs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal-libs.js","sourceRoot":"","sources":["../../src/orm/internal-libs.ts"],"names":[],"mappings":";;;AAAA,0CAA0C;AAC1C,0CAAyD;AAOzD,MAAM,uBAAuB,GAAG,CAC9B,SAAyC,EAAE,EACnB,EAAE;IAC1B,OAAO,MAAM,CAAC,QAAQ,IAAI,uBAAY,CAAC,QAAQ,CAAA;AACjD,CAAC,CAAA;AAEM,MAAM,sBAAsB,GAAG,CACpC,SAA4C,EAAE,EACzB,EAAE;IACvB,MAAM,MAAM,GAAG,MAAM,CAAC,mBAAmB,CAAA;IACzC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAA;IAC9C,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,uBAAY,CAAC,OAAO;YACvB,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,0BAAe,GAAE,CAAC,CAAC,CAAE,CAAC,CAAA;QACrD,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,qBAAU,GAAE,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAfY,QAAA,sBAAsB,0BAelC"}

package/orm/properties.d.ts

@@ -1,18 +1,18 @@
-import { DateValueType, PropertyConfig, Arrayable, DataValue, MaybeFunction, ModelType, DataDescription } from '../types';
-import { OrmPropertyConfig } from './types';
+import { DateValueType, PropertyConfig, Arrayable, DataValue, MaybeFunction, ModelType, DataDescription, ModelInstance, PropertyType } from '../types';
+import { OrmPropertyConfig, DatabaseKeyPropertyConfig } from './types';
 /**
  * A property that automatically updates whenever the model instance is saved.
  * @param config
  */
-declare const LastModifiedDateProperty: (config?: PropertyConfig<DateValueType>) => Readonly<{
+export declare const LastModifiedDateProperty: (config?: PropertyConfig<DateValueType>) => Readonly<{
     getConfig: () => object;
     getChoices: () => readonly import("../types").ChoiceTypes[];
     getDefaultValue: () => DateValueType | undefined;
     getConstantValue: () => DateValueType | undefined;
-    getPropertyType: () => import("../types").PropertyType | string;
+    getPropertyType: () => PropertyType | string;
     createGetter: (value: DateValueType, modelData: Readonly<{
         [s: string]: any;
-    }>, modelInstance: import("../types").ModelInstance<Readonly<{
+    }>, modelInstance: ModelInstance<Readonly<{
         [s: string]: any;
     }>, object, object>) => import("../types").ValueGetter<DateValueType, Readonly<{
         [s: string]: any;
@@ -24,32 +24,21 @@ declare const LastModifiedDateProperty: (config?: PropertyConfig<DateValueType>)
         [s: string]: any;
     }>>;
 }>;
-/**
- * A property that represents a foreign key to another model.
- * By default it is a "uuid" type, but if you want to use an arbitrary string, or an integer type you can set the `dataType` property.
- * @interface
- */
-type ForeignKeyPropertyConfig<TValue extends string | number> = PropertyConfig<TValue> & Readonly<{
-    /**
-     * Sets the type of the foreign key.
-     * @default 'uuid'
-     */
-    dataType?: 'uuid' | 'string' | 'integer';
-}>;
 /**
  * A property that represents a foreign key to another model in a database.
  * By default it is a "uuid" type, but if you want to use an arbitrary string, or an integer type you can set the `dataType` property.
+ * NOTE: auto is ignored in config.
  * @param config - Additional configurations.
  */
-declare const ForeignKeyProperty: <TValue extends string | number, TModel extends DataDescription>(model: MaybeFunction<ModelType<TModel>>, config?: ForeignKeyPropertyConfig<TValue>) => (Readonly<{
+export declare const ForeignKeyProperty: <TValue extends string | number, TModel extends DataDescription>(model: MaybeFunction<ModelType<TModel>>, config?: Omit<DatabaseKeyPropertyConfig<TValue>, "auto" | "primaryKeyGenerator">) => (Readonly<{
     getConfig: () => object;
     getChoices: () => readonly import("../types").ChoiceTypes[];
     getDefaultValue: () => string | undefined;
     getConstantValue: () => string | undefined;
-    getPropertyType: () => import("../types").PropertyType | string;
+    getPropertyType: () => PropertyType | string;
     createGetter: (value: string, modelData: Readonly<{
         [s: string]: any;
-    }>, modelInstance: import("../types").ModelInstance<Readonly<{
+    }>, modelInstance: ModelInstance<Readonly<{
         [s: string]: any;
     }>, object, object>) => import("../types").ValueGetter<string, Readonly<{
         [s: string]: any;
@@ -65,10 +54,10 @@ declare const ForeignKeyProperty: <TValue extends string | number, TModel extend
     getChoices: () => readonly import("../types").ChoiceTypes[];
     getDefaultValue: () => number | undefined;
     getConstantValue: () => number | undefined;
-    getPropertyType: () => import("../types").PropertyType | string;
+    getPropertyType: () => PropertyType | string;
     createGetter: (value: number, modelData: Readonly<{
         [s: string]: any;
-    }>, modelInstance: import("../types").ModelInstance<Readonly<{
+    }>, modelInstance: ModelInstance<Readonly<{
         [s: string]: any;
     }>, object, object>) => import("../types").ValueGetter<number, Readonly<{
         [s: string]: any;
@@ -83,9 +72,54 @@ declare const ForeignKeyProperty: <TValue extends string | number, TModel extend
     getReferencedId: (instanceValues: TValue) => TValue;
     getReferencedModel: () => ModelType<TModel>;
 };
+/**
+ * A property that represents a primary key in a database.
+ * By default it is a "uuid" type, but if you want to use an arbitrary string, or an integer type you can set the `dataType` property.
+ * Includes an optional primaryKeyGenerator function that can be used to generate a primary key. This can allow primary keys that are generated at runtime, or grabbed from a database.
+ * @param config - Additional configurations.
+ * @returns
+ */
+export declare const PrimaryKeyProperty: <TValue extends string | number>(config?: DatabaseKeyPropertyConfig<TValue>) => Readonly<{
+    getConfig: () => object;
+    getChoices: () => readonly import("../types").ChoiceTypes[];
+    getDefaultValue: () => string | undefined;
+    getConstantValue: () => string | undefined;
+    getPropertyType: () => PropertyType | string;
+    createGetter: (value: string, modelData: Readonly<{
+        [s: string]: any;
+    }>, modelInstance: ModelInstance<Readonly<{
+        [s: string]: any;
+    }>, object, object>) => import("../types").ValueGetter<string, Readonly<{
+        [s: string]: any;
+    }>, object, object>;
+    getZod: () => import("zod").ZodType<string, unknown, import("zod/v4/core").$ZodTypeInternals<string, unknown>>;
+    getValidator: (valueGetter: import("../types").ValueGetter<string, Readonly<{
+        [s: string]: any;
+    }>, object, object>) => import("../types").PropertyValidator<Readonly<{
+        [s: string]: any;
+    }>>;
+}> | Readonly<{
+    getConfig: () => object;
+    getChoices: () => readonly import("../types").ChoiceTypes[];
+    getDefaultValue: () => number | undefined;
+    getConstantValue: () => number | undefined;
+    getPropertyType: () => PropertyType | string;
+    createGetter: (value: number, modelData: Readonly<{
+        [s: string]: any;
+    }>, modelInstance: ModelInstance<Readonly<{
+        [s: string]: any;
+    }>, object, object>) => import("../types").ValueGetter<number, Readonly<{
+        [s: string]: any;
+    }>, object, object>;
+    getZod: () => import("zod").ZodType<number, unknown, import("zod/v4/core").$ZodTypeInternals<number, unknown>>;
+    getValidator: (valueGetter: import("../types").ValueGetter<number, Readonly<{
+        [s: string]: any;
+    }>, object, object>) => import("../types").PropertyValidator<Readonly<{
+        [s: string]: any;
+    }>>;
+}>;
 /**
  * Creates an orm based property config.
  * @param config - Additional configurations.
  */
-declare const ormPropertyConfig: <T extends Arrayable<DataValue>>(config?: OrmPropertyConfig<T>) => PropertyConfig<T>;
-export { ormPropertyConfig, LastModifiedDateProperty, ForeignKeyProperty };
+export declare const ormPropertyConfig: <T extends Arrayable<DataValue>>(config?: OrmPropertyConfig<T>) => PropertyConfig<T>;

package/orm/properties.js

@@ -3,11 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ForeignKeyProperty = exports.LastModifiedDateProperty = exports.ormPropertyConfig = void 0;
+exports.ormPropertyConfig = exports.PrimaryKeyProperty = exports.ForeignKeyProperty = exports.LastModifiedDateProperty = void 0;
 const merge_1 = __importDefault(require("lodash/merge"));
 const identity_1 = __importDefault(require("lodash/identity"));
+const types_1 = require("../types");
 const properties_1 = require("../properties");
 const validation_1 = require("./validation");
+const internal_libs_1 = require("./internal-libs");
 const _defaultPropertyConfig = {
     unique: undefined,
 };
@@ -23,6 +25,7 @@ exports.LastModifiedDateProperty = LastModifiedDateProperty;
 /**
  * A property that represents a foreign key to another model in a database.
  * By default it is a "uuid" type, but if you want to use an arbitrary string, or an integer type you can set the `dataType` property.
+ * NOTE: auto is ignored in config.
  * @param config - Additional configurations.
  */
 const ForeignKeyProperty = (model, config = {}) => {
@@ -33,12 +36,12 @@ const ForeignKeyProperty = (model, config = {}) => {
         return model;
     };
     const _getProperty = () => {
-        if (config.dataType === 'uuid') {
+        if (config.dataType === types_1.PropertyType.UniqueId) {
             return (0, properties_1.UuidProperty)((0, merge_1.default)(config, {
                 autoNow: false,
             }));
         }
-        if (config.dataType === 'integer') {
+        if (config.dataType === types_1.PropertyType.Integer) {
             return (0, properties_1.IntegerProperty)(config);
         }
         return (0, properties_1.TextProperty)(config);
@@ -52,6 +55,43 @@ const ForeignKeyProperty = (model, config = {}) => {
     });
 };
 exports.ForeignKeyProperty = ForeignKeyProperty;
+/**
+ * A property that represents a primary key in a database.
+ * By default it is a "uuid" type, but if you want to use an arbitrary string, or an integer type you can set the `dataType` property.
+ * Includes an optional primaryKeyGenerator function that can be used to generate a primary key. This can allow primary keys that are generated at runtime, or grabbed from a database.
+ * @param config - Additional configurations.
+ * @returns
+ */
+const PrimaryKeyProperty = (config = {}) => {
+    const _getProperty = () => {
+        const auto = config.auto === undefined ? true : config.auto ? true : false;
+        const lazyLoadMethod = (value, modelData, instance) => {
+            if (config.primaryKeyGenerator) {
+                return config.primaryKeyGenerator(value, modelData, instance);
+            }
+            if (auto) {
+                return (0, internal_libs_1.getPrimaryKeyGenerator)(config)(value, modelData, instance);
+            }
+            return value;
+        };
+        if (config.dataType === types_1.PropertyType.UniqueId) {
+            return (0, properties_1.UuidProperty)((0, merge_1.default)(config, {
+                autoNow: auto,
+                lazyLoadMethod,
+            }));
+        }
+        if (config.dataType === types_1.PropertyType.Integer) {
+            return (0, properties_1.IntegerProperty)((0, merge_1.default)(config, {
+                lazyLoadMethod,
+            }));
+        }
+        return (0, properties_1.TextProperty)((0, merge_1.default)(config, {
+            lazyLoadMethod,
+        }));
+    };
+    return _getProperty();
+};
+exports.PrimaryKeyProperty = PrimaryKeyProperty;
 /**
  * Creates an orm based property config.
  * @param config - Additional configurations.

package/orm/properties.js.map

@@ -1 +1 @@
-{"version":3,"file":"properties.js","sourceRoot":"","sources":["../../src/orm/properties.ts"],"names":[],"mappings":";;;;;;AAAA,yDAAgC;AAChC,+DAAsC;AAUtC,8CAKsB;AACtB,6CAAqC;AAGrC,MAAM,sBAAsB,GAAG;IAC7B,MAAM,EAAE,SAAS;CAClB,CAAA;AAED;;;GAGG;AACH,MAAM,wBAAwB,GAAG,CAC/B,SAAwC,EAAE,EAC1C,EAAE;IACF,MAAM,kBAAkB,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,EAAE,CAAA;IACzE,OAAO,IAAA,6BAAgB,EAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;AACrD,CAAC,CAAA;AAyE2B,4DAAwB;AAxDpD;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAIzB,KAAuC,EACvC,SAA2C,EAAE,EAC7C,EAAE;IACF,MAAM,SAAS,GAAG,GAAG,EAAE;QACrB,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAChC,OAAO,KAAK,EAAE,CAAA;QAChB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,GAAG,EAAE;QACxB,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC/B,OAAO,IAAA,yBAAY,EACjB,IAAA,eAAK,EAAC,MAA0C,EAAE;gBAChD,OAAO,EAAE,KAAK;aACf,CAAC,CACH,CAAA;QACH,CAAC;QACD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,IAAA,4BAAe,EAAC,MAA0C,CAAC,CAAA;QACpE,CAAC;QACD,OAAO,IAAA,yBAAY,EAAC,MAA0C,CAAC,CAAA;IACjE,CAAC,CAAA;IACD,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAA;IAC/B,OAAO,IAAA,eAAK,EAAC,QAAQ,EAAE;QACrB,eAAe,EAAE,CAAC,cAAsB,EAAE,EAAE;YAC1C,OAAO,cAAc,CAAA;QACvB,CAAC;QACD,kBAAkB,EAAE,SAAS;KAC9B,CAAC,CAAA;AACJ,CAAC,CAAA;AAiBqD,gDAAkB;AAfxE;;;GAGG;AACH,MAAM,iBAAiB,GAAG,CACxB,SAA+B,sBAAsB,EAClC,EAAE;IACrB,OAAO,IAAA,eAAK,EAAC,MAAM,EAAE;QACnB,UAAU,EAAE;YACV,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,mBAAM,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;SAC7C,CAAC,MAAM,CAAC,kBAAQ,CAAC;KACnB,CAAC,CAAA;AACJ,CAAC,CAAA;AAEQ,8CAAiB"}
+{"version":3,"file":"properties.js","sourceRoot":"","sources":["../../src/orm/properties.ts"],"names":[],"mappings":";;;;;;AAAA,yDAAgC;AAChC,+DAAsC;AACtC,oCAWiB;AACjB,8CAKsB;AACtB,6CAAqC;AAErC,mDAAwD;AAExD,MAAM,sBAAsB,GAAG;IAC7B,MAAM,EAAE,SAAS;CAClB,CAAA;AAED;;;GAGG;AACI,MAAM,wBAAwB,GAAG,CACtC,SAAwC,EAAE,EAC1C,EAAE;IACF,MAAM,kBAAkB,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,EAAE,CAAA;IACzE,OAAO,IAAA,6BAAgB,EAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;AACrD,CAAC,CAAA;AALY,QAAA,wBAAwB,4BAKpC;AAED;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAIhC,KAAuC,EACvC,SAGI,EAAE,EACN,EAAE;IACF,MAAM,SAAS,GAAG,GAAG,EAAE;QACrB,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAChC,OAAO,KAAK,EAAE,CAAA;QAChB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,GAAG,EAAE;QACxB,IAAI,MAAM,CAAC,QAAQ,KAAK,oBAAY,CAAC,QAAQ,EAAE,CAAC;YAC9C,OAAO,IAAA,yBAAY,EACjB,IAAA,eAAK,EAAC,MAA2C,EAAE;gBACjD,OAAO,EAAE,KAAK;aACf,CAAC,CACH,CAAA;QACH,CAAC;QACD,IAAI,MAAM,CAAC,QAAQ,KAAK,oBAAY,CAAC,OAAO,EAAE,CAAC;YAC7C,OAAO,IAAA,4BAAe,EAAC,MAA2C,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,IAAA,yBAAY,EAAC,MAA2C,CAAC,CAAA;IAClE,CAAC,CAAA;IACD,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAA;IAC/B,OAAO,IAAA,eAAK,EAAC,QAAQ,EAAE;QACrB,eAAe,EAAE,CAAC,cAAsB,EAAE,EAAE;YAC1C,OAAO,cAAc,CAAA;QACvB,CAAC;QACD,kBAAkB,EAAE,SAAS;KAC9B,CAAC,CAAA;AACJ,CAAC,CAAA;AArCY,QAAA,kBAAkB,sBAqC9B;AAED;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,SAA4C,EAAE,EAC9C,EAAE;IACF,MAAM,YAAY,GAAG,GAAG,EAAE;QACxB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;QAC1E,MAAM,cAAc,GAAG,CACrB,KAAa,EACb,SAA4B,EAC5B,QAA4B,EAC5B,EAAE;YACF,IAAI,MAAM,CAAC,mBAAmB,EAAE,CAAC;gBAC/B,OAAO,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;YAC/D,CAAC;YACD,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,IAAA,sCAAsB,EAAC,MAAM,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;YACnE,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED,IAAI,MAAM,CAAC,QAAQ,KAAK,oBAAY,CAAC,QAAQ,EAAE,CAAC;YAC9C,OAAO,IAAA,yBAAY,EACjB,IAAA,eAAK,EAAC,MAA2C,EAAE;gBACjD,OAAO,EAAE,IAAI;gBACb,cAAc;aACf,CAAC,CACH,CAAA;QACH,CAAC;QACD,IAAI,MAAM,CAAC,QAAQ,KAAK,oBAAY,CAAC,OAAO,EAAE,CAAC;YAC7C,OAAO,IAAA,4BAAe,EACpB,IAAA,eAAK,EAAC,MAA2C,EAAE;gBACjD,cAAc;aACf,CAAC,CACH,CAAA;QACH,CAAC;QACD,OAAO,IAAA,yBAAY,EACjB,IAAA,eAAK,EAAC,MAA2C,EAAE;YACjD,cAAc;SACf,CAAC,CACH,CAAA;IACH,CAAC,CAAA;IACD,OAAO,YAAY,EAAE,CAAA;AACvB,CAAC,CAAA;AAzCY,QAAA,kBAAkB,sBAyC9B;AAED;;;GAGG;AACI,MAAM,iBAAiB,GAAG,CAC/B,SAA+B,sBAAsB,EAClC,EAAE;IACrB,OAAO,IAAA,eAAK,EAAC,MAAM,EAAE;QACnB,UAAU,EAAE;YACV,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,mBAAM,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;SAC7C,CAAC,MAAM,CAAC,kBAAQ,CAAC;KACnB,CAAC,CAAA;AACJ,CAAC,CAAA;AATY,QAAA,iBAAiB,qBAS7B"}

package/orm/types.d.ts

@@ -1,8 +1,8 @@
-import { Arrayable, DataValue, Maybe, ModelInstance, ModelType, DataDescription, PrimaryKeyType, MinimalModelDefinition, PropertyConfig, ValidatorContext, ToObjectResult, ModelInstanceFetcher, ModelFactoryOptions } from '../types';
+import { Arrayable, DataValue, Maybe, ModelInstance, ModelType, DataDescription, PrimaryKeyType, MinimalModelDefinition, PropertyConfig, ValidatorContext, ToObjectResult, ModelInstanceFetcher, ModelFactoryOptions, CreateParams, PropertyType } from '../types';
 /**
  * Equals symbols for doing database matching
  */
-declare enum EqualitySymbol {
+export declare enum EqualitySymbol {
     eq = "=",
     lt = "<",
     lte = "<=",
@@ -13,7 +13,7 @@ declare enum EqualitySymbol {
 /**
  * The value types that map to database types.
  */
-declare enum DatastoreValueType {
+export declare enum DatastoreValueType {
     string = "string",
     number = "number",
     date = "date",
@@ -23,7 +23,7 @@ declare enum DatastoreValueType {
 /**
  * A list of allowable equality symbols.
  */
-declare const AllowableEqualitySymbols: EqualitySymbol[];
+export declare const AllowableEqualitySymbols: EqualitySymbol[];
 /**
  * A function that can save.
  */
@@ -39,16 +39,16 @@ type DeleteMethod<TModelExtensions extends object = object, TModelInstanceExtens
 /**
  * A function that allows overriding the save functionality for a specific model.
  */
-type SaveOverride<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = <TData extends DataDescription>(existingSave: SaveMethod<TModelExtensions, TModelInstanceExtensions>, instance: ModelInstance<TData, TModelExtensions, TModelInstanceExtensions>) => Promise<OrmModelInstance<TData, TModelExtensions, TModelInstanceExtensions>>;
+export type SaveOverride<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = <TData extends DataDescription>(existingSave: SaveMethod<TModelExtensions, TModelInstanceExtensions>, instance: ModelInstance<TData, TModelExtensions, TModelInstanceExtensions>) => Promise<OrmModelInstance<TData, TModelExtensions, TModelInstanceExtensions>>;
 /**
  * A function that allows overriding the delete functionality for a specific model.
  */
-type DeleteOverride<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = <TData extends DataDescription>(existingDelete: DeleteMethod<TModelExtensions, TModelInstanceExtensions>, instance: ModelInstance<TData, TModelExtensions, TModelInstanceExtensions>) => Promise<void>;
+export type DeleteOverride<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = <TData extends DataDescription>(existingDelete: DeleteMethod<TModelExtensions, TModelInstanceExtensions>, instance: ModelInstance<TData, TModelExtensions, TModelInstanceExtensions>) => Promise<void>;
 /**
  * A result of an ORM search.
  * @interface
  */
-type OrmSearchResult<TData extends DataDescription, TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
+export type OrmSearchResult<TData extends DataDescription, TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
     /**
      * A list of instances
      */
@@ -62,7 +62,7 @@ type OrmSearchResult<TData extends DataDescription, TModelExtensions extends obj
  * ORM based ModelFactory extensions.
  * @interface
  */
-type OrmModelFactoryOptionsExtensions<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
+export type OrmModelFactoryOptionsExtensions<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
     /**
      * Optional: The save function to override.
      */
@@ -76,7 +76,7 @@ type OrmModelFactoryOptionsExtensions<TModelExtensions extends object = object,
  * Extensions to the Model type
  * @interface
  */
-type OrmModelExtensions<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
+export type OrmModelExtensions<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
     /**
      * Save the model
      * @param instance - The instance to save.
@@ -126,7 +126,7 @@ type OrmModelExtensions<TModelExtensions extends object = object, TModelInstance
  * Instance overrides that give it ORM functions.
  * @interface
  */
-type OrmModelInstanceExtensions<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
+export type OrmModelInstanceExtensions<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = Readonly<{
     /**
      * Save this model.
      */
@@ -153,12 +153,12 @@ type OrmModelConfigurations = Readonly<{
  * A minimum orm model definition
  * @interface
  */
-type MinimumOrmModelDefinition<TData extends DataDescription> = MinimalModelDefinition<TData> & OrmModelConfigurations;
+export type MinimumOrmModelDefinition<TData extends DataDescription> = MinimalModelDefinition<TData> & OrmModelConfigurations;
 /**
  * A model factory that produces ORM based models.
  *
  */
-type OrmModelFactory<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object, TModelOptionsExtensions extends object = object> = <TData extends DataDescription>(
+export type OrmModelFactory<TModelExtensions extends object = object, TModelInstanceExtensions extends object = object, TModelOptionsExtensions extends object = object> = <TData extends DataDescription>(
 /**
  * The model definition for the model
  */
@@ -171,7 +171,7 @@ options?: ModelFactoryOptions<TData, OrmModelFactoryOptionsExtensions<TModelExte
  * A search result from a datastore
  * @interface
  */
-type DatastoreSearchResult<T extends DataDescription> = Readonly<{
+export type DatastoreSearchResult<T extends DataDescription> = Readonly<{
     /**
      * An array of objects that represent the data from the datastore.
      */
@@ -185,17 +185,17 @@ type DatastoreSearchResult<T extends DataDescription> = Readonly<{
  * A model that has ORM functions attached.
  * @interface
  */
-type OrmModel<TData extends DataDescription, TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = ModelType<TData, OrmModelExtensions<TModelExtensions, TModelInstanceExtensions>, OrmModelInstanceExtensions<TModelExtensions, TModelInstanceExtensions>>;
+export type OrmModel<TData extends DataDescription, TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = ModelType<TData, OrmModelExtensions<TModelExtensions, TModelInstanceExtensions>, OrmModelInstanceExtensions<TModelExtensions, TModelInstanceExtensions>>;
 /**
  * A Model Instance with ORM functions attached.
  * @interface
  */
-type OrmModelInstance<TData extends DataDescription, TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = ModelInstance<TData, OrmModelExtensions<TModelExtensions, TModelInstanceExtensions>, OrmModelInstanceExtensions<TModelExtensions, TModelInstanceExtensions>>;
+export type OrmModelInstance<TData extends DataDescription, TModelExtensions extends object = object, TModelInstanceExtensions extends object = object> = ModelInstance<TData, OrmModelExtensions<TModelExtensions, TModelInstanceExtensions>, OrmModelInstanceExtensions<TModelExtensions, TModelInstanceExtensions>>;
 /**
  * An interface that describes a datastore. By implementing this interface, databases can be swapped.
  * @interface
  */
-type DatastoreAdapter = Readonly<{
+export type DatastoreAdapter = Readonly<{
     /**
      * Saving a model.
      * @param instance
@@ -246,7 +246,7 @@ type DatastoreAdapter = Readonly<{
  * A search that describes a property and its value.
  * @interface
  */
-type PropertyQuery = Readonly<{
+export type PropertyQuery = Readonly<{
     /**
      * Distinguishes this as a property  query.
      */
@@ -275,7 +275,7 @@ type PropertyQuery = Readonly<{
 /**
  * A property search for a string value.
  */
-type StringPropertyQuery = PropertyQuery & {
+export type StringPropertyQuery = PropertyQuery & {
     valueType: DatastoreValueType.string;
     equalitySymbol: EqualitySymbol.eq | EqualitySymbol.ne;
     options: PropertyOptions;
@@ -284,7 +284,7 @@ type StringPropertyQuery = PropertyQuery & {
  * A search that looks at dated objects after the given date.
  * @interface
  */
-type DatesAfterQuery = Readonly<{
+export type DatesAfterQuery = Readonly<{
     /**
      * Distinguishes this query
      */
@@ -315,7 +315,7 @@ type DatesAfterQuery = Readonly<{
  * A search query that looks at dates before the given date.
  * @interface
  */
-type DatesBeforeQuery = Readonly<{
+export type DatesBeforeQuery = Readonly<{
     /**
      * Distinguishes this query
      */
@@ -346,7 +346,7 @@ type DatesBeforeQuery = Readonly<{
  * Additional configurations for ORM based properties.
  * @interface
  */
-type OrmPropertyConfig<T extends Arrayable<DataValue>> = PropertyConfig<T> & Readonly<{
+export type OrmPropertyConfig<T extends Arrayable<DataValue>> = PropertyConfig<T> & Readonly<{
     /**
      * Validator: Checks to make sure that there is only one instance in a datastore that has this property's value.
      * NOTE: The value is a property KEY. Not true or false.
@@ -357,7 +357,7 @@ type OrmPropertyConfig<T extends Arrayable<DataValue>> = PropertyConfig<T> & Rea
  * Additional context that is provided for ORM based instance.
  * @interface
  */
-type OrmValidatorContext = Readonly<{
+export type OrmValidatorContext = Readonly<{
     /**
      * IMPORTANT: Sometimes you do not want to do any ORM based validation because of speed.
      * This disables any orm based validation, and only runs non-orm validation.
@@ -367,7 +367,7 @@ type OrmValidatorContext = Readonly<{
 /**
  * Options for a property query.
  */
-type PropertyOptions = {
+export type PropertyOptions = {
     /**
      * Is this a case sensitive search?
      */
@@ -398,7 +398,7 @@ type PropertyOptions = {
  * that can retrieve referenced models as needed. See {@see "functional-models.ModelReference"}
  * @interface
  */
-type Orm = {
+export type Orm = {
     /**
      * A model factory that can produce {@link OrmModel}
      */
@@ -411,19 +411,19 @@ type Orm = {
 /**
  * The sort order.
  */
-declare enum SortOrder {
+export declare enum SortOrder {
     asc = "asc",
     dsc = "dsc"
 }
 /**
  * The number of instances to receive back from a query.
  */
-type MaxMatchStatement = number;
+export type MaxMatchStatement = number;
 /**
  * Defines how a sort should happen. Which column and what order.
  * @interface
  */
-type SortStatement = {
+export type SortStatement = {
     /**
      * The property's key/name. Also could be a "column"
      */
@@ -436,12 +436,12 @@ type SortStatement = {
 /**
  * Pagination can be anything.
  */
-type PaginationQuery = any;
+export type PaginationQuery = any;
 /**
  * A query to a search function.
  * @interface
  */
-type OrmSearch = {
+export type OrmSearch = {
     /**
      * Optional: A number of max records to return.
      */
@@ -462,15 +462,15 @@ type OrmSearch = {
 /**
  * Statements that make up the meat of QueryTokens
  */
-type Query = PropertyQuery | DatesAfterQuery | DatesBeforeQuery | StringPropertyQuery;
+export type Query = PropertyQuery | DatesAfterQuery | DatesBeforeQuery | StringPropertyQuery;
 /**
  * A token type that links two queries together.
  */
-type BooleanQuery = 'AND' | 'OR';
+export type BooleanQuery = 'AND' | 'OR';
 /**
  * A generic structure of querys.
  */
-type QueryTokens = readonly QueryTokens[][] | readonly QueryTokens[] | BooleanQuery | Query;
+export type QueryTokens = readonly QueryTokens[][] | readonly QueryTokens[] | BooleanQuery | Query;
 /**
  * Builder functions that are not property related.
  * @interface
@@ -501,7 +501,7 @@ type NonQueryBuilder = Readonly<{
  * An in between or ending type to a builder creating a SearchQuery
  * @interface
  */
-type BuilderV2Link = NonQueryBuilder & Readonly<{
+export type BuilderV2Link = NonQueryBuilder & Readonly<{
     /**
      * Links together two or more {@link Query} or complex queries.
      */
@@ -515,17 +515,17 @@ type BuilderV2Link = NonQueryBuilder & Readonly<{
  * A function that can either take a builder or raw QueryTokens[] and create a sub-query.
  * @param builder - Can be either a BuilderV2 or a hand written Query
  **/
-type SubBuilderFunction = (builder: QueryBuilder) => Omit<OrmSearch, 'take' | 'sort' | 'page'> | (QueryBuilder | BuilderV2Link);
+export type SubBuilderFunction = (builder: QueryBuilder) => Omit<OrmSearch, 'take' | 'sort' | 'page'> | (QueryBuilder | BuilderV2Link);
 /**
  * A search builder is a structured way to create a complex query.
  * @interface
  */
-type QueryBuilder = InnerBuilderV2 & NonQueryBuilder;
+export type QueryBuilder = InnerBuilderV2 & NonQueryBuilder;
 /**
  * A builder for version 3.0 search queries.
  * @interface
  */
-type InnerBuilderV2 = {
+export type InnerBuilderV2 = {
     /**
      * Creates a query that has nested property queries.
      * @param subBuilderFunc - A function that can return a Builder
@@ -561,4 +561,36 @@ type InnerBuilderV2 = {
      */
     property: (key: string, value: any, options?: Partial<PropertyOptions>) => BuilderV2Link;
 };
-export { PropertyQuery, SortStatement, DatesAfterQuery, DatesBeforeQuery, PaginationQuery, MaxMatchStatement, OrmModel, OrmModelInstance, DatastoreAdapter, OrmModelFactory, SaveOverride, DeleteOverride, OrmPropertyConfig, DatastoreSearchResult, OrmValidatorContext, OrmSearchResult, EqualitySymbol, DatastoreValueType, AllowableEqualitySymbols, PropertyOptions, Orm, OrmModelExtensions, OrmModelInstanceExtensions, OrmModelFactoryOptionsExtensions, MinimumOrmModelDefinition, QueryBuilder, BuilderV2Link, SubBuilderFunction, OrmSearch, Query, BooleanQuery, QueryTokens, InnerBuilderV2, SortOrder, StringPropertyQuery, };
+/**
+ * The types of primary key properties.
+ */
+export type PrimaryKeyPropertyType = PropertyType.UniqueId | PropertyType.Text | PropertyType.Integer;
+/**
+ * A function that can generate a primary key for a model.
+ * @param model - The model to generate a primary key for.
+ * @returns A promise that resolves to the primary key.
+ */
+export type PrimaryKeyGenerator = <TValue extends string | number, TData extends DataDescription>(value: TValue, modelData: CreateParams<TData>, instance: ModelInstance<TData>) => Promise<PrimaryKeyType>;
+/**
+ * A property that represents a key in a database.
+ * By default it is a "uuid" type, but if you want to use an arbitrary string, or an integer type you can set the `dataType` property.
+ * @interface
+ */
+export type DatabaseKeyPropertyConfig<TValue extends string | number> = PropertyConfig<TValue> & Readonly<{
+    /**
+     * Sets the type of the key.
+     * @default PrimaryKeyDataType.Uuid
+     */
+    dataType?: PrimaryKeyPropertyType;
+    /**
+     * If true, the key will be automatically generated if not provided. Only applies to uuids and integers
+     * @default true
+     */
+    auto?: boolean;
+    /**
+     * Optional: A custom primary key generator function to use for models. If the property type is UniqueId (default) then this will produce random UUID. If the property type is a number, a random number will be generated.
+     * If using a SQL-like database that uses numbers, its HIGHLY recommended to get a number from the database itself.
+     */
+    primaryKeyGenerator?: PrimaryKeyGenerator;
+}>;
+export {};

package/orm/types.js

@@ -33,8 +33,7 @@ var DatastoreValueType;
 /**
  * A list of allowable equality symbols.
  */
-const AllowableEqualitySymbols = Object.values(EqualitySymbol);
-exports.AllowableEqualitySymbols = AllowableEqualitySymbols;
+exports.AllowableEqualitySymbols = Object.values(EqualitySymbol);
 /**
  * The sort order.
  */

package/orm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/orm/types.ts"],"names":[],"mappings":";;;AAgBA;;GAEG;AACH,IAAK,cAaJ;AAbD,WAAK,cAAc;IACjB,SAAS;IACT,0BAAQ,CAAA;IACR,YAAY;IACZ,0BAAQ,CAAA;IACR,wBAAwB;IACxB,4BAAU,CAAA;IACV,eAAe;IACf,0BAAQ,CAAA;IACR,2BAA2B;IAC3B,4BAAU,CAAA;IACV,eAAe;IACf,2BAAS,CAAA;AACX,CAAC,EAbI,cAAc,8BAAd,cAAc,QAalB;AAED;;GAEG;AACH,IAAK,kBAMJ;AAND,WAAK,kBAAkB;IACrB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;IACb,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;AACrB,CAAC,EANI,kBAAkB,kCAAlB,kBAAkB,QAMtB;AAED;;GAEG;AACH,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;AAixB5D,4DAAwB;AA1M1B;;GAEG;AACH,IAAK,SAGJ;AAHD,WAAK,SAAS;IACZ,wBAAW,CAAA;IACX,wBAAW,CAAA;AACb,CAAC,EAHI,SAAS,yBAAT,SAAS,QAGb"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/orm/types.ts"],"names":[],"mappings":";;;AAkBA;;GAEG;AACH,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB,SAAS;IACT,0BAAQ,CAAA;IACR,YAAY;IACZ,0BAAQ,CAAA;IACR,wBAAwB;IACxB,4BAAU,CAAA;IACV,eAAe;IACf,0BAAQ,CAAA;IACR,2BAA2B;IAC3B,4BAAU,CAAA;IACV,eAAe;IACf,2BAAS,CAAA;AACX,CAAC,EAbW,cAAc,8BAAd,cAAc,QAazB;AAED;;GAEG;AACH,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;IACb,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;AACrB,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AAED;;GAEG;AACU,QAAA,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;AAwkBrE;;GAEG;AACH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,wBAAW,CAAA;AACb,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}