@synnaxlabs/client 0.20.0 → 0.22.0

package/.turbo/turbo-build.log

@@ -1,16 +1,16 @@
 
-> @synnaxlabs/client@0.20.0 build /home/runner/work/synnax/synnax/client/ts
+> @synnaxlabs/client@0.22.0 build /home/runner/work/synnax/synnax/client/ts
 > tsc --noEmit && vite build
 
-vite v5.1.2 building for production...
+vite v5.2.8 building for production...
 transforming...
-✓ 103 modules transformed.
+✓ 122 modules transformed.
 rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-dist/client.js  465.47 kB │ gzip: 97.43 kB │ map: 1,062.29 kB
-[vite:dts] Declaration files built in 4062ms.
+dist/client.js  474.36 kB │ gzip: 100.51 kB │ map: 1,083.78 kB
+[vite:dts] Declaration files built in 4096ms.
 
-dist/client.cjs  308.94 kB │ gzip: 75.84 kB │ map: 1,010.66 kB
-✓ built in 5.39s
+dist/client.cjs  315.71 kB │ gzip: 78.27 kB │ map: 1,031.92 kB
+✓ built in 5.63s

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "vitest.disableWorkspaceWarning": true
+}

package/README.md

@@ -10,3 +10,16 @@ Detailed documentation is available [here](https://docs.synnaxlabs.com/typescrip
 npm install @synnaxlabs/client
 ```
 
+## Development
+
+Synnax's TypeScript client unit tests are written in [Vitest](https://vitest.dev/). To test the framework, run
+
+```bash
+pnpm test
+```
+
+Before running tests, make sure you build upstream dependencies, as specified in [this document](../../docs/tech/typescript/build.md):
+
+```
+pnpm build:PACKAGE_NAME
+```

package/dist/auth/auth.d.ts

@@ -1,7 +1,7 @@
-import type { Middleware, UnaryClient } from "@synnaxlabs/freighter";
-import { z } from "zod";
 import { user } from '../user';
-export declare const tokenMiddleware: (token: () => Promise<string>) => Middleware;
+import { z } from 'zod';
+import { Middleware, UnaryClient } from '@synnaxlabs/freighter';
+
 export declare const insecureCredentialsZ: z.ZodObject<{
     username: z.ZodString;
     password: z.ZodString;
@@ -40,13 +40,14 @@ export declare const tokenResponseZ: z.ZodObject<{
 }>;
 export type TokenResponse = z.infer<typeof tokenResponseZ>;
 export declare class Client {
-    private token;
+    token: string | undefined;
     private readonly client;
-    authenticating: Promise<void> | undefined;
+    private readonly credentials;
+    private authenticating;
     authenticated: boolean;
     user: user.Payload | undefined;
+    private retryCount;
     constructor(client: UnaryClient, credentials: InsecureCredentials);
-    authenticate(credentials: InsecureCredentials): void;
     middleware(): Middleware;
 }
 //# sourceMappingURL=auth.d.ts.map

package/dist/auth/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth/auth.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,eAAO,MAAM,eAAe,UAClB,MAAM,QAAQ,MAAM,CAAC,KAAG,UAS/B,CAAC;AAEJ,eAAO,MAAM,oBAAoB;;;;;;;;;EAG/B,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEvE,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;EAGzB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAI3D,qBAAa,MAAM;IACjB,OAAO,CAAC,KAAK,CAAqB;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,cAAc,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAC1C,aAAa,EAAE,OAAO,CAAC;IACvB,IAAI,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;gBAEnB,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB;IAMjE,YAAY,CAAC,WAAW,EAAE,mBAAmB,GAAG,IAAI;IAoBpD,UAAU,IAAI,UAAU;CAQzB"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth/auth.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,eAAO,MAAM,oBAAoB;;;;;;;;;EAG/B,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEvE,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;EAGzB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAM3D,qBAAa,MAAM;IACjB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,cAAc,CAAoC;IAC1D,aAAa,EAAE,OAAO,CAAC;IACvB,IAAI,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC/B,OAAO,CAAC,UAAU,CAAS;gBAEf,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB;IAOjE,UAAU,IAAI,UAAU;CAkCzB"}

package/dist/channel/client.d.ts

@@ -1,9 +1,11 @@
-import { type UnaryClient } from "@synnaxlabs/freighter";
-import { DataType, Rate, type TypedArray, type CrudeDensity, type TimeRange, type AsyncTermSearcher, type CrudeTimeStamp, type MultiSeries } from "@synnaxlabs/x";
-import { type Key, type KeyOrName, type Params, type Payload, type NewPayload } from './payload';
-import { type Retriever } from './retriever';
-import { type Writer } from './writer';
-import { type framer } from '../framer';
+import { framer } from '../framer';
+import { Writer } from './writer';
+import { Retriever, RetrieveOptions } from './retriever';
+import { Key, KeyOrName, Params, Payload, NewPayload } from './payload';
+import { DataType, Rate, TypedArray, CrudeDensity, TimeRange, CrudeTimeStamp, MultiSeries } from '@synnaxlabs/x/telem';
+import { AsyncTermSearcher } from '@synnaxlabs/x/search';
+import { UnaryClient } from '@synnaxlabs/freighter';
+
 interface CreateOptions {
     retrieveIfNameExists?: boolean;
 }
@@ -89,6 +91,7 @@ export declare class Channel {
  * through the `channels` property of an {@link Synnax} client.
  */
 export declare class Client implements AsyncTermSearcher<string, Key, Channel> {
+    readonly type = "channel";
     private readonly frameClient;
     private readonly client;
     readonly retriever: Retriever;
@@ -175,7 +178,7 @@ export declare class Client implements AsyncTermSearcher<string, Key, Channel> {
      * const channel = await client.channels.retrieve(1);
      * ```
      */
-    retrieve(channel: KeyOrName, rangeKey?: string): Promise<Channel>;
+    retrieve(channel: KeyOrName, options?: RetrieveOptions): Promise<Channel>;
     /**
      * Retrieves multiple channels from the database using the provided keys or the
      * provided names.
@@ -188,11 +191,11 @@ export declare class Client implements AsyncTermSearcher<string, Key, Channel> {
      * @param options.notDataTypes - Limits the query to only channels without the specified
      *
      */
-    retrieve(channels: Params, rangeKey?: string): Promise<Channel[]>;
+    retrieve(channels: Params, options?: RetrieveOptions): Promise<Channel[]>;
+    search(term: string, options?: RetrieveOptions): Promise<Channel[]>;
     delete(channels: Params): Promise<void>;
-    search(term: string, rangeKey?: string): Promise<Channel[]>;
-    newSearcherUnderRange(rangeKey?: string): AsyncTermSearcher<string, Key, Channel>;
-    page(offset: number, limit: number, rangeKey?: string): Promise<Channel[]>;
+    newSearcherWithOptions(options: RetrieveOptions): AsyncTermSearcher<string, Key, Channel>;
+    page(offset: number, limit: number, options?: Omit<RetrieveOptions, "limit" | "offset">): Promise<Channel[]>;
     createDebouncedBatchRetriever(deb?: number): Retriever;
     private sugar;
 }

package/dist/channel/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/channel/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EACL,QAAQ,EACR,IAAI,EACJ,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,iBAAiB,EAEtB,KAAK,cAAc,EACnB,KAAK,WAAW,EACjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,KAAK,GAAG,EACR,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,OAAO,EAEZ,KAAK,UAAU,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAKL,KAAK,SAAS,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,UAAU,aAAa;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuB;IACpD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEvB,EACV,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,WAAe,EACf,GAAO,EACP,OAAe,EACf,KAAS,EACT,WAAW,EACX,KAAK,GACN,EAAE,UAAU,GAAG;QACd,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,YAAY,CAAC;KACxB;IAYD,OAAO,KAAK,MAAM,GAIjB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAUrB;IAED;;;;;;OAMG;IACG,IAAI,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAI/C;;;;;OAKG;IACG,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAGpE;AAED;;;;GAIG;AACH,qBAAa,MAAO,YAAW,iBAAiB,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgB;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGtB,WAAW,EAAE,MAAM,CAAC,MAAM,EAC1B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,MAAM;IAQhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAE5E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAoBjF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAEvE;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAqBjE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAIjE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC;IAI3E,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAIhF,6BAA6B,CAAC,GAAG,GAAE,MAAW,GAAG,SAAS;IAM1D,OAAO,CAAC,KAAK;CAId"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/channel/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EACL,QAAQ,EACR,IAAI,EACJ,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,WAAW,EACjB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,KAAK,GAAG,EACR,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,OAAO,EAEZ,KAAK,UAAU,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAKL,KAAK,SAAS,EAEd,KAAK,eAAe,EACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,UAAU,aAAa;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuB;IACpD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEvB,EACV,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,WAAe,EACf,GAAO,EACP,OAAe,EACf,KAAS,EACT,WAAW,EACX,KAAK,GACN,EAAE,UAAU,GAAG;QACd,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,YAAY,CAAC;KACxB;IAYD,OAAO,KAAK,MAAM,GAIjB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAUrB;IAED;;;;;;OAMG;IACG,IAAI,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAI/C;;;;;OAKG;IACG,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAGpE;AAED;;;;GAIG;AACH,qBAAa,MAAO,YAAW,iBAAiB,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC;IACpE,QAAQ,CAAC,IAAI,aAAa;IAC1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgB;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGtB,WAAW,EAAE,MAAM,CAAC,MAAM,EAC1B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,MAAM;IAQhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAE5E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAoBjF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAE/E;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAmBzE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAInE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7C,sBAAsB,CACpB,OAAO,EAAE,eAAe,GACvB,iBAAiB,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC;IAUpC,IAAI,CACR,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,GAAG,QAAQ,CAAC,GAClD,OAAO,CAAC,OAAO,EAAE,CAAC;IAIrB,6BAA6B,CAAC,GAAG,GAAE,MAAW,GAAG,SAAS;IAM1D,OAAO,CAAC,KAAK;CAId"}

package/dist/channel/creator.d.ts

@@ -0,0 +1,10 @@
+import { Payload, NewPayload } from './payload';
+import { UnaryClient } from '@synnaxlabs/freighter';
+
+export declare class Creator {
+    private static readonly ENDPOINT;
+    private readonly client;
+    constructor(client: UnaryClient);
+    create(channels: NewPayload[]): Promise<Payload[]>;
+}
+//# sourceMappingURL=creator.d.ts.map

package/dist/channel/creator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creator.d.ts","sourceRoot":"","sources":["../../src/channel/creator.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGzD,OAAO,EAAE,KAAK,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAMvF,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAUzD"}

package/dist/channel/payload.d.ts

@@ -1,5 +1,6 @@
-import { DataType, Rate } from "@synnaxlabs/x";
-import { z } from "zod";
+import { z } from 'zod';
+import { DataType, Rate } from '@synnaxlabs/x/telem';
+
 export declare const keyZ: z.ZodNumber;
 export type Key = number;
 export type Keys = number[];
@@ -46,10 +47,12 @@ export declare const newPayload: z.ZodObject<{
     index: z.ZodOptional<z.ZodNumber>;
     rate: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodNumber, Rate, number>, z.ZodEffects<z.ZodType<Number, z.ZodTypeDef, Number>, Rate, Number>, z.ZodType<Rate, z.ZodTypeDef, Rate>]>>>;
     isIndex: z.ZodOptional<z.ZodBoolean>;
+    virtual: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     rate: Rate;
     dataType: DataType;
+    virtual: boolean;
     alias?: string | undefined;
     key?: number | undefined;
     leaseholder?: number | undefined;
@@ -64,6 +67,7 @@ export declare const newPayload: z.ZodObject<{
     index?: number | undefined;
     rate?: number | Number | Rate | undefined;
     isIndex?: boolean | undefined;
+    virtual?: boolean | undefined;
 }>;
 export type NewPayload = z.input<typeof newPayload>;
 //# sourceMappingURL=payload.d.ts.map

package/dist/channel/payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../src/channel/payload.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,IAAI,aAAa,CAAC;AAC/B,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AACzB,MAAM,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;AAC5B,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAC1B,MAAM,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC;AAC7B,MAAM,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC;AACnC,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,KAAK,CAAC;AACvC,MAAM,MAAM,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AAE/C,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;EASlB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMrB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC"}
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../src/channel/payload.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,IAAI,aAAa,CAAC;AAC/B,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AACzB,MAAM,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;AAC5B,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAC1B,MAAM,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC;AAC7B,MAAM,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC;AACnC,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,KAAK,CAAC;AACvC,MAAM,MAAM,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AAE/C,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;EASlB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOrB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC"}

package/dist/channel/retriever.d.ts

@@ -1,17 +1,68 @@
-import type { UnaryClient } from "@synnaxlabs/freighter";
-import { type Key, type Keys, type Name, type Names, type Params, type Payload } from './payload';
+import { ParamAnalysisResult } from '../util/retrieve';
+import { KeyOrName, Params, Payload } from './payload';
+import { z } from 'zod';
+import { DataType } from '@synnaxlabs/x/telem';
+import { UnaryClient } from '@synnaxlabs/freighter';
+
+declare const reqZ: z.ZodObject<{
+    leaseholder: z.ZodOptional<z.ZodNumber>;
+    keys: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+    names: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    search: z.ZodOptional<z.ZodString>;
+    rangeKey: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    dataTypes: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, DataType, string>, z.ZodType<DataType, z.ZodTypeDef, DataType>]>, "many">>;
+    notDataTypes: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, DataType, string>, z.ZodType<DataType, z.ZodTypeDef, DataType>]>, "many">>;
+    virtual: z.ZodOptional<z.ZodBoolean>;
+    isIndex: z.ZodOptional<z.ZodBoolean>;
+    internal: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    leaseholder?: number | undefined;
+    keys?: number[] | undefined;
+    names?: string[] | undefined;
+    search?: string | undefined;
+    rangeKey?: string | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    dataTypes?: DataType[] | undefined;
+    notDataTypes?: DataType[] | undefined;
+    virtual?: boolean | undefined;
+    isIndex?: boolean | undefined;
+    internal?: boolean | undefined;
+}, {
+    leaseholder?: number | undefined;
+    keys?: number[] | undefined;
+    names?: string[] | undefined;
+    search?: string | undefined;
+    rangeKey?: string | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    dataTypes?: (string | DataType)[] | undefined;
+    notDataTypes?: (string | DataType)[] | undefined;
+    virtual?: boolean | undefined;
+    isIndex?: boolean | undefined;
+    internal?: boolean | undefined;
+}>;
+type Request = z.input<typeof reqZ>;
+export type RetrieveOptions = Omit<Request, "keys" | "names" | "search">;
+export type PageOptions = Omit<RetrieveOptions, "offset" | "limit">;
+export declare const analyzeChannelParams: (channels: Params) => ParamAnalysisResult<KeyOrName, {
+    number: "keys";
+    string: "names";
+}>;
 export interface Retriever {
-    retrieve: (channels: Params, rangeKey?: string) => Promise<Payload[]>;
-    search: (term: string, rangeKey?: string) => Promise<Payload[]>;
-    page: (offset: number, limit: number, rangeKey?: string) => Promise<Payload[]>;
+    retrieve: (channels: Params, opts?: RetrieveOptions) => Promise<Payload[]>;
+    search: (term: string, opts?: RetrieveOptions) => Promise<Payload[]>;
+    page: (offset: number, limit: number, opts?: PageOptions) => Promise<Payload[]>;
 }
 export declare class ClusterRetriever implements Retriever {
     private static readonly ENDPOINT;
     private readonly client;
     constructor(client: UnaryClient);
-    search(term: string, rangeKey?: string): Promise<Payload[]>;
-    retrieve(channels: Params, rangeKey?: string): Promise<Payload[]>;
-    page(offset: number, limit: number, rangeKey?: string): Promise<Payload[]>;
+    search(term: string, options?: RetrieveOptions): Promise<Payload[]>;
+    retrieve(channels: Params, options?: RetrieveOptions): Promise<Payload[]>;
+    page(offset: number, limit: number, options?: PageOptions): Promise<Payload[]>;
     private execute;
 }
 export declare class CacheRetriever implements Retriever {
@@ -19,34 +70,12 @@ export declare class CacheRetriever implements Retriever {
     private readonly namesToKeys;
     private readonly wrapped;
     constructor(wrapped: Retriever);
-    search(term: string, rangeKey?: string): Promise<Payload[]>;
-    page(offset: number, limit: number, rangeKey?: string): Promise<Payload[]>;
-    retrieve(channels: Params): Promise<Payload[]>;
+    search(term: string, options?: RetrieveOptions): Promise<Payload[]>;
+    page(offset: number, limit: number, options?: PageOptions): Promise<Payload[]>;
+    retrieve(channels: Params, options?: RetrieveOptions): Promise<Payload[]>;
     private updateCache;
     private getFromCache;
 }
-export type ParamAnalysisResult = {
-    single: true;
-    variant: "names";
-    normalized: Names;
-    actual: Name;
-} | {
-    single: true;
-    variant: "keys";
-    normalized: Keys;
-    actual: Key;
-} | {
-    single: false;
-    variant: "keys";
-    normalized: Keys;
-    actual: Keys;
-} | {
-    single: false;
-    variant: "names";
-    normalized: Names;
-    actual: Names;
-};
-export declare const analyzeParams: (channels: Params) => ParamAnalysisResult;
 export interface PromiseFns<T> {
     resolve: (value: T) => void;
     reject: (reason?: any) => void;
@@ -57,10 +86,11 @@ export declare class DebouncedBatchRetriever implements Retriever {
     private readonly wrapped;
     private readonly debouncedRun;
     constructor(wrapped: Retriever, deb: number);
-    search(term: string, rangeKey?: string): Promise<Payload[]>;
-    page(offset: number, limit: number, rangeKey?: string): Promise<Payload[]>;
+    search(term: string, options?: RetrieveOptions): Promise<Payload[]>;
+    page(offset: number, limit: number, options?: RetrieveOptions): Promise<Payload[]>;
     retrieve(channels: Params): Promise<Payload[]>;
     run(): Promise<void>;
 }
 export declare const retrieveRequired: (r: Retriever, params: Params) => Promise<Payload[]>;
+export {};
 //# sourceMappingURL=retriever.d.ts.map

package/dist/channel/retriever.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retriever.d.ts","sourceRoot":"","sources":["../../src/channel/retriever.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAKzD,OAAO,EACL,KAAK,GAAG,EAER,KAAK,IAAI,EAET,KAAK,IAAI,EACT,KAAK,KAAK,EACV,KAAK,MAAM,EACX,KAAK,OAAO,EAEb,MAAM,mBAAmB,CAAC;AAmB3B,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACtE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAChE,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CAChF;AAED,qBAAa,gBAAiB,YAAW,SAAS;IAChD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI3D,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAKjE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAIlE,OAAO;CAUtB;AAED,qBAAa,cAAe,YAAW,SAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAC7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAY;gBAExB,OAAO,EAAE,SAAS;IAMxB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI3D,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI1E,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAepD,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,YAAY;CAKrB;AAED,MAAM,MAAM,mBAAmB,GAC3B;IACE,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;IAClB,MAAM,EAAE,IAAI,CAAC;CACd,GACD;IACE,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,MAAM,EAAE,GAAG,CAAC;CACb,GACD;IACE,MAAM,EAAE,KAAK,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,MAAM,EAAE,IAAI,CAAC;CACd,GACD;IACE,MAAM,EAAE,KAAK,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC;CACf,CAAC;AAEN,eAAO,MAAM,aAAa,aAAc,MAAM,KAAG,mBAehD,CAAC;AAEF,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC5B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC;AAGD,qBAAa,uBAAwB,YAAW,SAAS;IACvD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAe;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0C;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAY;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAa;gBAE9B,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM;IAOrC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI3D,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI1E,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAc9C,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAgB3B;AAED,eAAO,MAAM,gBAAgB,MACxB,SAAS,UACJ,MAAM,KACb,QAAQ,OAAO,EAAE,CAUnB,CAAC"}
+{"version":3,"file":"retriever.d.ts","sourceRoot":"","sources":["../../src/channel/retriever.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAEL,KAAK,SAAS,EAGd,KAAK,MAAM,EACX,KAAK,OAAO,EAEb,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,KAAK,mBAAmB,EAAiB,MAAM,iBAAiB,CAAC;AAG1E,QAAA,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAaR,CAAC;AAEH,KAAK,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AAEpC,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC,CAAC;AACzE,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC;AAMpE,eAAO,MAAM,oBAAoB,aACrB,MAAM,KACf,oBAAoB,SAAS,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAIjE,CAAC;AAEL,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACrE,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACjF;AAED,qBAAa,gBAAiB,YAAW,SAAS;IAChD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAInE,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQzE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAItE,OAAO;CAUtB;AAED,qBAAa,cAAe,YAAW,SAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAC7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAY;gBAExB,OAAO,EAAE,SAAS;IAMxB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAInE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI9E,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkB/E,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,YAAY;CAKrB;AAED,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC5B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC;AAGD,qBAAa,uBAAwB,YAAW,SAAS;IACvD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAe;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0C;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAY;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAa;gBAE9B,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM;IAOrC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAInE,IAAI,CACR,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,OAAO,EAAE,CAAC;IAIf,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAc9C,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAgB3B;AAED,eAAO,MAAM,gBAAgB,MACxB,SAAS,UACJ,MAAM,KACb,QAAQ,OAAO,EAAE,CAUnB,CAAC"}

package/dist/channel/writer.d.ts

@@ -1,6 +1,7 @@
-import { type UnaryClient } from "@synnaxlabs/freighter";
-import { z } from "zod";
-import { type Payload, type NewPayload } from './payload';
+import { Payload, NewPayload } from './payload';
+import { z } from 'zod';
+import { UnaryClient } from '@synnaxlabs/freighter';
+
 declare const deleteReqZ: z.ZodObject<{
     keys: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
     names: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;