@elysiumjs/moirai 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @elysiumjs/moirai
 
+## 0.2.0
+
+### Minor Changes
+
+- [#28](https://github.com/na2axl/elysiumjs/pull/28) [`1a5599c`](https://github.com/na2axl/elysiumjs/commit/1a5599c5421c98b5ee64b0c5cab87d158041d309) Thanks [@na2axl](https://github.com/na2axl)! - Type actions and queries with their errors, and let them take no input.
+
+  - `Action<TInput, TResult, TErrors>` and `Query<TInput, TResult, TErrors>` take the DomainErrors their `handle()` returns as a third type parameter (any DomainError by default), and `HandlerResult<TResult, TErrors>` gives `TResult` or one of `TErrors`. `Moirai.execute()` and `Moirai.ask()` return them next to the result.
+  - `input` is optional in `@Action.register()` and `@Query.register()`. A handler without an input schema takes no input, and `Moirai.ask(Categories)` or `Moirai.execute(Ping)` call it without one (`Moirai.execute(Ping, undefined, { idempotencyKey })` for an idempotent one). The input of `Moirai.execute()` and `Moirai.ask()` may be left out whenever `handle()` takes none or an optional one.
+
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies [[`4cd1ef2`](https://github.com/na2axl/elysiumjs/commit/4cd1ef217826164e69cd641ca99f74c6f5a7ebe7)]:
+  - @elysiumjs/mnemosyne@0.5.0
+  - @elysiumjs/core@0.11.1
+  - @elysiumjs/heracles@0.8.0
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -13,30 +13,47 @@ bun add @elysiumjs/moirai @elysiumjs/mnemosyne
 An action is a write: a class that extends `Action`, marked with `@Action.register()`. A query is a read: a class that extends `Query`, marked with `@Query.register()`. `Moirai.execute()` runs an action and `Moirai.ask()` runs a query.
 
 ```ts
-import { Service, t } from '@elysiumjs/core';
+import type { Static } from '@elysiumjs/core';
+
+import { DomainError, Service, t } from '@elysiumjs/core';
 import { Action, Moirai, Outbox, Query } from '@elysiumjs/moirai';
 
+const TopUpInput = t.Object({ walletId: t.String(), amount: t.Integer({ minimum: 1 }) });
+export type TopUpInput = Static<typeof TopUpInput>;
+export type TopUpResult = { balance: number };
+
+class WalletClosed extends DomainError.for('CONFLICT', 409) {}
+
 @Action.register({
-	input: t.Object({ walletId: t.String(), amount: t.Integer({ minimum: 1 }) }),
+	input: TopUpInput,
 	idempotent: true,
 	serializeBy: (input) => `wallet:${input.walletId}`
 })
-class TopUp extends Action {
+class TopUp extends Action<TopUpInput, TopUpResult, WalletClosed> {
 	constructor(@Service.inject() private readonly wallets: WalletRepository) {
 		super();
 	}
 
-	public async handle(input: { walletId: string; amount: number }) {
-		const wallet = await this.wallets.credit(input.walletId, input.amount);
-		await Outbox.enqueue({ kind: 'wallet.credited', payload: { walletId: wallet.id } });
-		return { balance: wallet.balance };
+	public override async handle(input: TopUpInput): Promise<TopUpResult | WalletClosed> {
+		const wallet = await this.wallets.find(input.walletId);
+		if (wallet.closed) return new WalletClosed(`wallet ${input.walletId} is closed`);
+		const credited = await this.wallets.credit(input.walletId, input.amount);
+		await Outbox.enqueue({ kind: 'wallet.credited', payload: { walletId: credited.id } });
+		return { balance: credited.balance };
 	}
 }
 
-@Query.register({ input: t.Object({ walletId: t.String() }) })
-class WalletBalance extends Query {
-	public handle(input: { walletId: string }) {
-		/* ... */
+const WalletBalanceInput = t.Object({ walletId: t.String() });
+export type WalletBalanceInput = Static<typeof WalletBalanceInput>;
+
+@Query.register({ input: WalletBalanceInput })
+class WalletBalance extends Query<WalletBalanceInput, { balance: number }> {
+	constructor(@Service.inject() private readonly wallets: WalletRepository) {
+		super();
+	}
+
+	public override async handle(input: WalletBalanceInput) {
+		return { balance: await this.wallets.balance(input.walletId) };
 	}
 }
 
@@ -45,6 +62,7 @@ return Moirai.execute(TopUp, body, { idempotencyKey: headers['idempotency-key']
 return Moirai.ask(WalletBalance, { walletId });
 ```
 
+- `Action<TInput, TResult, TErrors>` and `Query<TInput, TResult, TErrors>` type `handle()`: it takes `TInput` and gives `TResult` or one of `TErrors`, the DomainErrors it returns (any DomainError by default). `Moirai.execute()` and `Moirai.ask()` take their input type and return types from `handle()`.
 - A refusal is a value. `Moirai.execute()` and `Moirai.ask()` return the DomainError that refused the call, and their return type lists it next to the result. A controller that returns it sends it as the problem of its route, and typed clients see it under its status. Check one with `isDomainError(outcome)`.
 - An input that does not match the schema is refused with a 422 `VALIDATION_FAILED` problem, with one entry per mistake.
 - When `authorize(input)` returns `false`, the call is refused with a 403 `FORBIDDEN` problem.

package/dist/action.d.ts

@@ -16,22 +16,43 @@ export type HandlerContext = {
     attempt: number;
 };
 /**
- * What `handle()` gives: the result, or a DomainError that refuses the call.
+ * What `handle()` gives: the result, or one of the DomainErrors that refuse the call.
  * @author Axel Nana <axel.nana@workbud.com>
  */
-export type HandlerResult<TResult> = Promise<TResult | DomainError> | TResult | DomainError;
+export type HandlerResult<TResult, TErrors extends DomainError = DomainError> = Promise<TResult | TErrors> | TResult | TErrors;
 /**
  * An action class.
  * @author Axel Nana <axel.nana@workbud.com>
  */
-export type ActionClass<TInput = any, TResult = any> = new (...args: any[]) => Action<TInput, TResult>;
+export type ActionClass<TInput = any, TResult = any, TErrors extends DomainError = DomainError> = new (...args: any[]) => Action<TInput, TResult, TErrors>;
 /**
  * A query class.
  * @author Axel Nana <axel.nana@workbud.com>
  */
-export type QueryClass<TInput = any, TResult = any> = new (...args: any[]) => Query<TInput, TResult>;
+export type QueryClass<TInput = any, TResult = any, TErrors extends DomainError = DomainError> = new (...args: any[]) => Query<TInput, TResult, TErrors>;
 type HandlerClass = ActionClass | QueryClass;
-type InputOf<C extends HandlerClass> = Parameters<InstanceType<C>['handle']>[0];
+type HandleParameters<C extends HandlerClass> = Parameters<InstanceType<C>['handle']>;
+type InputOf<C extends HandlerClass> = HandleParameters<C> extends [] ? undefined : HandleParameters<C>[0];
+/**
+ * How an action or a query is called.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type ActionCall = {
+    idempotencyKey?: string;
+    scope?: string;
+};
+/**
+ * The arguments of `Moirai.execute()` after the action: its input, which may be left out when
+ * `handle()` takes none (or an optional one), and how it is called.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type ExecuteArgs<C extends ActionClass> = undefined extends InputOf<C> ? [input?: InputOf<C>, call?: ActionCall] : [input: InputOf<C>, call?: ActionCall];
+/**
+ * The arguments of `Moirai.ask()` after the query: its input, which may be left out when
+ * `handle()` takes none (or an optional one).
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type AskArgs<C extends QueryClass> = undefined extends InputOf<C> ? [input?: InputOf<C>] : [input: InputOf<C>];
 type OutcomeOf<C extends HandlerClass> = Awaited<ReturnType<InstanceType<C>['handle']>>;
 /**
  * What `Moirai.execute()` gives: the result, or the DomainError that refused the call, from the
@@ -64,8 +85,8 @@ export type ActionRetry = {
 export type ActionOptions<S extends TSchema = TSchema> = {
     /** The name of the action, in idempotency records and problems. Defaults to the class name. */
     name?: string;
-    /** The schema of the input. */
-    input: S;
+    /** The schema of the input. An action without one takes no input. */
+    input?: S;
     /**
      * Whether a call needs an idempotency key. A repeat with the same key and input replays the
      * stored response; with another input, it is refused with a 422 problem. Defaults to `false`.
@@ -103,8 +124,8 @@ export type ActionOptions<S extends TSchema = TSchema> = {
 export type QueryOptions<S extends TSchema = TSchema> = {
     /** The name of the query. Defaults to the class name. */
     name?: string;
-    /** The schema of the input. */
-    input: S;
+    /** The schema of the input. A query without one takes no input. */
+    input?: S;
     /** Decides whether the call may run. */
     authorize?: (input: Static<S>) => boolean | Promise<boolean>;
 };
@@ -129,7 +150,7 @@ export type QueryOptions<S extends TSchema = TSchema> = {
  * }
  * ```
  */
-export declare abstract class Action<TInput = any, TResult = any> {
+export declare abstract class Action<TInput = any, TResult = any, TErrors extends DomainError = DomainError> {
     /**
      * Marks a class as an action.
      * @param props The options of the action.
@@ -139,21 +160,21 @@ export declare abstract class Action<TInput = any, TResult = any> {
      * Runs the action with its validated input. Returning or throwing a DomainError refuses the
      * call and rolls its unit of work back.
      */
-    abstract handle(input: TInput, context: HandlerContext): HandlerResult<TResult>;
+    abstract handle(input: TInput, context: HandlerContext): HandlerResult<TResult, TErrors>;
 }
 /**
  * A query: a read, validated and run without a transaction. Mark the class with
  * `@Query.register()` and run it with {@link Moirai.ask}.
  * @author Axel Nana <axel.nana@workbud.com>
  */
-export declare abstract class Query<TInput = any, TResult = any> {
+export declare abstract class Query<TInput = any, TResult = any, TErrors extends DomainError = DomainError> {
     /**
      * Marks a class as a query.
      * @param props The options of the query.
      */
     static register<S extends TSchema>(props: QueryOptions<S>): (target: QueryClass) => void;
     /** Runs the query with its validated input. Returning or throwing a DomainError refuses it. */
-    abstract handle(input: TInput, context: HandlerContext): HandlerResult<TResult>;
+    abstract handle(input: TInput, context: HandlerContext): HandlerResult<TResult, TErrors>;
 }
 export declare namespace Moirai {
     /**
@@ -167,13 +188,10 @@ export declare namespace Moirai {
      * that returns it sends it as the problem of its route.
      * @author Axel Nana <axel.nana@workbud.com>
      * @param action The action class.
-     * @param input The raw input.
-     * @param call The idempotency key of the call.
+     * @param args The raw input, left out when `handle()` takes none, and the idempotency key and
+     * scope of the call.
      */
-    const execute: <C extends ActionClass>(action: C, input: InputOf<C>, call?: {
-        idempotencyKey?: string;
-        scope?: string;
-    }) => Promise<ActionOutcome<C>>;
+    const execute: <C extends ActionClass>(action: C, ...[input, call]: ExecuteArgs<C>) => Promise<ActionOutcome<C>>;
     /**
      * The stores and options of a module, as private services to list in its `services`. The
      * actions and event handlers of the module, and the code that runs in it, use them instead of
@@ -204,8 +222,8 @@ export declare namespace Moirai {
      * `authorize`.
      * @author Axel Nana <axel.nana@workbud.com>
      * @param query The query class.
-     * @param input The raw input.
+     * @param args The raw input, left out when `handle()` takes none.
      */
-    const ask: <C extends QueryClass>(query: C, input: InputOf<C>) => Promise<QueryOutcome<C>>;
+    const ask: <C extends QueryClass>(query: C, ...[input]: AskArgs<C>) => Promise<QueryOutcome<C>>;
 }
 export {};

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { type ActionClass, type ActionOptions, type ActionOutcome, type ActionRetry, type HandlerContext, type HandlerResult, type QueryClass, type QueryOptions, type QueryOutcome, Action, Moirai, Query } from './action';
+export { type ActionCall, type ActionClass, type ActionOptions, type ActionOutcome, type ActionRetry, type AskArgs, type ExecuteArgs, type HandlerContext, type HandlerResult, type QueryClass, type QueryOptions, type QueryOutcome, Action, Moirai, Query } from './action';
 export { isTransientError, MOIRAI_ACTION_LOCK, MOIRAI_IDEMPOTENCY_STORE, MOIRAI_INBOX_STORE, MOIRAI_MODULE_OPTIONS, MOIRAI_OPTIONS, MOIRAI_OUTBOX_STORE, type MoiraiOptions } from './config';
 export { CallForbiddenError, DuplicateEventConsumerError, IdempotencyConflictError, IdempotencyKeyRequiredError, IdempotencyKeyReusedError, InvalidInputError, MissingStoreError, UnknownEventConsumerError, UnknownEffectError } from './errors';
 export { type EventCatalogue, type EventHandlerOptions, type EventMeta, type EventName, type EventPayload, Event, MOIRAI_EVENT_EFFECT } from './event';

package/dist/index.js

@@ -1 +1 @@
-import{IdempotencyKeyRequiredError2,IdempotencyKeyReusedError2,IdempotencyConflictError2,InvalidInputError2,CallForbiddenError2,MissingStoreError2,UnknownEffectError2,DuplicateEventConsumerError2,UnknownEventConsumerError2,MOIRAI_IDEMPOTENCY_STORE2,MOIRAI_OUTBOX_STORE2,MOIRAI_INBOX_STORE2,MOIRAI_ACTION_LOCK2,MOIRAI_OPTIONS2,MOIRAI_MODULE_OPTIONS2,isTransientError2,DEFAULT_OPTIONS,options,idempotencyStore,actionLock,inOwnerModule,uuidv72,effectHandler2,registerEffect2,backoffMs2,Outbox2,Inbox2}from"./index-2t45ppfs.js";var __legacyDecorateClassTS=function(decorators,target,key,desc){var c=arguments.length,r=c<3?target:desc===null?desc=Object.getOwnPropertyDescriptor(target,key):desc,d;if(typeof Reflect==="object"&&typeof Reflect.decorate==="function")r=Reflect.decorate(decorators,target,key,desc);else for(var i=decorators.length-1;i>=0;i--)if(d=decorators[i])r=(c<3?d(r):c>3?d(target,key,r):d(target,key))||r;return c>3&&r&&Object.defineProperty(target,key,r),r};import{currentUserId,DATABASE_TRANSACTION_SERVICE,DomainError,Metadata,Service}from"@elysiumjs/core";import{UnitOfWork}from"@elysiumjs/mnemosyne";import Value from"typebox/value";var canonical=(value)=>{if(typeof value==="bigint")return value.toString();if(Array.isArray(value))return value.map(canonical);if(value instanceof Date)return value.toISOString();if(value!==null&&typeof value==="object")return Object.fromEntries(Object.keys(value).sort().map((key)=>[key,canonical(value[key])]));return value},requestHash=async(input)=>{let bytes=new TextEncoder().encode(JSON.stringify(canonical(input))??"null"),digest=await crypto.subtle.digest("SHA-256",bytes);return[...new Uint8Array(digest)].map((byte)=>byte.toString(16).padStart(2,"0")).join("")};import{Module}from"@elysiumjs/core";var build=(option)=>typeof option==="function"?option():option,definitions=(config,global)=>{let{idempotency,outbox,inbox,lock,...rest}=config,stores=[[MOIRAI_IDEMPOTENCY_STORE2,idempotency],[MOIRAI_OUTBOX_STORE2,outbox],[MOIRAI_INBOX_STORE2,inbox],[MOIRAI_ACTION_LOCK2,lock]];return[...global?[{name:MOIRAI_OPTIONS2,global,factory:()=>({...DEFAULT_OPTIONS,...rest})}]:Object.keys(rest).length>0?[{name:MOIRAI_MODULE_OPTIONS2,global,factory:()=>({...rest})}]:[],...stores.filter(([,option])=>option!==void 0).map(([name,option])=>({name,global,factory:()=>build(option)}))]},moduleStores=(config)=>definitions(config,!1);class MoiraiModule extends Module.configurable(){}MoiraiModule=__legacyDecorateClassTS([Module.register({services:(config)=>definitions(config,!0)})],MoiraiModule);var ACTION=Symbol.for("elysium:moirai:action"),QUERY=Symbol.for("elysium:moirai:query");class Action{static register(props){return(target)=>{Metadata.define(ACTION,{...props,name:props.name??target.name},target)}}}class Query{static register(props){return(target)=>{Metadata.define(QUERY,{...props,name:props.name??target.name},target)}}}var instanceOf=(target)=>Service.get(target)??Service.make(target),validate=(schema,raw,name)=>{let value=Value.Default(schema,structuredClone(raw)),errors=[...Value.Errors(schema,value)];if(errors.length>0)throw new InvalidInputError2(name,errors.map((error)=>({pointer:`/${error.instancePath?.replace(/^\//,"")??""}`,message:error.message})));return value},unwrap=(result)=>{if(result instanceof DomainError)throw result;return result},settle=async(call)=>{try{return await call()}catch(error){if(error instanceof DomainError)return error;throw error}},Moirai;((Moirai)=>{Moirai.execute=(action,input,call={})=>settle(()=>{let props=Metadata.get(ACTION,action);if(!props)throw TypeError(`${action.name} is not marked with @Action.register().`);return inOwnerModule(action,()=>run(action,props,input,call))}),Moirai.stores=(stores)=>moduleStores(stores);let run=async(action,props,input,call)=>{let{name,idempotent=!1,transactional=!0,retry=!0}=props,config=options(),value=validate(props.input,input,name);if(props.authorize&&!await props.authorize(value))throw new CallForbiddenError2(name);let key=call.idempotencyKey;if(idempotent&&!key)throw new IdempotencyKeyRequiredError2(name);let storedKey=idempotent?[call.scope??props.scope?.(value)??currentUserId()??"anonymous",name,key].map(encodeURIComponent).join(":"):void 0,body=async(attempt)=>{let release=props.serializeBy?await actionLock().lock(props.serializeBy(value)):void 0;try{let handler=instanceOf(action),context={name,idempotencyKey:key,attempt};if(!idempotent)return unwrap(await handler.handle(value,context));let store=idempotencyStore(),hash=await requestHash(value),seen=await store.get(storedKey);if(seen){if(seen.action===name&&seen.requestHash===hash)return seen.response;throw new IdempotencyKeyReusedError2(key)}let response=unwrap(await handler.handle(value,context));return await store.put({key:storedKey,action:name,requestHash:hash,response:response===void 0?null:JSON.parse(JSON.stringify(response)),createdAt:new Date}),response}finally{release?.()}},transaction=transactional&&Service.exists(DATABASE_TRANSACTION_SERVICE);if(transaction&&UnitOfWork.active())return body(1);for(let attempt=1;;attempt++)try{return transaction?await UnitOfWork.run(()=>body(attempt),{connection:props.connection}):await body(attempt)}catch(error){let policy=typeof retry==="object"?retry:{},attempts=retry===!1?1:policy.attempts??config.maxAttempts,transient=policy.isTransient??config.isTransient;if(!(attempt<attempts&&transient(error)))throw error}};Moirai.ask=(query,input)=>settle(async()=>{let props=Metadata.get(QUERY,query);if(!props)throw TypeError(`${query.name} is not marked with @Query.register().`);let value=validate(props.input,input,props.name);if(props.authorize&&!await props.authorize(value))throw new CallForbiddenError2(props.name);return instanceOf(query).handle(value,{name:props.name,attempt:1})})})(Moirai||={});import{Service as Service2}from"@elysiumjs/core";var MOIRAI_EVENT_EFFECT="moirai.event",CONSUMERS=new Map;registerEffect2(MOIRAI_EVENT_EFFECT,async(payload,row)=>{let delivery=payload,handler=CONSUMERS.get(delivery.consumer);if(!handler)throw new UnknownEventConsumerError2(delivery.consumer,delivery.event);await inOwnerModule(handler.owner,()=>Inbox2.once({messageId:delivery.id,consumer:delivery.consumer},async()=>{await handler.run(delivery.payload,{id:delivery.id,event:delivery.event,publishedAt:new Date(delivery.publishedAt),attempt:row.attempts+1})}))},{attempts:(row)=>CONSUMERS.get(row.payload?.consumer??"")?.attempts});var Event;((Event)=>(Event.on=(event,options={})=>(target,method,_descriptor)=>{let isStatic=typeof target==="function",owner=isStatic?target:target.constructor,consumer=options.consumer??`${owner.name}.${String(method)}`;if(CONSUMERS.has(consumer))throw new DuplicateEventConsumerError2(consumer);let{retry}=options;CONSUMERS.set(consumer,{event,owner,attempts:retry===!1?1:retry?.attempts,run:(payload,meta)=>(isStatic?owner:Service2.get(owner)??Service2.make(owner))[method](payload,meta)})},Event.publish=async(event,payload)=>{let publishedAt=new Date,id=uuidv72(publishedAt.getTime()),deliveries=[...CONSUMERS].filter(([,handler])=>handler.event===event).map(([consumer])=>({kind:MOIRAI_EVENT_EFFECT,payload:{id,event,consumer,payload,publishedAt:publishedAt.toISOString()}}));return await Outbox2.enqueue(...deliveries),id},Event.consumersOf=(event)=>[...CONSUMERS].filter(([,handler])=>handler.event===event).map(([consumer])=>consumer)))(Event||={});import{UnitOfWork as UnitOfWork2}from"@elysiumjs/mnemosyne";class MemoryIdempotencyStore{#records=new Map;async get(key){let record=this.#records.get(key);return record?structuredClone(record):void 0}async put(record){if(this.#records.has(record.key))throw new IdempotencyConflictError2(record.key);this.#records.set(record.key,structuredClone(record))}}class MemoryActionLock{#tails=new Map;async lock(key){let previous=this.#tails.get(key)??Promise.resolve(),release,current=new Promise((resolve)=>release=resolve),tail=previous.then(()=>current);return this.#tails.set(key,tail),await previous,()=>{if(release(),this.#tails.get(key)===tail)this.#tails.delete(key)}}}class MemoryOutboxStore{#rows=new Map;get rows(){return[...this.#rows.values()].map((row)=>({...row}))}async insert(rows){for(let row of rows)this.#rows.set(row.id,{...row});UnitOfWork2.afterRollback(()=>{for(let row of rows)this.#rows.delete(row.id)})}async claimDue(claim){let{now,leaseUntil,limit,kinds,ids}=claim;if(kinds?.length===0||ids?.length===0)return[];let due=[...this.#rows.values()].filter((row)=>row.dispatchedAt===null&&row.deadAt===null&&row.availableAt.getTime()<=now.getTime()&&(!kinds||kinds.includes(row.kind))&&(!ids||ids.includes(row.id))).sort((a,b)=>a.availableAt.getTime()-b.availableAt.getTime()).slice(0,limit);for(let row of due)this.#rows.set(row.id,{...row,availableAt:leaseUntil});return due.map((row)=>({...row,availableAt:leaseUntil}))}async markDispatched(id,dispatchedAt){this.#update(id,{dispatchedAt})}async markFailed(id,update){this.#update(id,update)}async markDead(id,update){this.#update(id,update)}#update(id,update){let row=this.#rows.get(id);if(row)this.#rows.set(id,{...row,...update})}}class MemoryInboxStore{#seen=new Set;async record(messageId,consumer){let key=`${consumer}\x00${messageId}`;if(this.#seen.has(key))return!1;return this.#seen.add(key),UnitOfWork2.afterRollback(()=>void this.#seen.delete(key)),!0}}export{Action,CallForbiddenError2 as CallForbiddenError,DuplicateEventConsumerError2 as DuplicateEventConsumerError,Event,IdempotencyConflictError2 as IdempotencyConflictError,IdempotencyKeyRequiredError2 as IdempotencyKeyRequiredError,IdempotencyKeyReusedError2 as IdempotencyKeyReusedError,Inbox2 as Inbox,InvalidInputError2 as InvalidInputError,MOIRAI_ACTION_LOCK2 as MOIRAI_ACTION_LOCK,MOIRAI_EVENT_EFFECT,MOIRAI_IDEMPOTENCY_STORE2 as MOIRAI_IDEMPOTENCY_STORE,MOIRAI_INBOX_STORE2 as MOIRAI_INBOX_STORE,MOIRAI_MODULE_OPTIONS2 as MOIRAI_MODULE_OPTIONS,MOIRAI_OPTIONS2 as MOIRAI_OPTIONS,MOIRAI_OUTBOX_STORE2 as MOIRAI_OUTBOX_STORE,MemoryActionLock,MemoryIdempotencyStore,MemoryInboxStore,MemoryOutboxStore,MissingStoreError2 as MissingStoreError,Moirai,MoiraiModule,Outbox2 as Outbox,Query,UnknownEffectError2 as UnknownEffectError,UnknownEventConsumerError2 as UnknownEventConsumerError,backoffMs2 as backoffMs,effectHandler2 as effectHandler,isTransientError2 as isTransientError,registerEffect2 as registerEffect,requestHash,uuidv72 as uuidv7};
+import{IdempotencyKeyRequiredError2,IdempotencyKeyReusedError2,IdempotencyConflictError2,InvalidInputError2,CallForbiddenError2,MissingStoreError2,UnknownEffectError2,DuplicateEventConsumerError2,UnknownEventConsumerError2,MOIRAI_IDEMPOTENCY_STORE2,MOIRAI_OUTBOX_STORE2,MOIRAI_INBOX_STORE2,MOIRAI_ACTION_LOCK2,MOIRAI_OPTIONS2,MOIRAI_MODULE_OPTIONS2,isTransientError2,DEFAULT_OPTIONS,options,idempotencyStore,actionLock,inOwnerModule,uuidv72,effectHandler2,registerEffect2,backoffMs2,Outbox2,Inbox2}from"./index-2t45ppfs.js";var __legacyDecorateClassTS=function(decorators,target,key,desc){var c=arguments.length,r=c<3?target:desc===null?desc=Object.getOwnPropertyDescriptor(target,key):desc,d;if(typeof Reflect==="object"&&typeof Reflect.decorate==="function")r=Reflect.decorate(decorators,target,key,desc);else for(var i=decorators.length-1;i>=0;i--)if(d=decorators[i])r=(c<3?d(r):c>3?d(target,key,r):d(target,key))||r;return c>3&&r&&Object.defineProperty(target,key,r),r};import{currentUserId,DATABASE_TRANSACTION_SERVICE,DomainError,Metadata,Service}from"@elysiumjs/core";import{UnitOfWork}from"@elysiumjs/mnemosyne";import Value from"typebox/value";var canonical=(value)=>{if(typeof value==="bigint")return value.toString();if(Array.isArray(value))return value.map(canonical);if(value instanceof Date)return value.toISOString();if(value!==null&&typeof value==="object")return Object.fromEntries(Object.keys(value).sort().map((key)=>[key,canonical(value[key])]));return value},requestHash=async(input)=>{let bytes=new TextEncoder().encode(JSON.stringify(canonical(input))??"null"),digest=await crypto.subtle.digest("SHA-256",bytes);return[...new Uint8Array(digest)].map((byte)=>byte.toString(16).padStart(2,"0")).join("")};import{Module}from"@elysiumjs/core";var build=(option)=>typeof option==="function"?option():option,definitions=(config,global)=>{let{idempotency,outbox,inbox,lock,...rest}=config,stores=[[MOIRAI_IDEMPOTENCY_STORE2,idempotency],[MOIRAI_OUTBOX_STORE2,outbox],[MOIRAI_INBOX_STORE2,inbox],[MOIRAI_ACTION_LOCK2,lock]];return[...global?[{name:MOIRAI_OPTIONS2,global,factory:()=>({...DEFAULT_OPTIONS,...rest})}]:Object.keys(rest).length>0?[{name:MOIRAI_MODULE_OPTIONS2,global,factory:()=>({...rest})}]:[],...stores.filter(([,option])=>option!==void 0).map(([name,option])=>({name,global,factory:()=>build(option)}))]},moduleStores=(config)=>definitions(config,!1);class MoiraiModule extends Module.configurable(){}MoiraiModule=__legacyDecorateClassTS([Module.register({services:(config)=>definitions(config,!0)})],MoiraiModule);var ACTION=Symbol.for("elysium:moirai:action"),QUERY=Symbol.for("elysium:moirai:query");class Action{static register(props){return(target)=>{Metadata.define(ACTION,{...props,name:props.name??target.name},target)}}}class Query{static register(props){return(target)=>{Metadata.define(QUERY,{...props,name:props.name??target.name},target)}}}var instanceOf=(target)=>Service.get(target)??Service.make(target),validate=(schema,raw,name)=>{if(schema===void 0)return;let value=Value.Default(schema,structuredClone(raw)),errors=[...Value.Errors(schema,value)];if(errors.length>0)throw new InvalidInputError2(name,errors.map((error)=>({pointer:`/${error.instancePath?.replace(/^\//,"")??""}`,message:error.message})));return value},unwrap=(result)=>{if(result instanceof DomainError)throw result;return result},settle=async(call)=>{try{return await call()}catch(error){if(error instanceof DomainError)return error;throw error}},Moirai;((Moirai)=>{Moirai.execute=(action,...[input,call={}])=>settle(()=>{let props=Metadata.get(ACTION,action);if(!props)throw TypeError(`${action.name} is not marked with @Action.register().`);return inOwnerModule(action,()=>run(action,props,input,call))}),Moirai.stores=(stores)=>moduleStores(stores);let run=async(action,props,input,call)=>{let{name,idempotent=!1,transactional=!0,retry=!0}=props,config=options(),value=validate(props.input,input,name);if(props.authorize&&!await props.authorize(value))throw new CallForbiddenError2(name);let key=call.idempotencyKey;if(idempotent&&!key)throw new IdempotencyKeyRequiredError2(name);let storedKey=idempotent?[call.scope??props.scope?.(value)??currentUserId()??"anonymous",name,key].map(encodeURIComponent).join(":"):void 0,body=async(attempt)=>{let release=props.serializeBy?await actionLock().lock(props.serializeBy(value)):void 0;try{let handler=instanceOf(action),context={name,idempotencyKey:key,attempt};if(!idempotent)return unwrap(await handler.handle(value,context));let store=idempotencyStore(),hash=await requestHash(value),seen=await store.get(storedKey);if(seen){if(seen.action===name&&seen.requestHash===hash)return seen.response;throw new IdempotencyKeyReusedError2(key)}let response=unwrap(await handler.handle(value,context));return await store.put({key:storedKey,action:name,requestHash:hash,response:response===void 0?null:JSON.parse(JSON.stringify(response)),createdAt:new Date}),response}finally{release?.()}},transaction=transactional&&Service.exists(DATABASE_TRANSACTION_SERVICE);if(transaction&&UnitOfWork.active())return body(1);for(let attempt=1;;attempt++)try{return transaction?await UnitOfWork.run(()=>body(attempt),{connection:props.connection}):await body(attempt)}catch(error){let policy=typeof retry==="object"?retry:{},attempts=retry===!1?1:policy.attempts??config.maxAttempts,transient=policy.isTransient??config.isTransient;if(!(attempt<attempts&&transient(error)))throw error}};Moirai.ask=(query,...[input])=>settle(async()=>{let props=Metadata.get(QUERY,query);if(!props)throw TypeError(`${query.name} is not marked with @Query.register().`);let value=validate(props.input,input,props.name);if(props.authorize&&!await props.authorize(value))throw new CallForbiddenError2(props.name);return instanceOf(query).handle(value,{name:props.name,attempt:1})})})(Moirai||={});import{Service as Service2}from"@elysiumjs/core";var MOIRAI_EVENT_EFFECT="moirai.event",CONSUMERS=new Map;registerEffect2(MOIRAI_EVENT_EFFECT,async(payload,row)=>{let delivery=payload,handler=CONSUMERS.get(delivery.consumer);if(!handler)throw new UnknownEventConsumerError2(delivery.consumer,delivery.event);await inOwnerModule(handler.owner,()=>Inbox2.once({messageId:delivery.id,consumer:delivery.consumer},async()=>{await handler.run(delivery.payload,{id:delivery.id,event:delivery.event,publishedAt:new Date(delivery.publishedAt),attempt:row.attempts+1})}))},{attempts:(row)=>CONSUMERS.get(row.payload?.consumer??"")?.attempts});var Event;((Event)=>(Event.on=(event,options={})=>(target,method,_descriptor)=>{let isStatic=typeof target==="function",owner=isStatic?target:target.constructor,consumer=options.consumer??`${owner.name}.${String(method)}`;if(CONSUMERS.has(consumer))throw new DuplicateEventConsumerError2(consumer);let{retry}=options;CONSUMERS.set(consumer,{event,owner,attempts:retry===!1?1:retry?.attempts,run:(payload,meta)=>(isStatic?owner:Service2.get(owner)??Service2.make(owner))[method](payload,meta)})},Event.publish=async(event,payload)=>{let publishedAt=new Date,id=uuidv72(publishedAt.getTime()),deliveries=[...CONSUMERS].filter(([,handler])=>handler.event===event).map(([consumer])=>({kind:MOIRAI_EVENT_EFFECT,payload:{id,event,consumer,payload,publishedAt:publishedAt.toISOString()}}));return await Outbox2.enqueue(...deliveries),id},Event.consumersOf=(event)=>[...CONSUMERS].filter(([,handler])=>handler.event===event).map(([consumer])=>consumer)))(Event||={});import{UnitOfWork as UnitOfWork2}from"@elysiumjs/mnemosyne";class MemoryIdempotencyStore{#records=new Map;async get(key){let record=this.#records.get(key);return record?structuredClone(record):void 0}async put(record){if(this.#records.has(record.key))throw new IdempotencyConflictError2(record.key);this.#records.set(record.key,structuredClone(record))}}class MemoryActionLock{#tails=new Map;async lock(key){let previous=this.#tails.get(key)??Promise.resolve(),release,current=new Promise((resolve)=>release=resolve),tail=previous.then(()=>current);return this.#tails.set(key,tail),await previous,()=>{if(release(),this.#tails.get(key)===tail)this.#tails.delete(key)}}}class MemoryOutboxStore{#rows=new Map;get rows(){return[...this.#rows.values()].map((row)=>({...row}))}async insert(rows){for(let row of rows)this.#rows.set(row.id,{...row});UnitOfWork2.afterRollback(()=>{for(let row of rows)this.#rows.delete(row.id)})}async claimDue(claim){let{now,leaseUntil,limit,kinds,ids}=claim;if(kinds?.length===0||ids?.length===0)return[];let due=[...this.#rows.values()].filter((row)=>row.dispatchedAt===null&&row.deadAt===null&&row.availableAt.getTime()<=now.getTime()&&(!kinds||kinds.includes(row.kind))&&(!ids||ids.includes(row.id))).sort((a,b)=>a.availableAt.getTime()-b.availableAt.getTime()).slice(0,limit);for(let row of due)this.#rows.set(row.id,{...row,availableAt:leaseUntil});return due.map((row)=>({...row,availableAt:leaseUntil}))}async markDispatched(id,dispatchedAt){this.#update(id,{dispatchedAt})}async markFailed(id,update){this.#update(id,update)}async markDead(id,update){this.#update(id,update)}#update(id,update){let row=this.#rows.get(id);if(row)this.#rows.set(id,{...row,...update})}}class MemoryInboxStore{#seen=new Set;async record(messageId,consumer){let key=`${consumer}\x00${messageId}`;if(this.#seen.has(key))return!1;return this.#seen.add(key),UnitOfWork2.afterRollback(()=>void this.#seen.delete(key)),!0}}export{Action,CallForbiddenError2 as CallForbiddenError,DuplicateEventConsumerError2 as DuplicateEventConsumerError,Event,IdempotencyConflictError2 as IdempotencyConflictError,IdempotencyKeyRequiredError2 as IdempotencyKeyRequiredError,IdempotencyKeyReusedError2 as IdempotencyKeyReusedError,Inbox2 as Inbox,InvalidInputError2 as InvalidInputError,MOIRAI_ACTION_LOCK2 as MOIRAI_ACTION_LOCK,MOIRAI_EVENT_EFFECT,MOIRAI_IDEMPOTENCY_STORE2 as MOIRAI_IDEMPOTENCY_STORE,MOIRAI_INBOX_STORE2 as MOIRAI_INBOX_STORE,MOIRAI_MODULE_OPTIONS2 as MOIRAI_MODULE_OPTIONS,MOIRAI_OPTIONS2 as MOIRAI_OPTIONS,MOIRAI_OUTBOX_STORE2 as MOIRAI_OUTBOX_STORE,MemoryActionLock,MemoryIdempotencyStore,MemoryInboxStore,MemoryOutboxStore,MissingStoreError2 as MissingStoreError,Moirai,MoiraiModule,Outbox2 as Outbox,Query,UnknownEffectError2 as UnknownEffectError,UnknownEventConsumerError2 as UnknownEventConsumerError,backoffMs2 as backoffMs,effectHandler2 as effectHandler,isTransientError2 as isTransientError,registerEffect2 as registerEffect,requestHash,uuidv72 as uuidv7};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elysiumjs/moirai",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "description": "Actions, queries, idempotency, outbox, inbox and domain events for the Elysium.js framework.",
   "private": false,
@@ -62,16 +62,16 @@
     "typebox": "^1.3.0"
   },
   "devDependencies": {
-    "@elysiumjs/core": "0.11.0",
+    "@elysiumjs/core": "0.11.1",
     "@elysiumjs/heracles": "0.8.0",
-    "@elysiumjs/mnemosyne": "0.4.0",
+    "@elysiumjs/mnemosyne": "0.5.0",
     "@elysiumjs/redis": "0.1.0",
     "elysia": "^2.0.0-rc.1"
   },
   "peerDependencies": {
-    "@elysiumjs/core": "^0.11.0",
+    "@elysiumjs/core": "^0.11.1",
     "@elysiumjs/heracles": "^0.8.0",
-    "@elysiumjs/mnemosyne": "^0.4.0"
+    "@elysiumjs/mnemosyne": "^0.5.0"
   },
   "peerDependenciesMeta": {
     "@elysiumjs/heracles": {