@bernierllc/flow-lifecycle-events 0.0.1 → 0.1.0

package/dist/emitter.d.ts

@@ -0,0 +1,40 @@
+import type { FlowLifecycleEventMap, FlowLifecycleEventName } from './types';
+/**
+ * Type-safe listener function for a specific flow lifecycle event.
+ */
+export type FlowLifecycleListener<K extends FlowLifecycleEventName> = (payload: FlowLifecycleEventMap[K]) => void;
+/**
+ * Typed lifecycle event emitter for flow engine observability.
+ *
+ * Wraps Node.js `EventEmitter` to provide a type-safe API for all flow
+ * lifecycle events: item operations, definition management, and engine status.
+ *
+ * This emitter is for internal observability only — it is distinct from
+ * Nevar triggers which drive business logic.
+ */
+export declare class FlowLifecycleEmitter {
+    private readonly emitter;
+    constructor();
+    /**
+     * Subscribe to a lifecycle event with a typed listener.
+     */
+    on<K extends FlowLifecycleEventName>(event: K, listener: FlowLifecycleListener<K>): void;
+    /**
+     * Unsubscribe a listener from a lifecycle event.
+     */
+    off<K extends FlowLifecycleEventName>(event: K, listener: FlowLifecycleListener<K>): void;
+    /**
+     * Emit a lifecycle event with a typed payload.
+     *
+     * Wraps errors thrown by listeners in `FlowLifecycleError` with cause chaining.
+     */
+    emit<K extends FlowLifecycleEventName>(event: K, payload: FlowLifecycleEventMap[K]): void;
+    /**
+     * Remove all listeners for a specific event, or all listeners if no event is specified.
+     */
+    removeAllListeners(event?: FlowLifecycleEventName): void;
+    /**
+     * Get the number of listeners for a lifecycle event.
+     */
+    listenerCount(event: FlowLifecycleEventName): number;
+}

package/dist/emitter.js

@@ -0,0 +1,74 @@
+"use strict";
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowLifecycleEmitter = void 0;
+const node_events_1 = require("node:events");
+const errors_1 = require("./errors");
+/**
+ * Typed lifecycle event emitter for flow engine observability.
+ *
+ * Wraps Node.js `EventEmitter` to provide a type-safe API for all flow
+ * lifecycle events: item operations, definition management, and engine status.
+ *
+ * This emitter is for internal observability only — it is distinct from
+ * Nevar triggers which drive business logic.
+ */
+class FlowLifecycleEmitter {
+    emitter;
+    constructor() {
+        this.emitter = new node_events_1.EventEmitter();
+    }
+    /**
+     * Subscribe to a lifecycle event with a typed listener.
+     */
+    on(event, listener) {
+        this.emitter.on(event, listener);
+    }
+    /**
+     * Unsubscribe a listener from a lifecycle event.
+     */
+    off(event, listener) {
+        this.emitter.off(event, listener);
+    }
+    /**
+     * Emit a lifecycle event with a typed payload.
+     *
+     * Wraps errors thrown by listeners in `FlowLifecycleError` with cause chaining.
+     */
+    emit(event, payload) {
+        try {
+            this.emitter.emit(event, payload);
+        }
+        catch (error) {
+            throw new errors_1.FlowLifecycleError(`Failed to emit lifecycle event: ${event}`, {
+                cause: error instanceof Error ? error : new Error(String(error)),
+                code: 'LIFECYCLE_EMIT_ERROR',
+                context: { event },
+            });
+        }
+    }
+    /**
+     * Remove all listeners for a specific event, or all listeners if no event is specified.
+     */
+    removeAllListeners(event) {
+        if (event) {
+            this.emitter.removeAllListeners(event);
+        }
+        else {
+            this.emitter.removeAllListeners();
+        }
+    }
+    /**
+     * Get the number of listeners for a lifecycle event.
+     */
+    listenerCount(event) {
+        return this.emitter.listenerCount(event);
+    }
+}
+exports.FlowLifecycleEmitter = FlowLifecycleEmitter;

package/dist/errors.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Error class for flow lifecycle event operations.
+ */
+export declare class FlowLifecycleError extends Error {
+    readonly code: string;
+    readonly context?: Record<string, unknown>;
+    constructor(message: string, options?: {
+        cause?: Error;
+        code?: string;
+        context?: Record<string, unknown>;
+    });
+}

package/dist/errors.js

@@ -0,0 +1,24 @@
+"use strict";
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowLifecycleError = void 0;
+/**
+ * Error class for flow lifecycle event operations.
+ */
+class FlowLifecycleError extends Error {
+    code;
+    context;
+    constructor(message, options) {
+        super(message, { cause: options?.cause });
+        this.name = 'FlowLifecycleError';
+        this.code = options?.code ?? 'FLOW_LIFECYCLE_ERROR';
+        this.context = options?.context;
+    }
+}
+exports.FlowLifecycleError = FlowLifecycleError;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { FlowLifecycleEmitter } from './emitter';
+export type { FlowLifecycleListener } from './emitter';
+export type { FlowLifecycleEventMap, FlowLifecycleEventName, FlowDefinitionCreatedPayload, FlowDefinitionUpdatedPayload, FlowDefinitionDeletedPayload, FlowEngineStartedPayload, FlowEngineStoppedPayload, FlowEngineErrorPayload, } from './types';
+export { FlowLifecycleError } from './errors';
+/**
+ * All flow lifecycle event names as a readonly array, useful for iteration and validation.
+ */
+export declare const FLOW_LIFECYCLE_EVENT_NAMES: readonly ["flow.item.created", "flow.item.transitioned", "flow.item.entered_stage", "flow.item.exited_stage", "flow.item.assigned", "flow.item.completed", "flow.item.stale", "flow.definition.created", "flow.definition.updated", "flow.definition.deleted", "flow.engine.started", "flow.engine.stopped", "flow.engine.error"];

package/dist/index.js

@@ -0,0 +1,32 @@
+"use strict";
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FLOW_LIFECYCLE_EVENT_NAMES = exports.FlowLifecycleError = exports.FlowLifecycleEmitter = void 0;
+var emitter_1 = require("./emitter");
+Object.defineProperty(exports, "FlowLifecycleEmitter", { enumerable: true, get: function () { return emitter_1.FlowLifecycleEmitter; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "FlowLifecycleError", { enumerable: true, get: function () { return errors_1.FlowLifecycleError; } });
+/**
+ * All flow lifecycle event names as a readonly array, useful for iteration and validation.
+ */
+exports.FLOW_LIFECYCLE_EVENT_NAMES = [
+    'flow.item.created',
+    'flow.item.transitioned',
+    'flow.item.entered_stage',
+    'flow.item.exited_stage',
+    'flow.item.assigned',
+    'flow.item.completed',
+    'flow.item.stale',
+    'flow.definition.created',
+    'flow.definition.updated',
+    'flow.definition.deleted',
+    'flow.engine.started',
+    'flow.engine.stopped',
+    'flow.engine.error',
+];

package/dist/types.d.ts

@@ -0,0 +1,44 @@
+import type { FlowItemCreatedPayload, FlowItemTransitionedPayload, FlowItemEnteredStagePayload, FlowItemExitedStagePayload, FlowItemAssignedPayload, FlowItemCompletedPayload, FlowItemStalePayload } from '@bernierllc/flow-types';
+export interface FlowDefinitionCreatedPayload {
+    flowId: string;
+    name: string;
+}
+export interface FlowDefinitionUpdatedPayload {
+    flowId: string;
+    changes: string[];
+}
+export interface FlowDefinitionDeletedPayload {
+    flowId: string;
+}
+export interface FlowEngineStartedPayload {
+    timestamp: Date;
+}
+export interface FlowEngineStoppedPayload {
+    timestamp: Date;
+}
+export interface FlowEngineErrorPayload {
+    error: Error;
+    context: string;
+}
+/**
+ * Type-safe mapping of all flow lifecycle event names to their payload types.
+ */
+export interface FlowLifecycleEventMap {
+    'flow.item.created': FlowItemCreatedPayload;
+    'flow.item.transitioned': FlowItemTransitionedPayload;
+    'flow.item.entered_stage': FlowItemEnteredStagePayload;
+    'flow.item.exited_stage': FlowItemExitedStagePayload;
+    'flow.item.assigned': FlowItemAssignedPayload;
+    'flow.item.completed': FlowItemCompletedPayload;
+    'flow.item.stale': FlowItemStalePayload;
+    'flow.definition.created': FlowDefinitionCreatedPayload;
+    'flow.definition.updated': FlowDefinitionUpdatedPayload;
+    'flow.definition.deleted': FlowDefinitionDeletedPayload;
+    'flow.engine.started': FlowEngineStartedPayload;
+    'flow.engine.stopped': FlowEngineStoppedPayload;
+    'flow.engine.error': FlowEngineErrorPayload;
+}
+/**
+ * Union type of all flow lifecycle event names.
+ */
+export type FlowLifecycleEventName = keyof FlowLifecycleEventMap;

package/dist/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,10 +1,56 @@
 {
   "name": "@bernierllc/flow-lifecycle-events",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @bernierllc/flow-lifecycle-events",
+  "version": "0.1.0",
+  "description": "Typed lifecycle event emitter for flow engine observability",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "flow-engine",
+    "lifecycle",
+    "events",
+    "observability",
+    "typed-emitter"
+  ],
+  "author": "Bernier LLC",
+  "license": "SEE LICENSE IN LICENSE",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bernierllc/tools.git",
+    "directory": "packages/service/flow-lifecycle-events"
+  },
+  "dependencies": {
+    "@bernierllc/flow-types": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.5.0",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prebuild": "npm run clean",
+    "clean": "rimraf dist",
+    "test": "jest",
+    "test:run": "jest",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src __tests__ --ext .ts"
+  }
+}

package/README.md

@@ -1,45 +0,0 @@
-# @bernierllc/flow-lifecycle-events
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@bernierllc/flow-lifecycle-events`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**