@aiworkbench/vibe-types 0.0.1

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@aiworkbench/vibe-types",
+  "version": "0.0.1",
+  "publishConfig": { "access": "public" },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target=node && tsc --emitDeclarationOnly",
+    "dev": "tsc --watch --emitDeclarationOnly",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "files": ["dist", "src"]
+}

package/src/index.ts

@@ -0,0 +1,154 @@
+/**
+ * @aiworkbench/vibe-types
+ *
+ * Bridge interface — the contract between the Host application
+ * and micro-frontend mini-apps.
+ *
+ * The Host injects a bridge object into each mini-app based on
+ * the permissions declared in its manifest.json.
+ */
+
+// ---------------------------------------------------------------------------
+// Capability type
+// ---------------------------------------------------------------------------
+
+export type BridgeCapability =
+  | "auth"
+  | "api"
+  | "navigation"
+  | "theme"
+  | "toast"
+  | "storage"
+  | "events";
+
+// ---------------------------------------------------------------------------
+// Auth
+// ---------------------------------------------------------------------------
+
+export interface BridgeUser {
+  id: string;
+  name: string;
+  email?: string;
+}
+
+export interface AuthBridge {
+  getUser(): BridgeUser;
+  getToken(): Promise<string>;
+}
+
+// ---------------------------------------------------------------------------
+// Navigation
+// ---------------------------------------------------------------------------
+
+export interface NavigationBridge {
+  navigate(path: string): void;
+}
+
+// ---------------------------------------------------------------------------
+// Theme
+// ---------------------------------------------------------------------------
+
+export interface ThemeBridge {
+  current(): "light" | "dark";
+}
+
+// ---------------------------------------------------------------------------
+// Toast
+// ---------------------------------------------------------------------------
+
+export interface ToastBridge {
+  show(
+    message: string,
+    options?: { type?: "info" | "success" | "error" },
+  ): void;
+}
+
+// ---------------------------------------------------------------------------
+// API
+// ---------------------------------------------------------------------------
+
+export interface ApiBridge {
+  fetch(endpoint: string, options?: RequestInit): Promise<Response>;
+}
+
+// ---------------------------------------------------------------------------
+// Storage — namespaced key-value persistence
+// ---------------------------------------------------------------------------
+
+export interface StorageBridge {
+  /** Get a value by key. Returns null if not found. */
+  get(key: string): Promise<string | null>;
+  /** Set a key-value pair. */
+  set(key: string, value: string): Promise<void>;
+  /** Remove a key. */
+  remove(key: string): Promise<void>;
+  /** List all keys in this mini-app's namespace. */
+  keys(): Promise<string[]>;
+}
+
+// ---------------------------------------------------------------------------
+// Events — typed pub/sub between mini-app and host
+// ---------------------------------------------------------------------------
+
+export interface EventPayload {
+  [key: string]: unknown;
+}
+
+export interface EventsBridge {
+  /** Emit an event to the host. */
+  emit(event: string, payload?: EventPayload): void;
+  /** Subscribe to events from the host. Returns an unsubscribe function. */
+  on(event: string, handler: (payload: EventPayload) => void): () => void;
+  /** Subscribe once, then auto-unsubscribe. Returns an unsubscribe function. */
+  once(event: string, handler: (payload: EventPayload) => void): () => void;
+}
+
+// ---------------------------------------------------------------------------
+// Composite Bridge
+// ---------------------------------------------------------------------------
+
+export interface Bridge {
+  auth: AuthBridge;
+  navigation: NavigationBridge;
+  theme: ThemeBridge;
+  toast: ToastBridge;
+  api: ApiBridge;
+  storage: StorageBridge;
+  events: EventsBridge;
+}
+
+/** Props passed to every mini-app component. */
+export interface VibeProps {
+  bridge: Bridge;
+}
+
+/** Manifest schema for a mini-app. */
+export interface VibeManifest {
+  id: string;
+  version: string;
+  framework: "react" | "vue" | "vanilla";
+  permissions: BridgeCapability[];
+  description: string;
+  entry?: string;
+}
+
+// ---------------------------------------------------------------------------
+// Registry — published mini-app metadata
+// ---------------------------------------------------------------------------
+
+/** A published mini-app entry in the registry. */
+export interface RegistryEntry extends VibeManifest {
+  /** URL to the ES module bundle on storage. */
+  bundleUrl: string;
+  /** SRI hash (sha384-…). */
+  integrity: string;
+  /** Raw bundle size in bytes. */
+  bundleSizeBytes?: number;
+  /** ISO 8601 publish timestamp. */
+  publishedAt: string;
+  /** Publisher identity (e.g. GitHub username). */
+  publishedBy: string;
+}
+
+/** An environment's apps.json file — an array of published entries. */
+export type RegistryManifest = RegistryEntry[];