@useorgx/openclaw-plugin 0.4.8 → 0.7.0

package/dist/http/helpers/workspace-scope.js

@@ -0,0 +1,170 @@
+const ALL_SCOPE_TOKENS = new Set(["all", "__all__", "*"]);
+function normalizeScopeId(value) {
+    if (Array.isArray(value)) {
+        for (const entry of value) {
+            const normalized = normalizeScopeId(entry);
+            if (normalized)
+                return normalized;
+        }
+        return null;
+    }
+    if (typeof value !== "string")
+        return null;
+    const trimmed = value.trim();
+    return trimmed.length > 0 ? trimmed : null;
+}
+function readScopeValue(input, keys) {
+    if (!input)
+        return null;
+    if (input instanceof URLSearchParams) {
+        for (const key of keys) {
+            const value = normalizeScopeId(input.get(key));
+            if (value)
+                return value;
+        }
+        return null;
+    }
+    for (const key of keys) {
+        const value = normalizeScopeId(input[key]);
+        if (value)
+            return value;
+    }
+    return null;
+}
+function isAllScopeToken(value) {
+    if (typeof value !== "string")
+        return false;
+    const normalized = value.trim().toLowerCase();
+    return ALL_SCOPE_TOKENS.has(normalized);
+}
+function readWorkspaceCandidates(input) {
+    return {
+        workspaceId: readScopeValue(input, [
+            "workspace_id",
+            "workspaceId",
+            "x-orgx-workspace-id",
+            "x_orgx_workspace_id",
+        ]),
+        commandCenterId: readScopeValue(input, [
+            "command_center_id",
+            "commandCenterId",
+            "x-orgx-command-center-id",
+            "x_orgx_command_center_id",
+        ]),
+        centerId: readScopeValue(input, ["center"]),
+        projectId: readScopeValue(input, ["project_id", "projectId"]),
+    };
+}
+export function workspaceScopeFromHeaders(headers) {
+    if (!headers || typeof headers !== "object")
+        return null;
+    const workspaceId = readScopeValue(headers, [
+        "workspace_id",
+        "workspaceId",
+        "x-orgx-workspace-id",
+        "x_orgx_workspace_id",
+    ]);
+    const commandCenterId = readScopeValue(headers, [
+        "command_center_id",
+        "commandCenterId",
+        "x-orgx-command-center-id",
+        "x_orgx_command_center_id",
+    ]);
+    if (workspaceId && commandCenterId && workspaceId !== commandCenterId) {
+        return {
+            workspace_id: workspaceId,
+            command_center_id: commandCenterId,
+            center: workspaceId,
+        };
+    }
+    const canonical = workspaceId ?? commandCenterId;
+    if (!canonical)
+        return null;
+    return {
+        workspace_id: canonical,
+        command_center_id: canonical,
+        center: canonical,
+    };
+}
+function mergeCandidates(payloadCandidates, queryCandidates) {
+    return {
+        workspaceId: payloadCandidates.workspaceId ?? queryCandidates.workspaceId,
+        commandCenterId: payloadCandidates.commandCenterId ?? queryCandidates.commandCenterId,
+        centerId: payloadCandidates.centerId ?? queryCandidates.centerId,
+        projectId: payloadCandidates.projectId ?? queryCandidates.projectId,
+    };
+}
+export function resolveWorkspaceScope(query, payload, options) {
+    const merged = mergeCandidates(readWorkspaceCandidates(payload ?? null), readWorkspaceCandidates(query));
+    const allowProjectScope = Boolean(options?.allowProjectScope);
+    const canonical = merged.workspaceId ?? merged.commandCenterId ?? merged.centerId;
+    if (merged.workspaceId &&
+        merged.commandCenterId &&
+        merged.workspaceId !== merged.commandCenterId) {
+        return {
+            workspaceId: null,
+            error: "workspace_id and command_center_id must match when both are provided",
+        };
+    }
+    if (canonical && merged.centerId && canonical !== merged.centerId) {
+        return {
+            workspaceId: null,
+            error: "center must match workspace_id/command_center_id when combined",
+        };
+    }
+    if (canonical && merged.projectId && canonical !== merged.projectId) {
+        return {
+            workspaceId: null,
+            error: "project_id cannot be combined with a different workspace scope identifier",
+        };
+    }
+    if (canonical && isAllScopeToken(canonical)) {
+        return {
+            workspaceId: null,
+            isAll: true,
+        };
+    }
+    if (canonical) {
+        return { workspaceId: canonical };
+    }
+    if (merged.projectId) {
+        if (isAllScopeToken(merged.projectId)) {
+            return {
+                workspaceId: null,
+                isAll: true,
+            };
+        }
+        if (!allowProjectScope) {
+            return {
+                workspaceId: null,
+                error: "project_id is no longer accepted for workspace scope; use workspace_id (or command_center_id alias)",
+            };
+        }
+        return {
+            workspaceId: merged.projectId,
+            usedLegacyProjectScope: true,
+        };
+    }
+    return { workspaceId: null };
+}
+export function setCanonicalWorkspaceScopeParams(params, workspaceId, options) {
+    params.delete("project_id");
+    params.delete("projectId");
+    const normalized = normalizeScopeId(workspaceId);
+    if (!normalized) {
+        if (options?.allTokenWhenMissing) {
+            params.set("workspace_id", "all");
+            params.set("command_center_id", "all");
+            params.set("center", "all");
+        }
+        else {
+            params.delete("workspace_id");
+            params.delete("command_center_id");
+            params.delete("center");
+        }
+        return;
+    }
+    params.set("workspace_id", normalized);
+    params.set("command_center_id", normalized);
+    params.set("center", normalized);
+}

package/dist/http/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * HTTP Handler — Serves the React dashboard SPA and API proxy endpoints.
+ *
+ * Registered at the `/orgx` prefix. Handles:
+ *   /orgx/live           → dashboard SPA (index.html)
+ *   /orgx/live/assets/*  → static assets (JS, CSS, images)
+ *   /orgx/api/status     → org status summary
+ *   /orgx/api/agents     → agent states
+ *   /orgx/api/activity   → activity feed
+ *   /orgx/api/initiatives → initiative data
+ *   /orgx/api/health     → plugin diagnostics + outbox/sync status
+ *   /orgx/api/onboarding → onboarding / config state
+ *   /orgx/api/agent-suite/status → suite provisioning plan (OpenClaw-local)
+ *   /orgx/api/agent-suite/install → install/update suite (OpenClaw-local)
+ *   /orgx/api/delegation/preflight → delegation preflight
+ *   /orgx/api/runs/:id/checkpoints → list/create checkpoints
+ *   /orgx/api/runs/:id/checkpoints/:checkpointId/restore → restore checkpoint
+ *   /orgx/api/runs/:id/actions/:action → run control action
+ */
+import type { OrgXClient } from "../api.js";
+import type { OnboardingState, OrgXConfig, OrgSnapshot } from "../types.js";
+import { type OutboxAdapter } from "../adapters/outbox.js";
+type OpenClawAdapter = {
+    listAgents?: () => Promise<Array<Record<string, unknown>>>;
+    spawnAgentTurn?: (input: {
+        agentId: string;
+        sessionId: string;
+        message: string;
+        thinking?: string | null;
+    }) => {
+        pid: number | null;
+    };
+    stopDetachedProcess?: (pid: number) => Promise<{
+        stopped: boolean;
+        wasRunning: boolean;
+    }>;
+    isPidAlive?: (pid: number) => boolean;
+};
+interface PluginRequest {
+    method?: string;
+    url?: string;
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    on?: (event: string, listener: (...args: unknown[]) => void) => void;
+    once?: (event: string, listener: (...args: unknown[]) => void) => void;
+}
+interface PluginResponse {
+    writeHead(status: number, headers?: Record<string, string>): void;
+    end(body?: string | Buffer): void;
+    write?(chunk: string | Buffer): boolean | void;
+    on?: (event: string, listener: (...args: unknown[]) => void) => void;
+    once?: (event: string, listener: (...args: unknown[]) => void) => void;
+    writableEnded?: boolean;
+}
+interface OnboardingController {
+    getState: () => OnboardingState;
+    startPairing: (input: {
+        openclawVersion?: string;
+        platform?: string;
+        deviceName?: string;
+    }) => Promise<{
+        pairingId: string;
+        connectUrl: string;
+        expiresAt: string;
+        pollIntervalMs: number;
+        state: OnboardingState;
+    }>;
+    getStatus: () => Promise<OnboardingState>;
+    submitManualKey: (input: {
+        apiKey: string;
+        userId?: string;
+    }) => Promise<OnboardingState>;
+    disconnect: () => Promise<OnboardingState>;
+}
+interface DiagnosticsProvider {
+    getHealth?: (input?: {
+        probeRemote?: boolean;
+    }) => Promise<unknown>;
+}
+export declare function createHttpHandler(config: OrgXConfig & {
+    dashboardEnabled?: boolean;
+    pluginVersion?: string;
+    installationId?: string | null;
+}, client: OrgXClient, getSnapshot: () => OrgSnapshot | null, onboarding: OnboardingController, diagnostics?: DiagnosticsProvider, adapters?: {
+    outbox?: OutboxAdapter;
+    openclaw?: OpenClawAdapter;
+}): (req: PluginRequest, res: PluginResponse) => Promise<boolean>;
+export {};