@kitledger/core 0.0.7 → 0.0.8

package/dist/art.d.ts

@@ -0,0 +1 @@
+export declare function getAsciiLogo(): string;

package/dist/art.js

@@ -0,0 +1,37 @@
+export function getAsciiLogo() {
+    return `.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+............################.......################-.............
+............#++++++++++###.......###++++++++++###................
+............#++++++++###.......###++++++++++###..................
+............#++++++###.......###++++++++++###....................
+............#++++###.......###++++++++++###......................
+............#++###.......###++++++++++###........................
+............####.......###++++++++++###..........................
+............##.......###++++++++++###............................
+...................###++++++++++###..............................
+.................###++++++++++###................................
+...............###++++++++++###..................................
+.............###++++++++++###....................................
+............##++++++++++###........####..........................
+............#+++++++++###........###++###........................
+............#++++++++##........###++++++###......................
+............#++++++++#.......###++++++++++###....................
+............#++++++++###.......###++++++++++###..................
+............#++++++++++###.......###++++++++++###................
+............################.......################..............
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................
+.................................................................`;
+}

package/dist/db.js

@@ -2,13 +2,13 @@ import { drizzle } from "drizzle-orm/postgres-js";
 import { migrate } from "drizzle-orm/postgres-js/migrator";
 import { dirname, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
+import postgres from "postgres";
 import * as v from "valibot";
 import * as schema from "./schema.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 export async function runMigrations(db, migrationsTable, migrationsSchema) {
     const migrationsPath = resolve(__dirname, "../dist/migrations");
-    console.log("***Using migrations path:", migrationsPath);
     await migrate(db, {
         migrationsFolder: migrationsPath,
         migrationsTable: migrationsTable,
@@ -22,8 +22,20 @@ export async function initializeDatabase(options) {
         max: options.max ? options.max : 10,
         autoMigrate: options.autoMigrate ?? true,
     };
+    const queryClient = postgres(dbConfig.url, {
+        ssl: dbConfig.ssl,
+        max: dbConfig.max,
+        onnotice: (msg) => {
+            /**
+             * Ignore notices about skipping already applied migrations
+             */
+            if (!msg.message.includes("skipping")) {
+                console.log("Kitledger Postgres notice:", msg);
+            }
+        },
+    });
     const db = drizzle({
-        connection: dbConfig,
+        client: queryClient,
         schema: schema,
     });
     const migrationsTable = options.migrationsTable || "schema_history";

package/dist/entities.d.ts

@@ -4,13 +4,13 @@ export declare enum EntityModelStatus {
     INACTIVE = 1
 }
 export type InferEntityMetaType<TFields extends readonly Field[]> = {
-    [K in TFields[number] as K["ref_id"]]: K["__primitive_type"];
+    [K in TFields[number] as K["refId"]]: K["__valueType"];
 };
 export type Entity<TData = Record<string, any>> = {
     id: string;
-    model_ref_id: string;
-    created_at: Date;
-    updated_at: Date;
+    modelRefId: string;
+    createdAt: Date;
+    updatedAt: Date;
     data: TData;
 };
 export type EntityHook<TData> = (entity: Entity<TData>) => Promise<Entity<TData>>;
@@ -23,19 +23,21 @@ export type EntityHooks<TData = Record<string, any>> = {
     deleted?: EntityHook<TData>[];
 };
 export type EntityModel = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status: EntityModelStatus;
     fields?: Field[];
     hooks?: EntityHooks<any>;
 };
 export type EntityModelOptions<TFields extends readonly Field[]> = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status?: EntityModelStatus;
     fields?: TFields;
     hooks?: EntityHooks<InferEntityMetaType<TFields>>;
 };
-export declare function defineEntityModel<const TFields extends readonly Field[]>(options: EntityModelOptions<TFields>): EntityModel;
+export declare function defineEntityModel<const TFields extends readonly Field[]>(options: EntityModelOptions<TFields>): EntityModel & {
+    fields: TFields;
+};

package/dist/entities.js

@@ -4,11 +4,10 @@ export var EntityModelStatus;
     EntityModelStatus[EntityModelStatus["INACTIVE"] = 1] = "INACTIVE";
 })(EntityModelStatus || (EntityModelStatus = {}));
 export function defineEntityModel(options) {
-    const entityModel = {
+    return {
         ...options,
         status: options.status ?? EntityModelStatus.ACTIVE,
         fields: options.fields,
         hooks: options.hooks,
     };
-    return entityModel;
 }

package/dist/fields.d.ts

@@ -8,13 +8,14 @@ export declare enum FieldType {
     RELATION = "relation"
 }
 interface BaseField {
-    readonly ref_id: string;
+    readonly refId: string;
     name: string;
     description?: string;
+    required: boolean;
 }
 export interface TextField extends BaseField {
     type: FieldType.TEXT;
-    readonly __primitive_type?: string;
+    readonly __valueType: string;
     maxLength?: number;
     format?: "email" | "plain" | "rich_text";
 }
@@ -29,31 +30,31 @@ export type NumberFormatting = {
 };
 export interface NumberField extends BaseField {
     type: FieldType.NUMBER;
-    readonly __primitive_type?: number;
+    readonly __valueType: number;
     min?: number;
     max?: number;
     formatting: NumberFormatting;
 }
 export interface DateField extends BaseField {
     type: FieldType.DATE;
-    readonly __primitive_type?: Date;
+    readonly __valueType: Date;
     includeTime: boolean;
     formatStr: string;
 }
 export interface BooleanField extends BaseField {
     type: FieldType.BOOLEAN;
-    readonly __primitive_type?: boolean;
+    readonly __valueType: boolean;
     defaultValue?: boolean;
 }
 export interface URLField extends BaseField {
     type: FieldType.URL;
-    readonly __primitive_type?: string;
+    readonly __valueType: string;
     defaultValue?: string;
 }
 export type QueryConfig = {};
 export interface SelectField extends BaseField {
     type: FieldType.SELECT;
-    readonly __primitive_type?: string | number | (string | number)[];
+    readonly __valueType: string | number | (string | number)[];
     multiSelect: boolean;
     items: Array<{
         label: string;
@@ -64,53 +65,81 @@ export interface SelectField extends BaseField {
 }
 export interface RelationField extends BaseField {
     type: FieldType.RELATION;
-    readonly __primitive_type?: any;
+    readonly __valueType: any;
     multiSelect: boolean;
     targetEntityId: string;
     displayFieldId: string;
     query: QueryConfig;
 }
 export type Field = TextField | NumberField | DateField | BooleanField | URLField | SelectField | RelationField;
-export type TextFieldOptions = Omit<TextField, "type" | "__primitive_type" | "ref_id">;
-export type NumberFieldOptions = Omit<NumberField, "type" | "__primitive_type" | "ref_id">;
-export type DateFieldOptions = Omit<DateField, "type" | "__primitive_type" | "ref_id">;
-export type BooleanFieldOptions = Omit<BooleanField, "type" | "__primitive_type" | "ref_id">;
-export type URLFieldOptions = Omit<URLField, "type" | "__primitive_type" | "ref_id">;
-export type SelectFieldOptions = Omit<SelectField, "type" | "__primitive_type" | "ref_id">;
-export type RelationFieldOptions = Omit<RelationField, "type" | "__primitive_type" | "ref_id">;
-export declare function defineTextField<const T extends string>(options: TextFieldOptions & {
-    ref_id: T;
+export type TextFieldOptions = Omit<TextField, "type" | "__valueType" | "refId" | "required"> & {
+    required?: boolean;
+};
+export type NumberFieldOptions = Omit<NumberField, "type" | "__valueType" | "refId" | "required"> & {
+    required?: boolean;
+};
+export type DateFieldOptions = Omit<DateField, "type" | "__valueType" | "refId" | "required"> & {
+    required?: boolean;
+};
+export type BooleanFieldOptions = Omit<BooleanField, "type" | "__valueType" | "refId" | "required"> & {
+    required?: boolean;
+};
+export type URLFieldOptions = Omit<URLField, "type" | "__valueType" | "refId" | "required"> & {
+    required?: boolean;
+};
+export type SelectFieldOptions = Omit<SelectField, "type" | "__valueType" | "refId" | "required"> & {
+    required?: boolean;
+};
+export type RelationFieldOptions = Omit<RelationField, "type" | "__valueType" | "refId" | "required"> & {
+    required?: boolean;
+};
+export declare function defineTextField<const T extends string, const R extends boolean = false>(options: TextFieldOptions & {
+    refId: T;
+    required?: R;
 }): TextField & {
-    ref_id: T;
+    refId: T;
+    required: R;
 };
-export declare function defineNumberField<const T extends string>(options: NumberFieldOptions & {
-    ref_id: T;
+export declare function defineNumberField<const T extends string, const R extends boolean = false>(options: NumberFieldOptions & {
+    refId: T;
+    required?: R;
 }): NumberField & {
-    ref_id: T;
+    refId: T;
+    required: R;
 };
-export declare function defineDateField<const T extends string>(options: DateFieldOptions & {
-    ref_id: T;
+export declare function defineDateField<const T extends string, const R extends boolean = false>(options: DateFieldOptions & {
+    refId: T;
+    required?: R;
 }): DateField & {
-    ref_id: T;
+    refId: T;
+    required: R;
 };
-export declare function defineBooleanField<const T extends string>(options: BooleanFieldOptions & {
-    ref_id: T;
+export declare function defineBooleanField<const T extends string, const R extends boolean = false>(options: BooleanFieldOptions & {
+    refId: T;
+    required?: R;
 }): BooleanField & {
-    ref_id: T;
+    refId: T;
+    required: R;
 };
-export declare function defineURLField<const T extends string>(options: URLFieldOptions & {
-    ref_id: T;
+export declare function defineURLField<const T extends string, const R extends boolean = false>(options: URLFieldOptions & {
+    refId: T;
+    required?: R;
 }): URLField & {
-    ref_id: T;
+    refId: T;
+    required: R;
 };
-export declare function defineSelectField<const T extends string>(options: SelectFieldOptions & {
-    ref_id: T;
+export declare function defineSelectField<const T extends string, const R extends boolean = false>(options: SelectFieldOptions & {
+    refId: T;
+    required?: R;
 }): SelectField & {
-    ref_id: T;
+    refId: T;
+    required: R;
 };
-export declare function defineRelationField<const T extends string>(options: RelationFieldOptions & {
-    ref_id: T;
+export declare function defineRelationField<const T extends string, const R extends boolean = false>(options: RelationFieldOptions & {
+    refId: T;
+    required?: R;
 }): RelationField & {
-    ref_id: T;
+    refId: T;
+    required: R;
 };
 export {};

package/dist/fields.js

@@ -9,23 +9,58 @@ export var FieldType;
     FieldType["RELATION"] = "relation";
 })(FieldType || (FieldType = {}));
 export function defineTextField(options) {
-    return { type: FieldType.TEXT, ...options };
+    const { required = false, ...rest } = options;
+    return {
+        type: FieldType.TEXT,
+        required,
+        ...rest,
+    };
 }
 export function defineNumberField(options) {
-    return { type: FieldType.NUMBER, ...options };
+    const { required = false, ...rest } = options;
+    return {
+        type: FieldType.NUMBER,
+        required,
+        ...rest,
+    };
 }
 export function defineDateField(options) {
-    return { type: FieldType.DATE, ...options };
+    const { required = false, ...rest } = options;
+    return {
+        type: FieldType.DATE,
+        required,
+        ...rest,
+    };
 }
 export function defineBooleanField(options) {
-    return { type: FieldType.BOOLEAN, ...options };
+    const { required = false, ...rest } = options;
+    return {
+        type: FieldType.BOOLEAN,
+        required,
+        ...rest,
+    };
 }
 export function defineURLField(options) {
-    return { type: FieldType.URL, ...options };
+    const { required = false, ...rest } = options;
+    return {
+        type: FieldType.URL,
+        required,
+        ...rest,
+    };
 }
 export function defineSelectField(options) {
-    return { type: FieldType.SELECT, ...options };
+    const { required = false, ...rest } = options;
+    return {
+        type: FieldType.SELECT,
+        required,
+        ...rest,
+    };
 }
 export function defineRelationField(options) {
-    return { type: FieldType.RELATION, ...options };
+    const { required = false, ...rest } = options;
+    return {
+        type: FieldType.RELATION,
+        required,
+        ...rest,
+    };
 }

package/dist/forms.d.ts

@@ -0,0 +1,67 @@
+import type { EntityModel } from "./entities.js";
+import type { Field } from "./fields.js";
+import type { TransactionModel } from "./transactions.js";
+import type { UnitModel } from "./units.js";
+export declare enum FormType {
+    ENTITY = "ENTITY",
+    TRANSACTION = "TRANSACTION",
+    UNIT = "UNIT"
+}
+export type FormFieldDisplay = "normal" | "inline" | "disabled" | "hidden";
+export type FormFieldConfig = {
+    label?: string;
+    description?: string;
+    display?: FormFieldDisplay;
+};
+type InferFieldConfig<TFields extends readonly Field[]> = {
+    [K in TFields[number] as K["refId"]]?: FormFieldConfig & {
+        required?: K["required"] extends true ? true : boolean;
+    };
+};
+export interface BaseForm {
+    refId: string;
+    modelRefId: string;
+    name: string;
+    description?: string;
+    fieldOrder?: string[];
+}
+export type EntityFormOptions<TModel extends {
+    fields?: readonly any[];
+}> = {
+    name: string;
+    description?: string;
+    refId: string;
+    fields: InferFieldConfig<NonNullable<TModel["fields"]>>;
+};
+export type UnitFormOptions<TModel extends {
+    fields?: readonly any[];
+}> = {
+    name: string;
+    description?: string;
+    refId: string;
+    fields: InferFieldConfig<NonNullable<TModel["fields"]>>;
+};
+export type TransactionFormOptions<TModel extends {
+    fields?: readonly any[];
+}> = {
+    name: string;
+    description?: string;
+    refId: string;
+    fields: InferFieldConfig<NonNullable<TModel["fields"]>>;
+};
+export interface TransactionForm<TModel extends TransactionModel> extends BaseForm {
+    type: FormType.TRANSACTION;
+    fields: InferFieldConfig<NonNullable<TModel["fields"]>>;
+}
+export interface EntityForm<TModel extends EntityModel> extends BaseForm {
+    type: FormType.ENTITY;
+    fields: InferFieldConfig<NonNullable<TModel["fields"]>>;
+}
+export interface UnitForm<TModel extends UnitModel> extends BaseForm {
+    type: FormType.UNIT;
+    fields: InferFieldConfig<NonNullable<TModel["fields"]>>;
+}
+export declare function defineTransactionForm<const TModel extends TransactionModel>(model: TModel, config: TransactionFormOptions<TModel>): TransactionForm<TModel>;
+export declare function defineEntityForm<const TModel extends EntityModel>(model: TModel, config: EntityFormOptions<TModel>): EntityForm<TModel>;
+export declare function defineUnitForm<const TModel extends UnitModel>(model: TModel, config: UnitFormOptions<TModel>): UnitForm<TModel>;
+export {};

package/dist/forms.js

@@ -0,0 +1,38 @@
+// --- CORE TYPES ---
+export var FormType;
+(function (FormType) {
+    FormType["ENTITY"] = "ENTITY";
+    FormType["TRANSACTION"] = "TRANSACTION";
+    FormType["UNIT"] = "UNIT";
+})(FormType || (FormType = {}));
+// --- FACTORIES (Pure Configuration) ---
+export function defineTransactionForm(model, config) {
+    return {
+        refId: config.refId,
+        name: config.name,
+        description: config.description,
+        type: FormType.TRANSACTION,
+        modelRefId: model.refId,
+        fields: config.fields,
+    };
+}
+export function defineEntityForm(model, config) {
+    return {
+        refId: config.refId,
+        name: config.name,
+        description: config.description,
+        type: FormType.ENTITY,
+        modelRefId: model.refId,
+        fields: config.fields,
+    };
+}
+export function defineUnitForm(model, config) {
+    return {
+        refId: config.refId,
+        name: config.name,
+        description: config.description,
+        type: FormType.UNIT,
+        modelRefId: model.refId,
+        fields: config.fields,
+    };
+}

package/dist/main.d.ts

@@ -1,9 +1,15 @@
+import type { TransactionForm, EntityForm, UnitForm } from "./forms.js";
 import { KitledgerDb } from "./db.js";
 import { EntityModel } from "./entities.js";
 import { TransactionModel } from "./transactions.js";
+import { UnitModel } from "./units.js";
 export interface KitledgerConfig {
     database: KitledgerDb;
     entityModels: EntityModel[];
     transactionModels: TransactionModel[];
+    unitModels: UnitModel[];
+    transactionForms?: TransactionForm<TransactionModel>[];
+    entityForms?: EntityForm<EntityModel>[];
+    unitForms?: UnitForm<UnitModel>[];
 }
 export declare function defineConfig(config: KitledgerConfig): KitledgerConfig;

package/dist/transactions.d.ts

@@ -4,13 +4,13 @@ export declare enum TransactionModelStatus {
     INACTIVE = 1
 }
 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"];
 };
 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;
 };
 export type TransactionHook<TData> = (transaction: Transaction<TData>) => Promise<Transaction<TData>>;
@@ -23,19 +23,21 @@ export type TransactionHooks<TData = Record<string, any>> = {
     deleted?: TransactionHook<TData>[];
 };
 export type TransactionModel = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status: TransactionModelStatus;
     fields?: Field[];
     hooks?: TransactionHooks<any>;
 };
 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;
+export declare function defineTransactionModel<const TFields extends readonly Field[]>(options: TransactionModelOptions<TFields>): TransactionModel & {
+    fields: TFields;
+};

package/dist/transactions.js

@@ -4,11 +4,10 @@ export var TransactionModelStatus;
     TransactionModelStatus[TransactionModelStatus["INACTIVE"] = 1] = "INACTIVE";
 })(TransactionModelStatus || (TransactionModelStatus = {}));
 export function defineTransactionModel(options) {
-    const transactionModel = {
+    return {
         ...options,
         status: options.status ?? TransactionModelStatus.ACTIVE,
         fields: options.fields,
         hooks: options.hooks,
     };
-    return transactionModel;
 }

package/dist/units.d.ts

@@ -4,13 +4,13 @@ export declare enum UnitModelStatus {
     INACTIVE = 1
 }
 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"];
 };
 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;
 };
 export type UnitHook<TData> = (unit: Unit<TData>) => Promise<Unit<TData>>;
@@ -23,19 +23,21 @@ export type UnitHooks<TData = Record<string, any>> = {
     deleted?: UnitHook<TData>[];
 };
 export type UnitModel = {
-    ref_id: string;
-    alt_id?: string;
+    refId: string;
+    altId?: string;
     name: string;
     status: UnitModelStatus;
     fields?: Field[];
     hooks?: UnitHooks<any>;
 };
 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;
+export declare function defineUnitModel<const TFields extends readonly Field[]>(options: UnitModelOptions<TFields>): UnitModel & {
+    fields: TFields;
+};

package/dist/units.js

@@ -4,11 +4,10 @@ export var UnitModelStatus;
     UnitModelStatus[UnitModelStatus["INACTIVE"] = 1] = "INACTIVE";
 })(UnitModelStatus || (UnitModelStatus = {}));
 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.8",
   "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,10 @@
       "types": "./dist/fields.d.ts",
       "default": "./dist/fields.js"
     },
+    "./forms": {
+      "types": "./dist/forms.d.ts",
+      "default": "./dist/forms.js"
+    },
     "./transactions": {
       "types": "./dist/transactions.d.ts",
       "default": "./dist/transactions.js"