@stateflowx/common 1.0.1 → 1.0.2

package/README.md

@@ -0,0 +1,34 @@
+# @stateflowx/common
+
+Shared contracts and type definitions used throughout the StateFlowX ecosystem.
+
+This package contains common interfaces, events, envelopes, and execution models shared between:
+
+- `@stateflowx/runtime`
+- `@stateflowx/client`
+
+## Installation
+
+```bash
+npm install @stateflowx/common
+```
+
+## Included Contracts
+
+Examples include:
+
+- `RuntimeEvent`
+- `RuntimeEnvelope`
+- `ExecutionContext`
+
+## Usage
+
+```typescript
+import {
+  RuntimeEvent,
+  RuntimeEnvelope,
+  ExecutionContext
+} from '@stateflowx/common';
+```
+
+Most application developers will not need to install this package directly. It is primarily intended for StateFlowX package development and shared contract definitions.

package/package.json

@@ -1,6 +1,25 @@
 {
   "name": "@stateflowx/common",
-  "version": "1.0.1",
+  "version": "1.0.2",
+  "description": "Shared contracts and types for StateFlowX runtime and client packages.",
+  "license": "Apache-2.0",
+  "author": "Burt Snyder",
+  "homepage": "https://github.com/NewJerseySoftware/stateflowx",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NewJerseySoftware/stateflowx.git"
+  },
+  "keywords": [
+    "stateflowx",
+    "workflow",
+    "orchestration",
+    "runtime",
+    "contracts",
+    "types"
+  ],
   "main": "dist/index.js",
-  "types": "dist/index.d.ts"
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ]
 }

package/events/runtime-envelope.ts

@@ -1,7 +0,0 @@
-import { RuntimeEvent } from './runtime-event.js';
-
-export interface RuntimeEnvelope {
-    type: 'runtime.event';
-
-    payload: RuntimeEvent;
-}

package/events/runtime-event.ts

@@ -1,8 +0,0 @@
-export interface RuntimeEvent {
-    id: string;
-    type: string;
-    timestamp: number;
-    source: string;
-    payload?: unknown;
-    metadata?: Record<string, unknown>;
-}

package/execution/execution-context.interface.ts

@@ -1,15 +0,0 @@
-export interface ExecutionContext {
-  id: string;
-
-  parentId?: string;
-
-  type: 'workflow' | 'service' | 'provider';
-
-  name: string;
-
-  startedAt: number;
-
-  completedAt?: number;
-
-  status: 'running' | 'completed' | 'failed';
-}

package/index.ts

@@ -1,4 +0,0 @@
-export * from './events/runtime-event.js';
-export * from './events/runtime-envelope.js';
-
-export * from './execution/execution-context.interface.js';