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

package/dist/graphClient.d.ts

@@ -0,0 +1,271 @@
+import { GatewayClientConfig, PlatformGatewaySuccess } from './coreClient.js';
+export { GatewayScope, LucernApiError } from './coreClient.js';
+import { TopicIdentifierInput, JsonObject, TextAliasInput, GraphAnalyticsMetric, ListResult, PlatformGraphNode, PlatformGraphEdge, DeleteEdgeResponse, GraphNeighborhoodResponse, GraphPathResponse, GraphAnalyticsResponse } from './types.js';
+export { CreateEdgeResponse, CreateNodeResponse, QueryEdgesResponse, QueryNodesResponse, UpdateNodeResponse } from './types.js';
+import './contracts/workflow-runtime.contract.js';
+import './contracts/lens-workflow.contract.js';
+import './contracts/lens-filter.contract.js';
+
+/** Configuration for the graph client. */
+type GraphClientConfig = GatewayClientConfig;
+/** Filter parameters for listing graph nodes. */
+type ListNodesInput = {
+    nodeId?: string;
+    globalId?: string;
+    topicId?: string;
+    nodeType?: string;
+    limit?: number;
+} & TopicIdentifierInput;
+/** Paginated list response containing graph nodes. */
+type ListNodesResponse = ListResult<PlatformGraphNode, "nodes">;
+/** @deprecated Use ListNodesInput. */
+type QueryNodesInput = ListNodesInput;
+/** Input for creating a new graph node. */
+type CreateNodeInput = {
+    text?: string;
+    /** @deprecated Use text. */
+    canonicalText?: string;
+    nodeType: string;
+    topicId?: string;
+    content?: string;
+    contentHash?: string;
+    globalId?: string;
+    sourceType?: string;
+    subtype?: string;
+    title?: string;
+    confidence?: number;
+    status?: string;
+    tags?: string[];
+    metadata?: JsonObject;
+    verificationStatus?: string;
+} & TextAliasInput & TopicIdentifierInput;
+/** Input for updating an existing graph node. */
+type UpdateNodeInput = {
+    nodeId: string;
+    text?: string;
+    canonicalText?: string;
+    content?: string;
+    contentHash?: string;
+    title?: string;
+    subtype?: string;
+    confidence?: number;
+    status?: string;
+    tags?: string[];
+    metadata?: JsonObject;
+    verificationStatus?: string;
+} & TextAliasInput;
+/** Input for retrieving a single graph node by canonical identifier. */
+type GetNodeInput = {
+    nodeId?: string;
+    globalId?: string;
+};
+/** Filter parameters for listing graph edges. */
+type ListEdgesInput = {
+    edgeId?: string;
+    topicId?: string;
+    fromNodeId?: string;
+    toNodeId?: string;
+    edgeType?: string;
+    limit?: number;
+} & TopicIdentifierInput;
+/** Paginated list response containing graph edges. */
+type ListEdgesResponse = ListResult<PlatformGraphEdge, "edges">;
+/** @deprecated Use ListEdgesInput. */
+type QueryEdgesInput = ListEdgesInput;
+/** Input for creating a typed edge between two graph nodes. */
+type CreateEdgeInput = {
+    fromNodeId: string;
+    toNodeId: string;
+    edgeType: string;
+    globalId?: string;
+    topicId?: string;
+    confidence?: number;
+    weight?: number;
+    context?: string;
+    derivationType?: string;
+} & TopicIdentifierInput;
+/** Filter for selecting edges to delete. */
+type DeleteEdgeInput = {
+    edgeId?: string;
+    fromNodeId?: string;
+    toNodeId?: string;
+    edgeType?: string;
+};
+/** Input for batch-creating multiple graph nodes. */
+type BatchCreateNodesInput = {
+    nodes: Array<CreateNodeInput>;
+};
+/** Input for superseding an existing graph node with a new version. */
+type SupersedeNodeInput = {
+    oldNodeId?: string;
+    nodeId?: string;
+    newGlobalId?: string;
+    newCanonicalText?: string;
+    text?: string;
+    canonicalText?: string;
+    newContentHash?: string;
+    reason?: string;
+};
+/** Input for updating a node's verification state. */
+type VerifyNodeInput = {
+    nodeId?: string;
+    id?: string;
+    verificationStatus: string;
+    confidence?: number;
+};
+/** Input for permanently deleting a node via admin-only API. */
+type HardDeleteNodeInput = {
+    nodeId?: string;
+    id?: string;
+    reason: string;
+    allowBeliefHardDelete?: boolean;
+};
+/** Input for retrieving the local neighborhood around a graph node. */
+type NeighborhoodInput = {
+    globalId?: string;
+    globalIds?: string;
+    maxDepth?: number;
+};
+/** Input for finding the shortest path between two graph nodes. */
+type PathInput = {
+    fromGlobalId: string;
+    toGlobalId: string;
+    maxDepth?: number;
+};
+/** Input for retrieving a specific graph analytics metric. */
+type AnalyticsInput = {
+    metric?: GraphAnalyticsMetric;
+    limit?: number;
+};
+/** Input for traversing the graph from a starting node. */
+type TraverseInput = {
+    startNode: string;
+    direction?: string;
+    maxDepth?: number;
+    topicId?: string;
+} & TopicIdentifierInput;
+/** Input for structural analysis of a topic graph. */
+type AnalyzeInput = {
+    topicId?: string;
+    metric?: GraphAnalyticsMetric;
+    limit?: number;
+} & TopicIdentifierInput;
+/** Input for detecting confirmation-bias patterns in a topic graph. */
+type BiasInput = {
+    topicId?: string;
+    threshold?: number;
+    limit?: number;
+} & TopicIdentifierInput;
+/** Input for finding beliefs without sufficient testing questions. */
+type GapsInput = {
+    topicId?: string;
+    minConfidence?: number;
+} & TopicIdentifierInput;
+/** Input for cross-resource search within a topic scope. */
+type SearchInput = {
+    q?: string;
+    query?: string;
+    topicId?: string;
+    types?: string[];
+    status?: string;
+    minConfidence?: number;
+    limit?: number;
+    cursor?: string;
+} & TopicIdentifierInput;
+/**
+ * Create the low-level graph client for nodes, edges, and graph analytics.
+ * @param config - Gateway transport configuration.
+ * @returns An object with methods for CRUD on nodes/edges plus analytics, traversal, and search.
+ */
+declare function createGraphClient(config?: GraphClientConfig): {
+    /**
+     * List graph nodes matching the provided filters.
+     */
+    listNodes(query: ListNodesInput): Promise<PlatformGatewaySuccess<ListResult<PlatformGraphNode, "nodes">>>;
+    /**
+     * @deprecated Use listNodes.
+     */
+    queryNodes(query: QueryNodesInput): Promise<PlatformGatewaySuccess<ListResult<PlatformGraphNode, "nodes">>>;
+    /**
+     * Retrieve a single graph node by nodeId or globalId.
+     */
+    getNode(query: GetNodeInput): Promise<PlatformGatewaySuccess<PlatformGraphNode>>;
+    /**
+     * Create a graph node.
+     */
+    createNode(input: CreateNodeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<PlatformGraphNode>>;
+    /**
+     * Update a graph node.
+     */
+    updateNode(input: UpdateNodeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<PlatformGraphNode>>;
+    /**
+     * Batch create graph nodes through the admin route surface.
+     */
+    batchCreateNodes(input: BatchCreateNodesInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Supersede an existing graph node with a new canonical version.
+     */
+    supersedeNode(input: SupersedeNodeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Update a node's verification status.
+     */
+    verifyNode(input: VerifyNodeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Permanently delete a node via the admin-only hard-delete route.
+     */
+    hardDeleteNode(input: HardDeleteNodeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * List graph edges matching the provided filters.
+     */
+    listEdges(query: ListEdgesInput): Promise<PlatformGatewaySuccess<ListResult<PlatformGraphEdge, "edges">>>;
+    /**
+     * @deprecated Use listEdges.
+     */
+    queryEdges(query: QueryEdgesInput): Promise<PlatformGatewaySuccess<ListResult<PlatformGraphEdge, "edges">>>;
+    /**
+     * Create a graph edge.
+     */
+    createEdge(input: CreateEdgeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<PlatformGraphEdge>>;
+    /**
+     * Delete one or more edges matching the provided filter.
+     */
+    deleteEdge(query: DeleteEdgeInput, idempotencyKey?: string): Promise<PlatformGatewaySuccess<DeleteEdgeResponse>>;
+    /**
+     * Retrieve a graph neighborhood around a root node.
+     */
+    neighborhood(query: NeighborhoodInput): Promise<PlatformGatewaySuccess<GraphNeighborhoodResponse>>;
+    /**
+     * Traverse the graph from a starting node.
+     */
+    traverse(query: TraverseInput): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Analyze graph structure for a topic.
+     */
+    analyze(query?: AnalyzeInput): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Detect confirmation-bias patterns for a topic graph.
+     */
+    bias(query?: BiasInput): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Find graph gaps for beliefs that still need testing.
+     */
+    gaps(query: GapsInput): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Search across graph resources within a topic.
+     */
+    search(query: SearchInput): Promise<PlatformGatewaySuccess<Record<string, unknown>>>;
+    /**
+     * Retrieve a graph neighborhood around a root node.
+     */
+    getNeighborhood(query: NeighborhoodInput): Promise<PlatformGatewaySuccess<GraphNeighborhoodResponse>>;
+    /**
+     * Retrieve the shortest known path between two graph nodes.
+     */
+    getPath(query: PathInput): Promise<PlatformGatewaySuccess<GraphPathResponse>>;
+    /**
+     * Retrieve graph analytics for the requested metric.
+     */
+    getAnalytics(query?: AnalyticsInput): Promise<PlatformGatewaySuccess<GraphAnalyticsResponse>>;
+};
+
+export { type AnalyticsInput, type AnalyzeInput, type BatchCreateNodesInput, type BiasInput, type CreateEdgeInput, type CreateNodeInput, type DeleteEdgeInput, DeleteEdgeResponse, type GapsInput, type GetNodeInput, GraphAnalyticsMetric, GraphAnalyticsResponse, type GraphClientConfig, GraphNeighborhoodResponse, GraphPathResponse, type HardDeleteNodeInput, type ListEdgesInput, type ListEdgesResponse, type ListNodesInput, type ListNodesResponse, ListResult, type NeighborhoodInput, type PathInput, PlatformGatewaySuccess, type QueryEdgesInput, type QueryNodesInput, type SearchInput, type SupersedeNodeInput, type TraverseInput, type UpdateNodeInput, type VerifyNodeInput, createGraphClient };