@nervur-org/dock 0.3.0

package/dist/beings/user.d.ts

@@ -0,0 +1,315 @@
+import type { Asker, Blueprint, Invitation, JsonObject, OccupantRecord, Stance } from '@nervur-org/nervur';
+import { Carrier } from './carry.ts';
+export declare const DESK = "desk";
+export declare const BELL = "bell";
+export declare const HOME = "home";
+declare const isDevice: (occ: OccupantRecord | undefined) => boolean;
+declare const rootMinted: (occ: OccupantRecord | undefined) => boolean;
+declare const mayWake: (occ: OccupantRecord | undefined) => boolean;
+declare const mayMint: (occ: OccupantRecord | undefined) => boolean;
+declare const mayRevoke: (occ: OccupantRecord | undefined) => boolean;
+export declare class User extends Carrier {
+    #private;
+    static carries(occ: OccupantRecord | undefined): boolean;
+    static hidden(id: string): boolean;
+    static shows(id: string, occ: OccupantRecord | undefined): boolean;
+    static cells: {
+        name: string;
+        reports: JsonObject[];
+        ways: Record<string, Invitation>;
+        outbox: Record<string, JsonObject[]>;
+    };
+    constructor(stance: Stance);
+    describe(asker: Asker): Blueprint;
+    static asks: {
+        hello: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    invitation: {
+                        type: string;
+                    };
+                };
+            };
+        };
+        whoami: {
+            description: string;
+            input: {
+                type: string;
+            };
+            for: typeof isDevice;
+        };
+        device: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    client: {
+                        type: string;
+                    };
+                    wake: {
+                        type: string;
+                    };
+                    reach: {
+                        type: string;
+                    };
+                    mint: {
+                        type: string;
+                    };
+                    revoke: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            };
+            for: typeof mayMint;
+        };
+        push: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    client: {
+                        type: string;
+                    };
+                    object: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            };
+            for: typeof mayWake;
+        };
+        chores: {
+            description: string;
+            input: {
+                type: string;
+            };
+            for: (occ: OccupantRecord | undefined) => boolean;
+        };
+        look: {
+            description: string;
+            input: {
+                type: string;
+            };
+            for: typeof isDevice;
+        };
+        page: {
+            description: string;
+            input: {
+                type: string;
+            };
+            for: typeof isDevice;
+        };
+        name: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            };
+            for: typeof rootMinted;
+        };
+        devices: {
+            description: string;
+            input: {
+                type: string;
+            };
+            for: typeof isDevice;
+        };
+        join: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    invitation: {
+                        type: string;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                };
+                required: string[];
+            };
+            for: typeof mayMint;
+        };
+        forget: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    client: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            };
+            for: typeof mayRevoke;
+        };
+        report: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    event: {
+                        type: string;
+                    };
+                    result: {};
+                };
+                required: string[];
+            };
+            for: typeof isDevice;
+        };
+        bell: {
+            description: string;
+            input: {
+                type: string;
+                properties: {
+                    invitation: {
+                        type: string;
+                    };
+                    banner: {
+                        type: string;
+                    };
+                    token: {
+                        type: string;
+                    };
+                };
+            };
+            for: typeof isDevice;
+        };
+        missed: {
+            description: string;
+            input: {
+                type: string;
+            };
+            for: typeof isDevice;
+        };
+    };
+    hello(args: JsonObject, asker: Asker): Promise<{
+        welcome: string | null;
+        name: import("@nervur-org/nervur").Json;
+    }>;
+    wayBack(id: string, inv: Invitation): Promise<boolean>;
+    whoami(_args: JsonObject, asker: Asker): {
+        id: string | null;
+        client: string | null;
+    };
+    device(args: JsonObject, asker: Asker): Promise<JsonObject>;
+    push(args: JsonObject): Promise<{
+        error: string;
+        pushed?: undefined;
+    } | {
+        error?: undefined;
+        pushed: import("@nervur-org/nervur").Json;
+    } | {
+        unreached: boolean;
+        rang: boolean;
+    }>;
+    private unreached;
+    private ring;
+    bell(args: JsonObject, asker: Asker): Promise<JsonObject>;
+    missed(_args: JsonObject, asker: Asker): {
+        error: string;
+        missed?: undefined;
+    } | {
+        error?: undefined;
+        missed: JsonObject[];
+    };
+    join(args: JsonObject): Promise<JsonObject>;
+    devices(_args: JsonObject, asker: Asker): {
+        name: string;
+        line: string;
+        client: string;
+        you?: boolean | undefined;
+        may?: ("mint" | "reach" | "revoke" | "wake")[] | undefined;
+    }[];
+    forget(args: JsonObject): {
+        error: string;
+        forgot?: undefined;
+    } | {
+        error?: undefined;
+        forgot: string;
+    };
+    chores(): {
+        chores: string[];
+    };
+    look(): {
+        name: string;
+        order: string[];
+        asks: {
+            whoami: {
+                title: string;
+                readOnly: boolean;
+            };
+            devices: {
+                title: string;
+                readOnly: boolean;
+            };
+            device: {
+                title: string;
+            };
+            join: {
+                title: string;
+            };
+            push: {
+                title: string;
+            };
+            forget: {
+                title: string;
+                destructive: boolean;
+            };
+            name: {
+                title: string;
+            };
+        };
+    };
+    page(_args: JsonObject, asker: Asker): {
+        kind: string;
+        of: ({
+            kind: string;
+            text: string;
+            role: string;
+            as?: undefined;
+            ask?: undefined;
+        } | {
+            text?: undefined;
+            role?: undefined;
+            kind: string;
+            ask: string;
+            as: string;
+        } | {
+            kind: string;
+            id: string;
+            as: string;
+        } | {
+            as?: undefined;
+            kind: string;
+            id: string;
+        } | {
+            text?: undefined;
+            role?: undefined;
+            as?: undefined;
+            kind: string;
+            ask: string;
+        })[];
+    };
+    name(args: JsonObject): {
+        error: string;
+        named?: undefined;
+    } | {
+        error?: undefined;
+        named: string;
+    };
+    report(args: JsonObject, asker: Asker): {
+        reported: boolean;
+    };
+}
+export {};