briyah 1.0.9 → 1.1.0

package/README.md

@@ -352,6 +352,115 @@ const messages = await appService.getRoomMessages(room.roomId);
 console.log(`Messages: ${messages.messages.length}`);
 ```
 
+### Example 6: Story Message Emitter
+
+The story message emitter delivers real-time events during gameplay. Subscribe to it after creating the story but before the first player turn, so no events are missed.
+
+```typescript
+import type {
+    StoryStateEvent,
+    StoryIntroduceCharacterEvent,
+    StoryProgressChapterEvent,
+    StoryErrorEvent,
+} from 'briyah';
+
+const app = briyah.getAppService('user-123');
+
+const story = await app.createStory(
+    'The Lost Kingdom',
+    'A medieval fantasy where ancient ruins hold a terrible secret',
+    'A disgraced knight seeking redemption'
+);
+
+const emitter = app.getStoryMessageEmitter(story.id);
+
+// Fires after every turn with the full updated game state.
+emitter.on('story-state', async (event: StoryStateEvent) => {
+    const { state } = event;
+    console.log('Latest message:', state.latestRoomMessage?.content);
+
+    // Detect the player's turn by comparing speaker names.
+    // Do NOT use state.humanPrompt for this — it is a UI display string,
+    // not a reliable turn indicator.
+    if (state.currentSpeaker === state.userAgentName) {
+        const input = await promptPlayer(state.humanPrompt);
+        await app.respondToStory(story.id, input);
+    }
+});
+
+// Fires when the narrator wants to introduce a new character.
+// The host app should present this to the player before acting.
+// Accept by calling introduceCharacterToStory, or decline with declineCharacter.
+emitter.on('suggest-introduce-character', async (event: StoryIntroduceCharacterEvent) => {
+    const accept = await askPlayer(`Add ${event.characterName} to the story?`);
+    if (accept) {
+        await app.introduceCharacterToStory(story.id, event.characterName!, '', undefined, true);
+    } else {
+        await app.declineCharacter(story.id, event.characterName!);
+    }
+});
+
+// Fires when the narrator wants to advance to the next chapter.
+// Call progressStory to accept. Ignoring the event stays in the current chapter —
+// there is no explicit rejection call.
+emitter.on('suggest-progress-chapter', async (_event: StoryProgressChapterEvent) => {
+    const accept = await askPlayer('The narrator suggests ending this chapter. Continue?');
+    if (accept) {
+        await app.progressStory(story.id);
+    }
+});
+
+// Fires on fatal errors during room processing.
+// Named 'story-error' rather than 'error' to avoid Node.js throwing when no
+// listener is attached.
+emitter.on('story-error', (event: StoryErrorEvent) => {
+    if (event.errorType === 'InsufficientBalanceError') {
+        console.error('Out of credits:', event.message);
+    } else {
+        console.error(`Story error [${event.errorType}]:`, event.message);
+    }
+});
+```
+
+### Example 7: Recording Payments and Managing Balance
+
+Briyah does not process payments itself — your application handles the payment provider interaction. Once a payment is confirmed, use `AppService` to record the transaction, credit the user's balance, and restart any stories that stalled due to insufficient funds.
+
+```typescript
+const app = briyah.getAppService(userId);
+
+// --- When your payment provider initiates a charge ---
+// Record it as pending so the transaction log stays consistent.
+await app.recordTransaction(amount, paymentIntentId, 'pending');
+
+// --- When your payment provider webhook confirms success ---
+await app.updateTransactionStatus(paymentIntentId, 'succeeded');
+await app.addBalance(amount);
+
+// Resume any stories that paused mid-turn due to InsufficientBalanceError.
+await app.resumePausedStories();
+
+// --- When a payment fails or is cancelled ---
+await app.updateTransactionStatus(paymentIntentId, 'failed');
+
+// --- Querying balance and history ---
+const balance = app.getBalance();
+
+const { transactions, total } = await app.getTransactions(50, 0);
+
+const tx = await app.getTransactionByPaymentId(paymentIntentId);
+console.log(tx?.status); // 'pending' | 'succeeded' | 'failed' | 'cancelled'
+```
+
+To push real-time balance updates to a connected client (e.g. via SSE), subscribe to the balance emitter before crediting the user:
+
+```typescript
+const emitter = app.getBalanceMessageEmitter(userId);
+emitter.on('update', (newBalance: number) => {
+    // Push newBalance to the client
+});
+```
+
 ## Data Storage
 
 Briyah stores data in the following structure:

package/dist/server/src/app/stripe.controller.js

@@ -30,16 +30,14 @@ let StripeController = class StripeController {
         const userId = req.user.userId;
         const { amount } = body;
         const appService = this.userServiceManager.getAppService(userId);
-        const transactionService = appService.getTransactionService();
-        const result = await this.stripeService.createPaymentIntent(userId, amount, transactionService);
+        const result = await this.stripeService.createPaymentIntent(userId, amount, appService);
         return result;
     }
     async createCheckoutSession(req, body) {
         const userId = req.user.userId;
         const { amount } = body;
         const appService = this.userServiceManager.getAppService(userId);
-        const transactionService = appService.getTransactionService();
-        const result = await this.stripeService.createCheckoutSession(userId, amount, transactionService);
+        const result = await this.stripeService.createCheckoutSession(userId, amount, appService);
         return result;
     }
     async getStripeConfig() {
@@ -95,8 +93,7 @@ let StripeController = class StripeController {
         const parsedLimit = limit ? parseInt(limit, 10) : 50;
         const parsedOffset = offset ? parseInt(offset, 10) : 0;
         const appService = this.userServiceManager.getAppService(userId);
-        const transactionService = appService.getTransactionService();
-        const result = await transactionService.getTransactions(parsedLimit, parsedOffset);
+        const result = await appService.getTransactions(parsedLimit, parsedOffset);
         return result;
     }
 };

package/dist/server/src/app/stripe.service.d.ts

@@ -1,5 +1,4 @@
 import Stripe from 'stripe';
-import { TransactionService } from './transaction.service';
 import { AppService } from '../app.service';
 type StripeInstance = ReturnType<typeof Stripe>;
 type StripeEvent = ReturnType<StripeInstance['webhooks']['constructEvent']>;
@@ -11,11 +10,11 @@ export declare class StripeService {
     private publishableKey;
     private webhookSecret;
     constructor();
-    createPaymentIntent(userId: string, amount: number, transactionService: TransactionService): Promise<{
+    createPaymentIntent(userId: string, amount: number, appService: AppService): Promise<{
         clientSecret: string;
         publishableKey: string;
     }>;
-    createCheckoutSession(userId: string, amount: number, transactionService: TransactionService): Promise<{
+    createCheckoutSession(userId: string, amount: number, appService: AppService): Promise<{
         url: string;
     }>;
     getStripeConfig(): {

package/dist/server/src/app/stripe.service.js

@@ -40,7 +40,7 @@ let StripeService = class StripeService {
         this.minPaymentAmount = parseFloat(process.env.MIN_PAYMENT_AMOUNT || '5.00');
         this.maxPaymentAmount = parseFloat(process.env.MAX_PAYMENT_AMOUNT || '500.00');
     }
-    async createPaymentIntent(userId, amount, transactionService) {
+    async createPaymentIntent(userId, amount, appService) {
         if (!amount || amount <= 0) {
             throw new common_1.BadRequestException('Amount must be greater than 0');
         }
@@ -62,7 +62,7 @@ let StripeService = class StripeService {
                     enabled: true,
                 },
             });
-            await transactionService.recordTransaction(amount, paymentIntent.id, 'pending');
+            await appService.recordTransaction(amount, paymentIntent.id, 'pending');
             return {
                 clientSecret: paymentIntent.client_secret,
                 publishableKey: this.publishableKey,
@@ -73,7 +73,7 @@ let StripeService = class StripeService {
             throw new common_1.InternalServerErrorException('Failed to create payment intent');
         }
     }
-    async createCheckoutSession(userId, amount, transactionService) {
+    async createCheckoutSession(userId, amount, appService) {
         if (!amount || amount <= 0) {
             throw new common_1.BadRequestException('Amount must be greater than 0');
         }
@@ -113,7 +113,7 @@ let StripeService = class StripeService {
                 },
             });
             if (session.payment_intent) {
-                await transactionService.recordTransaction(amount, session.payment_intent, 'pending');
+                await appService.recordTransaction(amount, session.payment_intent, 'pending');
             }
             return {
                 url: session.url,
@@ -148,8 +148,7 @@ let StripeService = class StripeService {
             }
             const amount = paymentIntent.amount / 100;
             logger_1.logger.log(`[Stripe Webhook] Amount: $${amount.toFixed(2)}`);
-            const transactionService = appService.getTransactionService();
-            const existingTransaction = await transactionService.getTransactionByPaymentIntent(paymentIntent.id);
+            const existingTransaction = await appService.getTransactionByPaymentId(paymentIntent.id);
             logger_1.logger.log(`[Stripe Webhook] Existing transaction:`, existingTransaction);
             if (existingTransaction?.status === 'succeeded') {
                 logger_1.logger.log(`Transaction ${paymentIntent.id} already processed, skipping`);
@@ -162,7 +161,7 @@ let StripeService = class StripeService {
             const balanceAfter = await appService.getBalance();
             logger_1.logger.log(`[Stripe Webhook] Balance after: $${balanceAfter.toFixed(2)}`);
             logger_1.logger.log(`[Stripe Webhook] Updating transaction status to 'succeeded'`);
-            await transactionService.updateTransactionStatus(paymentIntent.id, 'succeeded');
+            await appService.updateTransactionStatus(paymentIntent.id, 'succeeded');
             logger_1.logger.log(`[Stripe Webhook] Checking for paused stories to resume...`);
             const resumedCount = await appService.resumePausedStories();
             if (resumedCount > 0) {
@@ -182,8 +181,7 @@ let StripeService = class StripeService {
                 logger_1.logger.error('Payment Intent missing userId in metadata:', paymentIntent.id);
                 return;
             }
-            const transactionService = appService.getTransactionService();
-            await transactionService.updateTransactionStatus(paymentIntent.id, 'failed');
+            await appService.updateTransactionStatus(paymentIntent.id, 'failed');
             logger_1.logger.log(`Payment failed for user ${userId}: ${paymentIntent.id}`);
         }
         catch (error) {

package/dist/server/src/app/transaction.service.d.ts

@@ -5,9 +5,9 @@ export declare class TransactionService {
     private configService;
     private transactionsDir;
     constructor(userId: string, configService: ConfigurationService);
-    recordTransaction(amount: number, stripePaymentIntentId: string, status?: 'pending' | 'succeeded' | 'failed' | 'cancelled'): Promise<Transaction>;
-    updateTransactionStatus(paymentIntentId: string, status: 'pending' | 'succeeded' | 'failed' | 'cancelled'): Promise<void>;
-    getTransactionByPaymentIntent(paymentIntentId: string): Promise<Transaction | null>;
+    recordTransaction(amount: number, paymentId: string, status?: 'pending' | 'succeeded' | 'failed' | 'cancelled'): Promise<Transaction>;
+    updateTransactionStatus(paymentId: string, status: 'pending' | 'succeeded' | 'failed' | 'cancelled'): Promise<void>;
+    getTransactionByPaymentId(paymentId: string): Promise<Transaction | null>;
     getTransactions(limit?: number, offset?: number): Promise<{
         transactions: Transaction[];
         total: number;

package/dist/server/src/app/transaction.service.js

@@ -51,19 +51,19 @@ class TransactionService {
             fs.mkdirSync(this.transactionsDir, { recursive: true });
         }
     }
-    async recordTransaction(amount, stripePaymentIntentId, status = 'pending') {
+    async recordTransaction(amount, paymentId, status = 'pending') {
         const timestamp = Date.now();
         const transaction = {
             id: (0, zod_1.uuidv4)().toString(),
             userId: this.userId,
             amount,
             currency: 'usd',
-            stripePaymentIntentId,
+            paymentId,
             status,
             createdAt: timestamp,
             updatedAt: timestamp,
         };
-        const filename = `${timestamp}-${stripePaymentIntentId}.json`;
+        const filename = `${timestamp}-${paymentId}.json`;
         const filePath = path.join(this.transactionsDir, filename);
         try {
             fs.writeFileSync(filePath, JSON.stringify(transaction, null, 2), 'utf-8');
@@ -74,31 +74,31 @@ class TransactionService {
             throw error;
         }
     }
-    async updateTransactionStatus(paymentIntentId, status) {
+    async updateTransactionStatus(paymentId, status) {
         try {
-            const transaction = await this.getTransactionByPaymentIntent(paymentIntentId);
+            const transaction = await this.getTransactionByPaymentId(paymentId);
             if (!transaction) {
-                logger_1.logger.error(`Transaction not found for payment intent ${paymentIntentId}`);
+                logger_1.logger.error(`Transaction not found for payment ID ${paymentId}`);
                 return;
             }
             transaction.status = status;
             transaction.updatedAt = Date.now();
             const files = fs.readdirSync(this.transactionsDir);
-            const matchingFile = files.find((file) => file.includes(paymentIntentId));
+            const matchingFile = files.find((file) => file.includes(paymentId));
             if (matchingFile) {
                 const filePath = path.join(this.transactionsDir, matchingFile);
                 fs.writeFileSync(filePath, JSON.stringify(transaction, null, 2), 'utf-8');
             }
         }
         catch (error) {
-            logger_1.logger.error(`Error updating transaction status for ${paymentIntentId}:`, error);
+            logger_1.logger.error(`Error updating transaction status for ${paymentId}:`, error);
             throw error;
         }
     }
-    async getTransactionByPaymentIntent(paymentIntentId) {
+    async getTransactionByPaymentId(paymentId) {
         try {
             const files = fs.readdirSync(this.transactionsDir);
-            const matchingFile = files.find((file) => file.includes(paymentIntentId));
+            const matchingFile = files.find((file) => file.includes(paymentId));
             if (!matchingFile) {
                 return null;
             }
@@ -107,7 +107,7 @@ class TransactionService {
             return JSON.parse(content);
         }
         catch (error) {
-            logger_1.logger.error(`Error getting transaction for payment intent ${paymentIntentId}:`, error);
+            logger_1.logger.error(`Error getting transaction for payment ID ${paymentId}:`, error);
             return null;
         }
     }

package/dist/server/src/app.controller.js

@@ -1415,10 +1415,16 @@ let AppController = class AppController {
                 const updateHandler = (data) => {
                     subscriber.next({ data });
                 };
-                emitter.on('update', updateHandler);
+                emitter.on('story-state', updateHandler);
+                emitter.on('suggest-introduce-character', updateHandler);
+                emitter.on('suggest-progress-chapter', updateHandler);
+                emitter.on('story-error', updateHandler);
                 return () => {
                     logger_1.logger.log(`[SSE] Cleanup for story ${storyId}`);
-                    emitter.off('update', updateHandler);
+                    emitter.off('story-state', updateHandler);
+                    emitter.off('suggest-introduce-character', updateHandler);
+                    emitter.off('suggest-progress-chapter', updateHandler);
+                    emitter.off('story-error', updateHandler);
                 };
             });
         }

package/dist/server/src/app.service.d.ts

@@ -21,7 +21,7 @@ import { TransactionService } from './app/transaction.service';
 import { AgentFactory } from './ai/agent-factory';
 import { RoomFactory } from './room/room-factory';
 import { EventEmitter } from 'events';
-import { AgentInfo, RoomInfo, RoomDetails, CreateRoomResponse, FileList, PromptFileContent, PromptFoldersResponse, PromptFilesResponse, PromptScope, ProcessTextResponse, PreparedPromptResponse, AttachDocumentResponse, AgentMessagesResponse, RoomMessagesResponse, StoryInfo, StoryState, Character } from '../../shared/types/app.types';
+import { AgentInfo, RoomInfo, RoomDetails, CreateRoomResponse, FileList, PromptFileContent, PromptFoldersResponse, PromptFilesResponse, PromptScope, ProcessTextResponse, PreparedPromptResponse, AttachDocumentResponse, AgentMessagesResponse, RoomMessagesResponse, StoryInfo, StoryState, Character, Transaction, TransactionHistoryResponse } from '../../shared/types/app.types';
 import { RoomMessage } from './room/message';
 export declare class AppService {
     private readonly aiFactoryService;
@@ -166,7 +166,10 @@ export declare class AppService {
     savePlotPlan(storyId: string, content: string): Promise<void>;
     getBalance(): number;
     addBalance(amount: number): void;
-    getTransactionService(): TransactionService;
+    recordTransaction(amount: number, paymentId: string, status?: 'pending' | 'succeeded' | 'failed' | 'cancelled'): Promise<Transaction>;
+    updateTransactionStatus(paymentId: string, status: 'pending' | 'succeeded' | 'failed' | 'cancelled'): Promise<void>;
+    getTransactionByPaymentId(paymentId: string): Promise<Transaction | null>;
+    getTransactions(limit?: number, offset?: number): Promise<TransactionHistoryResponse>;
     listUserArtifacts(): ArtifactMetadata[];
     getUserArtifact(artifactId: string): string | Buffer | null;
     createUserArtifact(name: string, content: string): string;

package/dist/server/src/app.service.js

@@ -1155,8 +1155,17 @@ class AppService {
     addBalance(amount) {
         return this.balanceService.addBalance(amount);
     }
-    getTransactionService() {
-        return this.transactionService;
+    async recordTransaction(amount, paymentId, status = 'pending') {
+        return this.transactionService.recordTransaction(amount, paymentId, status);
+    }
+    async updateTransactionStatus(paymentId, status) {
+        return this.transactionService.updateTransactionStatus(paymentId, status);
+    }
+    async getTransactionByPaymentId(paymentId) {
+        return this.transactionService.getTransactionByPaymentId(paymentId);
+    }
+    async getTransactions(limit = 50, offset = 0) {
+        return this.transactionService.getTransactions(limit, offset);
     }
     listUserArtifacts() {
         return this.artifactService.listArtifacts();

package/dist/server/src/sdk/index.d.ts

@@ -1,7 +1,7 @@
 export { Briyah } from './briyah';
 export { BriyahConfigService, BriyahConfigOptions } from './briyah-config';
 export type { AppService } from '../app.service';
-export type { AgentInfo, CreateAgentResponse, RoomInfo, RoomDetails, CreateRoomResponse, StoryInfo, CreateStoryResponse, ProcessTextResponse, FileList, PromptFileContent, AttachDocumentResponse, AgentMessagesResponse, RoomMessagesResponse, StoryState, Message, MessageAction, ModelInfo, ArtifactMetadata, PreparedPromptResponse, PromptScope, PromptFolder, PromptFoldersResponse, PromptFile, PromptFilesResponse, StoryIdea, StorySuggestion, StoryMessageUpdate, Character, ChapterInfo, } from '../../../shared/types/app.types';
+export type { AgentInfo, CreateAgentResponse, RoomInfo, RoomDetails, CreateRoomResponse, StoryInfo, CreateStoryResponse, ProcessTextResponse, FileList, PromptFileContent, AttachDocumentResponse, AgentMessagesResponse, RoomMessagesResponse, StoryState, Message, MessageAction, ModelInfo, ArtifactMetadata, PreparedPromptResponse, PromptScope, PromptFolder, PromptFoldersResponse, PromptFile, PromptFilesResponse, StoryIdea, Transaction, TransactionHistoryResponse, StoryStateEvent, StoryIntroduceCharacterEvent, StoryProgressChapterEvent, StoryErrorEvent, Character, ChapterInfo, } from '../../../shared/types/app.types';
 export type { LoggingOptions } from './briyah-config';
 export { Agent } from '../ai/agent';
 export { Room } from '../room/room';

package/dist/server/src/story/story-message.service.d.ts

@@ -1,10 +1,12 @@
 import { EventEmitter } from 'events';
-import { StoryMessageUpdate } from '../../../shared/types/app.types';
+import { StoryState } from '../../../shared/types/app.types';
 export declare class StoryMessageService {
     private messageEmitters;
     getOrCreateEmitter(storyId: string): EventEmitter;
     getEmitter(storyId: string): EventEmitter | undefined;
-    emitUpdate(storyId: string, update: StoryMessageUpdate): void;
+    emitStoryState(storyId: string, state: StoryState): void;
+    emitIntroduceCharacter(storyId: string, characterName?: string): void;
+    emitProgressChapter(storyId: string): void;
     emitError(storyId: string, error: Error): void;
     cleanup(storyId: string): void;
 }

package/dist/server/src/story/story-message.service.js

@@ -22,25 +22,44 @@ let StoryMessageService = class StoryMessageService {
     getEmitter(storyId) {
         return this.messageEmitters.get(storyId);
     }
-    emitUpdate(storyId, update) {
+    emitStoryState(storyId, state) {
         const emitter = this.messageEmitters.get(storyId);
         if (emitter) {
-            const updateWithTimestamp = {
+            const payload = { type: 'story-state', state, timestamp: Date.now() };
+            emitter.emit('story-state', payload);
+        }
+    }
+    emitIntroduceCharacter(storyId, characterName) {
+        const emitter = this.messageEmitters.get(storyId);
+        if (emitter) {
+            const payload = {
+                type: 'suggest-introduce-character',
+                characterName,
                 timestamp: Date.now(),
-                ...update
             };
-            emitter.emit('update', updateWithTimestamp);
+            emitter.emit('suggest-introduce-character', payload);
         }
     }
-    emitError(storyId, error) {
+    emitProgressChapter(storyId) {
         const emitter = this.messageEmitters.get(storyId);
         if (emitter) {
-            emitter.emit('update', {
+            const payload = {
+                type: 'suggest-progress-chapter',
                 timestamp: Date.now(),
-                type: 'error',
+            };
+            emitter.emit('suggest-progress-chapter', payload);
+        }
+    }
+    emitError(storyId, error) {
+        const emitter = this.messageEmitters.get(storyId);
+        if (emitter) {
+            const payload = {
+                type: 'story-error',
                 errorType: error.name,
                 message: error.message,
-            });
+                timestamp: Date.now(),
+            };
+            emitter.emit('story-error', payload);
         }
     }
     cleanup(storyId) {

package/dist/server/src/story/story.service.js

@@ -138,10 +138,7 @@ let StoryService = class StoryService {
                 totalInputTokens: story.totalInputTokens || 0,
                 totalOutputTokens: story.totalOutputTokens || 0,
             };
-            this.messageService.emitUpdate(storyId, {
-                type: 'state',
-                state: stateUpdate
-            });
+            this.messageService.emitStoryState(storyId, stateUpdate);
         }
         catch (error) {
             logger_1.logger.error(`Error emitting story state update for ${storyId}:`, error);
@@ -1627,13 +1624,7 @@ let StoryService = class StoryService {
                 story.declinedCharacters = [];
                 this.storyStore.updateStoryMetadata(storyId, story);
             }
-            this.messageService.emitUpdate(storyId, {
-                type: 'suggestion',
-                suggestion: {
-                    type: 'progress_chapter',
-                    timestamp: Date.now()
-                }
-            });
+            this.messageService.emitProgressChapter(storyId);
             return;
         }
         let agentCompactionThreshold = Number(process.env.AGENT_COMPACTION_THRESHOLD) || 150000;
@@ -1647,14 +1638,7 @@ let StoryService = class StoryService {
                     logger_1.logger.log(`Character ${newCharacterName} was declined, skipping prompt`);
                     return;
                 }
-                this.messageService.emitUpdate(storyId, {
-                    type: 'suggestion',
-                    suggestion: {
-                        type: 'introduce_character',
-                        characterName: newCharacterName,
-                        timestamp: Date.now()
-                    }
-                });
+                this.messageService.emitIntroduceCharacter(storyId, newCharacterName);
             }
             return;
         }

package/dist/shared/types/app.types.d.ts

@@ -241,19 +241,25 @@ export interface StoryState {
     totalInputTokens: number;
     totalOutputTokens: number;
 }
-export interface StorySuggestion {
-    type: 'introduce_character' | 'progress_chapter';
+export interface StoryStateEvent {
+    type: 'story-state';
+    state: StoryState;
+    timestamp: number;
+}
+export interface StoryIntroduceCharacterEvent {
+    type: 'suggest-introduce-character';
     characterName?: string;
     timestamp: number;
 }
-export interface StoryMessageUpdate {
-    type: 'state' | 'suggestion' | 'error';
-    state?: StoryState;
-    suggestion?: StorySuggestion;
-    error?: {
-        message: string;
-        errorType?: string;
-    };
+export interface StoryProgressChapterEvent {
+    type: 'suggest-progress-chapter';
+    timestamp: number;
+}
+export interface StoryErrorEvent {
+    type: 'story-error';
+    message: string;
+    errorType?: string;
+    timestamp: number;
 }
 export interface ChaptersResponse {
     chapters: ChapterInfo[];
@@ -283,7 +289,7 @@ export interface Transaction {
     userId: string;
     amount: number;
     currency: string;
-    stripePaymentIntentId: string;
+    paymentId: string;
     status: 'pending' | 'succeeded' | 'failed' | 'cancelled';
     createdAt: number;
     updatedAt: number;

package/docs/assets/hierarchy.js

@@ -1 +1 @@
-window.hierarchyData = "eJx1jc0KgzAQhN9lzrFWwWLyDr30Kh6CWWtoTCCbniTvXtI/pNDTwM63822IISSGGjopR4FIs6Mp2eAZakMnZQmvV4LCmZj1lSBws95Atd1J4B4dFKxPFGc9Eddv6rCk1UFgcpoZColNVd6qL1rKxToTyUMNzbHvxyxQcue8hLD+epu2/3if68T1Dvsrfh1yzg8aB1Bi"
+window.hierarchyData = "eJx1jc0KwjAQhN9lzqklLRbdd/DitfQQ2tUG0wSy8VTy7hL/KIKngZ1v51sRQ0gC6jvdDgqRL47HZIMX0IpOtyW8WRiEE4uYK0PhZv0Eavadwj06EKxPHC9mZKnf1G5Oi4PC6IwICEmmqrxVX7SUs3VTZA/qtdbHISuU3DjPISy/Xt0cPt7nOku9wf6KX4ec8wP/YVA+"

package/docs/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "eJyN1sFO4zAQBuB38blalkrA0htbhIQEAtHdE+JgOdPEIrEte4qoEO+OEtJgN/bY1/y/v6buOOnzB0N4R7Zi9+Acr+FKoNSKLZjh2LAVA7Xr3EkQ/mqwa9mCvUpVsdWfz8VkXNWg8GetaLlz4E6Gy+Gq06W/7q+Ve97MF35fz69ca7WV9QbsmxSQYoISZT5p3c2R/mpu1bhN8cVjSBnDRt2qrf4RpEKwWy4O29inIbE8Oz8mxo9yT+CMVg7S3HGTpI2ZbbHvTTGJWJRbLjBOjGEJcA/IK46chA4lEkTkornWYteBQnrLolUK90fvwfSnx0XlSI9i1w03CDY5Kl6eYSwXCDaFfKckYYEjDLNEbl2kl2f7Y1Og+rU8ukFt9wVq0KPYG9nCnXTxkT6EFHCn61oqcj7CCoXNnkGeEn0EHS3XFbTJuZpSini0YLiF6tHqztBTEa/SuBbg3D94z8mzXobtDPY/Vkob4zJkrRUGr8KoNbbKSPphHukVsLqtEmffL5RCRXcYNim6P9XXgFy28SPh5TkmOc+HMAcUvVBjRQoeHjC3FcRfYVOaJ1LfbkqzxHjb/03FMf7l5rUsukESG+I8sqtrcOF/0pk0dfKjuhHaeDeFezPN5hAdCb8vL07Plp8vX/pW2ak="
+window.navigationData = "eJyNlk1P4zAQhv+Lz9WyVAJ2e2MLCCTQVpQb4mA508QisS17iqhW/PdVQpo6iT321e87j5PJfOT1H0P4RLZiT+AcL+FaoNSKLZjhWLEVA7Vv3NlI/FFhU7MFe5eqYKtfX4uBcV2CwlOsqLlz4M6643HU+dKP+2PlgVfzwO/zdORaq50st2A/pIAYZmSimM9aN3NIe5qK6tMUDu5FitEl6kHt9IkgFYLdcXFMY6uOEcuLyymiv8o9gzNaOYjjpk4SbcwsxT5vkEmIRbnjAsOIXswBPAHygiMnQUcTCUTkorrRYt+AQjplQSsF90vvr2m7xwXJAR+FXVfcINhoqXh6AmO5QLAxyLdKIixwhK6WyNQFfGls2zYZVN+Whm5R20MGdeSjsHeyhkfpwiV9FCnAoy5Lqcj6GFso2GwGeZTgCJqE6wLqaF0NKoXYWDDcQrGxujF0VYStNFwLcO4FPlPkmS+BbQy2HytG6+U8yForHK3CIKt35SHpYR7wZWB1XUR63zfkgrKecOyk0G1X3wByWYdbwtNTmGg9H8UUIGuhhowUuBswt9Zqe/sRK5aJJ4l7KCC8EQc1jYgla1AzEGh1sRcwrJDEG0YCkhdtrC4tONfvu8QtIXfyii1yDH/vk5wHSTzdyUPhXixXjk9+0j2Up2di7qVLbsS4PT0ctkIbj4oHM0yDTpoQfv6+Or9Yfr39ByjAXqw="