zeus-api-types 1.0.0

package/README.md

@@ -0,0 +1,28 @@
+# zeus-api-types
+
+Shared TypeScript types for the Wagtales API.
+
+## Installation
+
+```bash
+npm install zeus-api-types
+```
+
+## Usage
+
+```typescript
+import { ApiError, NarrativeChunkEventPayload } from 'zeus-api-types';
+```
+
+## Exports
+
+- **ApiError, ApiErrorResponse** - Standard API error types
+- **NarrativeSSEEventPayload** - Server-Sent Event payloads for narrative streaming
+  - `NarrativeStartEventPayload`
+  - `NarrativeChunkEventPayload`
+  - `NarrativeCompleteEventPayload`
+  - `NarrativeMetadataEventPayload`
+  - `MetadataEventPayload`
+  - `DoneEventPayload`
+  - `ErrorEventPayload`
+

package/dist/errors.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Standard API error object
+ */
+export interface ApiError {
+    code: string;
+    message: string;
+    timestamp: string;
+    requestId: string;
+    details?: unknown;
+}
+/**
+ * Standard API error response envelope
+ */
+export interface ApiErrorResponse {
+    error: ApiError;
+}

package/dist/errors.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { ApiError, ApiErrorResponse } from './errors';
+export { NarrativeStartEventPayload, NarrativeChunkEventPayload, NarrativeCompleteEventPayload, NarrativeMetadataEventPayload, MetadataEventPayload, DoneEventPayload, ErrorEventPayload, NarrativeSSEEventPayload, } from './sse/narrative';

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sse/narrative.d.ts

@@ -0,0 +1,77 @@
+/**
+ * SSE Event Payloads for narrative streaming
+ */
+/**
+ * Sent when narrative generation starts
+ */
+export interface NarrativeStartEventPayload {
+    turnId: string;
+    timestamp: string;
+}
+/**
+ * Sent for each chunk of narrative text
+ */
+export interface NarrativeChunkEventPayload {
+    text: string;
+    index: number;
+}
+/**
+ * Sent when narrative generation completes
+ */
+export interface NarrativeCompleteEventPayload {
+    turnId: string;
+    totalChunks: number;
+    timestamp: string;
+}
+/**
+ * Sent with narrative metadata (tone, characters, etc.)
+ */
+export interface NarrativeMetadataEventPayload {
+    tone?: string;
+    characters?: string[];
+    location?: string;
+    [key: string]: unknown;
+}
+/**
+ * Generic metadata event payload
+ */
+export interface MetadataEventPayload {
+    [key: string]: unknown;
+}
+/**
+ * Sent when the SSE stream is done
+ */
+export interface DoneEventPayload {
+    success: boolean;
+    timestamp: string;
+}
+/**
+ * Sent when an error occurs during streaming
+ */
+export interface ErrorEventPayload {
+    code: string;
+    message: string;
+    timestamp: string;
+}
+/**
+ * Union type for all narrative SSE event payloads
+ */
+export type NarrativeSSEEventPayload = {
+    type: 'start';
+    data: NarrativeStartEventPayload;
+} | {
+    type: 'chunk';
+    data: NarrativeChunkEventPayload;
+} | {
+    type: 'complete';
+    data: NarrativeCompleteEventPayload;
+} | {
+    type: 'metadata';
+    data: NarrativeMetadataEventPayload;
+} | {
+    type: 'done';
+    data: DoneEventPayload;
+} | {
+    type: 'error';
+    data: ErrorEventPayload;
+};

package/dist/sse/narrative.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * SSE Event Payloads for narrative streaming
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "zeus-api-types",
+  "version": "1.0.0",
+  "description": "Shared API types for Wagtales - SSE payloads, error types, and common interfaces",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "wagtales",
+    "api",
+    "types",
+    "typescript",
+    "sse"
+  ],
+  "author": "Lovebowls",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lovebowls/zeus-api-types"
+  },
+  "homepage": "https://github.com/lovebowls/zeus-api-types#readme",
+  "bugs": {
+    "url": "https://github.com/lovebowls/zeus-api-types/issues"
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "rimraf": "^5.0.0",
+    "typescript": "^5.0.0"
+  }
+}
+