refactor(uc)!: make UCDataStore compliant with Initializable

c100k · c100k · commit 068604ce0a03 · 2025-06-20T14:17:55.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - Introduce `Initializable.initSync()` : useful for contexts where async is not available (e.g. Cloudflare workers initialization) => To address, simply add the method in the concerned implementations. You can leave it empty, re-use the same logic as your existing `init()` if its core is not async, or copy it and adapt it to make it sync. If you want to forbid its usage, use `throw new NotCallableError<this>('initSync', 'init', 'async-only');`
 - Introduce `ServerManager.mountSync()` : useful for contexts where async is not available (e.g. Cloudflare workers initialization) => To address, simply add the method in the concerned implementations. You can leave it empty, re-use the same logic as your existing `mount()` if its core is not async, or copy it and adapt it to make it sync. If you want to forbid its usage, use `throw new NotCallableError<this>('mountSync', 'mount', 'async-only');`
 - Change `uc_data_store_ucs_dataset_name` default value from `use-cases` to `uc_executions` : if you relied on the default value and want to keep it, explicitly set `uc_data_store_ucs_dataset_name` in your settings. If you want the new name, rename your existing collection to the new name
+- Make `UCDataStore` compliant with `Initializable` : rename `install` to `init`, add `initSync` and rename `initTx` to `startTx`
 
 **Added**
 
diff --git a/dist/esm/std/impl/UCDataStoreExternalResourceManager.js b/dist/esm/std/impl/UCDataStoreExternalResourceManager.js
@@ -20,7 +20,7 @@ let UCDataStoreExternalResourceManager = class UCDataStoreExternalResourceManage
         this.ucDataStore = ucDataStore;
     }
     async create() {
-        return this.ucDataStore.install();
+        return this.ucDataStore.init();
     }
     async delete() {
         return this.ucDataStore.destroy();
diff --git a/dist/esm/testing/UCDataStoreTester.js b/dist/esm/testing/UCDataStoreTester.js
@@ -16,7 +16,7 @@ import { APP_NAME_PLACEHOLDER } from '../convention.js';
 import { TAmount, TCompanyName, } from '../dt/index.js';
 import { UCExecMode, } from '../uc/index.js';
 const ERR_SHOULD_NOT_EXIST_AFTER_DESTROY = 'It should not exist after destroy';
-const ERR_SHOULD_EXIST_AFTER_INSTALL = 'It should exist after install';
+const ERR_SHOULD_EXIST_AFTER_INIT = 'It should exist after init';
 const ERR_SHOULD_RETURN_X_RECORDS = (n) => `It should return ${n} record(s)`;
 /**
  * Test that a {@link UCDataStore} conforms to the spec
@@ -52,10 +52,10 @@ let UCDataStoreTester = class UCDataStoreTester {
         if (this.exists) {
             throw new Error(ERR_SHOULD_NOT_EXIST_AFTER_DESTROY);
         }
-        await ucDataStore.install();
+        await ucDataStore.init();
         this.exists = await ucDataStore.exists();
         if (!this.exists) {
-            throw new Error(ERR_SHOULD_EXIST_AFTER_INSTALL);
+            throw new Error(ERR_SHOULD_EXIST_AFTER_INIT);
         }
         this.readRes = await ucDataStore.read();
         this.expectXRecords(0);
diff --git a/dist/esm/uc/data-store.d.ts b/dist/esm/uc/data-store.d.ts
@@ -1,6 +1,6 @@
 import type { AppName } from '../app/index.js';
 import type { UIntQuantity, UUID } from '../dt/index.js';
-import type { Clearable, StringKeys } from '../utils/index.js';
+import type { Clearable, Initializable, StringKeys } from '../utils/index.js';
 import type { UCData } from './data.js';
 import type { UCExecMode } from './exec.js';
 import type { UCInput } from './input.js';
@@ -55,13 +55,12 @@ export interface UCDataStoreRecord<I extends UCInput | undefined = undefined, D
     organizationId: UUID | null;
     userId: UUID | null;
 }
-export interface UCDataStore extends Clearable {
+export interface UCDataStore extends Clearable, Initializable {
     destroy(): Promise<void>;
     exists(): Promise<boolean>;
-    initTx(): Promise<UCDataStoreTx['ref']>;
-    install(): Promise<void>;
     read<I extends UCInput | undefined = undefined, D extends UCData | null = null>(opts?: UCDataStoreReadOpts<I, D>): Promise<UCDataStoreReadResponse<I, D>>;
     readProjection<T extends object>(name: string, opts?: UCDataStoreReadProjectionOpts<T>): Promise<T[]>;
+    startTx(): Promise<UCDataStoreTx['ref']>;
     supportedSpecificBindings(): UCDataStoreWriteProjectionSpecificBinding[];
     testKey(encryptionKey: Uint8Array): Promise<void>;
     write<I extends UCInput | undefined = undefined, D extends UCData | null = null>(record: UCDataStoreRecord<I, D>, opts?: UCDataStoreWriteOpts): Promise<void>;
diff --git a/dist/esm/uc/impl/CloudflareD1UCDataStore.d.ts b/dist/esm/uc/impl/CloudflareD1UCDataStore.d.ts
@@ -17,10 +17,11 @@ export declare class CloudflareD1UCDataStore implements Configurable<S>, UCDataS
     clear(): Promise<void>;
     destroy(): Promise<void>;
     exists(): Promise<boolean>;
-    initTx(): Promise<UCDataStoreTx['ref']>;
-    install(): Promise<void>;
+    init(): Promise<void>;
+    initSync(): void;
     read<I extends UCInput | undefined = undefined, D extends UCData | null = null>(opts?: UCDataStoreReadOpts<I, D>): Promise<UCDataStoreReadResponse<I, D>>;
     readProjection<T extends object>(_name: string, _opts?: UCDataStoreReadProjectionOpts<T>): Promise<T[]>;
+    startTx(): Promise<UCDataStoreTx['ref']>;
     supportedSpecificBindings(): UCDataStoreWriteProjectionSpecificBinding[];
     testKey(_encryptionKey: Uint8Array): Promise<void>;
     write<I extends UCInput | undefined = undefined, D extends UCData | null = null>(record: UCDataStoreRecord<I, D>, _opts?: UCDataStoreWriteOpts): Promise<void>;
diff --git a/dist/esm/uc/impl/CloudflareD1UCDataStore.js b/dist/esm/uc/impl/CloudflareD1UCDataStore.js
@@ -50,11 +50,8 @@ let CloudflareD1UCDataStore = class CloudflareD1UCDataStore {
     async exists() {
         throw new NotImplementedError('exists');
     }
-    async initTx() {
-        throw new NotImplementedError('initTx');
-    }
-    async install() {
-        throw new NotImplementedError('install');
+    async init() {
+        throw new NotAvailableError('initSync');
         // Since workers do not accept top-level await, we cannot invoke this method when initiating it.
         // Plus, calling it in every request handler would be overkill and would add too much overhead.
         // In the meantime, process as follows :
@@ -90,6 +87,9 @@ CREATE INDEX IF NOT EXISTS uc_executions_user_id_index ON uc_executions (userId)
             pnpm wrangler d1 list
         */
     }
+    initSync() {
+        throw new NotAvailableError('initSync');
+    }
     async read(opts) {
         this.assertClient();
         // TODO : Consider using a query builder (or Google's pipe operator ?) when it gets too complicated or dangerous
@@ -133,6 +133,9 @@ CREATE INDEX IF NOT EXISTS uc_executions_user_id_index ON uc_executions (userId)
     async readProjection(_name, _opts) {
         throw new NotImplementedError('readProjection');
     }
+    async startTx() {
+        throw new NotImplementedError('startTx');
+    }
     supportedSpecificBindings() {
         throw new NotImplementedError('supportedSpecificBindings');
     }
diff --git a/dist/esm/uc/impl/InMemoryUCDataStore.d.ts b/dist/esm/uc/impl/InMemoryUCDataStore.d.ts
@@ -9,10 +9,11 @@ export declare class InMemoryUCDataStore implements UCDataStore {
     clear(): Promise<void>;
     destroy(): Promise<void>;
     exists(): Promise<boolean>;
-    initTx(): Promise<UCDataStoreTx['ref']>;
-    install(): Promise<void>;
+    init(): Promise<void>;
+    initSync(): void;
     read<I extends UCInput | undefined = undefined, D extends UCData | null = null>(opts?: UCDataStoreReadOpts<I, D>): Promise<UCDataStoreReadResponse<I, D>>;
     readProjection<T extends object>(): Promise<T[]>;
+    startTx(): Promise<UCDataStoreTx['ref']>;
     supportedSpecificBindings(): UCDataStoreWriteProjectionSpecificBinding[];
     testKey(): Promise<void>;
     write<I extends UCInput | undefined = undefined, D extends UCData | null = null>(record: UCDataStoreRecord<I, D>): Promise<void>;
diff --git a/dist/esm/uc/impl/InMemoryUCDataStore.js b/dist/esm/uc/impl/InMemoryUCDataStore.js
@@ -34,19 +34,10 @@ let InMemoryUCDataStore = class InMemoryUCDataStore {
     async exists() {
         return this.entries.length > 0;
     }
-    async initTx() {
-        this.tx = 'pending';
-        return {
-            commit: async () => {
-                this.tx = 'committed';
-            },
-            rollback: async () => {
-                this.tx = 'rollbacked';
-                this.entries = [];
-            },
-        };
+    async init() {
+        // Nothing to do
     }
-    async install() {
+    initSync() {
         // Nothing to do
     }
     async read(opts) {
@@ -81,6 +72,18 @@ let InMemoryUCDataStore = class InMemoryUCDataStore {
     async readProjection() {
         return [];
     }
+    async startTx() {
+        this.tx = 'pending';
+        return {
+            commit: async () => {
+                this.tx = 'committed';
+            },
+            rollback: async () => {
+                this.tx = 'rollbacked';
+                this.entries = [];
+            },
+        };
+    }
     supportedSpecificBindings() {
         return [];
     }
diff --git a/dist/esm/uc/impl/KnexUCDataStore.d.ts b/dist/esm/uc/impl/KnexUCDataStore.d.ts
@@ -26,10 +26,11 @@ export declare class KnexUCDataStore implements Configurable<S>, UCDataStore {
     clear(): Promise<void>;
     destroy(): Promise<void>;
     exists(): Promise<boolean>;
-    initTx(): Promise<UCDataStoreTx['ref']>;
-    install(): Promise<void>;
+    init(): Promise<void>;
+    initSync(): void;
     read<I extends UCInput | undefined = undefined, D extends UCData | null = null>(opts?: UCDataStoreReadOpts<I, D>): Promise<UCDataStoreReadResponse<I, D>>;
     readProjection<T extends object>(name: string, opts?: UCDataStoreReadProjectionOpts<T>): Promise<T[]>;
+    startTx(): Promise<UCDataStoreTx['ref']>;
     supportedSpecificBindings(): UCDataStoreWriteProjectionSpecificBinding[];
     testKey(_encryptionKey: Uint8Array): Promise<void>;
     write<I extends UCInput | undefined = undefined, D extends UCData | null = null>(record: UCDataStoreRecord<I, D>, opts?: UCDataStoreWriteOpts): Promise<void>;
diff --git a/dist/esm/uc/impl/KnexUCDataStore.js b/dist/esm/uc/impl/KnexUCDataStore.js
@@ -12,7 +12,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 import { inject, injectable } from 'inversify';
 import knex, {} from 'knex';
-import { NotAvailableError } from '../../error/index.js';
+import { NotAvailableError, NotCallableError } from '../../error/index.js';
 const FILTERS_MAPPING = new Map([
     ['aggregateId', 'aggregate_id'],
     ['appName', 'app_name'],
@@ -51,12 +51,12 @@ let KnexUCDataStore = class KnexUCDataStore {
     async exists() {
         return this.client.schema.hasTable(this.s().uc_data_store_ucs_dataset_name);
     }
-    async initTx() {
-        return this.client.transaction();
-    }
-    async install() {
+    async init() {
         await this.migration001CreateMainTable();
     }
+    initSync() {
+        throw new NotCallableError('initSync', 'init', 'async-only');
+    }
     async read(opts) {
         const query = this.client(this.s().uc_data_store_ucs_dataset_name);
         // Filter
@@ -101,6 +101,9 @@ let KnexUCDataStore = class KnexUCDataStore {
         const records = await query;
         return records;
     }
+    async startTx() {
+        return this.client.transaction();
+    }
     supportedSpecificBindings() {
         const type = this.s().knex_uc_data_store_type;
         switch (type) {
diff --git a/dist/esm/uc/impl/SimpleUCManager.d.ts b/dist/esm/uc/impl/SimpleUCManager.d.ts
@@ -32,7 +32,7 @@ export declare class SimpleUCManager implements UCManager {
     execClient<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>): Promise<UCOutputReader<I, OPI0, OPI1>>;
     execServer<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>): Promise<UCOutputOrNothing<OPI0, OPI1>>;
     initServer<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>): Promise<void>;
-    initTx(): Promise<void>;
+    startTx(): Promise<void>;
     persist<I extends UCInput | undefined = undefined, D extends UCData | null = null, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>, data?: D, opts?: UCManagerPersistOpts): Promise<UCDataStoreRecord<I, D>>;
     persistProjection<T extends object>(name: string, data: T): Promise<void>;
     rollbackTx(): Promise<void>;
diff --git a/dist/esm/uc/impl/SimpleUCManager.js b/dist/esm/uc/impl/SimpleUCManager.js
@@ -116,9 +116,9 @@ let SimpleUCManager = class SimpleUCManager {
         const init = (await this.ucInitProvider(server.init));
         await init.exec();
     }
-    async initTx() {
+    async startTx() {
         this.tx = {
-            ref: await this.ucDataStore.initTx(),
+            ref: await this.ucDataStore.startTx(),
         };
     }
     async persist(uc, data, opts) {
diff --git a/dist/esm/uc/manager.d.ts b/dist/esm/uc/manager.d.ts
@@ -29,7 +29,7 @@ export interface UCManager {
     execClient<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>): Promise<UCOutputReader<I, OPI0, OPI1>>;
     execServer<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>): Promise<UCOutputOrNothing<OPI0, OPI1>>;
     initServer<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>): Promise<void>;
-    initTx(): Promise<void>;
+    startTx(): Promise<void>;
     persist<I extends UCInput | undefined = undefined, D extends UCData | null = null, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined>(uc: UC<I, OPI0, OPI1>, data?: D, opts?: UCManagerPersistOpts): Promise<UCDataStoreRecord<I, D>>;
     persistProjection<T extends object>(name: string, data: T): Promise<void>;
     rollbackTx(): Promise<void>;

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ let UCDataStoreExternalResourceManager = class UCDataStoreExternalResourceManage`
`20`	`20`	`this.ucDataStore = ucDataStore;`
`21`	`21`	`}`
`22`	`22`	`async create() {`
`23`		`- return this.ucDataStore.install();`
	`23`	`+ return this.ucDataStore.init();`
`24`	`24`	`}`
`25`	`25`	`async delete() {`
`26`	`26`	`return this.ucDataStore.destroy();`