@synap-core/cli 1.6.1 → 1.7.0

package/node_modules/@synap/hub-rest-client/src/types.ts

@@ -0,0 +1,639 @@
+/**
+ * @synap/hub-rest-client — Hub Protocol REST API Types
+ *
+ * Canonical TypeScript interfaces for all objects returned by the
+ * Synap Hub Protocol REST API (`/api/hub/*`).
+ *
+ * These are the source of truth for external consumers (Raycast extension,
+ * CLI, third-party integrations). Keep in sync with hub-protocol-rest.ts
+ * response shapes in synap-backend.
+ *
+ * Zero runtime dependencies — pure TypeScript interfaces.
+ */
+
+// ─── Core entities ───────────────────────────────────────────────────────────
+
+export interface HubEntity {
+  id: string;
+  title: string;
+  profileSlug: string;
+  workspaceId: string | null;
+  /** JSONB property bag — keys depend on the profile schema */
+  properties: Record<string, unknown>;
+  createdAt: string;
+  updatedAt: string;
+  // Convenience shortcuts pulled from properties at response time
+  status?: string;
+  priority?: string;
+  dueDate?: string;
+  content?: string;
+  url?: string;
+}
+
+export interface HubDocument {
+  id: string;
+  title: string;
+  content: string;
+  workspaceId: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface HubChannel {
+  id: string;
+  name: string;
+  type:
+    | "personal"
+    | "thread"
+    | "sub_thread"
+    | "feed"
+    | "external"
+    | "agent_collab";
+  workspaceId: string | null;
+  agentType?: string;
+  contextObjectType?:
+    | "workspace"
+    | "entity"
+    | "document"
+    | "view"
+    | "project"
+    | "task"
+    | "user"
+    | "external"
+    | null;
+  contextObjectId?: string | null;
+  createdAt: string;
+}
+
+export interface HubWorkspace {
+  id: string;
+  name: string;
+  role?: string;
+}
+
+/** GET /api/hub/workspaces — canonical Hub Protocol shape (not `data`). */
+export interface HubWorkspacesListResponse {
+  workspaces: HubWorkspace[];
+}
+
+/** GET /api/hub/users/me returns at least `id` (and `scopes`); email may be omitted. */
+export interface HubUser {
+  id: string;
+  email?: string;
+  name?: string;
+  scopes?: string[];
+}
+
+export interface HubMemoryResult {
+  id: string;
+  content: string;
+  score?: number;
+  createdAt: string;
+}
+
+// ─── Response wrappers ───────────────────────────────────────────────────────
+
+export interface HubListResponse<T> {
+  data: T[];
+  total?: number;
+  hasMore?: boolean;
+}
+
+export interface HubSingleResponse<T> {
+  data: T;
+}
+
+// ─── Input types ─────────────────────────────────────────────────────────────
+
+export interface CreateEntityInput {
+  profileSlug: string;
+  title: string;
+  workspaceId?: string;
+  properties?: Record<string, unknown>;
+  content?: string;
+  url?: string;
+  status?: string;
+  priority?: "low" | "medium" | "high" | "urgent";
+  dueDate?: string;
+}
+
+export interface UpdateEntityInput {
+  title?: string;
+  properties?: Record<string, unknown>;
+  content?: string;
+  url?: string;
+  status?: string;
+  priority?: "low" | "medium" | "high" | "urgent";
+  dueDate?: string;
+}
+
+export interface CreateDocumentInput {
+  title: string;
+  content?: string;
+  workspaceId?: string;
+  entityId?: string;
+}
+
+export interface StoreMemoryInput {
+  fact: string;
+  context?: string;
+  workspaceId?: string;
+}
+
+export interface SendToChannelInput {
+  channelId: string;
+  content: string;
+  /** Defaults to the authenticated user (GET /users/me). */
+  userId?: string;
+  role?: "system" | "assistant" | "user";
+  /** When true, may queue an IS response on AI-active threads (server-side). */
+  autoRespond?: boolean;
+  workspaceId?: string;
+}
+
+// ─── Setup types ─────────────────────────────────────────────────────────────
+
+export interface AgentSetupResult {
+  hubApiKey: string;
+  agentUserId: string;
+  workspaceId: string;
+}
+
+export interface PodStatus {
+  url: string;
+  healthy: boolean;
+  version?: string;
+}
+
+// ─── Capture pipeline types ───────────────────────────────────────────────────
+
+export interface CaptureProposal {
+  tempId: string;
+  profileSlug: string;
+  title: string;
+  description?: string;
+  properties?: Record<string, unknown>;
+  confidence: number;
+  action: "create" | "link" | "dismiss";
+  linkedEntityId?: string;
+  linkedEntityTitle?: string;
+  dedupCandidates?: Array<{
+    entityId: string;
+    title: string;
+    profileSlug: string;
+    score: number;
+  }>;
+}
+
+export interface CaptureRelation {
+  sourceTempId: string;
+  targetTempId: string;
+  relationType: string;
+}
+
+export interface CaptureStructureResponse {
+  proposals: CaptureProposal[];
+  relations: CaptureRelation[];
+  followUp: string | null;
+  dedupCandidates?: Record<
+    string,
+    Array<{ entityId: string; title: string; score: number }>
+  >;
+}
+
+export interface CaptureExecuteInput {
+  entities: Array<{
+    tempId: string;
+    profileSlug: string;
+    title: string;
+    description?: string;
+    properties?: Record<string, unknown>;
+    action: "create" | "link" | "dismiss";
+    linkedEntityId?: string;
+    confidence?: number;
+  }>;
+  relations?: CaptureRelation[];
+}
+
+export interface CaptureExecuteResponse {
+  created: Array<{
+    tempId: string;
+    entityId: string;
+    profileSlug: string;
+    linked: boolean;
+  }>;
+  relations: Array<{
+    sourceTempId: string;
+    targetTempId: string;
+    relationType: string;
+  }>;
+}
+
+// ─── Relations & Graph ───────────────────────────────────────────────────────
+
+export interface HubRelation {
+  id: string;
+  sourceEntityId: string;
+  targetEntityId: string;
+  type: string;
+  label?: string;
+  createdAt: string;
+}
+
+export interface HubGraphNode extends HubEntity {
+  depth: number;
+}
+
+export interface HubGraphEdge {
+  sourceId: string;
+  targetId: string;
+  type: string;
+  label?: string;
+}
+
+export interface HubGraphResult {
+  nodes: HubGraphNode[];
+  edges: HubGraphEdge[];
+}
+
+/**
+ * A single link returned by getConnections() — unified view across three sources:
+ *  - `"graph"` : an explicit row in the relations table
+ *  - `"property"` : derived from another entity's `entity_id` property pointing here
+ *  - `"thread"` : a chat thread created, updated, or referenced this entity
+ */
+export interface HubConnection {
+  entityId: string;
+  entity: HubEntity | null;
+  label: string;
+  direction: "outgoing" | "incoming" | "structural";
+  source: "graph" | "property" | "thread";
+  relationType?: string;
+  propertySlug?: string;
+  propertyLabel?: string;
+  channelId?: string;
+  channelRelationshipType?: string;
+  createdAt?: string | null;
+}
+
+export interface HubConnectionsResult {
+  connections: HubConnection[];
+  counts: {
+    total: number;
+    graph: number;
+    structural: number;
+    threads: number;
+  };
+}
+
+// ─── Profiles & Property Defs ────────────────────────────────────────────────
+
+export interface HubProfile {
+  id: string;
+  slug: string;
+  displayName: string;
+  description?: string;
+  entityScope: "pod" | "workspace";
+  parentSlug?: string;
+  icon?: string;
+  color?: string;
+  properties?: HubPropertyDef[];
+}
+
+export interface HubPropertyDef {
+  id: string;
+  slug: string;
+  displayName: string;
+  type:
+    | "string"
+    | "number"
+    | "boolean"
+    | "date"
+    | "entity_id"
+    | "array"
+    | "object"
+    | "secret";
+  required?: boolean;
+  options?: string[];
+}
+
+// ─── Discover ────────────────────────────────────────────────────────────────
+
+export interface HubDiscoverProperty {
+  slug: string;
+  displayName: string;
+  type: string;
+  options?: string[];
+  required?: boolean;
+}
+
+export interface HubDiscoverProfile {
+  slug: string;
+  displayName: string;
+  scope: "pod" | "workspace";
+  description?: string | null;
+  icon?: string | null;
+  properties: HubDiscoverProperty[];
+  createCommand: string;
+}
+
+export interface HubDiscoverResult {
+  profiles: HubDiscoverProfile[];
+  commands: Record<string, string>;
+  hint: string;
+}
+
+// ─── Threads & Channels ──────────────────────────────────────────────────────
+
+export interface HubThread {
+  id: string;
+  name?: string;
+  type:
+    | "personal"
+    | "thread"
+    | "sub_thread"
+    | "feed"
+    | "external"
+    | "agent_collab";
+  workspaceId?: string;
+  agentType?: string;
+  contextObjectType?:
+    | "workspace"
+    | "entity"
+    | "document"
+    | "view"
+    | "project"
+    | "task"
+    | "user"
+    | "external";
+  contextObjectId?: string;
+  parentChannelId?: string;
+  linkedEntityIds?: string[];
+  linkedDocumentIds?: string[];
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface HubMessage {
+  id: string;
+  content: string;
+  role: "user" | "assistant" | "system";
+  userId?: string;
+  createdAt: string;
+}
+
+export interface HubThreadContext {
+  thread: HubThread;
+  messages: HubMessage[];
+  linkedEntities: HubEntity[];
+  linkedDocuments: HubDocument[];
+}
+
+// ─── Proposals ───────────────────────────────────────────────────────────────
+
+export interface HubProposal {
+  id: string;
+  status: "pending" | "approved" | "rejected";
+  action: "create" | "update" | "delete";
+  subjectType: string;
+  data: Record<string, unknown>;
+  reason?: string;
+  createdAt: string;
+  reviewedAt?: string;
+}
+
+// ─── Views ───────────────────────────────────────────────────────────────────
+
+export interface HubView {
+  id: string;
+  name: string;
+  type:
+    | "table"
+    | "kanban"
+    | "list"
+    | "grid"
+    | "gallery"
+    | "calendar"
+    | "timeline"
+    | "graph"
+    | "bento"
+    | string;
+  profileSlug?: string;
+  workspaceId?: string;
+  config?: Record<string, unknown>;
+  createdAt: string;
+  updatedAt: string;
+}
+
+// ─── Search ───────────────────────────────────────────────────────────────────
+
+export interface HubSearchResult {
+  entities: HubEntity[];
+  documents: HubDocument[];
+  total: number;
+}
+
+// ─── Commands ────────────────────────────────────────────────────────────────
+
+export interface HubCommand {
+  id: string;
+  name: string;
+  slug: string;
+  description?: string;
+  workspaceId?: string;
+}
+
+// ─── Agent Users ─────────────────────────────────────────────────────────────
+
+export interface HubAgentUser {
+  id: string;
+  name: string;
+  agentType?: string;
+  workspaceId?: string;
+}
+
+// ─── User Context ─────────────────────────────────────────────────────────────
+
+export interface HubUserContext {
+  recentEntities: HubEntity[];
+  activeThreads: HubThread[];
+  workspaceSummary?: Record<string, unknown>;
+}
+
+// ─── Governance ───────────────────────────────────────────────────────────────
+
+export interface HubGovernanceResult {
+  status: "approved" | "proposed" | "denied";
+  id?: string;
+  proposalId?: string;
+  reason?: string;
+  message?: string;
+  /**
+   * Short human-readable summary of what was proposed. Present on `proposed`
+   * responses. Example: `Delete task "Q2 plan review"`.
+   */
+  summary?: string;
+  /**
+   * Reasoning — echoed from the AI's rationale or the policy's explanation
+   * of why review is needed. Present on `proposed` responses.
+   */
+  reasoning?: string;
+  /**
+   * Pod-relative path for the review UI: `/proposals/{id}`.
+   * Present on `proposed` responses.
+   */
+  reviewPath?: string;
+  /**
+   * Absolute URL for the review UI (defaults to `studio.synap.live`,
+   * overridable via `SYNAP_APP_URL` on the pod). Surface this directly to
+   * the user so they can approve without digging through the app.
+   */
+  reviewUrl?: string;
+}
+
+// ─── Write input types ────────────────────────────────────────────────────────
+
+export interface CreateThreadInput {
+  name?: string;
+  type?: HubThread["type"];
+  workspaceId?: string;
+  agentType?: string;
+  entityId?: string;
+  documentId?: string;
+  userId?: string;
+}
+
+export interface CreateRelationInput {
+  sourceEntityId: string;
+  targetEntityId: string;
+  type: string;
+  label?: string;
+  workspaceId?: string;
+  userId?: string;
+}
+
+export interface CreateViewInput {
+  name: string;
+  type: HubView["type"];
+  profileSlug?: string;
+  workspaceId: string;
+  config?: Record<string, unknown>;
+  userId?: string;
+}
+
+export interface ExecuteCommandInput {
+  slug: string;
+  workspaceId?: string;
+  parameters?: Record<string, unknown>;
+  userId?: string;
+}
+
+// ─── Automations ──────────────────────────────────────────────────────────────
+
+export type AutomationStatus = "draft" | "active" | "paused" | "error";
+export type AutomationTriggerType = "event" | "cron" | "webhook" | "manual";
+
+export interface HubAutomation {
+  id: string;
+  userId: string;
+  workspaceId?: string | null;
+  name: string;
+  description?: string | null;
+  triggerType: AutomationTriggerType;
+  triggerConfig?: Record<string, unknown>;
+  flowDefinition?: {
+    nodes: Record<string, unknown>[];
+    edges: Record<string, unknown>[];
+  };
+  status: AutomationStatus;
+  metadata?: Record<string, unknown>;
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+export interface CreateAutomationInput {
+  name: string;
+  triggerType: AutomationTriggerType;
+  workspaceId?: string | null;
+  description?: string;
+  triggerConfig?: Record<string, unknown>;
+  flowDefinition?: {
+    nodes: Record<string, unknown>[];
+    edges: Record<string, unknown>[];
+  };
+  status?: AutomationStatus;
+  metadata?: Record<string, unknown>;
+  userId?: string;
+  agentUserId?: string;
+}
+
+export interface UpdateAutomationInput {
+  name?: string;
+  description?: string;
+  triggerType?: AutomationTriggerType;
+  triggerConfig?: Record<string, unknown>;
+  flowDefinition?: {
+    nodes: Record<string, unknown>[];
+    edges: Record<string, unknown>[];
+  };
+  status?: AutomationStatus;
+  metadata?: Record<string, unknown>;
+  workspaceId?: string;
+  userId?: string;
+}
+
+// ─── Subscriptions / Reactions (Pulse) ───────────────────────────────────────
+
+export type ReactionKind =
+  | "automation"
+  | "ai_feed"
+  | "ai_react"
+  | "notify"
+  | "webhook"
+  | "message_out";
+
+export type ReactionLens = "all" | "internal" | "external";
+
+/** Opaque reaction event from the Pulse feed — shape varies by kind. */
+export interface HubReactionEvent {
+  id: string;
+  eventType: string;
+  kind?: ReactionKind;
+  workspaceId?: string | null;
+  userId?: string;
+  createdAt: string;
+  reactions?: Record<string, unknown>[];
+  [key: string]: unknown;
+}
+
+// ─── Notifications ────────────────────────────────────────────────────────────
+
+export type NotificationSourceType =
+  | "proposal"
+  | "connector"
+  | "agent"
+  | "system"
+  | "inbox_item";
+
+export interface CreateNotificationInput {
+  userId: string;
+  workspaceId: string;
+  type: string;
+  sourceType?: NotificationSourceType;
+  sourceId?: string;
+  workspaceUrl?: string;
+  groupKey?: string;
+  data?: Record<string, unknown>;
+}
+
+// ─── Webhooks ─────────────────────────────────────────────────────────────────
+
+export interface HubWebhookDelivery {
+  id: string;
+  subscriptionId: string;
+  status: string;
+  responseStatus?: number;
+  attempt: number;
+  deliveredAt?: string;
+  createdAt: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synap-core/cli",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "Synap CLI — connect OpenClaw to sovereign knowledge infrastructure",
   "type": "module",
   "bin": {
@@ -10,9 +10,12 @@
     "build": "tsc",
     "dev": "tsx src/index.ts",
     "sync-skills": "bash scripts/sync-skills.sh",
-    "prepublishOnly": "pnpm sync-skills && pnpm build"
+    "prepublishOnly": "pnpm sync-skills && pnpm build",
+    "prepack": "rm -rf node_modules/@synap/hub-rest-client && cp -r ../synap-backend/packages/hub-rest-client node_modules/@synap/",
+    "postpack": "rm -rf node_modules/@synap/hub-rest-client && ln -s ../../../synap-backend/packages/hub-rest-client node_modules/@synap/hub-rest-client"
   },
   "dependencies": {
+    "@synap/hub-rest-client": "file:../synap-backend/packages/hub-rest-client",
     "chalk": "^5.4.0",
     "commander": "^13.0.0",
     "ora": "^8.0.0",
@@ -24,6 +27,9 @@
     "tsx": "^4.0.0",
     "typescript": "^5.7.0"
   },
+  "bundledDependencies": [
+    "@synap/hub-rest-client"
+  ],
   "files": [
     "dist",
     "skills"