@portalshq/channel-registry 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import { z } from "zod";
 declare const channel: z.ZodObject<{
-    controlEndpoint: z.ZodString;
+    controlEndpoint: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
     queueTokenEnv: z.ZodString;
     requiredEntities: z.ZodArray<z.ZodString>;
+    interactions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     youtube: z.ZodOptional<z.ZodObject<{
         liveChatId: z.ZodString;
         clientIdEnv: z.ZodString;
@@ -19,9 +20,10 @@ declare const channel: z.ZodObject<{
 }, z.core.$strip>;
 declare const registrySchema: z.ZodObject<{
     channels: z.ZodRecord<z.ZodString, z.ZodObject<{
-        controlEndpoint: z.ZodString;
+        controlEndpoint: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
         queueTokenEnv: z.ZodString;
         requiredEntities: z.ZodArray<z.ZodString>;
+        interactions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         youtube: z.ZodOptional<z.ZodObject<{
             liveChatId: z.ZodString;
             clientIdEnv: z.ZodString;
@@ -41,6 +43,33 @@ declare const registrySchema: z.ZodObject<{
     }, z.core.$loose>>>;
     entitiesFetchedAt: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/** Validate without refreshing manifests or writing the registry. */
+export declare function parseChannelRegistry(value: unknown): {
+    channels: Record<string, {
+        controlEndpoint: string;
+        queueTokenEnv: string;
+        requiredEntities: string[];
+        interactions?: Record<string, unknown> | undefined;
+        youtube?: {
+            liveChatId: string;
+            clientIdEnv: string;
+            clientSecretEnv: string;
+            refreshTokenEnv: string;
+        } | undefined;
+        twitch?: {
+            broadcasterUserId: string;
+            userId: string;
+            clientIdEnv: string;
+            clientSecretEnv: string;
+            refreshTokenEnv: string;
+        } | undefined;
+    }>;
+    entities: Record<string, {
+        [x: string]: unknown;
+        id: string;
+    }>;
+    entitiesFetchedAt?: string | undefined;
+};
 export type Channel = z.infer<typeof channel>;
 export type EntityManifest = {
     id: string;

package/dist/index.js

@@ -4,9 +4,11 @@ import { z } from "zod";
 const secretRef = z.string().regex(/^[A-Z][A-Z0-9_]*$/);
 const entityUri = z.string().regex(/^px:\/\/[\w.-]+\/[\w.-]+\/[\w.-]+$/);
 const channel = z.object({
-    controlEndpoint: z.string().url(),
+    controlEndpoint: z.union([z.string().url(), z.string().regex(/^\$\{[A-Z][A-Z0-9_]*\}$/)]),
     queueTokenEnv: secretRef,
     requiredEntities: z.array(entityUri).min(1),
+    // Capability-specific settings are validated by their owning package.
+    interactions: z.record(z.string(), z.unknown()).optional(),
     youtube: z.object({ liveChatId: z.string().min(1), clientIdEnv: secretRef, clientSecretEnv: secretRef, refreshTokenEnv: secretRef }).optional(),
     twitch: z.object({ broadcasterUserId: z.string().min(1), userId: z.string().min(1), clientIdEnv: secretRef, clientSecretEnv: secretRef, refreshTokenEnv: secretRef }).optional(),
 });
@@ -15,6 +17,10 @@ const registrySchema = z.object({
     entities: z.record(entityUri, z.object({ id: entityUri }).passthrough()).default({}),
     entitiesFetchedAt: z.string().datetime().optional(),
 });
+/** Validate without refreshing manifests or writing the registry. */
+export function parseChannelRegistry(value) {
+    return registrySchema.parse(value);
+}
 export function openChannelRegistry(options) {
     let current;
     function requireCurrent() {
@@ -35,7 +41,7 @@ export function openChannelRegistry(options) {
         },
         async refresh() {
             const filePath = path.resolve(options.filePath);
-            const parsed = registrySchema.parse(JSON.parse(await readFile(filePath, "utf8")));
+            const parsed = parseChannelRegistry(JSON.parse(await readFile(filePath, "utf8")));
             const uris = [...new Set(Object.values(parsed.channels).flatMap((value) => value.requiredEntities))];
             const manifests = await options.resolveManifests(uris);
             if (manifests.length !== uris.length)

package/package.json

@@ -1,15 +1,41 @@
 {
   "name": "@portalshq/channel-registry",
-  "version": "0.1.0",
-  "repository": { "type": "git", "url": "git+https://github.com/portalshq/portals-cloud.git", "directory": "packages/channel-registry" },
+  "version": "0.2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/portalshq/portals-cloud.git",
+    "directory": "packages/channel-registry"
+  },
   "description": "Validated, PX-refreshed deployment-local channel registries.",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "exports": { ".": { "types": "./dist/index.d.ts", "default": "./dist/index.js" } },
-  "files": ["dist", "README.md"],
-  "scripts": { "build": "rm -rf dist && tsc -p tsconfig.json", "typecheck": "tsc -p tsconfig.json --noEmit", "test": "vitest run", "prepack": "npm run build" },
-  "dependencies": { "zod": "^4.3.6" },
-  "devDependencies": { "@types/node": "^20.0.0", "typescript": "^5.6.3", "vitest": "^3.2.7" },
-  "publishConfig": { "access": "public", "registry": "https://registry.npmjs.org/" }
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.6.3",
+    "vitest": "^3.2.7"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
 }