@lucern/sdk 0.3.0-alpha.1 → 0.3.0-alpha.11

package/dist/ontologyClient.d.ts

@@ -3,6 +3,8 @@ import { GatewayClientConfig, GatewayScope, PlatformGatewaySuccess } from './cor
 import './contracts/workflow-runtime.contract.js';
 import './contracts/lens-workflow.contract.js';
 import './contracts/lens-filter.contract.js';
+import './authContext.js';
+import './contracts/auth-session.contract.js';
 
 /** Configuration for the ontology client. */
 type OntologyClientConfig = GatewayClientConfig;
@@ -63,10 +65,10 @@ declare function createOntologyClient(config?: OntologyClientConfig): {
         tier?: string;
         status?: string;
     }): Promise<PlatformGatewaySuccess<{
-        ontologies: any[];
+        ontologies: unknown[];
         total: number;
-        items: any[];
-        definitions: any[];
+        items: unknown[];
+        definitions: unknown[];
     }>>;
     /**
      * Get an ontology definition by identifier.
@@ -76,23 +78,6 @@ declare function createOntologyClient(config?: OntologyClientConfig): {
      * Bind an ontology definition to a topic.
      */
     bind(input: OntologyBindingInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
-    /**
-     * List ontology definitions.
-     */
-    listDefinitions(filters?: GatewayScope & {
-        tenantId?: string;
-        tier?: string;
-        status?: string;
-    }): Promise<PlatformGatewaySuccess<{
-        ontologies: any[];
-        total: number;
-        items: any[];
-        definitions: any[];
-    }>>;
-    /**
-     * Get an ontology definition.
-     */
-    getDefinition(id: string): Promise<PlatformGatewaySuccess<unknown>>;
     /**
      * Create an ontology definition.
      */
@@ -110,7 +95,7 @@ declare function createOntologyClient(config?: OntologyClientConfig): {
      */
     listVersions(ontologyId: string, filters?: GatewayScope & {
         status?: string;
-    }): Promise<PlatformGatewaySuccess<ListResult<any, "versions">>>;
+    }): Promise<PlatformGatewaySuccess<ListResult<unknown, "versions">>>;
     /**
      * Create an ontology version.
      */
@@ -128,10 +113,19 @@ declare function createOntologyClient(config?: OntologyClientConfig): {
      * Uses the topics gateway with ontologyId filter.
      */
     listTopics(ontologyId: string): Promise<PlatformGatewaySuccess<ListResult<any, "topics">>>;
-    /**
-     * @deprecated Use listTopics.
-     */
-    listTopicsByOntology(ontologyId: string): Promise<PlatformGatewaySuccess<ListResult<any, "topics">>>;
+} & {
+    listDefinitions: (filters?: GatewayScope & {
+        tenantId?: string;
+        tier?: string;
+        status?: string;
+    }) => Promise<PlatformGatewaySuccess<{
+        ontologies: unknown[];
+        total: number;
+        items: unknown[];
+        definitions: unknown[];
+    }>>;
+    getDefinition: (id: string) => Promise<PlatformGatewaySuccess<unknown>>;
+    listTopicsByOntology: (ontologyId: string) => Promise<PlatformGatewaySuccess<ListResult<any, "topics">>>;
 };
 
 export { type OntologyBindingInput, type OntologyClientConfig, type OntologyDefinitionInput, type OntologyDefinitionUpdateInput, type OntologyVersionInput, createOntologyClient };

package/dist/ontologyClient.js

@@ -1,3 +1,170 @@
+// src/authContext.ts
+var LucernSdkAuthContextError = class extends Error {
+  reason;
+  constructor(reason, message) {
+    super(message);
+    this.name = "LucernSdkAuthContextError";
+    this.reason = reason;
+  }
+};
+function cleanString(value) {
+  const normalized = value?.trim();
+  return normalized ? normalized : void 0;
+}
+function cleanStringList(values) {
+  if (!values) {
+    return [];
+  }
+  return values.map((value) => value.trim()).filter(
+    (value, index, list) => value.length > 0 && list.indexOf(value) === index
+  );
+}
+function requireString(value, reason, label) {
+  const normalized = cleanString(value);
+  if (!normalized) {
+    throw new LucernSdkAuthContextError(
+      reason,
+      `Canonical Lucern SDK auth context is missing ${label}.`
+    );
+  }
+  return normalized;
+}
+function requirePrincipalType(principalType) {
+  if (!principalType) {
+    throw new LucernSdkAuthContextError(
+      "principal_missing",
+      "Canonical Lucern SDK auth context is missing principalType."
+    );
+  }
+  return principalType;
+}
+function requireAuthMode(authMode) {
+  if (!authMode) {
+    throw new LucernSdkAuthContextError(
+      "principal_missing",
+      "Canonical Lucern SDK auth context is missing authMode."
+    );
+  }
+  return authMode;
+}
+function ensurePermitMatch(args) {
+  const actual = cleanString(args.actual);
+  if (actual && actual !== args.expected) {
+    throw new LucernSdkAuthContextError(
+      "policy_denied",
+      `Canonical Lucern SDK auth context has conflicting Permit ${args.field}.`
+    );
+  }
+}
+function normalizeCanonicalLucernAuthContext(input) {
+  if (!input) {
+    throw new LucernSdkAuthContextError(
+      "principal_missing",
+      "Canonical Lucern SDK auth context is required."
+    );
+  }
+  if (input.policyDecision === "deny") {
+    throw new LucernSdkAuthContextError(
+      "policy_denied",
+      "Canonical Lucern SDK auth context carries a denied policy decision."
+    );
+  }
+  const principalId = requireString(
+    input.principalId,
+    "principal_missing",
+    "principalId"
+  );
+  const tenantId = requireString(input.tenantId, "tenant_missing", "tenantId");
+  const workspaceId = requireString(
+    input.workspaceId,
+    "workspace_missing",
+    "workspaceId"
+  );
+  const roles = cleanStringList(input.roles);
+  const scopes = cleanStringList(input.scopes);
+  const principalType = requirePrincipalType(input.principalType);
+  const authMode = requireAuthMode(input.authMode);
+  const roleBasedInteractiveAuth = authMode === "interactive_user" && roles.length > 0;
+  if (roles.length === 0 || scopes.length === 0 && !roleBasedInteractiveAuth) {
+    throw new LucernSdkAuthContextError(
+      "membership_missing",
+      "Canonical Lucern SDK auth context requires non-empty roles and scopes."
+    );
+  }
+  const subject = cleanString(input.permit?.subject) ?? principalId;
+  const tenant = cleanString(input.permit?.tenant) ?? tenantId;
+  const workspace = cleanString(input.permit?.workspace) ?? workspaceId;
+  ensurePermitMatch({
+    field: "subject",
+    expected: principalId,
+    actual: subject
+  });
+  ensurePermitMatch({ field: "tenant", expected: tenantId, actual: tenant });
+  ensurePermitMatch({
+    field: "workspace",
+    expected: workspaceId,
+    actual: workspace
+  });
+  const context = input.permit?.context ? { ...input.permit.context } : void 0;
+  return {
+    clerkId: cleanString(input.clerkId),
+    principalId,
+    tenantId,
+    workspaceId,
+    principalType,
+    authMode,
+    roles,
+    scopes,
+    delegationChain: input.delegationChain ? [...input.delegationChain] : [],
+    policyTraceId: cleanString(input.policyTraceId),
+    correlationId: cleanString(input.correlationId),
+    membershipId: cleanString(input.membershipId),
+    permit: {
+      subject,
+      tenant,
+      workspace,
+      resource: cleanString(input.permit?.resource),
+      action: cleanString(input.permit?.action),
+      relation: cleanString(input.permit?.relation),
+      context
+    }
+  };
+}
+function createCanonicalAuthHeaders(authContext) {
+  const headers = {
+    "x-lucern-principal-id": authContext.principalId,
+    "x-lucern-principal-type": authContext.principalType,
+    "x-lucern-tenant": authContext.tenantId,
+    "x-lucern-tenant-id": authContext.tenantId,
+    "x-lucern-workspace": authContext.workspaceId,
+    "x-lucern-workspace-id": authContext.workspaceId,
+    "x-lucern-auth-mode": authContext.authMode,
+    "x-lucern-roles": authContext.roles.join(","),
+    "x-lucern-scopes": authContext.scopes.join(","),
+    "x-lucern-permit-context": JSON.stringify(authContext.permit)
+  };
+  if (authContext.clerkId) {
+    headers["x-lucern-clerk-id"] = authContext.clerkId;
+    headers["x-lucern-user-id"] = authContext.clerkId;
+  }
+  if (authContext.delegationChain.length > 0) {
+    headers["x-lucern-delegation-chain"] = JSON.stringify(
+      authContext.delegationChain
+    );
+  }
+  if (authContext.policyTraceId) {
+    headers["x-lucern-policy-trace-id"] = authContext.policyTraceId;
+  }
+  if (authContext.correlationId) {
+    headers["x-correlation-id"] = authContext.correlationId;
+    headers["x-lucern-correlation-id"] = authContext.correlationId;
+  }
+  if (authContext.membershipId) {
+    headers["x-lucern-membership-id"] = authContext.membershipId;
+  }
+  return headers;
+}
+
 // src/coreClient.ts
 var LucernApiError = class extends Error {
   code;
@@ -65,9 +232,7 @@ function generatePortableRequestId() {
     8
   ).join("")}-${hex.slice(8, 10).join("")}-${hex.slice(10).join("")}`;
 }
-function randomIdempotencyKey() {
-  return generatePortableRequestId();
-}
+var randomIdempotencyKey = generatePortableRequestId;
 function isRetryableStatus(status) {
   return status >= 500 || status === 408 || status === 429;
 }
@@ -132,8 +297,11 @@ function timeoutError(timeoutMs) {
   error.name = "AbortError";
   return error;
 }
+function isRecord(value) {
+  return value !== null && typeof value === "object" && !Array.isArray(value);
+}
 function readPolicySummaryFromDetails(details) {
-  if (!details || typeof details !== "object" || Array.isArray(details)) {
+  if (!isRecord(details)) {
     return null;
   }
   const directSummary = details.summary;
@@ -141,11 +309,11 @@ function readPolicySummaryFromDetails(details) {
     return directSummary.trim();
   }
   const policy = details.policy;
-  if (!policy || typeof policy !== "object" || Array.isArray(policy)) {
+  if (!isRecord(policy)) {
     return null;
   }
   const explanation = policy.explanation;
-  if (!explanation || typeof explanation !== "object" || Array.isArray(explanation)) {
+  if (!isRecord(explanation)) {
     return null;
   }
   const nestedSummary = explanation.summary;
@@ -154,16 +322,41 @@ function readPolicySummaryFromDetails(details) {
   }
   return null;
 }
+async function resolveConfiguredAuthContext(authContext) {
+  if (typeof authContext === "function") {
+    return await authContext();
+  }
+  return authContext;
+}
+function mergeHeaderRecord(base, addition) {
+  const headers = new Headers(base);
+  for (const [key, value] of Object.entries(addition)) {
+    const existing = headers.get(key);
+    if (existing !== null && existing !== value) {
+      throw new LucernSdkAuthContextError(
+        "policy_denied",
+        `Canonical Lucern SDK auth context conflicts with existing ${key} header.`
+      );
+    }
+    headers.set(key, value);
+  }
+  return Object.fromEntries(headers.entries());
+}
 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 {};
+    const base = config.getAuthHeaders ? await config.getAuthHeaders() : {};
+    const authContextInput = await resolveConfiguredAuthContext(
+      config.authContext
+    );
+    if (!authContextInput && !config.requireCanonicalAuthContext) {
+      return base;
     }
-    return await config.getAuthHeaders();
+    const authContext = normalizeCanonicalLucernAuthContext(authContextInput);
+    return mergeHeaderRecord(base, createCanonicalAuthHeaders(authContext));
   }
   async function fetchWithTimeout(url, init, timeoutMs) {
     const controller = new AbortController();
@@ -184,11 +377,11 @@ function createGatewayRequestClient(config = {}) {
     if (!text) {
       return null;
     }
-    try {
-      return JSON.parse(text);
-    } catch {
+    const parsed = tryParseGatewayEnvelopeJson(text);
+    if (!parsed.ok) {
       return null;
     }
+    return isRecord(parsed.value) ? parsed.value : null;
   }
   function resolveTimeoutMs(method, requestTimeoutMs) {
     if (typeof requestTimeoutMs === "number") {
@@ -200,16 +393,31 @@ function createGatewayRequestClient(config = {}) {
     }
     return config.timeoutMs ?? 15e3;
   }
+  function tryParseGatewayEnvelopeJson(text) {
+    const trimmed = text.trim();
+    if (!trimmed.startsWith("{") && !trimmed.startsWith("[")) {
+      return { ok: false, reason: "non-json" };
+    }
+    try {
+      return { ok: true, value: JSON.parse(trimmed) };
+    } catch (error) {
+      if (error instanceof SyntaxError) {
+        return { ok: false, reason: "invalid-json", error };
+      }
+      throw error;
+    }
+  }
   function buildApiError(args) {
     const failure = args.failure;
-    const legacyError = failure && typeof failure.error === "object" && failure.error !== null ? failure.error : failure?.legacyError;
+    const legacyError = failure && isRecord(failure.error) ? 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);
+    const failureMessage = typeof failure?.error === "string" ? failure.error : legacyError?.message;
     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.")),
+      message: policySummary ?? failureMessage ?? (args.response.ok ? "Platform API returned an invalid success payload." : "Platform API request failed."),
       status: args.response.status,
       invariant: failure?.invariant,
       suggestion: failure?.suggestion,
@@ -335,13 +543,35 @@ function createGatewayRequestClient(config = {}) {
 }
 
 // src/sdkSurface.ts
+function isRecord2(value) {
+  return Boolean(value) && typeof value === "object" && !Array.isArray(value);
+}
+function asRecord(value) {
+  return isRecord2(value) ? value : {};
+}
+function asListItems(data, legacyKey) {
+  if (Array.isArray(data)) {
+    return data;
+  }
+  const record = asRecord(data);
+  if (Array.isArray(record.items)) {
+    return record.items;
+  }
+  if (legacyKey && Array.isArray(record[legacyKey])) {
+    return record[legacyKey];
+  }
+  return [];
+}
 function createListResult(items, legacyKey) {
   const result = {
     items,
     total: items.length
   };
   if (legacyKey) {
-    result[legacyKey] = items;
+    return {
+      ...result,
+      [legacyKey]: items
+    };
   }
   return result;
 }
@@ -355,7 +585,7 @@ function mapGatewayData(response, mapper) {
 // src/ontologyClient.ts
 function createOntologyClient(config = {}) {
   const gateway = createGatewayRequestClient(config);
-  return {
+  const client = {
     /**
      * List ontology definitions matching optional filters.
      */
@@ -364,13 +594,14 @@ function createOntologyClient(config = {}) {
         path: `/api/platform/v1/ontologies${toQueryString(filters)}`
       }).then(
         (response) => mapGatewayData(response, (data) => {
-          const record = data && typeof data === "object" && !Array.isArray(data) ? data : {};
-          const ontologies = Array.isArray(record.ontologies) ? record.ontologies : Array.isArray(record.definitions) ? record.definitions : Array.isArray(data) ? data : [];
-          const total = typeof record.total === "number" && Number.isFinite(record.total) ? record.total : ontologies.length;
+          const record = asRecord(data);
+          const ontologies = asListItems(data, "ontologies");
+          const definitions = ontologies.length > 0 ? ontologies : asListItems(data, "definitions");
+          const total = typeof record.total === "number" && Number.isFinite(record.total) ? record.total : definitions.length;
           return {
             ...record,
-            ...createListResult(ontologies, "definitions"),
-            ontologies,
+            ...createListResult(definitions, "definitions"),
+            ontologies: definitions,
             total
           };
         })
@@ -397,18 +628,6 @@ function createOntologyClient(config = {}) {
         idempotencyKey: idempotencyKey ?? randomIdempotencyKey()
       });
     },
-    /**
-     * List ontology definitions.
-     */
-    async listDefinitions(filters = {}) {
-      return this.list(filters);
-    },
-    /**
-     * Get an ontology definition.
-     */
-    async getDefinition(id) {
-      return this.get(id);
-    },
     /**
      * Create an ontology definition.
      */
@@ -450,7 +669,7 @@ function createOntologyClient(config = {}) {
       }).then(
         (response) => mapGatewayData(
           response,
-          (data) => createListResult(Array.isArray(data) ? data : [], "versions")
+          (data) => createListResult(asListItems(data, "versions"), "versions")
         )
       );
     },
@@ -498,14 +717,13 @@ function createOntologyClient(config = {}) {
           (data) => createListResult(Array.isArray(data) ? data : [], "topics")
         )
       );
-    },
-    /**
-     * @deprecated Use listTopics.
-     */
-    async listTopicsByOntology(ontologyId) {
-      return this.listTopics(ontologyId);
     }
   };
+  return Object.assign(client, {
+    listDefinitions: client.list,
+    getDefinition: client.get,
+    listTopicsByOntology: client.listTopics
+  });
 }
 
 export { createOntologyClient };