demo-pkg-dalana 0.0.2 → 0.0.5

package/README.md

@@ -1,4 +1,8 @@
-# zeyasdk
+# Zeya Development Kit (ZDK)
+
+The Zeya Development Kit (ZDK) is a TypeScript SDK designed to interact with various Zeya services, including configuration management, digital twins, and internal services like Flagger and Switchboard.
+
+## Installation and Usage
 
 To install dependencies:
 
@@ -12,4 +16,35 @@ To run:
 bun run index.ts
 ```
 
-This project was created using `bun init` in bun v1.3.6. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+## Modules
+ 
+Different modules can be found in the `src` folder.
+- Internal
+    - Flagger: client for the config backend
+    - Switchboard: client for the switchboard (proxy / event broker) backend
+
+- Public
+    - Digital Twin: client for the digital twin backend
+    - Config: configuration management module 
+    - Utils: utility functions and helpers
+
+# Responsibilities
+
+## Flagger
+Configuration management
+- tenant & app scoping (app can be a worklfow, backend service, or a simple script)
+
+## Switch Board
+Routing of payloads for both egress and ingress
+- Credentials
+- Rate limits, retries handling
+- Tracing
+
+## Digital Twin aka Integrator
+
+Integration with external world (CMS / Converse, Plato, Google, ...)
+- Caching
+- Validation
+- API augmentation / enrichment
+- Job-based requests
+- Shadow Execution

package/build.ts

@@ -0,0 +1,7 @@
+import dts from "bun-plugin-dts";
+
+await Bun.build({
+  entrypoints: ["./src/index.ts"],
+  outdir: "./dist",
+  plugins: [dts()],
+});

package/index.ts

@@ -1,7 +1 @@
-console.log("Hello via Bun!");
-
-export const Sdk = {
-  greet: function () {
-    return "Hello from the SDK!";
-  },
-};
+export * from "./src/index.ts";

package/package.json

@@ -2,11 +2,17 @@
   "name": "demo-pkg-dalana",
   "module": "index.ts",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "devDependencies": {
-    "@types/bun": "latest"
+    "@types/bun": "latest",
+    "bun-plugin-dts": "^0.3.0"
   },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "peerDependencies": {
     "typescript": "^5"
+  },
+  "dependencies": {
+    "windmill-client": "^1.616.0"
   }
 }

package/src/_internal/flagger/index.ts

@@ -0,0 +1,5 @@
+export const Flagger = {
+  get: () => {
+    throw new Error("Not implemented");
+  },
+};

package/src/_internal/index.ts

@@ -0,0 +1,13 @@
+type ZDKContext = {
+  appId: string;
+  tenantId: string;
+  branchId: string;
+};
+
+export type ZDKOptions = {
+  appId?: string;
+  tenantId?: string;
+  branchId?: string;
+};
+
+export async function init(options?: ZDKOptions) {}

package/src/_internal/switchboard/index.ts

@@ -0,0 +1,70 @@
+export interface HttpCallbackPayload {
+  body?: string;
+  method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+  headers?: Record<string, string>;
+  url: string;
+  callbacks: {
+    onSuccess: string;
+    onError?: string;
+  };
+}
+
+export interface RegisterEventCallbackPayload {
+  source: string;
+  filter: Record<string, unknown>;
+  url: string;
+}
+
+export class Switchboard {
+    
+  constructor(private baseUrl: string) {}
+  // will do the requested http call and call the success  or failure callbacks with the response
+  async registerHttpCallback(payload: HttpCallbackPayload): Promise<void> {
+    const response = await fetch(`${this.baseUrl}/proxy`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(payload),
+    });
+
+    if (!response.ok) {
+      throw new Error(
+        `Failed to register http callback: ${response.statusText}`,
+      );
+    }
+  }
+
+  // will register an event listener for the given event filter returns a context id
+  async registerEventCallback(
+    payload: RegisterEventCallbackPayload,
+  ): Promise<string> {
+    const response = await fetch(`${this.baseUrl}/register_event_handler`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(payload),
+    });
+
+    if (!response.ok) {
+      throw new Error(
+        `Failed to register event callback: ${response.statusText}`,
+      );
+    }
+
+    const data = (await response.json()) as { contextId: string };
+    return data.contextId;
+  }
+
+  // will deregister the event listener for the given context id
+  async deregisterEventCallback(contextId: string): Promise<void> {
+    const response = await fetch(`${this.baseUrl}/deregister_event_handler`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ contextId }),
+    });
+
+    if (!response.ok) {
+      throw new Error(
+        `Failed to deregister event callback: ${response.statusText}`,
+      );
+    }
+  }
+}

package/src/config/index.ts

@@ -0,0 +1,11 @@
+export class Config {
+  // validate and ensure the config schema is resolvable within the current context
+  static validate(schema: unknown) {
+    // call flagger with schema and current context
+    throw new Error("Not implemented");
+  }
+
+  static getConfig(key: string) {
+    throw new Error("Not implemented");
+  }
+}

package/src/digital-twin/index.ts

@@ -0,0 +1,4 @@
+export class DigitalTwin {
+  query() {}
+  mutate() {}
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import { init } from "./_internal/index";
+
+import { Config } from "./config";
+import { DigitalTwin } from "./digital-twin";
+
+await init();
+
+export { Config, DigitalTwin };

package/src/utils/chrono.ts

@@ -0,0 +1,4 @@
+export const Time = {
+  now: () => Date.now(),
+  toDateString: (timestamp: number) => new Date(timestamp).toDateString(),
+};