@githonllc/avouch 0.0.0-stage → 0.1.0

package/dist/src/query.d.ts

@@ -0,0 +1,304 @@
+import { type Expr, type Type } from "./expr.js";
+export type S = string | null;
+export type QueryCite = {
+    doc: string;
+    quote: string;
+};
+export type QueryStamp = {
+    ontology: string;
+    git: {
+        commit: string;
+        dirty: boolean;
+        path: string;
+    } | null;
+    check: {
+        status: "not_run";
+    } | {
+        status: "pass" | "fail";
+        adapter: string;
+        schemaErrors: number;
+        violations: number;
+        waived: number;
+    };
+};
+export type QueryVerb = "list" | "action" | "object" | "result" | "writes" | "reads" | "cites";
+export type QueryEnvelope = {
+    avouchQuery: 1;
+    stamp: QueryStamp;
+    verb: QueryVerb;
+    arg: string;
+    result: unknown;
+};
+export type QueryList = {
+    kind: "actions";
+    items: {
+        id: string;
+        context: S;
+        doc: S;
+        docTerm: S;
+        permissionKeys: string[];
+    }[];
+} | {
+    kind: "objects";
+    items: {
+        id: string;
+        context: S;
+        datasource: S;
+        outOfScope: S;
+    }[];
+} | {
+    kind: "links";
+    items: {
+        id: string;
+        from: S;
+        to: S;
+        cardinality: S;
+        via: S;
+        table: S;
+    }[];
+} | {
+    kind: "derived";
+    items: {
+        id: string;
+        of: S;
+        type: Type | null;
+        docTerm: S;
+        hasExpr: boolean;
+    }[];
+} | {
+    kind: "dispositions";
+    items: {
+        id: string;
+        class: S;
+        cite: QueryCite | null;
+    }[];
+} | {
+    kind: "anchors";
+    items: {
+        doc: string;
+        claims: number;
+    }[];
+} | {
+    kind: "gaps";
+    items: {
+        id: S;
+        rule: S;
+        kind: S;
+        keys: string[];
+        conflict: S;
+        proposed: S;
+    }[];
+};
+export type QueryAlt = {
+    keys: string[];
+    conditionalKeys: string[];
+    cite: QueryCite | null;
+    conditionalCite: QueryCite | null;
+    principals: {
+        kinds: string[];
+        cite: QueryCite | null;
+    } | null;
+};
+export type QueryRow = {
+    row: number | "otherwise";
+    when: {
+        passes: string;
+    } | {
+        fails: string;
+    } | null;
+    result: S;
+    class: S;
+    cites: QueryCite[];
+    next: unknown;
+    requires: {
+        condition: string;
+        must: "pass" | "fail";
+        specified: boolean;
+    }[];
+    blockedBy: S;
+};
+export type QueryAction = {
+    id: string;
+    context: S;
+    doc: S;
+    docTerm: S;
+    permission: {
+        form: "unknown";
+    } | {
+        form: "none";
+        reason: S;
+        cite: QueryCite | null;
+        principals: QueryAlt["principals"];
+    } | {
+        form: "keys";
+        alternatives: QueryAlt[];
+    };
+    idempotencyKey: {
+        required: boolean;
+        cite: QueryCite | null;
+    } | null;
+    parameters: {
+        name: string;
+        type: Type | null;
+        optional: boolean;
+        values: string[] | null;
+        cite: QueryCite | null;
+    }[];
+    conditions: {
+        id: string;
+        expr: Expr | null;
+        exprText: S;
+        unspecified: S;
+        reads: unknown[];
+        cites: QueryCite[];
+        scenarios: string[];
+    }[];
+    decision: {
+        order: QueryCite | null;
+        rows: QueryRow[];
+    } | null;
+    edits: {
+        prop: string;
+        cite: QueryCite | null;
+    }[];
+    creates: string[];
+    emits: string[];
+    linkEffects: {
+        link: string;
+        kind: "effect" | "none" | "unspecified";
+        text: S;
+        cite: QueryCite | null;
+        scenarios: string[];
+    }[];
+    crossContext: {
+        via: S;
+        unspecified: S;
+        cite: QueryCite | null;
+    } | null;
+    evidence: S;
+    transitions: {
+        object: string;
+        from: S;
+        to: S;
+    }[];
+};
+export type QueryObject = {
+    id: string;
+    context: S;
+    datasource: S;
+    doc: S;
+    outOfScope: S;
+    scope: "tenant" | "global" | "root" | null;
+    properties: {
+        name: string;
+        class: S;
+        type: Type | null;
+        cite: QueryCite | null;
+        canonicalValues: {
+            values: string[];
+            cite: QueryCite | null;
+        } | null;
+        materializedFrom: {
+            reads: string[];
+            cites: QueryCite[];
+        } | null;
+    }[];
+    derived: {
+        id: string;
+        type: Type | null;
+        docTerm: S;
+        exprText: S;
+        cite: QueryCite | null;
+    }[];
+    stateMachine: {
+        doc: S;
+        initial: S;
+        terminal: string[];
+        transitions: {
+            from: S;
+            to: S;
+            by: string[];
+            outOfScope: S;
+        }[];
+    } | null;
+    links: {
+        id: string;
+        end: "from" | "to";
+        other: S;
+        cardinality: S;
+        via: S;
+    }[];
+    writers: {
+        action: string;
+        edits: string[];
+        creates: boolean;
+    }[];
+    readers: {
+        action: string;
+        condition: string;
+        props: string[];
+    }[];
+    unanalyzed: QueryWrites["unanalyzed"];
+};
+export type QueryDisposition = {
+    disposition: string;
+    class: S;
+    cite: QueryCite | null;
+    rows: ({
+        action: string;
+    } & QueryRow)[];
+};
+export type QueryWrites = {
+    target: string;
+    kind: "property" | "derived";
+    unanalyzed: {
+        at: string;
+        error: string;
+    }[];
+    writers: {
+        action: string;
+        cite: QueryCite | null;
+        path: string[];
+    }[];
+    creators: string[];
+};
+export type QueryReads = {
+    target: string;
+    kind: "property" | "derived";
+    materialized: string[];
+    unanalyzed: {
+        at: string;
+        error: string;
+    }[];
+    conditions: {
+        action: string;
+        condition: string;
+        source: "expr" | "reads";
+        direct: boolean;
+        via: string[];
+        rows: number[];
+    }[];
+    derived: {
+        id: string;
+        source: "expr" | "reads";
+        direct: boolean;
+        via: string[];
+    }[];
+};
+export type QueryCites = {
+    anchor: string;
+    claims: {
+        path: string;
+        subject: string;
+        quote: S;
+    }[];
+};
+export declare function showExpr(e: unknown): string;
+export declare function queryAction(ont: unknown, id: string): QueryAction | null;
+export declare function queryDisposition(ont: unknown, id: string): QueryDisposition | null;
+export declare function queryObject(ont: unknown, id: string): QueryObject | null;
+export declare function queryWrites(ont: unknown, t: string): QueryWrites | null;
+export declare function queryReads(ont: unknown, t: string): QueryReads | null;
+export declare function queryCites(ont: unknown, anchor: string): QueryCites;
+export declare const QUERY_LIST_KINDS: readonly ["actions", "objects", "links", "derived", "dispositions", "anchors", "gaps"];
+export declare function queryList(ont: unknown, kind: string): QueryList | null;