openrtc 0.1.3 → 0.2.1

package/env/index.d.ts

@@ -0,0 +1,64 @@
+/** Type declarations for the `openrtc/env` subpath (see index.mjs). */
+
+export interface EmulatorStack {
+  readonly projectId: string;
+  readonly functions: number;
+  readonly firestore: number;
+  readonly auth: number;
+  readonly ui: number;
+  readonly hub: number;
+  readonly logging: number;
+  readonly eventarc: number;
+  readonly tasks: number;
+  readonly database?: number;
+}
+
+export declare const EMULATOR_STACKS: {
+  readonly identity: EmulatorStack;
+  readonly signaling: EmulatorStack;
+};
+
+export declare const SEEDED_INTEGRATION_IDENTITY: {
+  readonly appTag: string;
+  readonly secretKey: string;
+};
+
+export type EmulatorStackName = 'signaling' | 'identity';
+
+export declare function emulatorEnv(stack?: EmulatorStackName): Readonly<Record<string, string>>;
+
+export declare function emulatorFunctionsUrls(): {
+  readonly signaling: string;
+  readonly identity: string;
+};
+
+export type OpenRtcEnvTier = 'local' | 'dev' | 'staging' | 'prod';
+
+export interface ResolvedOpenRtcEnv {
+  readonly tier: OpenRtcEnvTier;
+  readonly emulated: boolean;
+  readonly env: Readonly<Record<string, string>>;
+  readonly functionsUrls: { readonly signaling: string; readonly identity: string };
+  readonly seededIdentity: { readonly appTag: string; readonly secretKey: string } | null;
+}
+
+export declare function resolveOpenRtcEnv(tier?: OpenRtcEnvTier): ResolvedOpenRtcEnv;
+
+export declare function allEmulatorPorts(): readonly number[];
+
+export interface SeedEmulatorOptions {
+  readonly reset?: boolean;
+  readonly seedScript?: string;
+  readonly nodePath?: string;
+  readonly cwd?: string;
+  readonly env?: Readonly<Record<string, string>>;
+  readonly stdio?: 'inherit' | 'ignore' | 'pipe';
+}
+
+export interface SeedEmulatorResult {
+  readonly appTag: string;
+  readonly firestoreHost: string;
+  readonly seedScript: string;
+}
+
+export declare function seedEmulator(options?: SeedEmulatorOptions): Promise<SeedEmulatorResult>;

package/env/index.mjs

@@ -0,0 +1,230 @@
+/**
+ * OpenRTC environment/testing surface (`openrtc/env`).
+ *
+ * Canonical, dependency-free constants and helpers for wiring OpenRTC into an
+ * app's environment tiers. Hand-written ESM (no build step) so workspace
+ * scripts, boilerplates, and CI can import it directly with plain Node.
+ *
+ * Consumers: instead of copying emulator ports or the seeded integration
+ * identity into your own scripts, import them from here.
+ *
+ * Scope note: this subpath is a workspace/test helper for OpenRTC consumers.
+ * The `signaling` stack belongs to OpenRTC; the `identity` stack is the
+ * current workspace consumer identity stack used by Plutonium tests.
+ */
+
+/**
+ * Firebase emulator port maps for the two OpenRTC-adjacent stacks.
+ * `identity` = the consumer app's own Firebase project (Plutonium:
+ * files-bb895); `signaling` = the OpenRTC signaling project (pluto-rtc-prod).
+ */
+export const EMULATOR_STACKS = Object.freeze({
+  identity: Object.freeze({
+    projectId: 'files-bb895',
+    functions: 5001,
+    firestore: 8080,
+    auth: 9099,
+    ui: 4000,
+    hub: 4400,
+    logging: 4500,
+    eventarc: 9298,
+    tasks: 9498,
+  }),
+  signaling: Object.freeze({
+    projectId: 'pluto-rtc-prod',
+    functions: 5002,
+    firestore: 8082,
+    auth: 9100,
+    database: 9001,
+    ui: 4001,
+    hub: 4401,
+    logging: 4501,
+    eventarc: 9297,
+    tasks: 9499,
+  }),
+});
+
+const HOST = '127.0.0.1';
+
+/** Seeded emulator app identity written by seed-integration-emulator.mjs. */
+export const SEEDED_INTEGRATION_IDENTITY = Object.freeze({
+  appTag: 'app_integration_test',
+  secretKey: 'sk_test_integration_plutonium',
+});
+
+/** OpenRTC signaling-stack env vars in the exact shapes the SDK and crate read. */
+function signalingEmulatorEnv() {
+  const s = EMULATOR_STACKS.signaling;
+  return Object.freeze({
+    OPENRTC_FIRESTORE_EMULATOR_HOST: `${HOST}:${s.firestore}`,
+    FIRESTORE_EMULATOR_HOST: `${HOST}:${s.firestore}`,
+    FIREBASE_AUTH_EMULATOR_HOST: `${HOST}:${s.auth}`,
+    FIREBASE_DATABASE_EMULATOR_HOST: `${HOST}:${s.database}`,
+    VITE_OPENRTC_FIRESTORE_EMULATOR_HOST: `${HOST}:${s.firestore}`,
+    VITE_OPENRTC_RTDB_EMULATOR_HOST: `${HOST}:${s.database}`,
+    VITE_USE_EMULATORS: 'true',
+    FUNCTIONS_EMULATOR: 'true',
+  });
+}
+
+/** Consumer identity-stack env vars (Plutonium uses files-bb895 locally). */
+function identityEmulatorEnv() {
+  const i = EMULATOR_STACKS.identity;
+  return Object.freeze({
+    FIRESTORE_EMULATOR_HOST: `${HOST}:${i.firestore}`,
+    FIREBASE_AUTH_EMULATOR_HOST: `${HOST}:${i.auth}`,
+    FUNCTIONS_EMULATOR: 'true',
+    VITE_USE_EMULATORS: 'true',
+  });
+}
+
+/**
+ * Emulator hosts/URLs in the exact env-var shapes local processes read.
+ *
+ * Prefer `emulatorEnv('signaling')` for OpenRTC platform processes and
+ * `emulatorEnv('identity')` for consumer-app identity processes. The no-arg
+ * form is the historical mixed map: OpenRTC-prefixed vars point at signaling,
+ * while unprefixed Firestore/Functions vars point at identity.
+ */
+export function emulatorEnv(stack) {
+  if (stack === 'signaling') return signalingEmulatorEnv();
+  if (stack === 'identity') return identityEmulatorEnv();
+  if (stack !== undefined) {
+    throw new Error(`Unknown emulator stack "${stack}" (expected signaling|identity).`);
+  }
+  const s = EMULATOR_STACKS.signaling;
+  const i = EMULATOR_STACKS.identity;
+  return Object.freeze({
+    // Read by the Rust crate (native signaling/auth/RTDB):
+    OPENRTC_FIRESTORE_EMULATOR_HOST: `${HOST}:${s.firestore}`,
+    FIREBASE_AUTH_EMULATOR_HOST: `${HOST}:${s.auth}`,
+    FIREBASE_DATABASE_EMULATOR_HOST: `${HOST}:${s.database}`,
+    // Read by the browser SDK (Vite-prefixed):
+    VITE_OPENRTC_FIRESTORE_EMULATOR_HOST: `${HOST}:${s.firestore}`,
+    VITE_OPENRTC_RTDB_EMULATOR_HOST: `${HOST}:${s.database}`,
+    VITE_USE_EMULATORS: 'true',
+    // Consumer-app identity stack (Plutonium naming):
+    FIRESTORE_EMULATOR_HOST: `${HOST}:${i.firestore}`,
+    FUNCTIONS_EMULATOR: 'true',
+  });
+}
+
+/** Emulator Functions base URLs per stack. */
+export function emulatorFunctionsUrls() {
+  const s = EMULATOR_STACKS.signaling;
+  const i = EMULATOR_STACKS.identity;
+  return Object.freeze({
+    signaling: `http://${HOST}:${s.functions}/${s.projectId}/us-central1`,
+    identity: `http://${HOST}:${i.functions}/${i.projectId}/us-central1`,
+  });
+}
+
+/**
+ * Resolve the OpenRTC-relevant environment for a canonical workspace tier
+ * (`emulator` | `dev` | `staging` | `prod`). `local` is accepted as a
+ * compatibility alias for `emulator`. Dev and staging use the hosted
+ * non-production project family so real-device testing does not depend on
+ * same-machine emulators.
+ */
+export function resolveOpenRtcEnv(tier = 'emulator') {
+  const resolvedTier = tier === 'local' ? 'emulator' : tier;
+  if (resolvedTier === 'emulator') {
+    return Object.freeze({
+      tier: resolvedTier,
+      emulated: true,
+      env: emulatorEnv(),
+      functionsUrls: emulatorFunctionsUrls(),
+      seededIdentity: SEEDED_INTEGRATION_IDENTITY,
+    });
+  }
+  if (resolvedTier === 'dev' || resolvedTier === 'staging') {
+    return Object.freeze({
+      tier: resolvedTier,
+      emulated: false,
+      env: Object.freeze({ VITE_USE_EMULATORS: 'false' }),
+      functionsUrls: Object.freeze({
+        signaling: 'https://us-central1-openrtc-platform-staging.cloudfunctions.net',
+        identity: 'https://us-central1-plutonium-app-staging.cloudfunctions.net',
+      }),
+      seededIdentity: null,
+    });
+  }
+  if (resolvedTier === 'prod') {
+    return Object.freeze({
+      tier: resolvedTier,
+      emulated: false,
+      env: Object.freeze({ VITE_USE_EMULATORS: 'false' }),
+      functionsUrls: Object.freeze({
+        signaling: 'https://us-central1-pluto-rtc-prod.cloudfunctions.net',
+        identity: 'https://us-central1-files-bb895.cloudfunctions.net',
+      }),
+      seededIdentity: null,
+    });
+  }
+  throw new Error(`Unknown OpenRTC environment tier "${tier}" (expected emulator|dev|staging|prod; local is an emulator alias).`);
+}
+
+/** All emulator ports across both stacks (cleanup/port-check helpers). */
+export function allEmulatorPorts() {
+  const ports = new Set();
+  for (const stack of Object.values(EMULATOR_STACKS)) {
+    for (const value of Object.values(stack)) {
+      if (typeof value === 'number') ports.add(value);
+    }
+  }
+  return Object.freeze([...ports].sort((a, b) => a - b));
+}
+
+/**
+ * Seed the OpenRTC Firestore emulator with the canonical integration identity.
+ *
+ * Node-only helper. It delegates to OpenRTC's checked-in seed script, which
+ * refuses non-loopback Firestore hosts. Installed npm packages do not include
+ * the workspace seed script; in that case this throws with a routing hint.
+ */
+export async function seedEmulator(options = {}) {
+  const [
+    { spawnSync },
+    { existsSync },
+    { dirname, join },
+    { fileURLToPath },
+  ] = await Promise.all([
+    import('node:child_process'),
+    import('node:fs'),
+    import('node:path'),
+    import('node:url'),
+  ]);
+  const envDir = dirname(fileURLToPath(import.meta.url));
+  const openRtcRoot = join(envDir, '..', '..', '..');
+  const seedScript = options.seedScript ?? join(openRtcRoot, 'tests', 'emulator', 'seed-integration-emulator.mjs');
+  if (!existsSync(seedScript)) {
+    throw new Error(
+      'OpenRTC emulator seed script was not found. Run seedEmulator() from the workspace checkout, or invoke openrtc/tests/emulator/seed-integration-emulator.mjs directly.',
+    );
+  }
+  const local = resolveOpenRtcEnv('emulator');
+  const args = [seedScript, ...(options.reset ? ['--reset'] : [])];
+  // Pin the child to the SIGNALING stack explicitly. `local.env`'s flat map
+  // sets FIRESTORE_EMULATOR_HOST to the identity stack (for consumer-app
+  // functions), but the seed script targets FIRESTORE_EMULATOR_HOST directly —
+  // spreading the flat map unpinned would seed OpenRTC app docs into the wrong
+  // emulator.
+  const result = spawnSync(options.nodePath ?? process.execPath, args, {
+    cwd: options.cwd ?? openRtcRoot,
+    env: {
+      ...process.env,
+      ...local.env,
+      ...emulatorEnv('signaling'),
+      ...(options.env ?? {}),
+    },
+    stdio: options.stdio ?? 'inherit',
+  });
+  if (result.status !== 0) {
+    throw new Error(`OpenRTC emulator seed failed with exit code ${result.status ?? 'unknown'}`);
+  }
+  return Object.freeze({
+    appTag: SEEDED_INTEGRATION_IDENTITY.appTag,
+    firestoreHost: local.env.OPENRTC_FIRESTORE_EMULATOR_HOST,
+    seedScript,
+  });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openrtc",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "private": false,
   "type": "module",
   "sideEffects": false,
@@ -15,11 +15,11 @@
     "runtime"
   ],
   "author": "Bryant Hargreaves",
-  "license": "MIT",
+  "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://openrtc.app",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bluestarburst/Plutonium.git"
+    "url": "git+https://github.com/bluestarburst/openrtc.git"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,13 +27,10 @@
     "dist/**/*.js",
     "dist/**/*.d.ts",
     "dist/**/*.wasm",
-    "README.md",
-    "wasm/openrtc.js",
-    "wasm/openrtc.d.ts",
-    "wasm/openrtc_bg.wasm",
-    "wasm/openrtc_bg.wasm.d.ts",
-    "wasm/package.json",
-    "wasm/README.md"
+    "env/index.mjs",
+    "env/index.d.ts",
+    "LICENSE",
+    "README.md"
   ],
   "exports": {
     ".": {
@@ -56,26 +53,40 @@
       "types": "./dist/runtime/tauri.d.ts",
       "import": "./dist/runtime/tauri.js"
     },
+    "./transport": {
+      "types": "./dist/transport/index.d.ts",
+      "import": "./dist/transport/index.js"
+    },
     "./auth/internal": {
       "types": "./dist/auth/internal.d.ts",
       "import": "./dist/auth/internal.js"
     },
+    "./env": {
+      "types": "./env/index.d.ts",
+      "import": "./env/index.mjs"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {
     "build": "tsup",
+    "build:clean": "rm -rf dist && pnpm run build",
     "build:types": "tsc --noEmit",
-    "build:wasm": "cd ../../crates/openrtc && wasm-pack build --target web --out-dir ../../packages/openrtc/wasm && rm -rf ../../packages/openrtc/wasm/.gitignore",
-    "test": "pnpm run test:deterministic",
-    "test:deterministic": "OPENRTC_LIVE_TESTS=0 vitest run tests/unit tests/contract",
-    "test:emulator": "OPENRTC_EMULATOR_TESTS=1 OPENRTC_LIVE_TESTS=1 FIREBASE_AUTH_EMULATOR_HOST=127.0.0.1:9100 VITE_USE_EMULATORS=true VITE_OPENRTC_FIRESTORE_EMULATOR_HOST=127.0.0.1:8082 VITE_OPENRTC_RTDB_EMULATOR_HOST=127.0.0.1:9001 vitest run tests/emulator",
-    "test:live": "pnpm run build:wasm && pnpm run build && OPENRTC_LIVE_TESTS=1 vitest run tests/live",
-    "test:live:emulator": "OPENRTC_LIVE_TESTS=1 FIREBASE_AUTH_EMULATOR_HOST=127.0.0.1:9099 vitest run tests/live",
+    "build:wasm": "cd ../../crates/openrtc && OPENRTC_REPO_ROOT=$(cd ../.. && pwd) && CARGO_REGISTRY_ROOT=${CARGO_HOME:-$HOME/.cargo} && RUSTUP_TOOLCHAIN=nightly RUSTFLAGS=\"-Zlocation-detail=none --remap-path-prefix=$HOME=/home --remap-path-prefix=$CARGO_REGISTRY_ROOT=/cargo --remap-path-prefix=$OPENRTC_REPO_ROOT=/openrtc\" wasm-pack build --target web --out-dir ../../packages/openrtc/wasm && rm -rf ../../packages/openrtc/wasm/.gitignore",
+    "test": "pnpm run test:deterministic && pnpm run test:emulator",
+    "test:deterministic": "OPENRTC_DETERMINISTIC_TESTS=1 vitest run tests/unit tests/contract",
+    "test:emulator": "node ../../tests/emulator/run-emulator-suite.mjs",
+    "test:emulator:running": "FIREBASE_AUTH_EMULATOR_HOST=127.0.0.1:9100 FIRESTORE_EMULATOR_HOST=127.0.0.1:8082 OPENRTC_FIRESTORE_HOST=127.0.0.1:8082 VITE_USE_EMULATORS=true VITE_OPENRTC_FIRESTORE_EMULATOR_HOST=127.0.0.1:8082 VITE_OPENRTC_RTDB_EMULATOR_HOST=127.0.0.1:9001 vitest run tests/emulator --no-file-parallelism --maxWorkers=1 --maxConcurrency=1",
+    "test:acceptance:native:running": "FIREBASE_AUTH_EMULATOR_HOST=127.0.0.1:9100 FIRESTORE_EMULATOR_HOST=127.0.0.1:8082 OPENRTC_FIRESTORE_HOST=127.0.0.1:8082 VITE_USE_EMULATORS=true VITE_OPENRTC_FIRESTORE_EMULATOR_HOST=127.0.0.1:8082 VITE_OPENRTC_RTDB_EMULATOR_HOST=127.0.0.1:9001 vitest run tests/emulator/RealOpenRtcAcceptance.native-wasm.emulator.test.ts --no-file-parallelism --maxWorkers=1 --maxConcurrency=1",
+    "test:live": "pnpm run build:wasm && pnpm run build && vitest run tests/live",
+    "test:live:emulator": "FIREBASE_AUTH_EMULATOR_HOST=127.0.0.1:9099 vitest run tests/live",
     "test:watch": "vitest",
     "coverage": "vitest run --coverage",
-    "prepublishOnly": "npm run build:wasm && npm run build"
+    "prepublishOnly": "npm run build:wasm && npm run build:clean"
   },
   "dependencies": {
+    "@noble/ciphers": "^2.2.0",
+    "@noble/curves": "^1.9.0",
+    "@noble/hashes": "^1.8.0",
     "firebase": "^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0",
     "tweetnacl": "^1.0.3"
   },
@@ -96,6 +107,6 @@
     "test": "tests"
   },
   "bugs": {
-    "url": "https://github.com/bluestarburst/Plutonium/issues"
+    "url": "https://github.com/bluestarburst/openrtc/issues"
   }
 }