@synnaxlabs/client 0.56.2 → 0.57.0

package/dist/src/schematic/client.d.ts

@@ -1,58 +1,16 @@
-import { UnaryClient } from '@synnaxlabs/freighter';
+import { FileTransport, UnaryClient } from '@synnaxlabs/freighter';
+import { destructor } from '@synnaxlabs/x';
 import { z } from 'zod';
+import { actions } from '../actions';
+import { group } from '../group';
+import { ontology } from '../ontology';
+import { project } from '../project';
+import { query } from '../query';
 import { Action } from './actions.gen';
 import { symbol } from './symbol';
 import { Key, New, Schematic } from './types.gen';
-import { workspace } from '../workspace';
 export declare const SET_CHANNEL_NAME = "sy_schematic_set";
-declare const setDataBodyZ: z.ZodObject<{
-    nodes: z.ZodDefault<z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<{
-        key: string;
-        position: {
-            x: number;
-            y: number;
-        };
-        zIndex?: number | undefined;
-        measured?: {
-            width: number;
-            height: number;
-        } | undefined;
-    }[], null>>, z.ZodArray<z.ZodObject<{
-        key: z.ZodString;
-        position: z.ZodObject<{
-            x: z.ZodNumber;
-            y: z.ZodNumber;
-        }, z.core.$strip>;
-        zIndex: z.ZodOptional<z.ZodInt>;
-        measured: z.ZodOptional<z.ZodObject<{
-            width: z.ZodNumber;
-            height: z.ZodNumber;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>]>>;
-    edges: z.ZodDefault<z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<{
-        key: string;
-        source: {
-            node: string;
-            param: string;
-        };
-        target: {
-            node: string;
-            param: string;
-        };
-    }[], null>>, z.ZodArray<z.ZodObject<{
-        key: z.ZodString;
-        source: z.ZodObject<{
-            node: z.ZodString;
-            param: z.ZodString;
-        }, z.core.$strip>;
-        target: z.ZodObject<{
-            node: z.ZodString;
-            param: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>>]>>;
-    configs: z.ZodType<Record<string, Record<string | number, unknown>>, unknown, z.core.$ZodTypeInternals<Record<string, Record<string | number, unknown>>, unknown>>;
-}, z.core.$strip>;
-export type SetDataBody = z.input<typeof setDataBodyZ>;
+export declare const DELETE_CHANNEL_NAME = "sy_schematic_delete";
 declare const copyReqZ: z.ZodObject<{
     key: z.ZodUUID;
     name: z.ZodString;
@@ -60,15 +18,22 @@ declare const copyReqZ: z.ZodObject<{
 }, z.core.$strip>;
 declare const retrieveReqZ: z.ZodObject<{
     keys: z.ZodArray<z.ZodUUID>;
+    ignoreNotFoundError: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
-declare const singleRetrieveArgsZ: z.ZodPipe<z.ZodObject<{
+declare const retrieveMultiParamsZ: z.ZodUnion<[z.ZodObject<{
+    keys: z.ZodArray<z.ZodUUID>;
+    ignoreNotFoundError: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodPipe<z.ZodArray<z.ZodUUID>, z.ZodTransform<{
+    keys: string[];
+}, string[]>>]>;
+declare const singleRetrieveParamsZ: z.ZodPipe<z.ZodObject<{
     key: z.ZodUUID;
 }, z.core.$strip>, z.ZodTransform<{
     keys: string[];
 }, {
     key: string;
 }>>;
-export declare const retrieveArgsZ: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
+export declare const retrieveParamsZ: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
     key: z.ZodUUID;
 }, z.core.$strip>, z.ZodTransform<{
     keys: string[];
@@ -76,25 +41,62 @@ export declare const retrieveArgsZ: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
     key: string;
 }>>, z.ZodObject<{
     keys: z.ZodArray<z.ZodUUID>;
+    ignoreNotFoundError: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>]>;
-export type RetrieveArgs = z.input<typeof retrieveArgsZ>;
-export type RetrieveSingleParams = z.input<typeof singleRetrieveArgsZ>;
+export type RetrieveParams = z.input<typeof retrieveParamsZ>;
+export type RetrieveSingleParams = z.input<typeof singleRetrieveParamsZ>;
 export type RetrieveMultipleParams = z.input<typeof retrieveReqZ>;
-export type CopyArgs = z.input<typeof copyReqZ>;
-export declare class Client {
+export type CopyParams = z.input<typeof copyReqZ>;
+export interface ClientConfig {
+    unary: UnaryClient;
+    file: FileTransport;
+    ontology: ontology.Client;
+    cache: query.Cache;
+    groupStore: query.Table<group.Key, group.Group>;
+}
+export declare class Client extends query.Retriever<typeof retrieveMultiParamsZ, Key, Schematic> {
     readonly symbols: symbol.Client;
-    private readonly client;
-    constructor(client: UnaryClient);
-    create(workspace: workspace.Key, schematic: New): Promise<Schematic>;
-    create(workspace: workspace.Key, schematics: New[]): Promise<Schematic[]>;
-    rename(key: Key, name: string): Promise<void>;
-    setData(key: Key, data: SetDataBody): Promise<void>;
-    dispatch(key: Key, dispatchKey: string, actions: Action[]): Promise<void>;
-    retrieve(args: RetrieveSingleParams): Promise<Schematic>;
-    retrieve(args: RetrieveMultipleParams): Promise<Schematic[]>;
-    delete(keys: Key | Key[]): Promise<void>;
-    copy(args: CopyArgs): Promise<Schematic>;
+    private readonly cfg;
+    private readonly store;
+    private readonly dispatcher;
+    constructor(cfg: ClientConfig);
+    create(project: project.Key, schematic: New, opts?: query.WriteOptions<Schematic[]>): Promise<Schematic>;
+    create(project: project.Key, schematics: New[], opts?: query.WriteOptions<Schematic[]>): Promise<Schematic[]>;
+    rename(key: Key, name: string, opts?: query.WriteOptions): Promise<void>;
+    /**
+     * Applies actions to the cached document and sends them to the server, recording an
+     * undoable entry. Returns false without side effects when the document isn't cached.
+     * Rolls back the local apply and rethrows on send failure.
+     */
+    dispatch(key: Key, actions: Action | Action[], opts?: actions.Options<Schematic, Action>): Promise<boolean>;
+    /**
+     * Reverts the document's most recent undoable entry. Returns false when
+     * nothing is undoable.
+     */
+    undo(key: Key): Promise<boolean>;
+    /**
+     * Re-applies the document's most recently undone entry. Returns false when
+     * nothing is redoable.
+     */
+    redo(key: Key): Promise<boolean>;
+    /** Whether the document has a live undo entry. */
+    hasUndo(key: Key): boolean;
+    /** Whether the document has a live redo entry. */
+    hasRedo(key: Key): boolean;
+    /**
+     * Subscribes to changes in the document's undo/redo stacks. Returns a
+     * destructor that unsubscribes.
+     */
+    onUndoStateChange(callback: () => void, key?: Key): destructor.Destructor;
+    /** Stages actions committed atomically as one undoable entry. */
+    beginTransaction(key: Key, kind?: string): actions.Transaction<Action>;
+    private dispatchSender;
+    private sendDispatch;
+    delete(keys: Key | Key[], opts?: query.WriteOptions): Promise<void>;
+    /** Subscribes to every schematic delete delivered to the cache. */
+    onDelete(handler: (key: Key) => void): destructor.Destructor;
+    copy(params: CopyParams): Promise<Schematic>;
+    private execRetrieve;
 }
-export declare const ZERO_NEW: New;
 export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/src/schematic/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/schematic/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,KAAK,MAAM,EAGZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EACL,KAAK,GAAG,EAER,KAAK,GAAG,EAER,KAAK,SAAS,EAEf,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AAEnD,QAAA,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAA6D,CAAC;AAChF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAIvD,QAAA,MAAM,QAAQ;;;;iBAIZ,CAAC;AAEH,QAAA,MAAM,YAAY;;iBAAmC,CAAC;AACtD,QAAA,MAAM,mBAAmB;;;;;;GAEmB,CAAC;AAE7C,eAAO,MAAM,aAAa;;;;;;;;mBAA+C,CAAC;AAC1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACzD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACvE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAahD,qBAAa,MAAM;IACjB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAKzB,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC;IACpE,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAezE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASnD,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IASzE,QAAQ,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;IACxD,QAAQ,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAe5D,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IASxC,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;CAI/C;AAED,eAAO,MAAM,QAAQ,EAAE,GAKtB,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/schematic/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAS,KAAK,UAAU,EAAkB,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EACL,KAAK,MAAM,EAIZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EACL,KAAK,GAAG,EAER,KAAK,GAAG,EAER,KAAK,SAAS,EAEf,MAAM,uBAAuB,CAAC;AAE/B,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AACnD,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AAIzD,QAAA,MAAM,QAAQ;;;;iBAIZ,CAAC;AAEH,QAAA,MAAM,YAAY;;;iBAGhB,CAAC;AACH,QAAA,MAAM,oBAAoB;;;;;eAAwC,CAAC;AACnE,QAAA,MAAM,qBAAqB;;;;;;GAEiB,CAAC;AAE7C,eAAO,MAAM,eAAe;;;;;;;;;mBAAiD,CAAC;AAC9E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC7D,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACzE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAwBlD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;IACnB,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACjD;AAED,qBAAa,MAAO,SAAQ,KAAK,CAAC,SAAS,CACzC,OAAO,oBAAoB,EAC3B,GAAG,EACH,SAAS,CACV;IACC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8B;IACpD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA6C;gBAE5D,GAAG,EAAE,YAAY;IAkCvB,MAAM,CACV,OAAO,EAAE,OAAO,CAAC,GAAG,EACpB,SAAS,EAAE,GAAG,EACd,IAAI,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,GACrC,OAAO,CAAC,SAAS,CAAC;IACf,MAAM,CACV,OAAO,EAAE,OAAO,CAAC,GAAG,EACpB,UAAU,EAAE,GAAG,EAAE,EACjB,IAAI,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,GACrC,OAAO,CAAC,SAAS,EAAE,CAAC;IAyBjB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,KAAK,CAAC,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAalF;;;;OAIG;IACG,QAAQ,CACZ,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAC1B,IAAI,GAAE,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAM,GAC5C,OAAO,CAAC,OAAO,CAAC;IASnB;;;OAGG;IACG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAItC;;;OAGG;IACG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAItC,kDAAkD;IAClD,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO;IAI1B,kDAAkD;IAClD,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO;IAI1B;;;OAGG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,UAAU;IAIzE,iEAAiE;IACjE,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC;IAItE,OAAO,CAAC,cAAc;YAKR,YAAY;IAapB,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,IAAI,GAAE,KAAK,CAAC,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB7E,mEAAmE;IACnE,QAAQ,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,GAAG,UAAU,CAAC,UAAU;IAMtD,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;YAWpC,YAAY;CAS3B"}

package/dist/src/schematic/symbol/client.d.ts

@@ -1,51 +1,157 @@
-import { UnaryClient } from '@synnaxlabs/freighter';
+import { FileTransport, UnaryClient, UploadBody } from '@synnaxlabs/freighter';
 import { z } from 'zod';
 import { group } from '../../group';
+import { imex } from '../../imex';
 import { ontology } from '../../ontology';
+import { query } from '../../query';
 import { Key, New, Symbol } from './types.gen';
+export declare const SET_CHANNEL_NAME = "sy_schematic_symbol_set";
+export declare const DELETE_CHANNEL_NAME = "sy_schematic_symbol_delete";
 declare const retrieveRequestZ: z.ZodObject<{
     keys: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
     searchTerm: z.ZodOptional<z.ZodString>;
+    parent: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        type: z.ZodEnum<{
+            arc: "arc";
+            builtin: "builtin";
+            channel: "channel";
+            device: "device";
+            framer: "framer";
+            group: "group";
+            label: "label";
+            lineplot: "lineplot";
+            log: "log";
+            node: "node";
+            panel: "panel";
+            policy: "policy";
+            project: "project";
+            rack: "rack";
+            range: "range";
+            "range-alias": "range-alias";
+            role: "role";
+            schematic: "schematic";
+            schematic_symbol: "schematic_symbol";
+            status: "status";
+            table: "table";
+            task: "task";
+            user: "user";
+            view: "view";
+        }>;
+        key: z.ZodString;
+    }, z.core.$strip>, z.ZodPipe<z.ZodString, z.ZodTransform<{
+        type: "arc" | "builtin" | "channel" | "device" | "framer" | "group" | "label" | "lineplot" | "log" | "node" | "panel" | "policy" | "project" | "rack" | "range" | "range-alias" | "role" | "schematic" | "schematic_symbol" | "status" | "table" | "task" | "user" | "view";
+        key: string;
+    }, string>>]>>;
 }, z.core.$strip>;
-declare const singleRetrieveArgsZ: z.ZodPipe<z.ZodObject<{
-    key: z.ZodUUID;
-}, z.core.$strip>, z.ZodTransform<{
+declare const retrieveMultiParamsZ: z.ZodUnion<[z.ZodObject<{
+    keys: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
+    searchTerm: z.ZodOptional<z.ZodString>;
+    parent: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        type: z.ZodEnum<{
+            arc: "arc";
+            builtin: "builtin";
+            channel: "channel";
+            device: "device";
+            framer: "framer";
+            group: "group";
+            label: "label";
+            lineplot: "lineplot";
+            log: "log";
+            node: "node";
+            panel: "panel";
+            policy: "policy";
+            project: "project";
+            rack: "rack";
+            range: "range";
+            "range-alias": "range-alias";
+            role: "role";
+            schematic: "schematic";
+            schematic_symbol: "schematic_symbol";
+            status: "status";
+            table: "table";
+            task: "task";
+            user: "user";
+            view: "view";
+        }>;
+        key: z.ZodString;
+    }, z.core.$strip>, z.ZodPipe<z.ZodString, z.ZodTransform<{
+        type: "arc" | "builtin" | "channel" | "device" | "framer" | "group" | "label" | "lineplot" | "log" | "node" | "panel" | "policy" | "project" | "rack" | "range" | "range-alias" | "role" | "schematic" | "schematic_symbol" | "status" | "table" | "task" | "user" | "view";
+        key: string;
+    }, string>>]>>;
+}, z.core.$strip>, z.ZodPipe<z.ZodArray<z.ZodUUID>, z.ZodTransform<{
     keys: string[];
-}, {
-    key: string;
-}>>;
-declare const retrieveArgsZ: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
+}, string[]>>]>;
+declare const singleRetrieveParamsZ: z.ZodPipe<z.ZodObject<{
     key: z.ZodUUID;
 }, z.core.$strip>, z.ZodTransform<{
     keys: string[];
 }, {
     key: string;
-}>>, z.ZodObject<{
-    keys: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
-    searchTerm: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>]>;
-export type RetrieveArgs = z.input<typeof retrieveArgsZ>;
-export type RetrieveSingleParams = z.input<typeof singleRetrieveArgsZ>;
+}>>;
+export type RetrieveSingleParams = z.input<typeof singleRetrieveParamsZ>;
 export type RetrieveMultipleParams = z.input<typeof retrieveRequestZ>;
-export declare const SET_CHANNEL_NAME = "sy_schematic_symbol_set";
-export declare const DELETE_CHANNEL_NAME = "sy_schematic_symbol_delete";
-export interface CreateArgs extends New {
+export type RetrieveParams = RetrieveSingleParams | RetrieveMultipleParams;
+export interface CreateParams extends New {
     parent: ontology.ID;
 }
-export interface CreateMultipleArgs {
+export interface CreateMultipleParams {
     symbols: New[];
     parent: ontology.ID;
 }
-export declare class Client {
-    private readonly client;
-    constructor(client: UnaryClient);
-    create(options: CreateArgs): Promise<Symbol>;
-    create(options: CreateMultipleArgs): Promise<Symbol[]>;
-    rename(key: Key, name: string): Promise<void>;
-    retrieve(args: RetrieveSingleParams): Promise<Symbol>;
-    retrieve(args: RetrieveMultipleParams): Promise<Symbol[]>;
-    delete(keys: Key | Key[]): Promise<void>;
+export interface ClientConfig {
+    unary: UnaryClient;
+    file: FileTransport;
+    ontology: ontology.Client;
+    cache: query.Cache;
+    groupStore: query.Table<group.Key, group.Group>;
+}
+export declare class Client extends query.Retriever<typeof retrieveMultiParamsZ, Key, Symbol> {
+    private readonly cfg;
+    private readonly store;
+    constructor(cfg: ClientConfig);
+    create(options: CreateParams): Promise<Symbol>;
+    create(options: CreateMultipleParams): Promise<Symbol[]>;
+    rename(key: Key, name: string, opts?: query.WriteOptions): Promise<void>;
+    delete(keys: Key | Key[], opts?: query.WriteOptions): Promise<void>;
+    /**
+     * Exports every symbol in the group as a bundle: a zip archive holding one JSON file
+     * per symbol beside a manifest.json naming the group. Two symbols that take the same
+     * file name keep distinct names through a numeric suffix, and children that are not
+     * symbols are skipped. The caller pipes the stream wherever it likes without the
+     * client buffering the whole archive.
+     * @param options - the export options, including the serialization member files are
+     * written in.
+     * @returns the bundle as a stream of zip bytes.
+     */
+    exportGroup(key: group.Key, options: imex.Options): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * Imports a symbol group bundle: a zip archive holding one JSON envelope per symbol
+     * beside a manifest.json naming the group. The Core creates a fresh group under the
+     * permanent symbol group and imports every member in a single transaction, so a
+     * failure leaves nothing behind.
+     * @returns the created group.
+     * @throws {ValidationError} if the manifest is missing, malformed, or of another
+     * bundle kind, if two member names collide, or if a member is not a symbol.
+     */
+    importGroup(data: UploadBody): Promise<group.Group>;
+    /**
+     * Deletes the group and every symbol in it. The Core removes both in a single
+     * transaction, so a failure leaves the group and its symbols untouched. A child that
+     * is not a symbol survives: the Core moves it to the permanent symbol group.
+     */
+    deleteGroup(key: group.Key, opts?: query.WriteOptions): Promise<void>;
     retrieveGroup(): Promise<group.Group>;
+    private execRetrieve;
+    /** Resolves a parent scope to its symbol children's keys via the ontology. */
+    private resolveChildKeys;
+    private fetchRequest;
+    /**
+     * Client-side matching for a request: exact for key sets and parent
+     * membership via the relationship table. Server-computed shapes (search)
+     * never reach this filter; they refetch instead.
+     */
+    private requestFilter;
+    private isChildOf;
 }
 export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/src/schematic/symbol/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/schematic/symbol/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EACL,KAAK,GAAG,EAER,KAAK,GAAG,EAER,KAAK,MAAM,EAEZ,MAAM,8BAA8B,CAAC;AAOtC,QAAA,MAAM,gBAAgB;;;iBAGpB,CAAC;AAEH,QAAA,MAAM,mBAAmB;;;;;;GAEmB,CAAC;AAE7C,QAAA,MAAM,aAAa;;;;;;;;;mBAAmD,CAAC;AAEvE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACzD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACvE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAQtE,eAAO,MAAM,gBAAgB,4BAA4B,CAAC;AAC1D,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAEhE,MAAM,WAAW,UAAW,SAAQ,GAAG;IACrC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;CACrB;AAED,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAC5C,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAatD,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS7C,QAAQ,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IACrD,QAAQ,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAazD,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IASxC,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;CAS5C"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/schematic/symbol/client.ts"],"names":[],"mappings":"AASA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,UAAU,EAChB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EACL,KAAK,GAAG,EAER,KAAK,GAAG,EAER,KAAK,MAAM,EAEZ,MAAM,8BAA8B,CAAC;AAEtC,eAAO,MAAM,gBAAgB,4BAA4B,CAAC;AAC1D,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAahE,QAAA,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAEpB,CAAC;AACH,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAA4C,CAAC;AAEvE,QAAA,MAAM,qBAAqB;;;;;;GAEiB,CAAC;AAI7C,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACzE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AACtE,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG,sBAAsB,CAAC;AAa3E,MAAM,WAAW,YAAa,SAAQ,GAAG;IACvC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;CACrB;AAkBD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;IACnB,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACjD;AAED,qBAAa,MAAO,SAAQ,KAAK,CAAC,SAAS,CAAC,OAAO,oBAAoB,EAAE,GAAG,EAAE,MAAM,CAAC;IACnF,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA2B;gBAErC,GAAG,EAAE,YAAY;IAsCvB,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9C,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAuBxD,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,KAAK,CAAC,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB5E,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,IAAI,GAAE,KAAK,CAAC,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB7E;;;;;;;;;OASG;IACG,WAAW,CACf,GAAG,EAAE,KAAK,CAAC,GAAG,EACd,OAAO,EAAE,IAAI,CAAC,OAAO,GACpB,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAStC;;;;;;;;OAQG;IACG,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAkBzD;;;;OAIG;IACG,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,GAAE,KAAK,CAAC,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BzE,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;YAU7B,YAAY;IAY1B,8EAA8E;YAChE,gBAAgB;YAUhB,YAAY;IAS1B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,SAAS;CAKlB"}