@lucern/sdk 0.2.0-alpha.13 → 0.2.0-alpha.3

package/dist/packages/sdk/src/packsClient.d.ts

@@ -0,0 +1,101 @@
+import { type GatewayClientConfig, type GatewayScope, LucernApiError } from "./coreClient";
+import type { JsonObject } from "./types";
+export { LucernApiError };
+export type { GatewayScope, PlatformGatewaySuccess } from "./coreClient";
+export type PacksClientConfig = GatewayClientConfig;
+export type PackInstallInput = GatewayScope & {
+    packKey: string;
+    version?: string;
+    autoEnable?: boolean;
+    metadata?: JsonObject;
+};
+export type PackEnableInput = GatewayScope & {
+    packKey: string;
+    metadata?: JsonObject;
+};
+export type PackDisableInput = GatewayScope & {
+    packKey: string;
+    force?: boolean;
+    metadata?: JsonObject;
+};
+export type PackUpgradeInput = GatewayScope & {
+    packKey: string;
+    mode: "prepare" | "canary" | "commit" | "rollback";
+    targetVersion?: string;
+    metadata?: JsonObject;
+};
+export 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.
+ */
+export declare function createPacksClient(config?: PacksClientConfig): {
+    /**
+     * List catalog entries for available packs.
+     */
+    listCatalog(): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "catalog">>>;
+    /**
+     * @deprecated Use listCatalog.
+     */
+    getCatalog(): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "catalog">>>;
+    /**
+     * List pack states for the current scope.
+     */
+    listStates(query?: GatewayScope): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "states">>>;
+    /**
+     * @deprecated Use listStates.
+     */
+    getStates(query?: GatewayScope): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "states">>>;
+    /**
+     * Get health details for a pack.
+     */
+    getHealth(packKey: string, query?: GatewayScope): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * List pack telemetry entries.
+     */
+    listTelemetry(query?: GatewayScope & {
+        lookbackHours?: number;
+        limit?: number;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "telemetry">>>;
+    /**
+     * @deprecated Use listTelemetry.
+     */
+    getTelemetry(query?: GatewayScope & {
+        lookbackHours?: number;
+        limit?: number;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "telemetry">>>;
+    /**
+     * Create a pack entitlement.
+     */
+    createEntitlement(input: PackEntitlementInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * Update a pack entitlement.
+     */
+    updateEntitlement(input: PackEntitlementInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * @deprecated Use createEntitlement or updateEntitlement.
+     */
+    upsertEntitlement(input: PackEntitlementInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * Install a pack.
+     */
+    install(input: PackInstallInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * Enable a pack.
+     */
+    enable(input: PackEnableInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * Disable a pack.
+     */
+    disable(input: PackDisableInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * Upgrade a pack.
+     */
+    upgrade(input: PackUpgradeInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+};

package/dist/{policyClient.d.ts → packages/sdk/src/policyClient.d.ts}

@@ -1,16 +1,9 @@
-import { GatewayClientConfig, GatewayScope, PlatformGatewaySuccess } from './coreClient.js';
-export { LucernApiError } from './coreClient.js';
-import { 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 policy client. */
-type PolicyClientConfig = GatewayClientConfig;
-/** Permission direction: read access or write access. */
-type PermissionKind = "read" | "write";
-/** Permission level for a write policy rule. */
-type WritePolicyPermission = "allow" | "deny" | "review_required";
+import { type GatewayClientConfig, type GatewayScope, LucernApiError } from "./coreClient";
+export { LucernApiError };
+export type { GatewayScope, PlatformGatewaySuccess } from "./coreClient";
+export type PolicyClientConfig = GatewayClientConfig;
+export type PermissionKind = "read" | "write";
+export type WritePolicyPermission = "allow" | "deny" | "review_required";
 type TopicRecord = {
     topicId?: string;
     name?: string;
@@ -18,8 +11,7 @@ type TopicRecord = {
     isOwner?: boolean;
     [key: string]: unknown;
 };
-/** Structured explanation of how a policy decision was derived. */
-type PolicyDecisionExplanation = {
+export type PolicyDecisionExplanation = {
     summary?: string;
     matchedReasonCode?: string;
     steps?: Array<{
@@ -30,8 +22,7 @@ type PolicyDecisionExplanation = {
     }>;
     [key: string]: unknown;
 };
-/** Result of a permission check against the policy engine. */
-type PermissionDecision = {
+export type PermissionDecision = {
     allowed?: boolean;
     decision?: string;
     reasonCode?: string;
@@ -42,8 +33,7 @@ type PermissionDecision = {
     traceId?: string | null;
     explanation?: PolicyDecisionExplanation;
 };
-/** A persisted write policy rule controlling mutation access. */
-type WritePolicyRecord = {
+export type WritePolicyRecord = {
     id?: string;
     topicId?: string;
     role?: string;
@@ -58,8 +48,7 @@ type WritePolicyRecord = {
     resolution?: string;
     [key: string]: unknown;
 };
-/** Input for creating a write policy rule. */
-type WritePolicyCreateInput = GatewayScope & {
+export type WritePolicyCreateInput = GatewayScope & {
     topicId?: string;
     role: string;
     toolCategory: string;
@@ -69,8 +58,7 @@ type WritePolicyCreateInput = GatewayScope & {
     rationale?: string;
     createdBy?: string;
 };
-/** Input for partially updating an existing write policy rule. */
-type WritePolicyUpdateInput = GatewayScope & {
+export type WritePolicyUpdateInput = GatewayScope & {
     topicId?: string;
     clearTopicId?: boolean;
     role?: string;
@@ -82,29 +70,10 @@ type WritePolicyUpdateInput = GatewayScope & {
     rationale?: string;
     clearRationale?: boolean;
 };
-type TenantPolicyPermission = {
-    resource: string;
-    actions: string[];
-};
-type TenantPolicyRecord = {
-    id?: string;
-    tenantId: string;
-    workspaceId?: string;
-    roleName: string;
-    description?: string;
-    permissions: TenantPolicyPermission[];
-    groupBindings: string[];
-    createdAt?: number;
-    updatedAt?: number;
-    createdBy?: string;
-    updatedBy?: string;
-};
 /**
- * Create the policy client for permission checks, grants, and write policies.
- * @param config - Gateway transport configuration.
- * @returns An object with methods to check permissions, manage grants, and manage write policies.
+ * Create the policy client for permission checks and grants.
  */
-declare function createPolicyClient(config?: PolicyClientConfig): {
+export declare function createPolicyClient(config?: PolicyClientConfig): {
     /**
      * List policy decisions in the current scope.
      */
@@ -115,7 +84,7 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         principalId?: string;
         topicId?: string;
         limit?: number;
-    }): Promise<PlatformGatewaySuccess<ListResult<any, "decisions">>>;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "decisions">>>;
     /**
      * Create a permission grant.
      */
@@ -127,7 +96,7 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         groupId?: string;
         beliefClusterId?: string;
         expiresAt?: number;
-    }, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
+    }, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
     /**
      * Delete a permission grant by revoking it.
      */
@@ -137,10 +106,7 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         principalId?: string;
         groupId?: string;
         beliefClusterId?: string;
-    }, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
-    /**
-     * List write policy rules for the current scope.
-     */
+    }, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
     listWritePolicies(query?: GatewayScope & {
         topicId?: string;
         role?: string;
@@ -155,9 +121,6 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         policyTraceId: string | null;
         idempotentReplay: boolean;
     }>;
-    /**
-     * Create a write policy rule.
-     */
     createWritePolicy(input: WritePolicyCreateInput, idempotencyKey?: string): Promise<{
         data: {
             id: string | undefined;
@@ -169,9 +132,6 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         policyTraceId: string | null;
         idempotentReplay: boolean;
     }>;
-    /**
-     * Update an existing write policy rule by identifier.
-     */
     updateWritePolicy(id: string, input: WritePolicyUpdateInput, idempotencyKey?: string): Promise<{
         data: {
             id: string | undefined;
@@ -183,63 +143,10 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         policyTraceId: string | null;
         idempotentReplay: boolean;
     }>;
-    /**
-     * Delete a write policy rule by identifier.
-     */
-    deleteWritePolicy(id: string, scope?: GatewayScope, idempotencyKey?: string): Promise<PlatformGatewaySuccess<{
+    deleteWritePolicy(id: string, scope?: GatewayScope, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<{
         id?: string;
         deleted?: boolean;
     }>>;
-    /**
-     * List tenant role policies for the current scope.
-     */
-    listRolePolicies(query?: GatewayScope): Promise<{
-        data: {
-            policies: TenantPolicyRecord[];
-        };
-        success: true;
-        correlationId: string;
-        policyTraceId: string | null;
-        idempotentReplay: boolean;
-    }>;
-    /**
-     * Create a tenant role policy.
-     */
-    createRolePolicy(input: GatewayScope & {
-        roleName: string;
-        description?: string;
-        permissions: TenantPolicyPermission[];
-        groupBindings?: string[];
-    }, idempotencyKey?: string): Promise<{
-        data: {
-            policy: TenantPolicyRecord | null;
-        };
-        success: true;
-        correlationId: string;
-        policyTraceId: string | null;
-        idempotentReplay: boolean;
-    }>;
-    /**
-     * Update a tenant role policy by identifier.
-     */
-    updateRolePolicy(id: string, input: GatewayScope & {
-        roleName: string;
-        description?: string;
-        permissions: TenantPolicyPermission[];
-        groupBindings?: string[];
-    }, idempotencyKey?: string): Promise<{
-        data: {
-            policy: TenantPolicyRecord | null;
-        };
-        success: true;
-        correlationId: string;
-        policyTraceId: string | null;
-        idempotentReplay: boolean;
-    }>;
-    /**
-     * Delete a tenant role policy by identifier.
-     */
-    deleteRolePolicy(id: string, scope?: GatewayScope, idempotencyKey?: string): Promise<PlatformGatewaySuccess<unknown>>;
     /**
      * Check a permission decision for a topic or project scope.
      */
@@ -249,7 +156,7 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         principal?: string;
         principalId?: string;
         beliefClusterId?: string;
-    }): Promise<PlatformGatewaySuccess<PermissionDecision>>;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<PermissionDecision>>;
     /**
      * List accessible topics for a principal.
      */
@@ -295,5 +202,3 @@ declare function createPolicyClient(config?: PolicyClientConfig): {
         };
     }>;
 };
-
-export { GatewayScope, type PermissionDecision, type PermissionKind, PlatformGatewaySuccess, type PolicyClientConfig, type PolicyDecisionExplanation, type TenantPolicyPermission, type TenantPolicyRecord, type WritePolicyCreateInput, type WritePolicyPermission, type WritePolicyRecord, type WritePolicyUpdateInput, createPolicyClient };

package/dist/packages/sdk/src/reportsClient.d.ts

@@ -0,0 +1,31 @@
+import { type GatewayClientConfig } from "./coreClient";
+import type { TopicIdentifierInput, ReportTemplatesResponse, ReportWithSectionsResponse } from "./types";
+export type ReportsClientConfig = GatewayClientConfig;
+export type { ProjectReportsResponse, ReportTemplatesResponse, ReportWithSectionsResponse, } from "./types";
+/**
+ * Create the reports client for report templates and generated reports.
+ */
+export declare function createReportsClient(config?: ReportsClientConfig): {
+    /**
+     * List report templates.
+     */
+    listTemplates(args?: {
+        slug?: string;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<ReportTemplatesResponse>>;
+    /**
+     * @deprecated Use listTemplates.
+     */
+    getTemplates(args?: {
+        slug?: string;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<ReportTemplatesResponse>>;
+    /**
+     * List reports for a topic scope.
+     */
+    listReports(input: TopicIdentifierInput, args?: {
+        summary?: boolean;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "reports">>>;
+    /**
+     * Get a generated report.
+     */
+    getReport(reportId: string): Promise<import("./coreClient").PlatformGatewaySuccess<ReportWithSectionsResponse>>;
+};

package/dist/packages/sdk/src/schemaClient.d.ts

@@ -0,0 +1,54 @@
+import { type GatewayClientConfig, type GatewayScope, LucernApiError } from "./coreClient";
+import type { JsonObject } from "./types";
+export { LucernApiError };
+export type { GatewayScope, PlatformGatewaySuccess } from "./coreClient";
+export type SchemaClientConfig = GatewayClientConfig;
+export type SchemaPackInstallInput = GatewayScope & {
+    packKey: string;
+    version?: string;
+    autoEnable?: boolean;
+    metadata?: JsonObject;
+};
+export type SchemaEntitlementInput = GatewayScope & {
+    packKey: string;
+    status: "active" | "disabled" | "revoked";
+    allowedLifecycles?: Array<"active" | "beta" | "experimental">;
+    minVersion?: string;
+    maxVersion?: string;
+    metadata?: JsonObject;
+};
+/**
+ * Create the schema client for pack catalog and entitlement operations.
+ */
+export declare function createSchemaClient(config?: SchemaClientConfig): {
+    /**
+     * List schema packs.
+     */
+    listPacks(scope?: GatewayScope): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "packs">>>;
+    /**
+     * Install a schema pack.
+     */
+    installPack(input: SchemaPackInstallInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * Get a schema pack by identifier.
+     */
+    getPack(packId: string, scope?: GatewayScope): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * List schema entitlements.
+     */
+    listEntitlements(scope?: GatewayScope & {
+        packKey?: string;
+    }): Promise<import("./coreClient").PlatformGatewaySuccess<import("./types").ListResult<any, "entitlements">>>;
+    /**
+     * Create a schema entitlement.
+     */
+    createEntitlement(input: SchemaEntitlementInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * Update a schema entitlement.
+     */
+    updateEntitlement(input: SchemaEntitlementInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+    /**
+     * @deprecated Use createEntitlement or updateEntitlement.
+     */
+    upsertEntitlement(input: SchemaEntitlementInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<unknown>>;
+};

package/dist/packages/sdk/src/sdkSurface.d.ts

@@ -0,0 +1,55 @@
+import type { PlatformGatewaySuccess } from "./coreClient";
+import type { JsonObject, ListResult } from "./types";
+type TopicScopedValue = {
+    topicId?: string;
+};
+type TextScopedValue = {
+    text?: string;
+    canonicalText?: string;
+};
+type AnyRecord = Record<string, unknown>;
+/**
+ * Resolve the canonical topic identifier.
+ */
+export declare function resolveTopicId(value: TopicScopedValue): string | undefined;
+/**
+ * Resolve the canonical text field from text-first or legacy canonicalText-first inputs.
+ */
+export declare function resolveText(value: TextScopedValue): string | undefined;
+/**
+ * Attach the topicId to a record.
+ */
+export declare function withTopicAlias<T extends AnyRecord>(value: T): T;
+/**
+ * Attach the text/canonicalText alias pair to a record.
+ */
+export declare function withTextAlias<T extends AnyRecord>(value: T): T;
+/**
+ * Attach topic and text aliases to SDK node-like records.
+ */
+export declare function withSdkAliases<T extends AnyRecord>(value: T): T;
+/**
+ * Normalize a belief/question/evidence write payload to the canonical gateway shape.
+ */
+export declare function normalizeNodeWriteInput<T extends JsonObject>(value: T): T;
+/**
+ * Build a topic-aware query object.
+ */
+export declare function normalizeTopicQuery<T extends JsonObject>(value: T): T;
+/**
+ * Extract list items from array or list-envelope payloads.
+ */
+export declare function asListItems<T>(data: unknown, legacyKey?: string): T[];
+/**
+ * Standardize list data to { items, total } while retaining an optional legacy array key.
+ */
+export declare function createListResult<T, LegacyKey extends string>(items: T[], legacyKey?: LegacyKey): ListResult<T, LegacyKey>;
+/**
+ * Map a gateway success envelope's data while preserving the transport metadata.
+ */
+export declare function mapGatewayData<T, U>(response: PlatformGatewaySuccess<T>, mapper: (data: T) => U): PlatformGatewaySuccess<U>;
+/**
+ * Apply SDK aliases across all items in a list-like payload.
+ */
+export declare function mapAliasedList<TItem extends AnyRecord, LegacyKey extends string>(data: unknown, legacyKey?: LegacyKey): ListResult<TItem, LegacyKey>;
+export {};

package/dist/packages/sdk/src/topicsClient.d.ts

@@ -0,0 +1,45 @@
+import { type GatewayClientConfig } from "./coreClient";
+import type { JsonObject, TopicCoverageResponse, TopicIdentifierInput, TopicListResponse, TopicRecord, TopicTreeResponse } from "./types";
+export type TopicsClientConfig = GatewayClientConfig;
+export type TopicListInput = TopicIdentifierInput & {
+    ontologyId?: string;
+    parentTopicId?: string;
+    status?: string;
+    type?: string;
+};
+export type TopicCreateInput = TopicIdentifierInput & {
+    name: string;
+    description?: string;
+    type?: string;
+    parentTopicId?: string;
+    ontologyId?: string;
+    tenantId?: string;
+    workspaceId?: string;
+    visibility?: "private" | "team" | "firm" | "external" | "public";
+    createdBy?: string;
+    metadata?: JsonObject;
+};
+export type TopicUpdateInput = TopicIdentifierInput & {
+    name?: string;
+    description?: string;
+    type?: string;
+    ontologyId?: string;
+    clearOntologyId?: boolean;
+    status?: "active" | "archived" | "watching";
+    visibility?: "private" | "team" | "firm" | "external" | "public";
+};
+export type TopicTreeQuery = {
+    maxDepth?: number;
+};
+export type TopicCoverageQuery = {
+    includeDescendants?: boolean;
+    maxDepth?: number;
+};
+export declare function createTopicsClient(config?: TopicsClientConfig): {
+    list(query?: TopicListInput): Promise<import("./coreClient").PlatformGatewaySuccess<TopicListResponse>>;
+    get(topicId: string): Promise<import("./coreClient").PlatformGatewaySuccess<TopicRecord>>;
+    create(input: TopicCreateInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<TopicRecord>>;
+    update(topicId: string, input: TopicUpdateInput, idempotencyKey?: string): Promise<import("./coreClient").PlatformGatewaySuccess<TopicRecord>>;
+    getTree(topicId: string, query?: TopicTreeQuery): Promise<import("./coreClient").PlatformGatewaySuccess<TopicTreeResponse>>;
+    getCoverage(topicId: string, query?: TopicCoverageQuery): Promise<import("./coreClient").PlatformGatewaySuccess<TopicCoverageResponse>>;
+};