functional-models 3.6.3 → 3.7.0

package/README.md

@@ -650,25 +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/properties.d.ts

@@ -25,23 +25,29 @@ declare const LastModifiedDateProperty: (config?: PropertyConfig<DateValueType>)
     }>>;
 }>;
 /**
- * A property that represents a foreign key to another model.
+ * 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
  */
-type ForeignKeyPropertyConfig<TValue extends string | number> = PropertyConfig<TValue> & Readonly<{
+type DatabaseKeyPropertyConfig<TValue extends string | number> = PropertyConfig<TValue> & Readonly<{
     /**
      * Sets the type of the foreign key.
      * @default 'uuid'
      */
     dataType?: 'uuid' | 'string' | 'integer';
+    /**
+     * If true, the key will be automatically generated if not provided. Only applies to uuids.
+     * @default true
+     */
+    auto?: boolean;
 }>;
 /**
  * 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<{
+declare const ForeignKeyProperty: <TValue extends string | number, TModel extends DataDescription>(model: MaybeFunction<ModelType<TModel>>, config?: DatabaseKeyPropertyConfig<TValue>) => (Readonly<{
     getConfig: () => object;
     getChoices: () => readonly import("../types").ChoiceTypes[];
     getDefaultValue: () => string | undefined;
@@ -83,9 +89,48 @@ declare const ForeignKeyProperty: <TValue extends string | number, TModel extend
     getReferencedId: (instanceValues: TValue) => TValue;
     getReferencedModel: () => ModelType<TModel>;
 };
+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: () => import("../types").PropertyType | string;
+    createGetter: (value: string, modelData: Readonly<{
+        [s: string]: any;
+    }>, modelInstance: import("../types").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: () => import("../types").PropertyType | string;
+    createGetter: (value: number, modelData: Readonly<{
+        [s: string]: any;
+    }>, modelInstance: import("../types").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 { ormPropertyConfig, LastModifiedDateProperty, ForeignKeyProperty, PrimaryKeyProperty, };

package/orm/properties.js

@@ -3,7 +3,7 @@ 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.PrimaryKeyProperty = exports.ForeignKeyProperty = exports.LastModifiedDateProperty = exports.ormPropertyConfig = void 0;
 const merge_1 = __importDefault(require("lodash/merge"));
 const identity_1 = __importDefault(require("lodash/identity"));
 const properties_1 = require("../properties");
@@ -23,6 +23,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 = {}) => {
@@ -52,6 +53,22 @@ const ForeignKeyProperty = (model, config = {}) => {
     });
 };
 exports.ForeignKeyProperty = ForeignKeyProperty;
+const PrimaryKeyProperty = (config = {}) => {
+    const _getProperty = () => {
+        const auto = config.auto === undefined ? true : config.auto ? true : false;
+        if (config.dataType === 'uuid') {
+            return (0, properties_1.UuidProperty)((0, merge_1.default)(config, {
+                autoNow: auto,
+            }));
+        }
+        if (config.dataType === 'integer') {
+            return (0, properties_1.IntegerProperty)(config);
+        }
+        return (0, properties_1.TextProperty)(config);
+    };
+    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;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;AAqGC,4DAAwB;AA/E1B;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG,CAIzB,KAAuC,EACvC,SAA4C,EAAE,EAC9C,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,MAA2C,EAAE;gBACjD,OAAO,EAAE,KAAK;aACf,CAAC,CACH,CAAA;QACH,CAAC;QACD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,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;AAwCC,gDAAkB;AAtCpB,MAAM,kBAAkB,GAAG,CACzB,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,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC/B,OAAO,IAAA,yBAAY,EACjB,IAAA,eAAK,EAAC,MAA2C,EAAE;gBACjD,OAAO,EAAE,IAAI;aACd,CAAC,CACH,CAAA;QACH,CAAC;QACD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,IAAA,4BAAe,EAAC,MAA2C,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,IAAA,yBAAY,EAAC,MAA2C,CAAC,CAAA;IAClE,CAAC,CAAA;IACD,OAAO,YAAY,EAAE,CAAA;AACvB,CAAC,CAAA;AAqBC,gDAAkB;AAnBpB;;;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;AAGC,8CAAiB"}

package/package.json

@@ -1,24 +1,24 @@
 {
   "name": "functional-models",
-  "version": "3.6.3",
+  "version": "3.7.0",
   "description": "Functional models is ooey gooey framework for building and using awesome models EVERYWHERE.",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "build": "rm -Rf ./dist && tsc && cp package.json ./dist && cp README.md ./dist",
-    "build:docs": "npx typedoc --out ./buildDocs ./src/index.ts",
-    "build:watch": "nodemon -e '*' --watch ./src --exec npm run build",
+    "mocha": "mocha -r tsx",
+    "test": "mocha -r tsx --extensions ts,tsx 'test/**/*.{ts,tsx}'",
+    "test:coverage": "c8 --all --reporter cobertura --reporter text --reporter lcov --reporter html npm run test",
+    "test:watch": "nodemon -e '*' --watch test --watch src --exec npm run test:coverage",
     "commit": "cz",
-    "coverage": "nyc --all --reporter=lcov npm test",
-    "dist": "npm run build && npm run build:docs && cd dist && npm publish && cd ../knowledge-mcp && npm run dist",
-    "eslint": "eslint . --fix",
     "feature-tests": "./node_modules/.bin/cucumber-js -p default",
-    "mocha": "mocha -r tsx",
+    "coverage": "nyc --all --reporter=lcov npm test",
+    "build": "rm -Rf ./dist && tsc && cp package.json ./dist && cp README.md ./dist",
+    "build:watch": "nodemon -e '*' --watch ./src --exec npm run build",
+    "build:docs": "npx typedoc --out ./buildDocs ./src/index.ts",
     "prettier": "prettier --write .",
     "prettier:check": "prettier -c .",
-    "test": "mocha -r tsx --extensions ts,tsx 'test/**/*.{ts,tsx}'",
-    "test:coverage": "c8 --all --reporter cobertura --reporter text --reporter lcov --reporter html npm run test",
-    "test:watch": "nodemon -e '*' --watch test --watch src --exec npm run test:coverage"
+    "eslint": "eslint . --fix",
+    "dist": "npm run build && cd dist && npm publish"
   },
   "repository": {
     "type": "git",

package/types.d.ts

@@ -29,7 +29,7 @@ type JsonObj = Readonly<{
 /**
  * A description of valid json values.
  */
-type JsonAble = Arrayable<JsonObj> | readonly (number | string | boolean)[] | readonly JsonAble[] | number | string | boolean | null | undefined;
+type JsonAble = Arrayable<JsonObj> | readonly (number | string | boolean)[] | number | string | boolean | null | undefined;
 /**
  * This is a fully Json compliant version of a DataDescription
  */

package/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAqmBA;;GAEG;AACH,IAAK,SAMJ;AAND,WAAK,SAAS;IACZ,8BAAiB,CAAA;IACjB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;AACnB,CAAC,EANI,SAAS,yBAAT,SAAS,QAMb;AAoTD;;;GAGG;AACH,IAAK,YAaJ;AAbD,WAAK,YAAY;IACf,qCAAqB,CAAA;IACrB,6BAAa,CAAA;IACb,qCAAqB,CAAA;IACrB,+BAAe,CAAA;IACf,iDAAiC,CAAA;IACjC,mCAAmB,CAAA;IACnB,6BAAa,CAAA;IACb,mCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,mCAAmB,CAAA;AACrB,CAAC,EAbI,YAAY,4BAAZ,YAAY,QAahB;AAED;;GAEG;AACH,IAAK,kBAMJ;AAND,WAAK,kBAAkB;IACrB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;AACrB,CAAC,EANI,kBAAkB,kCAAlB,kBAAkB,QAMtB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAmmBA;;GAEG;AACH,IAAK,SAMJ;AAND,WAAK,SAAS;IACZ,8BAAiB,CAAA;IACjB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;AACnB,CAAC,EANI,SAAS,yBAAT,SAAS,QAMb;AAoTD;;;GAGG;AACH,IAAK,YAaJ;AAbD,WAAK,YAAY;IACf,qCAAqB,CAAA;IACrB,6BAAa,CAAA;IACb,qCAAqB,CAAA;IACrB,+BAAe,CAAA;IACf,iDAAiC,CAAA;IACjC,mCAAmB,CAAA;IACnB,6BAAa,CAAA;IACb,mCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,mCAAmB,CAAA;AACrB,CAAC,EAbI,YAAY,4BAAZ,YAAY,QAahB;AAED;;GAEG;AACH,IAAK,kBAMJ;AAND,WAAK,kBAAkB;IACrB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;AACrB,CAAC,EANI,kBAAkB,kCAAlB,kBAAkB,QAMtB"}