@executor-js/sdk 1.5.19 → 1.5.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@executor-js/sdk",
-  "version": "1.5.19",
+  "version": "1.5.21",
   "homepage": "https://github.com/RhysSullivan/executor/tree/main/packages/core/sdk",
   "bugs": {
     "url": "https://github.com/RhysSullivan/executor/issues"

package/dist/chunk-EJKXSREX.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/server-connection.ts","../src/oauth-popup-types.ts","../src/api-errors.ts"],"sourcesContent":["import { Option, Schema } from \"effect\";\n\nexport const DEFAULT_EXECUTOR_SERVER_ORIGIN = \"http://127.0.0.1:4000\";\nexport const DEFAULT_EXECUTOR_SERVER_USERNAME = \"executor\";\n\nexport type ExecutorServerConnectionKind = \"http\" | \"desktop-sidecar\";\nexport type ExecutorLocalServerKind = \"cli-daemon\" | \"desktop-sidecar\" | \"foreground\";\n\nexport type ExecutorServerAuth =\n  | {\n      readonly kind: \"basic\";\n      readonly username?: string;\n      readonly password: string;\n    }\n  | {\n      readonly kind: \"bearer\";\n      readonly token: string;\n    }\n  | {\n      // OAuth 2.0 device-flow credential from `executor login` against a hosted\n      // server. The access token is sent as a Bearer; `refreshToken` +\n      // `expiresAt` (epoch seconds) + `tokenEndpoint` + `clientId` let the CLI\n      // refresh it before expiry without a fresh browser login.\n      readonly kind: \"oauth\";\n      readonly accessToken: string;\n      readonly refreshToken?: string;\n      readonly expiresAt?: number;\n      readonly tokenEndpoint?: string;\n      readonly clientId?: string;\n    };\n\nexport interface ExecutorServerConnection {\n  readonly kind: ExecutorServerConnectionKind;\n  readonly key: string;\n  readonly origin: string;\n  readonly apiBaseUrl: string;\n  readonly displayName: string;\n  readonly auth?: ExecutorServerAuth;\n}\n\nexport interface ExecutorServerConnectionInput {\n  readonly kind?: ExecutorServerConnectionKind;\n  readonly key?: string;\n  readonly origin?: string;\n  readonly apiBaseUrl?: string;\n  readonly displayName?: string;\n  readonly auth?: ExecutorServerAuth;\n}\n\nexport interface ExecutorLocalServerManifest {\n  readonly version: 1;\n  readonly kind: ExecutorLocalServerKind;\n  readonly pid: number;\n  readonly startedAt: string;\n  readonly dataDir: string;\n  readonly scopeDir: string | null;\n  readonly connection: ExecutorServerConnection;\n  readonly owner: {\n    readonly client: \"cli\" | \"desktop\";\n    readonly version: string | null;\n    readonly executablePath: string | null;\n  };\n}\n\nconst stripTrailingSlash = (value: string): string => value.replace(/\\/+$/, \"\");\n\nconst displayNameFromOrigin = (origin: string): string =>\n  origin.replace(/^https?:\\/\\//, \"\").replace(/\\/+$/, \"\");\n\nexport const normalizeExecutorServerOrigin = (raw: string): string => {\n  const trimmed = stripTrailingSlash(raw.trim());\n  if (!trimmed) return DEFAULT_EXECUTOR_SERVER_ORIGIN;\n\n  const parsed = new URL(/^https?:\\/\\//.test(trimmed) ? trimmed : `http://${trimmed}`);\n  if (parsed.pathname === \"/api\") {\n    parsed.pathname = \"/\";\n  }\n  parsed.search = \"\";\n  parsed.hash = \"\";\n  return stripTrailingSlash(parsed.toString());\n};\n\nexport const apiBaseUrlForServerOrigin = (origin: string): string => `${origin}/api`;\n\nexport const originFromApiBaseUrl = (raw: string): string => {\n  const parsed = new URL(raw);\n  if (parsed.pathname.endsWith(\"/api\")) {\n    parsed.pathname = parsed.pathname.slice(0, -\"/api\".length) || \"/\";\n  }\n  parsed.search = \"\";\n  parsed.hash = \"\";\n  return normalizeExecutorServerOrigin(parsed.toString());\n};\n\nexport const normalizeExecutorServerConnection = (\n  input: ExecutorServerConnectionInput = {},\n): ExecutorServerConnection => {\n  const origin = normalizeExecutorServerOrigin(\n    input.origin ??\n      (input.apiBaseUrl ? originFromApiBaseUrl(input.apiBaseUrl) : DEFAULT_EXECUTOR_SERVER_ORIGIN),\n  );\n  const apiBaseUrl = stripTrailingSlash(input.apiBaseUrl ?? apiBaseUrlForServerOrigin(origin));\n  const kind = input.kind ?? \"http\";\n\n  return {\n    kind,\n    key: input.key ?? `${kind}:${origin}`,\n    origin,\n    apiBaseUrl,\n    displayName: input.displayName ?? displayNameFromOrigin(origin),\n    ...(input.auth ? { auth: input.auth } : {}),\n  };\n};\n\nconst encodeBasicCredentials = (credentials: string): string | null => {\n  if (typeof globalThis.btoa === \"function\") {\n    return globalThis.btoa(credentials);\n  }\n\n  const buffer = (\n    globalThis as {\n      readonly Buffer?: {\n        readonly from: (value: string) => { readonly toString: (encoding: \"base64\") => string };\n      };\n    }\n  ).Buffer;\n  if (buffer) {\n    return buffer.from(credentials).toString(\"base64\");\n  }\n\n  return null;\n};\n\nexport const getExecutorServerAuthorizationHeader = (\n  connection: ExecutorServerConnection,\n): string | null => {\n  const auth = connection.auth;\n  if (!auth) return null;\n  if (auth.kind === \"bearer\") return `Bearer ${auth.token}`;\n  if (auth.kind === \"oauth\") return `Bearer ${auth.accessToken}`;\n  const encoded = encodeBasicCredentials(\n    `${auth.username ?? DEFAULT_EXECUTOR_SERVER_USERNAME}:${auth.password}`,\n  );\n  return encoded ? `Basic ${encoded}` : null;\n};\n\nconst ExecutorServerAuthJson = Schema.Union([\n  Schema.Struct({\n    kind: Schema.Literal(\"basic\"),\n    username: Schema.optional(Schema.String),\n    password: Schema.String,\n  }),\n  Schema.Struct({\n    kind: Schema.Literal(\"bearer\"),\n    token: Schema.String,\n  }),\n  Schema.Struct({\n    kind: Schema.Literal(\"oauth\"),\n    accessToken: Schema.String,\n    refreshToken: Schema.optional(Schema.String),\n    expiresAt: Schema.optional(Schema.Number),\n    tokenEndpoint: Schema.optional(Schema.String),\n    clientId: Schema.optional(Schema.String),\n  }),\n]);\n\nconst ExecutorServerConnectionJson = Schema.Struct({\n  kind: Schema.optional(Schema.Literals([\"http\", \"desktop-sidecar\"])),\n  key: Schema.optional(Schema.String),\n  origin: Schema.String,\n  apiBaseUrl: Schema.optional(Schema.String),\n  displayName: Schema.optional(Schema.String),\n  auth: Schema.optional(ExecutorServerAuthJson),\n});\n\nconst ExecutorLocalServerManifestJson = Schema.Struct({\n  version: Schema.Literal(1),\n  kind: Schema.Literals([\"cli-daemon\", \"desktop-sidecar\", \"foreground\"]),\n  pid: Schema.Number,\n  startedAt: Schema.String,\n  dataDir: Schema.String,\n  scopeDir: Schema.NullOr(Schema.String),\n  connection: ExecutorServerConnectionJson,\n  owner: Schema.Struct({\n    client: Schema.Literals([\"cli\", \"desktop\"]),\n    version: Schema.NullOr(Schema.String),\n    executablePath: Schema.NullOr(Schema.String),\n  }),\n});\n\nconst decodeUnknownJsonOption = Schema.decodeUnknownOption(Schema.UnknownFromJsonString);\nconst decodeExecutorLocalServerManifestJson = Schema.decodeUnknownOption(\n  ExecutorLocalServerManifestJson,\n);\n\nconst canNormalizeServerOrigin = (origin: string): boolean => {\n  const trimmed = stripTrailingSlash(origin.trim());\n  if (!trimmed) return true;\n  return URL.canParse(/^https?:\\/\\//.test(trimmed) ? trimmed : `http://${trimmed}`);\n};\n\nexport const parseExecutorLocalServerManifest = (\n  raw: string,\n): ExecutorLocalServerManifest | null => {\n  const json = decodeUnknownJsonOption(raw);\n  if (Option.isNone(json)) return null;\n  const decoded = decodeExecutorLocalServerManifestJson(json.value);\n  if (Option.isNone(decoded)) return null;\n  const parsed = decoded.value;\n  if (\n    !Number.isInteger(parsed.pid) ||\n    parsed.pid <= 0 ||\n    !canNormalizeServerOrigin(parsed.connection.origin)\n  ) {\n    return null;\n  }\n\n  const connection = normalizeExecutorServerConnection(parsed.connection);\n  return {\n    version: 1,\n    kind: parsed.kind,\n    pid: parsed.pid,\n    startedAt: parsed.startedAt,\n    dataDir: parsed.dataDir,\n    scopeDir: parsed.scopeDir,\n    connection,\n    owner: {\n      client: parsed.owner.client,\n      version: parsed.owner.version,\n      executablePath: parsed.owner.executablePath,\n    },\n  };\n};\n\nexport const serializeExecutorLocalServerManifest = (\n  manifest: ExecutorLocalServerManifest,\n): string => `${JSON.stringify(manifest, null, 2)}\\n`;\n","// ---------------------------------------------------------------------------\n// OAuth popup result — the message shape exchanged between the popup window\n// (opened during authorization) and the opener (the onboarding UI). Both the\n// server-side HTML generator and the client-side popup opener agree on this\n// shape so that success / failure can be communicated reliably via both\n// `postMessage` and `BroadcastChannel`.\n// ---------------------------------------------------------------------------\n\n/** Message type literal used to identify our popup results. */\nexport const OAUTH_POPUP_MESSAGE_TYPE = \"executor:oauth-result\" as const;\n\nexport type OAuthPopupResult<TAuth> =\n  | ({\n      readonly type: typeof OAUTH_POPUP_MESSAGE_TYPE;\n      readonly ok: true;\n      readonly sessionId: string;\n    } & TAuth)\n  | {\n      readonly type: typeof OAUTH_POPUP_MESSAGE_TYPE;\n      readonly ok: false;\n      readonly sessionId: string | null;\n      /** Short user-facing summary. */\n      readonly error: string;\n      /** Full technical detail. Omitted when identical to `error`. */\n      readonly errorDetails?: string;\n    };\n\nexport const isOAuthPopupResult = <TAuth>(value: unknown): value is OAuthPopupResult<TAuth> =>\n  typeof value === \"object\" &&\n  value !== null &&\n  (value as { type?: unknown }).type === OAUTH_POPUP_MESSAGE_TYPE;\n","// ---------------------------------------------------------------------------\n// Wire-level HTTP errors. Lives in the SDK so plugin `HttpApiGroup`\n// definitions (which sit on the SDK side of the dependency graph and\n// must stay publishable) can declare them without dragging in the\n// server-only `@executor-js/api` package. The HTTP edge in\n// `@executor-js/api` re-exports these and pairs them with the\n// translation/capture helpers used by handlers.\n// ---------------------------------------------------------------------------\n\nimport { Schema } from \"effect\";\n\n/** Public 500 surface. Opaque by schema — only `traceId` crosses the wire. */\nexport class InternalError extends Schema.TaggedErrorClass<InternalError>()(\n  \"InternalError\",\n  {\n    /** Opaque correlation id for backend lookup (Sentry event id, log line, etc.). */\n    traceId: Schema.String,\n  },\n  { httpApiStatus: 500 },\n) {}\n"],"mappings":";AAAA,SAAS,QAAQ,cAAc;AAExB,IAAM,iCAAiC;AACvC,IAAM,mCAAmC;AA6DhD,IAAM,qBAAqB,CAAC,UAA0B,MAAM,QAAQ,QAAQ,EAAE;AAE9E,IAAM,wBAAwB,CAAC,WAC7B,OAAO,QAAQ,gBAAgB,EAAE,EAAE,QAAQ,QAAQ,EAAE;AAEhD,IAAM,gCAAgC,CAAC,QAAwB;AACpE,QAAM,UAAU,mBAAmB,IAAI,KAAK,CAAC;AAC7C,MAAI,CAAC,QAAS,QAAO;AAErB,QAAM,SAAS,IAAI,IAAI,eAAe,KAAK,OAAO,IAAI,UAAU,UAAU,OAAO,EAAE;AACnF,MAAI,OAAO,aAAa,QAAQ;AAC9B,WAAO,WAAW;AAAA,EACpB;AACA,SAAO,SAAS;AAChB,SAAO,OAAO;AACd,SAAO,mBAAmB,OAAO,SAAS,CAAC;AAC7C;AAEO,IAAM,4BAA4B,CAAC,WAA2B,GAAG,MAAM;AAEvE,IAAM,uBAAuB,CAAC,QAAwB;AAC3D,QAAM,SAAS,IAAI,IAAI,GAAG;AAC1B,MAAI,OAAO,SAAS,SAAS,MAAM,GAAG;AACpC,WAAO,WAAW,OAAO,SAAS,MAAM,GAAG,CAAC,OAAO,MAAM,KAAK;AAAA,EAChE;AACA,SAAO,SAAS;AAChB,SAAO,OAAO;AACd,SAAO,8BAA8B,OAAO,SAAS,CAAC;AACxD;AAEO,IAAM,oCAAoC,CAC/C,QAAuC,CAAC,MACX;AAC7B,QAAM,SAAS;AAAA,IACb,MAAM,WACH,MAAM,aAAa,qBAAqB,MAAM,UAAU,IAAI;AAAA,EACjE;AACA,QAAM,aAAa,mBAAmB,MAAM,cAAc,0BAA0B,MAAM,CAAC;AAC3F,QAAM,OAAO,MAAM,QAAQ;AAE3B,SAAO;AAAA,IACL;AAAA,IACA,KAAK,MAAM,OAAO,GAAG,IAAI,IAAI,MAAM;AAAA,IACnC;AAAA,IACA;AAAA,IACA,aAAa,MAAM,eAAe,sBAAsB,MAAM;AAAA,IAC9D,GAAI,MAAM,OAAO,EAAE,MAAM,MAAM,KAAK,IAAI,CAAC;AAAA,EAC3C;AACF;AAEA,IAAM,yBAAyB,CAAC,gBAAuC;AACrE,MAAI,OAAO,WAAW,SAAS,YAAY;AACzC,WAAO,WAAW,KAAK,WAAW;AAAA,EACpC;AAEA,QAAM,SACJ,WAKA;AACF,MAAI,QAAQ;AACV,WAAO,OAAO,KAAK,WAAW,EAAE,SAAS,QAAQ;AAAA,EACnD;AAEA,SAAO;AACT;AAEO,IAAM,uCAAuC,CAClD,eACkB;AAClB,QAAM,OAAO,WAAW;AACxB,MAAI,CAAC,KAAM,QAAO;AAClB,MAAI,KAAK,SAAS,SAAU,QAAO,UAAU,KAAK,KAAK;AACvD,MAAI,KAAK,SAAS,QAAS,QAAO,UAAU,KAAK,WAAW;AAC5D,QAAM,UAAU;AAAA,IACd,GAAG,KAAK,YAAY,gCAAgC,IAAI,KAAK,QAAQ;AAAA,EACvE;AACA,SAAO,UAAU,SAAS,OAAO,KAAK;AACxC;AAEA,IAAM,yBAAyB,OAAO,MAAM;AAAA,EAC1C,OAAO,OAAO;AAAA,IACZ,MAAM,OAAO,QAAQ,OAAO;AAAA,IAC5B,UAAU,OAAO,SAAS,OAAO,MAAM;AAAA,IACvC,UAAU,OAAO;AAAA,EACnB,CAAC;AAAA,EACD,OAAO,OAAO;AAAA,IACZ,MAAM,OAAO,QAAQ,QAAQ;AAAA,IAC7B,OAAO,OAAO;AAAA,EAChB,CAAC;AAAA,EACD,OAAO,OAAO;AAAA,IACZ,MAAM,OAAO,QAAQ,OAAO;AAAA,IAC5B,aAAa,OAAO;AAAA,IACpB,cAAc,OAAO,SAAS,OAAO,MAAM;AAAA,IAC3C,WAAW,OAAO,SAAS,OAAO,MAAM;AAAA,IACxC,eAAe,OAAO,SAAS,OAAO,MAAM;AAAA,IAC5C,UAAU,OAAO,SAAS,OAAO,MAAM;AAAA,EACzC,CAAC;AACH,CAAC;AAED,IAAM,+BAA+B,OAAO,OAAO;AAAA,EACjD,MAAM,OAAO,SAAS,OAAO,SAAS,CAAC,QAAQ,iBAAiB,CAAC,CAAC;AAAA,EAClE,KAAK,OAAO,SAAS,OAAO,MAAM;AAAA,EAClC,QAAQ,OAAO;AAAA,EACf,YAAY,OAAO,SAAS,OAAO,MAAM;AAAA,EACzC,aAAa,OAAO,SAAS,OAAO,MAAM;AAAA,EAC1C,MAAM,OAAO,SAAS,sBAAsB;AAC9C,CAAC;AAED,IAAM,kCAAkC,OAAO,OAAO;AAAA,EACpD,SAAS,OAAO,QAAQ,CAAC;AAAA,EACzB,MAAM,OAAO,SAAS,CAAC,cAAc,mBAAmB,YAAY,CAAC;AAAA,EACrE,KAAK,OAAO;AAAA,EACZ,WAAW,OAAO;AAAA,EAClB,SAAS,OAAO;AAAA,EAChB,UAAU,OAAO,OAAO,OAAO,MAAM;AAAA,EACrC,YAAY;AAAA,EACZ,OAAO,OAAO,OAAO;AAAA,IACnB,QAAQ,OAAO,SAAS,CAAC,OAAO,SAAS,CAAC;AAAA,IAC1C,SAAS,OAAO,OAAO,OAAO,MAAM;AAAA,IACpC,gBAAgB,OAAO,OAAO,OAAO,MAAM;AAAA,EAC7C,CAAC;AACH,CAAC;AAED,IAAM,0BAA0B,OAAO,oBAAoB,OAAO,qBAAqB;AACvF,IAAM,wCAAwC,OAAO;AAAA,EACnD;AACF;AAEA,IAAM,2BAA2B,CAAC,WAA4B;AAC5D,QAAM,UAAU,mBAAmB,OAAO,KAAK,CAAC;AAChD,MAAI,CAAC,QAAS,QAAO;AACrB,SAAO,IAAI,SAAS,eAAe,KAAK,OAAO,IAAI,UAAU,UAAU,OAAO,EAAE;AAClF;AAEO,IAAM,mCAAmC,CAC9C,QACuC;AACvC,QAAM,OAAO,wBAAwB,GAAG;AACxC,MAAI,OAAO,OAAO,IAAI,EAAG,QAAO;AAChC,QAAM,UAAU,sCAAsC,KAAK,KAAK;AAChE,MAAI,OAAO,OAAO,OAAO,EAAG,QAAO;AACnC,QAAM,SAAS,QAAQ;AACvB,MACE,CAAC,OAAO,UAAU,OAAO,GAAG,KAC5B,OAAO,OAAO,KACd,CAAC,yBAAyB,OAAO,WAAW,MAAM,GAClD;AACA,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,kCAAkC,OAAO,UAAU;AACtE,SAAO;AAAA,IACL,SAAS;AAAA,IACT,MAAM,OAAO;AAAA,IACb,KAAK,OAAO;AAAA,IACZ,WAAW,OAAO;AAAA,IAClB,SAAS,OAAO;AAAA,IAChB,UAAU,OAAO;AAAA,IACjB;AAAA,IACA,OAAO;AAAA,MACL,QAAQ,OAAO,MAAM;AAAA,MACrB,SAAS,OAAO,MAAM;AAAA,MACtB,gBAAgB,OAAO,MAAM;AAAA,IAC/B;AAAA,EACF;AACF;AAEO,IAAM,uCAAuC,CAClD,aACW,GAAG,KAAK,UAAU,UAAU,MAAM,CAAC,CAAC;AAAA;;;ACnO1C,IAAM,2BAA2B;AAkBjC,IAAM,qBAAqB,CAAQ,UACxC,OAAO,UAAU,YACjB,UAAU,QACT,MAA6B,SAAS;;;ACrBzC,SAAS,UAAAA,eAAc;AAGhB,IAAM,gBAAN,cAA4BA,QAAO,iBAAgC;AAAA,EACxE;AAAA,EACA;AAAA;AAAA,IAEE,SAASA,QAAO;AAAA,EAClB;AAAA,EACA,EAAE,eAAe,IAAI;AACvB,EAAE;AAAC;","names":["Schema"]}