@anchrd/intel-api 0.6.6 → 0.7.0

package/dist/knowledge/knowledge.types.d.ts

@@ -1,198 +0,0 @@
-import type { AppendKnowledgeTableRowsInput, AppendKnowledgeTableRowsResult, ArchiveKnowledgeNodeInput, CreateKnowledgeNodeInput, DefineKnowledgeTableInput, KnowledgeAttachment, KnowledgeCitation, KnowledgeDocument, KnowledgeGraph, KnowledgeGraphInput, KnowledgeLink, KnowledgeNode, KnowledgeTable, KnowledgeVersion, ListKnowledgeNodesInput, ResolveKnowledgeLinksInput, ResolveKnowledgeLinksResult, ResourceGrant, ResourceGrantList, ResourceVerb, RevokeKnowledgeGrantInput, SaveKnowledgeAttachmentInput, SaveKnowledgeVersionInput, SearchKnowledgeInput, ShareKnowledgeInput, ShareKnowledgeResult, UpdateKnowledgeNodeInput } from "@anchrd/intel-contract";
-import type { SemanticIndex } from "../adapters/semantic-index/semantic-index.types.js";
-export interface Actor {
-    id: string;
-    email: string;
-    isAdmin?: boolean;
-}
-export interface NewKnowledgeNode {
-    node: KnowledgeNode;
-    actorId: string;
-    idempotencyKey: string;
-    auditId: string;
-}
-export interface NewKnowledgeVersion {
-    version: KnowledgeVersion;
-    actorId: string;
-    baseVersionId: string | null;
-    idempotencyKey: string;
-    auditId: string;
-}
-export interface NewKnowledgeTableVersion {
-    version: Omit<KnowledgeVersion, "sequence">;
-    actorId: string;
-    idempotencyKey: string;
-    auditId: string;
-}
-export interface KnowledgeRepository {
-    listVisible(actor: Actor, input: ListKnowledgeNodesInput): Promise<{
-        items: KnowledgeNode[];
-        withChildren: string[];
-    }>;
-    listVisibleBounded(actor: Actor, input: {
-        parentId: string | null;
-        limit: number;
-    }): Promise<BoundedChildren>;
-    getVisible(actor: Actor, nodeId: string): Promise<KnowledgeNode | null>;
-    can(actor: Actor, nodeId: string, verb: ResourceVerb): Promise<boolean>;
-    findIdempotentNode(actorId: string, operation: "knowledge.create" | "knowledge.save" | "knowledge.append" | "knowledge.update" | "knowledge.archive" | "knowledge.share" | "knowledge.revoke", idempotencyKey: string): Promise<string | null>;
-    findIdempotentRevocation(actorId: string, idempotencyKey: string): Promise<boolean | null>;
-    insertNode(input: NewKnowledgeNode): Promise<KnowledgeNode>;
-    getVersion(versionId: string): Promise<KnowledgeVersion | null>;
-    appendVersion(input: NewKnowledgeVersion): Promise<"saved" | "conflict">;
-    appendTableVersion(input: NewKnowledgeTableVersion): Promise<KnowledgeVersion>;
-    listVersionContentKeys(nodeId: string): Promise<string[]>;
-    firstVersionContentKey(nodeId: string): Promise<string | null>;
-    listVersions(nodeId: string): Promise<KnowledgeVersion[]>;
-    updateNode(input: {
-        node: KnowledgeNode;
-        baseUpdatedAt: string;
-        actorId: string;
-        idempotencyKey: string;
-        auditId: string;
-    }): Promise<"cycle" | "conflict" | KnowledgeNode>;
-    archiveNode(input: {
-        nodeId: string;
-        baseUpdatedAt: string;
-        archivedAt: string | null;
-        updatedAt: string;
-        actorId: string;
-        idempotencyKey: string;
-        auditId: string;
-    }): Promise<"conflict" | KnowledgeNode>;
-    listGrants(resourceId: string): Promise<ResourceGrant[]>;
-    organizationExecuteReaches(nodeId: string, exceptGrantId: string): Promise<boolean>;
-    listLinksVisible(actor: Actor, nodeId: string): Promise<KnowledgeLink[]>;
-    resolveVisibleTitles(actor: Actor, nodeIds: string[]): Promise<Array<{
-        nodeId: string;
-        title: string;
-    }>>;
-    replaceTextLinks(input: {
-        sourceNodeId: string;
-        links: Array<{
-            id: string;
-            targetNodeId: string;
-        }>;
-        actorId: string;
-        auditId: string;
-        occurredAt: string;
-    }): Promise<void>;
-    graphVisible(actor: Actor, input: KnowledgeGraphInput): Promise<KnowledgeGraph>;
-    setGrant(input: {
-        grant: ResourceGrant;
-        actorId: string;
-        idempotencyKey: string;
-        auditId: string;
-    }): Promise<ResourceGrant>;
-    revokeGrant(input: {
-        resourceId: string;
-        grantId: string;
-        actorId: string;
-        idempotencyKey: string;
-        auditId: string;
-        occurredAt: string;
-    }): Promise<boolean>;
-    searchVisible(actor: Actor, input: SearchKnowledgeInput): Promise<KnowledgeCitation[]>;
-    hydrateVisibleCitations(actor: Actor, nodeIds: string[]): Promise<KnowledgeCitation[]>;
-    listCurrentVersionIds(input: {
-        after: string | null;
-        limit: number;
-    }): Promise<string[]>;
-}
-export interface ContentStore {
-    get(key: string): Promise<string | null>;
-    getBytes(key: string): Promise<ArrayBuffer | null>;
-    getStream(key: string): Promise<ReadableStream<Uint8Array> | null>;
-    put(key: string, content: string, mediaType: string): Promise<void>;
-    putBytes(key: string, content: ArrayBuffer, mediaType: string): Promise<void>;
-    delete(key: string): Promise<void>;
-}
-export interface KnowledgeAttachmentBody {
-    attachment: KnowledgeAttachment;
-    body: ReadableStream<Uint8Array>;
-}
-export interface KnowledgeDeps {
-    repository: KnowledgeRepository;
-    content: ContentStore;
-    id(): string;
-    now(): Date;
-    externalFlowCallers(actor: Actor, folderId: string): Promise<{
-        visible: string[];
-        hidden: number;
-    }>;
-    flowKnowledgeReferences(actor: Actor, folderId: string): Promise<string[]>;
-    hash(content: string | Uint8Array): Promise<string>;
-    indexing: {
-        enqueue(versionId: string): Promise<void>;
-    };
-    semantic?: SemanticIndex | undefined;
-}
-export type FolderAccess = "ok" | "missing" | "not-a-folder" | "forbidden";
-export interface BoundedChildren {
-    items: KnowledgeNode[];
-    total: number;
-}
-export interface KnowledgeService {
-    list(actor: Actor, input: ListKnowledgeNodesInput): Promise<{
-        items: KnowledgeNode[];
-    }>;
-    /**
-     * One level of the tree as this actor may see it, bounded: at most `limit` current children, and
-     * `total` for how many there are. Its caller is the relation graph, which draws a bounded picture
-     * and must not read a folder of a thousand documents to do it (#30).
-     *
-     * ⚠️ `total` counts what passed the visibility predicate and nothing else, or the size a picture
-     * reports would become a way of learning that something is filed here.
-     */
-    childrenBounded(actor: Actor, input: {
-        parentId: string | null;
-        limit: number;
-    }): Promise<BoundedChildren>;
-    get(actor: Actor, nodeId: string): Promise<KnowledgeDocument>;
-    folderAccess(actor: Actor, folderId: string): Promise<FolderAccess>;
-    create(actor: Actor, input: CreateKnowledgeNodeInput): Promise<KnowledgeNode>;
-    save(actor: Actor, input: SaveKnowledgeVersionInput): Promise<KnowledgeDocument>;
-    saveAttachment(actor: Actor, input: SaveKnowledgeAttachmentInput): Promise<KnowledgeDocument>;
-    getTable(actor: Actor, nodeId: string): Promise<KnowledgeTable>;
-    defineTable(actor: Actor, input: DefineKnowledgeTableInput): Promise<KnowledgeTable>;
-    appendTableRows(actor: Actor, input: AppendKnowledgeTableRowsInput): Promise<AppendKnowledgeTableRowsResult>;
-    getAttachment(actor: Actor, nodeId: string): Promise<KnowledgeAttachment>;
-    readAttachment(actor: Actor, nodeId: string): Promise<KnowledgeAttachmentBody>;
-    listVersions(actor: Actor, nodeId: string): Promise<{
-        items: KnowledgeVersion[];
-    }>;
-    update(actor: Actor, input: UpdateKnowledgeNodeInput): Promise<KnowledgeNode>;
-    archive(actor: Actor, input: ArchiveKnowledgeNodeInput): Promise<KnowledgeNode>;
-    listGrants(actor: Actor, resourceId: string): Promise<ResourceGrantList>;
-    listLinks(actor: Actor, nodeId: string): Promise<{
-        items: KnowledgeLink[];
-    }>;
-    resolveLinks(actor: Actor, input: ResolveKnowledgeLinksInput): Promise<ResolveKnowledgeLinksResult>;
-    graph(actor: Actor, input: KnowledgeGraphInput): Promise<KnowledgeGraph>;
-    visibleNode(actor: Actor, nodeId: string): Promise<KnowledgeNode | null>;
-    share(actor: Actor, input: ShareKnowledgeInput): Promise<ShareKnowledgeResult>;
-    revokeGrant(actor: Actor, input: RevokeKnowledgeGrantInput): Promise<{
-        revoked: boolean;
-    }>;
-    search(actor: Actor, input: SearchKnowledgeInput): Promise<{
-        items: KnowledgeCitation[];
-    }>;
-    reindex(actor: Actor): Promise<{
-        queued: number;
-    }>;
-}
-export interface KnowledgeIndexTarget {
-    nodeId: string;
-    versionId: string;
-    title: string;
-    contentKeys: string[];
-    mediaType: string;
-    kind: "document" | "attachment" | "table";
-    updatedAt: string;
-}
-export interface KnowledgeIndexRepository {
-    getTarget(versionId: string): Promise<KnowledgeIndexTarget | null>;
-    replace(target: KnowledgeIndexTarget, content: string): Promise<void>;
-    markIndexed(versionId: string, occurredAt: string): Promise<void>;
-    markError(versionId: string, message: string, occurredAt: string): Promise<void>;
-}