@kitledger/core 0.0.7 → 0.0.9

package/dist/migrations/meta/_journal.json

@@ -1,27 +1,41 @@
 {
-	"version": "7",
-	"dialect": "postgresql",
-	"entries": [
-		{
-			"idx": 0,
-			"version": "7",
-			"when": 1756234194845,
-			"tag": "0000_damp_golden_guardian",
-			"breakpoints": true
-		},
-		{
-			"idx": 1,
-			"version": "7",
-			"when": 1759327531423,
-			"tag": "0001_purple_morph",
-			"breakpoints": true
-		},
-		{
-			"idx": 2,
-			"version": "7",
-			"when": 1759329362701,
-			"tag": "0002_fair_thundra",
-			"breakpoints": true
-		}
-	]
-}
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1756234194845,
+      "tag": "0000_damp_golden_guardian",
+      "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "7",
+      "when": 1759327531423,
+      "tag": "0001_purple_morph",
+      "breakpoints": true
+    },
+    {
+      "idx": 2,
+      "version": "7",
+      "when": 1759329362701,
+      "tag": "0002_fair_thundra",
+      "breakpoints": true
+    },
+    {
+      "idx": 3,
+      "version": "7",
+      "when": 1769959829280,
+      "tag": "0003_familiar_lila_cheney",
+      "breakpoints": true
+    },
+    {
+      "idx": 4,
+      "version": "7",
+      "when": 1769959850540,
+      "tag": "0004_magenta_hairball",
+      "breakpoints": true
+    }
+  ]
+}

package/dist/schema.d.ts

@@ -922,7 +922,7 @@ export declare const accounts: import("drizzle-orm/pg-core").PgTableWithColumns<
             name: "ledger_id";
             tableName: "accounts";
             dataType: "string";
-            columnType: "PgUUID";
+            columnType: "PgVarchar";
             data: string;
             driverParam: string;
             notNull: true;
@@ -930,11 +930,13 @@ export declare const accounts: import("drizzle-orm/pg-core").PgTableWithColumns<
             isPrimaryKey: false;
             isAutoincrement: false;
             hasRuntimeDefault: false;
-            enumValues: undefined;
+            enumValues: [string, ...string[]];
             baseColumn: never;
             identity: undefined;
             generated: undefined;
-        }, {}, {}>;
+        }, {}, {
+            length: 64;
+        }>;
         parent_id: import("drizzle-orm/pg-core").PgColumn<{
             name: "parent_id";
             tableName: "accounts";
@@ -1010,157 +1012,6 @@ export declare const accounts: import("drizzle-orm/pg-core").PgTableWithColumns<
     };
     dialect: "pg";
 }>;
-export declare const ledgers: import("drizzle-orm/pg-core").PgTableWithColumns<{
-    name: "ledgers";
-    schema: undefined;
-    columns: {
-        created_at: import("drizzle-orm/pg-core").PgColumn<{
-            name: "created_at";
-            tableName: "ledgers";
-            dataType: "date";
-            columnType: "PgTimestamp";
-            data: Date;
-            driverParam: string;
-            notNull: true;
-            hasDefault: true;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {}>;
-        updated_at: import("drizzle-orm/pg-core").PgColumn<{
-            name: "updated_at";
-            tableName: "ledgers";
-            dataType: "date";
-            columnType: "PgTimestamp";
-            data: Date;
-            driverParam: string;
-            notNull: false;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {}>;
-        id: import("drizzle-orm/pg-core").PgColumn<{
-            name: "id";
-            tableName: "ledgers";
-            dataType: "string";
-            columnType: "PgUUID";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: true;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {}>;
-        ref_id: import("drizzle-orm/pg-core").PgColumn<{
-            name: "ref_id";
-            tableName: "ledgers";
-            dataType: "string";
-            columnType: "PgVarchar";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: 64;
-        }>;
-        alt_id: import("drizzle-orm/pg-core").PgColumn<{
-            name: "alt_id";
-            tableName: "ledgers";
-            dataType: "string";
-            columnType: "PgVarchar";
-            data: string;
-            driverParam: string;
-            notNull: false;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: 64;
-        }>;
-        name: import("drizzle-orm/pg-core").PgColumn<{
-            name: "name";
-            tableName: "ledgers";
-            dataType: "string";
-            columnType: "PgVarchar";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: 64;
-        }>;
-        description: import("drizzle-orm/pg-core").PgColumn<{
-            name: "description";
-            tableName: "ledgers";
-            dataType: "string";
-            columnType: "PgVarchar";
-            data: string;
-            driverParam: string;
-            notNull: false;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: 255;
-        }>;
-        active: import("drizzle-orm/pg-core").PgColumn<{
-            name: "active";
-            tableName: "ledgers";
-            dataType: "boolean";
-            columnType: "PgBoolean";
-            data: boolean;
-            driverParam: boolean;
-            notNull: true;
-            hasDefault: true;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {}>;
-    };
-    dialect: "pg";
-}>;
 /**
  * 2. Relations
  * These are for Drizzle query building features and have no direct effect on the database schema.

package/dist/schema.js

@@ -92,22 +92,13 @@ export const accounts = pgTable("accounts", {
     ref_id: varchar("ref_id", { length: 64 }).notNull().unique(),
     alt_id: varchar("alt_id", { length: 64 }).unique(),
     balance_type: varchar("balance_type", { length: 10 }).notNull().$type(),
-    ledger_id: uuid("ledger_id").notNull(),
+    ledger_id: varchar("ledger_id", { length: 64 }).notNull(),
     parent_id: uuid("parent_id"),
     name: varchar("name", { length: 64 }).notNull(),
     meta: jsonb("meta").$type(),
     active: boolean("active").default(true).notNull(),
     ...timestamps,
 });
-export const ledgers = pgTable("ledgers", {
-    id: uuid("id").primaryKey(),
-    ref_id: varchar("ref_id", { length: 64 }).notNull().unique(),
-    alt_id: varchar("alt_id", { length: 64 }).unique(),
-    name: varchar("name", { length: 64 }).notNull(),
-    description: varchar("description", { length: 255 }),
-    active: boolean("active").default(true).notNull(),
-    ...timestamps,
-});
 /**
  * 2. Relations
  * These are for Drizzle query building features and have no direct effect on the database schema.

package/dist/transactions.d.ts

@@ -1,19 +1,40 @@
 import type { Field } from "./fields.js";
+/**
+ * Enumeration for the status of a transaction model.
+ */
 export declare enum TransactionModelStatus {
     ACTIVE = 0,
     INACTIVE = 1
 }
+/**
+ * Infers the meta type of a transaction based on its fields.
+ */
 export type InferTransactionMetaType<TFields extends readonly Field[]> = {
-    [K in TFields[number] as K["ref_id"]]: K["__primitive_type"];
+    [K in TFields[number] as K["refId"]]: K["__valueType"];
 };
+/**
+ * Type definition for a transaction in the system.
+ */
 export type Transaction<TData = Record<string, any>> = {
     id: string;
-    model_ref_id: string;
-    created_at: Date;
-    updated_at: Date;
+    modelRefId: string;
+    createdAt: Date;
+    updatedAt: Date;
     data: TData;
 };
+/**
+ * Type definition for a hook function that operates on a transaction.
+ *
+ * @param TData - The type of the data contained within the transaction.
+ * @returns A promise that resolves to the modified transaction.
+ *
+ */
 export type TransactionHook<TData> = (transaction: Transaction<TData>) => Promise<Transaction<TData>>;
+/**
+ * Type definition for the hooks associated with a transaction.
+ * @param TData - The type of the data contained within the transaction.
+ * @returns An object containing arrays of hook functions for various transaction lifecycle events.
+ */
 export type TransactionHooks<TData = Record<string, any>> = {
     creating?: TransactionHook<TData>[];
     updating?: TransactionHook<TData>[];
@@ -22,20 +43,41 @@ export type TransactionHooks<TData = Record<string, any>> = {
     updated?: TransactionHook<TData>[];
     deleted?: TransactionHook<TData>[];
 };
+/**
+ * Type definition for a transaction model in the system.
+ *
+ * @returns An object representing the transaction model with its metadata, fields, and hooks.
+ */
 export type TransactionModel = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status: TransactionModelStatus;
     fields?: Field[];
     hooks?: TransactionHooks<any>;
 };
+/** Options for defining a transaction model.
+ *
+ * @param TFields - An array of Field definitions.
+ * @returns An object containing the options for the transaction model.
+ */
 export type TransactionModelOptions<TFields extends readonly Field[]> = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status?: TransactionModelStatus;
     fields?: TFields;
     hooks?: TransactionHooks<InferTransactionMetaType<TFields>>;
 };
-export declare function defineTransactionModel<const TFields extends readonly Field[]>(options: TransactionModelOptions<TFields>): TransactionModel;
+/**
+ * Defines a transaction model with the given options.
+ *
+ * @remarks
+ * Sets default status to ACTIVE if not provided.
+ *
+ * @param options - The options for defining the transaction model.
+ * @returns The defined transaction model with its fields.
+ */
+export declare function defineTransactionModel<const TFields extends readonly Field[]>(options: TransactionModelOptions<TFields>): TransactionModel & {
+    fields: TFields;
+};

package/dist/transactions.js

@@ -1,14 +1,25 @@
+/**
+ * Enumeration for the status of a transaction model.
+ */
 export var TransactionModelStatus;
 (function (TransactionModelStatus) {
     TransactionModelStatus[TransactionModelStatus["ACTIVE"] = 0] = "ACTIVE";
     TransactionModelStatus[TransactionModelStatus["INACTIVE"] = 1] = "INACTIVE";
 })(TransactionModelStatus || (TransactionModelStatus = {}));
+/**
+ * Defines a transaction model with the given options.
+ *
+ * @remarks
+ * Sets default status to ACTIVE if not provided.
+ *
+ * @param options - The options for defining the transaction model.
+ * @returns The defined transaction model with its fields.
+ */
 export function defineTransactionModel(options) {
-    const transactionModel = {
+    return {
         ...options,
         status: options.status ?? TransactionModelStatus.ACTIVE,
         fields: options.fields,
         hooks: options.hooks,
     };
-    return transactionModel;
 }

package/dist/ui.d.ts

@@ -1,8 +1,24 @@
+/**
+ * Type definition for static UI configuration options.
+ *
+ * @returns An object containing the static UI configuration options.
+ */
 export type StaticUIOptions = {
     assetsPath: string;
     basePath: string;
     htmlContent: string;
     serverPath: string;
 };
+/**
+ * Type definition for static UI configuration.
+ *
+ * @returns An object containing the static UI configuration.
+ */
 export type StaticUIConfig = StaticUIOptions;
+/**
+ * Factory function to define static UI configuration.
+ *
+ * @param options
+ * @returns
+ */
 export declare function defineStaticUI(options: StaticUIOptions): StaticUIConfig;

package/dist/ui.js

@@ -1,3 +1,9 @@
+/**
+ * Factory function to define static UI configuration.
+ *
+ * @param options
+ * @returns
+ */
 export function defineStaticUI(options) {
     return options;
 }

package/dist/units.d.ts

@@ -1,19 +1,45 @@
 import type { Field } from "./fields.js";
+/**
+ * Enumeration for the status of a unit model.
+ */
 export declare enum UnitModelStatus {
     ACTIVE = 0,
     INACTIVE = 1
 }
+/**
+ * Infers the meta type of a unit based on its fields.
+ *
+ * @param TFields - An array of Field definitions.
+ * @returns A mapped type where each field's refId is the key and its value type is the value.
+ */
 export type InferUnitMetaType<TFields extends readonly Field[]> = {
-    [K in TFields[number] as K["ref_id"]]: K["__primitive_type"];
+    [K in TFields[number] as K["refId"]]: K["__valueType"];
 };
+/**
+ * Type definition for a unit in the system.
+ *
+ * @param TData - The type of the data contained within the unit.
+ * @returns An object representing the unit with its metadata and data.
+ */
 export type Unit<TData = Record<string, any>> = {
     id: string;
-    model_ref_id: string;
-    created_at: Date;
-    updated_at: Date;
+    modelRefId: string;
+    createdAt: Date;
+    updatedAt: Date;
     data: TData;
 };
+/**
+ * Type definition for a hook function that operates on a unit.
+ *
+ * @param TData - The type of the data contained within the unit.
+ * @returns A promise that resolves to the modified unit.
+ */
 export type UnitHook<TData> = (unit: Unit<TData>) => Promise<Unit<TData>>;
+/**
+ * Type definition for the hooks associated with a unit.
+ * @param TData - The type of the data contained within the unit.
+ * @returns An object containing arrays of hook functions for various unit lifecycle events.
+ */
 export type UnitHooks<TData = Record<string, any>> = {
     creating?: UnitHook<TData>[];
     updating?: UnitHook<TData>[];
@@ -22,20 +48,42 @@ export type UnitHooks<TData = Record<string, any>> = {
     updated?: UnitHook<TData>[];
     deleted?: UnitHook<TData>[];
 };
+/**
+ * Type definition for a unit model in the system.
+ *
+ * @returns An object representing the unit model with its metadata, fields, and hooks.
+ */
 export type UnitModel = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status: UnitModelStatus;
     fields?: Field[];
     hooks?: UnitHooks<any>;
 };
+/**
+ * Options for defining a unit model.
+ *
+ * @param TFields - An array of Field definitions.
+ * @returns An object containing the options for the unit model.
+ */
 export type UnitModelOptions<TFields extends readonly Field[]> = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status?: UnitModelStatus;
     fields?: TFields;
     hooks?: UnitHooks<InferUnitMetaType<TFields>>;
 };
-export declare function defineUnitModel<const TFields extends readonly Field[]>(options: UnitModelOptions<TFields>): UnitModel;
+/**
+ * Defines a unit model with the given options.
+ *
+ * @remarks
+ * Sets default status to ACTIVE if not provided.
+ *
+ * @param options - The options for defining the unit model.
+ * @returns The defined unit model with its fields.
+ */
+export declare function defineUnitModel<const TFields extends readonly Field[]>(options: UnitModelOptions<TFields>): UnitModel & {
+    fields: TFields;
+};

package/dist/units.js

@@ -1,14 +1,25 @@
+/**
+ * Enumeration for the status of a unit model.
+ */
 export var UnitModelStatus;
 (function (UnitModelStatus) {
     UnitModelStatus[UnitModelStatus["ACTIVE"] = 0] = "ACTIVE";
     UnitModelStatus[UnitModelStatus["INACTIVE"] = 1] = "INACTIVE";
 })(UnitModelStatus || (UnitModelStatus = {}));
+/**
+ * Defines a unit model with the given options.
+ *
+ * @remarks
+ * Sets default status to ACTIVE if not provided.
+ *
+ * @param options - The options for defining the unit model.
+ * @returns The defined unit model with its fields.
+ */
 export function defineUnitModel(options) {
-    const unitModel = {
+    return {
         ...options,
         status: options.status ?? UnitModelStatus.ACTIVE,
         fields: options.fields,
         hooks: options.hooks,
     };
-    return unitModel;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitledger/core",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "private": false,
   "license": "Apache-2.0",
   "type": "module",
@@ -9,6 +9,10 @@
       "types": "./dist/main.d.ts",
       "default": "./dist/main.js"
     },
+    "./art": {
+      "types": "./dist/art.d.ts",
+      "default": "./dist/art.js"
+    },
     "./db": {
       "types": "./dist/db.d.ts",
       "default": "./dist/db.js"
@@ -21,6 +25,14 @@
       "types": "./dist/fields.d.ts",
       "default": "./dist/fields.js"
     },
+    "./forms": {
+      "types": "./dist/forms.d.ts",
+      "default": "./dist/forms.js"
+    },
+    "./ledgers": {
+      "types": "./dist/ledgers.d.ts",
+      "default": "./dist/ledgers.js"
+    },
     "./transactions": {
       "types": "./dist/transactions.d.ts",
       "default": "./dist/transactions.js"
@@ -59,6 +71,8 @@
   },
   "scripts": {
     "build": "tsc && copyfiles -u 1 \"src/migrations/**/*\" dist",
+    "db:custom": "drizzle-kit generate --custom",
+    "db:generate": "drizzle-kit generate",
     "typecheck": "tsc --noEmit"
   }
 }