@lucern/sdk 0.2.0-alpha.7 → 0.2.0-alpha.9

package/dist/packsClient.d.ts

@@ -0,0 +1,131 @@
+import { GatewayClientConfig, GatewayScope, PlatformGatewaySuccess } from './coreClient.js';
+export { LucernApiError } from './coreClient.js';
+import { JsonObject, ListResult } from './types.js';
+import './contracts/workflow-runtime.contract.js';
+import './contracts/lens-workflow.contract.js';
+import './contracts/lens-filter.contract.js';
+
+/** Configuration for the packs client. */
+type PacksClientConfig = GatewayClientConfig;
+/** Input for installing a pack into a tenant or workspace scope. */
+type PackInstallInput = GatewayScope & {
+    packKey: string;
+    version?: string;
+    autoEnable?: boolean;
+    metadata?: JsonObject;
+};
+/** Input for enabling a previously installed pack. */
+type PackEnableInput = GatewayScope & {
+    packKey: string;
+    metadata?: JsonObject;
+};
+/** Input for disabling an active pack. */
+type PackDisableInput = GatewayScope & {
+    packKey: string;
+    force?: boolean;
+    metadata?: JsonObject;
+};
+/** Input for uninstalling a pack from a tenant or workspace scope. */
+type PackUninstallInput = GatewayScope & {
+    packKey: string;
+    metadata?: JsonObject;
+};
+/** Input for upgrading a pack through the prepare/canary/commit/rollback lifecycle. */
+type PackUpgradeInput = GatewayScope & {
+    packKey: string;
+    mode: "prepare" | "canary" | "commit" | "rollback";
+    targetVersion?: string;
+    metadata?: JsonObject;
+};
+/** Input for creating or updating a pack entitlement record. */
+type PackEntitlementInput = GatewayScope & {
+    packKey: string;
+    status: "active" | "disabled" | "revoked";
+    allowedLifecycles?: Array<"active" | "beta" | "experimental">;
+    minVersion?: string;
+    maxVersion?: string;
+    metadata?: JsonObject;
+};
+/**
+ * Create the packs client for pack catalog, state, and entitlement operations.
+ * @param config - Gateway transport configuration.
+ * @returns An object with methods to manage pack lifecycle, telemetry, and entitlements.
+ */
+declare function createPacksClient(config?: PacksClientConfig): {
+    /**
+     * List catalog entries for available packs.
+     */
+    listCatalog(): Promise<PlatformGatewaySuccess<ListResult<any, "catalog">>>;
+    /**
+     * @deprecated Use listCatalog.
+     */
+    getCatalog(): Promise<PlatformGatewaySuccess<ListResult<any, "catalog">>>;
+    /**
+     * Get the discovery catalog for packs.
+     */
+    getDiscoveryCatalog(): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * Get discovery details for a specific pack.
+     */
+    getDiscoveryDetail(packKey: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * List pack states for the current scope.
+     */
+    listStates(query?: GatewayScope): Promise<PlatformGatewaySuccess<ListResult<any, "states">>>;
+    /**
+     * @deprecated Use listStates.
+     */
+    getStates(query?: GatewayScope): Promise<PlatformGatewaySuccess<ListResult<any, "states">>>;
+    /**
+     * Get health details for a pack.
+     */
+    getHealth(packKey: string, query?: GatewayScope): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * List pack telemetry entries.
+     */
+    listTelemetry(query?: GatewayScope & {
+        lookbackHours?: number;
+        limit?: number;
+    }): Promise<PlatformGatewaySuccess<ListResult<any, "telemetry">>>;
+    /**
+     * @deprecated Use listTelemetry.
+     */
+    getTelemetry(query?: GatewayScope & {
+        lookbackHours?: number;
+        limit?: number;
+    }): Promise<PlatformGatewaySuccess<ListResult<any, "telemetry">>>;
+    /**
+     * Create a pack entitlement.
+     */
+    createEntitlement(input: PackEntitlementInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * Update a pack entitlement.
+     */
+    updateEntitlement(input: PackEntitlementInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * @deprecated Use createEntitlement or updateEntitlement.
+     */
+    upsertEntitlement(input: PackEntitlementInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * Install a pack.
+     */
+    install(input: PackInstallInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * Enable a pack.
+     */
+    enable(input: PackEnableInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * Disable a pack.
+     */
+    disable(input: PackDisableInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * Uninstall a pack.
+     */
+    uninstall(input: PackUninstallInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    /**
+     * Upgrade a pack.
+     */
+    upgrade(input: PackUpgradeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+};
+
+export { GatewayScope, type PackDisableInput, type PackEnableInput, type PackEntitlementInput, type PackInstallInput, type PackUninstallInput, type PackUpgradeInput, type PacksClientConfig, PlatformGatewaySuccess, createPacksClient };

package/dist/packsClient.js

@@ -0,0 +1,525 @@
+// src/coreClient.ts
+var LucernApiError = class extends Error {
+  code;
+  status;
+  invariant;
+  suggestion;
+  details;
+  requestId;
+  correlationId;
+  policyTraceId;
+  constructor(args) {
+    super(args.message);
+    this.name = "LucernApiError";
+    this.code = args.code;
+    this.status = args.status;
+    this.invariant = args.invariant;
+    this.suggestion = args.suggestion;
+    this.details = args.details;
+    this.requestId = args.requestId;
+    this.correlationId = args.correlationId;
+    this.policyTraceId = args.policyTraceId;
+  }
+};
+function toQueryString(scope) {
+  const params = new URLSearchParams();
+  if (scope.tenantId) {
+    params.set("tenantId", scope.tenantId);
+  }
+  if (scope.workspaceId) {
+    params.set("workspaceId", scope.workspaceId);
+  }
+  for (const [key, value] of Object.entries(scope)) {
+    if (key === "tenantId" || key === "workspaceId") {
+      continue;
+    }
+    if (value === void 0) {
+      continue;
+    }
+    params.set(key, String(value));
+  }
+  const serialized = params.toString();
+  return serialized.length > 0 ? `?${serialized}` : "";
+}
+function fillRandomBytes(length) {
+  const bytes = new Uint8Array(length);
+  if (typeof globalThis.crypto?.getRandomValues === "function") {
+    globalThis.crypto.getRandomValues(bytes);
+    return bytes;
+  }
+  for (let index = 0; index < length; index += 1) {
+    bytes[index] = Math.floor(Math.random() * 256);
+  }
+  return bytes;
+}
+function generatePortableRequestId() {
+  if (typeof globalThis.crypto?.randomUUID === "function") {
+    return globalThis.crypto.randomUUID();
+  }
+  const bytes = fillRandomBytes(16);
+  bytes[6] = bytes[6] & 15 | 64;
+  bytes[8] = bytes[8] & 63 | 128;
+  const hex = Array.from(bytes, (value) => value.toString(16).padStart(2, "0"));
+  return `${hex.slice(0, 4).join("")}-${hex.slice(4, 6).join("")}-${hex.slice(
+    6,
+    8
+  ).join("")}-${hex.slice(8, 10).join("")}-${hex.slice(10).join("")}`;
+}
+function randomIdempotencyKey() {
+  return generatePortableRequestId();
+}
+function isRetryableStatus(status) {
+  return status >= 500 || status === 408 || status === 429;
+}
+function fallbackErrorCode(status) {
+  if (status === 401) {
+    return "AUTHENTICATION_REQUIRED";
+  }
+  if (status === 403) {
+    return "FORBIDDEN";
+  }
+  if (status === 404) {
+    return "NOT_FOUND";
+  }
+  if (status === 408) {
+    return "UPSTREAM_ERROR";
+  }
+  if (status === 409) {
+    return "CONFLICT";
+  }
+  if (status === 429) {
+    return "RATE_LIMIT_EXCEEDED";
+  }
+  if (status >= 500) {
+    return "UPSTREAM_ERROR";
+  }
+  return "INTERNAL_ERROR";
+}
+function delay(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+function parseRetryAfterMs(value) {
+  if (!value) {
+    return null;
+  }
+  const trimmed = value.trim();
+  if (!trimmed) {
+    return null;
+  }
+  const numeric = Number(trimmed);
+  if (Number.isFinite(numeric)) {
+    return Math.max(0, Math.round(numeric * 1e3));
+  }
+  const parsedDate = Date.parse(trimmed);
+  if (Number.isFinite(parsedDate)) {
+    return Math.max(0, parsedDate - Date.now());
+  }
+  return null;
+}
+function computeRetryDelayMs(args) {
+  const baseDelay = args.status === 429 ? Math.max(
+    args.retryAfterMs ?? 0,
+    Math.min(1e3 * 2 ** args.attempt, 1e4)
+  ) : Math.min(1e3 * 2 ** args.attempt, 4e3);
+  if (args.status !== 429) {
+    return baseDelay;
+  }
+  const jitterWindow = Math.max(250, Math.round(baseDelay * 0.25));
+  return baseDelay + Math.round(Math.random() * jitterWindow);
+}
+function timeoutError(timeoutMs) {
+  const error = new Error(`Request timed out after ${timeoutMs}ms`);
+  error.name = "AbortError";
+  return error;
+}
+function readPolicySummaryFromDetails(details) {
+  if (!details || typeof details !== "object" || Array.isArray(details)) {
+    return null;
+  }
+  const directSummary = details.summary;
+  if (typeof directSummary === "string" && directSummary.trim().length > 0) {
+    return directSummary.trim();
+  }
+  const policy = details.policy;
+  if (!policy || typeof policy !== "object" || Array.isArray(policy)) {
+    return null;
+  }
+  const explanation = policy.explanation;
+  if (!explanation || typeof explanation !== "object" || Array.isArray(explanation)) {
+    return null;
+  }
+  const nestedSummary = explanation.summary;
+  if (typeof nestedSummary === "string" && nestedSummary.trim().length > 0) {
+    return nestedSummary.trim();
+  }
+  return null;
+}
+function createGatewayRequestClient(config = {}) {
+  const fetchImpl = config.fetchImpl ?? fetch;
+  const baseUrl = config.baseUrl?.replace(/\/+$/, "") ?? "";
+  const maxRetries = config.maxRetries ?? 2;
+  const requestIdFactory = config.requestIdFactory ?? (() => generatePortableRequestId());
+  async function resolveAuthHeaders() {
+    if (!config.getAuthHeaders) {
+      return {};
+    }
+    return await config.getAuthHeaders();
+  }
+  async function fetchWithTimeout(url, init, timeoutMs) {
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), timeoutMs);
+    try {
+      return await fetchImpl(url, { ...init, signal: controller.signal });
+    } catch (error) {
+      if (controller.signal.aborted) {
+        throw timeoutError(timeoutMs);
+      }
+      throw error;
+    } finally {
+      clearTimeout(timer);
+    }
+  }
+  async function parsePayload(response) {
+    const text = await response.text();
+    if (!text) {
+      return null;
+    }
+    try {
+      return JSON.parse(text);
+    } catch {
+      return null;
+    }
+  }
+  function resolveTimeoutMs(method, requestTimeoutMs) {
+    if (typeof requestTimeoutMs === "number") {
+      return requestTimeoutMs;
+    }
+    const methodTimeoutMs = config.timeoutMsByMethod?.[method];
+    if (typeof methodTimeoutMs === "number") {
+      return methodTimeoutMs;
+    }
+    return config.timeoutMs ?? 15e3;
+  }
+  function buildApiError(args) {
+    const failure = args.failure;
+    const legacyError = failure && typeof failure.error === "object" && failure.error !== null ? failure.error : failure?.legacyError;
+    const correlationId = failure?.correlationId ?? args.response.headers.get("x-lucern-correlation-id")?.trim() ?? args.requestId;
+    const policyTraceId = failure?.policyTraceId ?? args.response.headers.get("x-lucern-policy-trace-id")?.trim() ?? null;
+    const details = failure?.details ?? legacyError?.details;
+    const policySummary = readPolicySummaryFromDetails(details);
+    return new LucernApiError({
+      code: failure?.code ?? legacyError?.code ?? fallbackErrorCode(args.response.status),
+      message: policySummary ?? (typeof failure?.error === "string" ? failure.error : legacyError?.message ?? (args.response.ok ? "Platform API returned an invalid success payload." : "Platform API request failed.")),
+      status: args.response.status,
+      invariant: failure?.invariant,
+      suggestion: failure?.suggestion,
+      details,
+      requestId: args.requestId,
+      correlationId,
+      policyTraceId
+    });
+  }
+  async function request(args) {
+    const authHeaders = await resolveAuthHeaders();
+    const method = args.method ?? "GET";
+    const timeoutMs = resolveTimeoutMs(method, args.timeoutMs);
+    const headers = new Headers({
+      "content-type": "application/json",
+      ...authHeaders
+    });
+    if (args.idempotencyKey) {
+      headers.set("idempotency-key", args.idempotencyKey);
+    }
+    const requestId = headers.get("x-correlation-id")?.trim() || headers.get("x-request-id")?.trim() || args.requestId || requestIdFactory();
+    if (!headers.has("x-correlation-id") && !headers.has("x-request-id")) {
+      headers.set("x-correlation-id", requestId);
+    }
+    const url = `${baseUrl}${args.path}`;
+    const serializedBody = args.body ? JSON.stringify(args.body) : void 0;
+    const init = {
+      method,
+      headers,
+      body: serializedBody
+    };
+    let lastError;
+    for (let attempt = 0; attempt <= maxRetries; attempt++) {
+      const hookRequestContext = {
+        requestId,
+        attempt,
+        maxRetries,
+        method,
+        path: args.path,
+        url,
+        headers: new Headers(headers),
+        body: serializedBody,
+        timeoutMs
+      };
+      await config.onRequest?.(hookRequestContext);
+      const startedAt = Date.now();
+      try {
+        const response = await fetchWithTimeout(url, init, timeoutMs);
+        const responseClone = response.clone();
+        const payload = await parsePayload(response);
+        const retryAfterMs = parseRetryAfterMs(
+          response.headers.get("Retry-After")
+        );
+        if (!response.ok || !payload?.success) {
+          const failure = payload && !payload.success ? payload : null;
+          const apiError = buildApiError({
+            requestId,
+            response,
+            failure
+          });
+          const willRetry = attempt < maxRetries && isRetryableStatus(response.status);
+          await config.onResponse?.({
+            ...hookRequestContext,
+            durationMs: Date.now() - startedAt,
+            status: response.status,
+            response: responseClone,
+            error: apiError,
+            correlationId: apiError.correlationId ?? requestId,
+            policyTraceId: apiError.policyTraceId ?? null,
+            retryAfterMs,
+            willRetry
+          });
+          if (willRetry) {
+            lastError = apiError;
+            await delay(
+              computeRetryDelayMs({
+                attempt,
+                status: response.status,
+                retryAfterMs
+              })
+            );
+            continue;
+          }
+          throw apiError;
+        }
+        const successPayload = payload;
+        await config.onResponse?.({
+          ...hookRequestContext,
+          durationMs: Date.now() - startedAt,
+          status: response.status,
+          response: responseClone,
+          correlationId: successPayload.correlationId ?? response.headers.get("x-lucern-correlation-id")?.trim() ?? requestId,
+          policyTraceId: successPayload.policyTraceId ?? response.headers.get("x-lucern-policy-trace-id")?.trim() ?? null,
+          idempotentReplay: successPayload.idempotentReplay,
+          retryAfterMs,
+          willRetry: false
+        });
+        return successPayload;
+      } catch (fetchError) {
+        if (fetchError instanceof LucernApiError) {
+          throw fetchError;
+        }
+        const willRetry = attempt < maxRetries;
+        await config.onResponse?.({
+          ...hookRequestContext,
+          durationMs: Date.now() - startedAt,
+          error: fetchError,
+          correlationId: requestId,
+          policyTraceId: null,
+          willRetry
+        });
+        lastError = fetchError;
+        if (willRetry) {
+          await delay(computeRetryDelayMs({ attempt }));
+        }
+      }
+    }
+    throw lastError instanceof Error ? lastError : new Error("Platform API request failed after retries.");
+  }
+  return {
+    request
+  };
+}
+
+// src/sdkSurface.ts
+function createListResult(items, legacyKey) {
+  const result = {
+    items,
+    total: items.length
+  };
+  if (legacyKey) {
+    result[legacyKey] = items;
+  }
+  return result;
+}
+function mapGatewayData(response, mapper) {
+  return {
+    ...response,
+    data: mapper(response.data)
+  };
+}
+
+// src/packsClient.ts
+function createPacksClient(config = {}) {
+  const gateway = createGatewayRequestClient(config);
+  return {
+    /**
+     * List catalog entries for available packs.
+     */
+    async listCatalog() {
+      return gateway.request({
+        path: "/api/platform/v1/packs/catalog"
+      }).then(
+        (response) => mapGatewayData(
+          response,
+          (data) => createListResult(Array.isArray(data) ? data : [], "catalog")
+        )
+      );
+    },
+    /**
+     * @deprecated Use listCatalog.
+     */
+    async getCatalog() {
+      return this.listCatalog();
+    },
+    /**
+     * Get the discovery catalog for packs.
+     */
+    async getDiscoveryCatalog() {
+      return gateway.request({
+        path: "/api/platform/v1/packs/discovery"
+      });
+    },
+    /**
+     * Get discovery details for a specific pack.
+     */
+    async getDiscoveryDetail(packKey) {
+      return gateway.request({
+        path: `/api/platform/v1/packs/discovery/${encodeURIComponent(packKey)}`
+      });
+    },
+    /**
+     * List pack states for the current scope.
+     */
+    async listStates(query = {}) {
+      return gateway.request({
+        path: `/api/platform/v1/packs/states${toQueryString(query)}`
+      }).then(
+        (response) => mapGatewayData(
+          response,
+          (data) => createListResult(Array.isArray(data) ? data : [], "states")
+        )
+      );
+    },
+    /**
+     * @deprecated Use listStates.
+     */
+    async getStates(query = {}) {
+      return this.listStates(query);
+    },
+    /**
+     * Get health details for a pack.
+     */
+    async getHealth(packKey, query = {}) {
+      return gateway.request({
+        path: `/api/platform/v1/packs/${encodeURIComponent(packKey)}/health${toQueryString(
+          query
+        )}`
+      });
+    },
+    /**
+     * List pack telemetry entries.
+     */
+    async listTelemetry(query = {}) {
+      return gateway.request({
+        path: `/api/platform/v1/packs/telemetry${toQueryString(query)}`
+      }).then(
+        (response) => mapGatewayData(
+          response,
+          (data) => createListResult(Array.isArray(data) ? data : [], "telemetry")
+        )
+      );
+    },
+    /**
+     * @deprecated Use listTelemetry.
+     */
+    async getTelemetry(query = {}) {
+      return this.listTelemetry(query);
+    },
+    /**
+     * Create a pack entitlement.
+     */
+    async createEntitlement(input, idempotencyKey) {
+      return gateway.request({
+        path: "/api/platform/v1/packs/entitlements",
+        method: "POST",
+        body: input,
+        idempotencyKey: idempotencyKey ?? randomIdempotencyKey()
+      });
+    },
+    /**
+     * Update a pack entitlement.
+     */
+    async updateEntitlement(input, idempotencyKey) {
+      return this.createEntitlement(input, idempotencyKey);
+    },
+    /**
+     * @deprecated Use createEntitlement or updateEntitlement.
+     */
+    async upsertEntitlement(input, idempotencyKey) {
+      return this.createEntitlement(input, idempotencyKey);
+    },
+    /**
+     * Install a pack.
+     */
+    async install(input, idempotencyKey) {
+      return gateway.request({
+        path: "/api/platform/v1/packs/install",
+        method: "POST",
+        body: input,
+        idempotencyKey: idempotencyKey ?? randomIdempotencyKey()
+      });
+    },
+    /**
+     * Enable a pack.
+     */
+    async enable(input, idempotencyKey) {
+      return gateway.request({
+        path: "/api/platform/v1/packs/enable",
+        method: "POST",
+        body: input,
+        idempotencyKey: idempotencyKey ?? randomIdempotencyKey()
+      });
+    },
+    /**
+     * Disable a pack.
+     */
+    async disable(input, idempotencyKey) {
+      return gateway.request({
+        path: "/api/platform/v1/packs/disable",
+        method: "POST",
+        body: input,
+        idempotencyKey: idempotencyKey ?? randomIdempotencyKey()
+      });
+    },
+    /**
+     * Uninstall a pack.
+     */
+    async uninstall(input, idempotencyKey) {
+      return gateway.request({
+        path: "/api/platform/v1/packs/uninstall",
+        method: "POST",
+        body: input,
+        idempotencyKey: idempotencyKey ?? randomIdempotencyKey()
+      });
+    },
+    /**
+     * Upgrade a pack.
+     */
+    async upgrade(input, idempotencyKey) {
+      return gateway.request({
+        path: "/api/platform/v1/packs/upgrade",
+        method: "POST",
+        body: input,
+        idempotencyKey: idempotencyKey ?? randomIdempotencyKey()
+      });
+    }
+  };
+}
+
+export { LucernApiError, createPacksClient };
+//# sourceMappingURL=packsClient.js.map
+//# sourceMappingURL=packsClient.js.map