@sandeshnaroj/api-engine 1.0.0

package/dist/protocols/rest.d.ts

@@ -0,0 +1,3 @@
+import { Endpoint } from '../schemas/manifest';
+import { RequestOptions } from '../core/types';
+export declare const createRestAdapter: (baseUrl: string) => <T>(endpoint: Endpoint, options?: RequestOptions) => Promise<T>;

package/dist/protocols/socket.d.ts

@@ -0,0 +1,29 @@
+import { Endpoint } from '../schemas/manifest';
+export declare class SocketManager {
+    private endpoint;
+    private url;
+    private socket;
+    private subscribers;
+    private retryCount;
+    private reconnectTimer;
+    private heartbeatTimer;
+    constructor(endpoint: {
+        path: string;
+        autoReconnect?: boolean;
+        maxRetries?: number;
+        pingInterval?: number;
+    }, url: string);
+    connect(): void;
+    private reconnect;
+    private startHeartbeat;
+    private stopHeartbeat;
+    subscribe(callback: (data: any) => void): () => void;
+    send(data: any): void;
+    close(): void;
+}
+export interface SocketConnection {
+    send: (data: any) => void;
+    subscribe: (callback: (data: any) => void) => () => void;
+    close: () => void;
+}
+export declare const createSocketAdapter: (baseUrl: string) => (endpoint: Endpoint) => SocketManager;

package/dist/protocols/sse.d.ts

@@ -0,0 +1,11 @@
+import { Endpoint } from '../schemas/manifest';
+export interface WatchOptions {
+    headers?: Record<string, string>;
+    body?: any;
+    params?: Record<string, any>;
+}
+export interface SSEConnection {
+    subscribe: (callback: (data: any) => void) => () => void;
+    close: () => void;
+}
+export declare const createSSEAdapter: (baseUrl: string) => (endpoint: Endpoint, options?: WatchOptions) => SSEConnection;

package/dist/schemas/manifest.d.ts

@@ -0,0 +1,53 @@
+import * as v from 'valibot';
+export declare const EndpointSchema: v.VariantSchema<"protocol", [v.ObjectSchema<{
+    readonly protocol: v.LiteralSchema<"REST", undefined>;
+    readonly path: v.StringSchema<undefined>;
+    readonly method: v.PicklistSchema<["GET", "POST", "PUT", "DELETE"], undefined>;
+    readonly headers: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, {}>;
+    readonly options: v.OptionalSchema<v.ObjectSchema<{
+        readonly cache: v.OptionalSchema<v.PicklistSchema<["default", "no-store", "reload", "force-cache"], undefined>, undefined>;
+        readonly credentials: v.OptionalSchema<v.PicklistSchema<["include", "same-origin", "omit"], undefined>, undefined>;
+    }, undefined>, {}>;
+    readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, 5000>;
+}, undefined>, v.ObjectSchema<{
+    readonly protocol: v.LiteralSchema<"WS", undefined>;
+    readonly path: v.StringSchema<undefined>;
+    readonly autoReconnect: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+    readonly maxRetries: v.OptionalSchema<v.NumberSchema<undefined>, 5>;
+    readonly pingInterval: v.OptionalSchema<v.NumberSchema<undefined>, 30000>;
+}, undefined>, v.ObjectSchema<{
+    readonly protocol: v.LiteralSchema<"SSE", undefined>;
+    readonly path: v.StringSchema<undefined>;
+    readonly method: v.OptionalSchema<v.PicklistSchema<["GET", "POST"], undefined>, "GET">;
+    readonly headers: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, {}>;
+    readonly eventType: v.OptionalSchema<v.StringSchema<undefined>, "message">;
+}, undefined>], undefined>;
+export declare const ManifestSchema: v.ObjectSchema<{
+    readonly version: v.StringSchema<undefined>;
+    readonly baseUrl: v.StringSchema<undefined>;
+    readonly endpoints: v.RecordSchema<v.StringSchema<undefined>, v.VariantSchema<"protocol", [v.ObjectSchema<{
+        readonly protocol: v.LiteralSchema<"REST", undefined>;
+        readonly path: v.StringSchema<undefined>;
+        readonly method: v.PicklistSchema<["GET", "POST", "PUT", "DELETE"], undefined>;
+        readonly headers: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, {}>;
+        readonly options: v.OptionalSchema<v.ObjectSchema<{
+            readonly cache: v.OptionalSchema<v.PicklistSchema<["default", "no-store", "reload", "force-cache"], undefined>, undefined>;
+            readonly credentials: v.OptionalSchema<v.PicklistSchema<["include", "same-origin", "omit"], undefined>, undefined>;
+        }, undefined>, {}>;
+        readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, 5000>;
+    }, undefined>, v.ObjectSchema<{
+        readonly protocol: v.LiteralSchema<"WS", undefined>;
+        readonly path: v.StringSchema<undefined>;
+        readonly autoReconnect: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+        readonly maxRetries: v.OptionalSchema<v.NumberSchema<undefined>, 5>;
+        readonly pingInterval: v.OptionalSchema<v.NumberSchema<undefined>, 30000>;
+    }, undefined>, v.ObjectSchema<{
+        readonly protocol: v.LiteralSchema<"SSE", undefined>;
+        readonly path: v.StringSchema<undefined>;
+        readonly method: v.OptionalSchema<v.PicklistSchema<["GET", "POST"], undefined>, "GET">;
+        readonly headers: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, {}>;
+        readonly eventType: v.OptionalSchema<v.StringSchema<undefined>, "message">;
+    }, undefined>], undefined>, undefined>;
+}, undefined>;
+export type Manifest = v.InferOutput<typeof ManifestSchema>;
+export type Endpoint = v.InferOutput<typeof EndpointSchema>;

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@sandeshnaroj/api-engine",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "A lightweight, protocol-agnostic API client designed to unify REST, Server-Sent Events (SSE), and WebSockets (WS)",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "homepage": "https://github.com/sandeshnaroju/api-engine#readme",
+  "bugs": {
+    "url": "https://github.com/sandeshnaroju/api-engine/issues"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "vite",
+    "build": "vite build && tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "api",
+    "client",
+    "typescript",
+    "sse",
+    "websocket",
+    "rest",
+    "fetch",
+    "eventsource",
+    "axios"
+  ],
+  "sideEffects": false,
+  "author": "Naroju Sandesh",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sandeshnaroju/api-engine.git"
+  },
+  "dependencies": {
+    "@microsoft/fetch-event-source": "^2.0.1",
+    "axios": "^1.16.0",
+    "js-yaml": "^4.1.1",
+    "valibot": "^1.3.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-yaml": "^4.1.2",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.10"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "engineStrict": false
+}

package/readme.md

@@ -0,0 +1,3 @@
+### **APIEngine**
+
+A lightweight, protocol-agnostic API client designed to unify REST, Server-Sent Events (SSE), and WebSockets (WS). It transforms your API manifest into a strongly-typed, easy-to-use communication layer for modern web applications.