@synnaxlabs/client 0.56.1 → 0.57.0

package/dist/src/arc/types.gen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.gen.d.ts","sourceRoot":"","sources":["../../../src/arc/types.gen.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,eAAO,MAAM,KAAK,4BAA6B,CAAC;AAChD,eAAO,MAAM,KAAK;;;EAAgB,CAAC;AACnC,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAEzC,8EAA8E;AAC9E,eAAO,MAAM,cAAc;;iBAGzB,CAAC;AACH,MAAM,WAAW,aAAc,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC;CAAG;AAExE,eAAO,MAAM,IAAI,WAAW,CAAC;AAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AAEvC,eAAO,MAAM,OAAO;;;;;;;;;GAA8C,CAAC;AACnE,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE7C,6DAA6D;AAC7D,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBf,CAAC;AACH,MAAM,WAAW,GAAI,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;CAAG;AAEpD;;;;GAIG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBf,CAAC;AACH,MAAM,WAAW,GAAI,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;CAAG;AAEpD,eAAO,MAAM,UAAU,2BAAuC,CAAC;AAC/D,eAAO,MAAM,gBAAgB;;;;;;CAAiB,CAAC"}
+{"version":3,"file":"types.gen.d.ts","sourceRoot":"","sources":["../../../src/arc/types.gen.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,eAAO,MAAM,KAAK,4BAA6B,CAAC;AAChD,eAAO,MAAM,KAAK;;;EAAgB,CAAC;AACnC,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAEzC,eAAO,MAAM,eAAe,mFAOlB,CAAC;AACX,eAAO,MAAM,cAAc;;;;;;;EAA0B,CAAC;AACtD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAE3D,8EAA8E;AAC9E,eAAO,MAAM,cAAc;;iBAGzB,CAAC;AACH,MAAM,WAAW,aAAc,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC;CAAG;AAExE,eAAO,MAAM,IAAI,WAAW,CAAC;AAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AAEvC,eAAO,MAAM,OAAO;;;;;;;;;GAA8C,CAAC;AACnE,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE7C,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;iBAOtB,CAAC;AACH,MAAM,WAAW,UAAW,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC;CAAG;AAElE;;;GAGG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBf,CAAC;AACH,MAAM,WAAW,GAAI,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;CAAG;AACpD,MAAM,WAAW,GAAI,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;CAAG;AAEpD,eAAO,MAAM,UAAU,2BAAuC,CAAC;AAC/D,eAAO,MAAM,gBAAgB;;;;;;CAAiB,CAAC"}

package/dist/src/auth/auth.d.ts

@@ -5,15 +5,27 @@ declare const credentialsZ: z.ZodObject<{
     username: z.ZodString;
     password: z.ZodString;
 }, z.core.$strip>;
-interface Credentials extends z.infer<typeof credentialsZ> {
+export interface Credentials extends z.infer<typeof credentialsZ> {
+}
+export declare const LOGIN_ENDPOINT = "/auth/login";
+/** Login outcome hooks. The connection machine is the sole consumer. */
+export interface Observer {
+    /** Fires after every successful login. */
+    onSuccess?: () => void;
+    /** Fires on a definitive credential rejection, never on token self-heal. */
+    onFailure?: (error: Error) => void;
 }
 export declare class Client {
     private readonly client;
     private readonly credentials;
+    private readonly observer;
     private authState;
     authenticating: Promise<Error | null> | undefined;
     private retryCount;
-    constructor(client: UnaryClient, credentials: Credentials);
+    private generation;
+    constructor(client: UnaryClient, credentials: Credentials, observer?: Observer);
+    /** Replaces the stored credentials and clears auth state for a fresh login. */
+    setCredentials({ username, password }: Credentials): void;
     get authenticated(): boolean;
     get user(): user.User | undefined;
     get token(): string | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/auth/auth.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,QAAA,MAAM,YAAY;;;iBAA2D,CAAC;AAC9E,UAAU,WAAY,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC;CAAG;AAgC7D,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,SAAS,CAAuC;IACxD,cAAc,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;IAClD,OAAO,CAAC,UAAU,CAAS;gBAEf,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW;IAMzD,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,GAAG,SAAS,CAEhC;IAED,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAEK,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAQlC,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAexD,UAAU,IAAI,UAAU;CA0CzB"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/auth/auth.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,QAAA,MAAM,YAAY;;;iBAA2D,CAAC;AAC9E,MAAM,WAAW,WAAY,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC;CAAG;AAepE,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAgB5C,wEAAwE;AACxE,MAAM,WAAW,QAAQ;IACvB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CACpC;AAED,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,SAAS,CAAuC;IACxD,cAAc,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;IAClD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAK;gBAEX,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,GAAE,QAAa;IAOlF,+EAA+E;IAC/E,cAAc,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,WAAW,GAAG,IAAI;IASzD,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,GAAG,SAAS,CAEhC;IAED,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAEK,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAQlC,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAexD,UAAU,IAAI,UAAU;CAsDzB"}

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

@@ -1,28 +1,29 @@
 import { UnaryClient } from '@synnaxlabs/freighter';
-import { CrudeDensity, CrudeTimeRange, CrudeTimeSpan, CrudeTimeStamp, DataType, MultiSeries, status, TypedArray } from '@synnaxlabs/x';
-import { Params } from './payload';
-import { RetrieveOptions, Retriever, RetrieveRequest } from './retriever';
+import { control, CrudeTimeRange, CrudeTimeStamp, DataType, MultiSeries, TypedArray } from '@synnaxlabs/x';
+import { z } from 'zod';
+import { Params, PrimitiveParams } from './payload';
 import { Key, Name, New, Operation, Payload } from './types.gen';
 import { Writer } from './writer';
 import { framer } from '../framer';
 import { group } from '../group';
 import { ontology } from '../ontology';
+import { query } from '../query';
+import { ranger } from '../ranger';
+import { status } from '../status';
+export declare const SET_CHANNEL_NAME = "sy_channel_set";
+export declare const DELETE_CHANNEL_NAME = "sy_channel_delete";
 interface CreateOptions {
     retrieveIfNameExists?: boolean;
 }
-export declare const SET_CHANNEL_NAME = "sy_channel_set";
-export declare const DELETE_CHANNEL_NAME = "sy_channel_delete";
 /**
  * Represents a Channel in a Synnax database. Typically, channels should not be
  * instantiated directly, but instead created via the `.channels.create` or retrieved
- * via the `.channels.retrieve` method on a Synnax client.
- *
- * Please refer to the [Synnax
+ * via the `.channels.retrieve` method on a Synnax client. Please refer to the [Synnax
  * documentation](https://docs.synnaxlabs.com/reference/concepts/channels) for detailed
  * information on what channels are and how to use them.
  */
 export declare class Channel {
-    private readonly _frameClient;
+    private readonly frameClient;
     /**
      * A unique key identifying the channel in the Synnax database. This key is
      * automatically assigned by Synnax.
@@ -32,9 +33,7 @@ export declare class Channel {
      * A human-readable name for the channel. This name is not guaranteed to be unique.
      */
     readonly name: string;
-    /**
-     * The data type of the channel.
-     */
+    /** The data type of the channel. */
     readonly dataType: DataType;
     /**
      * The key of the node in the Synnax cluster that holds the 'lease' over the channel
@@ -47,13 +46,9 @@ export declare class Channel {
      * that stores its timestamps.
      */
     readonly index: Key;
-    /**
-     * This is set to true if the channel is an index channel, and false otherwise.
-     */
+    /** This is set to true if the channel is an index channel, and false otherwise. */
     readonly isIndex: boolean;
-    /**
-     * This is set to true if the channel is an internal channel, and false otherwise.
-     */
+    /** This is set to true if the channel is an internal channel, and false otherwise. */
     readonly internal: boolean;
     /**
      * An alias for the channel under a specific range. This parameter is unstable and
@@ -71,16 +66,11 @@ export declare class Channel {
      */
     readonly expression: string;
     readonly operations: Operation[];
-    /**
-     * The status of the channel.
-     */
+    readonly concurrency: control.Concurrency;
+    /** The status of the channel. */
     readonly status?: status.Status;
-    constructor({ dataType, name, leaseholder, key, isIndex, index, internal, virtual, frameClient, alias, status: argsStatus, expression, operations, }: New & {
-        internal?: boolean;
+    constructor({ dataType, name, leaseholder, key, isIndex, index, internal, virtual, frameClient, alias, status: argsStatus, expression, operations, concurrency, }: New & {
         frameClient?: framer.Client;
-        density?: CrudeDensity;
-        status?: status.New;
-        operations?: Operation[];
     });
     private get framer();
     /**
@@ -90,40 +80,78 @@ export declare class Channel {
      */
     get payload(): Payload;
     get isCalculated(): boolean;
-    /***
-     * @returns the ontology ID of the channel
-     */
+    /** @returns the ontology ID of the channel */
     get ontologyID(): ontology.ID;
     /**
      * Reads telemetry from the channel between the two timestamps.
-     *
-     * @param start - The starting timestamp of the range to read from.
-     * @param end - The ending timestamp of the range to read from.
      * @returns A typed array containing the retrieved
      */
     read(tr: CrudeTimeRange): Promise<MultiSeries>;
     /**
      * Writes telemetry to the channel starting at the given timestamp.
-     *
      * @param start - The starting timestamp of the first sample in data.
-     * @param data - THe telemetry to write to the channel.
      */
     write(start: CrudeTimeStamp, data: TypedArray): Promise<void>;
 }
+/** Zod schema for {@link RetrieveRequest}. */
+export declare const retrieveRequestZ: z.ZodObject<{
+    nodeKey: z.ZodOptional<z.ZodInt>;
+    keys: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>>;
+    names: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    searchTerm: z.ZodOptional<z.ZodString>;
+    rangeKey: z.ZodOptional<z.ZodUUID>;
+    limit: z.ZodOptional<z.ZodInt>;
+    offset: z.ZodOptional<z.ZodInt>;
+    dataTypes: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodCustom<DataType, DataType>, z.ZodPipe<z.ZodString, z.ZodTransform<DataType, string>>, z.ZodPipe<z.ZodObject<{
+        value: z.ZodString;
+    }, z.core.$strip>, z.ZodTransform<DataType, {
+        value: string;
+    }>>]>>>;
+    notDataTypes: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodCustom<DataType, DataType>, z.ZodPipe<z.ZodString, z.ZodTransform<DataType, string>>, z.ZodPipe<z.ZodObject<{
+        value: z.ZodString;
+    }, z.core.$strip>, z.ZodTransform<DataType, {
+        value: string;
+    }>>]>>>;
+    virtual: z.ZodOptional<z.ZodBoolean>;
+    isIndex: z.ZodOptional<z.ZodBoolean>;
+    internal: z.ZodOptional<z.ZodBoolean>;
+    legacyCalculated: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/** Everything a channel retrieval can filter on. */
+export type RetrieveRequest = z.input<typeof retrieveRequestZ>;
+/** The filters a retrieval accepts alongside its keys or names. */
+export type RetrieveOptions = Omit<RetrieveRequest, "keys" | "names" | "search">;
+/** Names one channel. Give a `rangeKey` to resolve its alias in that range. */
+export type RetrieveSingleParams = {
+    key: Key;
+    rangeKey?: ranger.Key;
+};
 /**
  * The main client class for executing channel operations against a Synnax Core. This
  * class should not be instantiated directly, and instead should be used through the
  * `channels` property of an {@link Synnax} client.
  */
-export declare class Client {
-    private readonly frameClient;
-    private readonly client;
-    readonly retriever: Retriever;
+export interface ClientConfig {
+    framer: framer.Client;
+    unary: UnaryClient;
+    writer: Writer;
+    statuses: status.Client;
+    ranges: ranger.Client;
+    cache: query.Cache;
+    ontology: ontology.Client;
+}
+/**
+ * Creates, reads, and deletes channels on a Core. Reach it through `client.channels`.
+ * Retrievals are served from a cache that a change stream keeps current, so a repeated
+ * read costs nothing.
+ */
+export declare class Client extends query.Retriever<typeof retrieveRequestZ, Key, Channel, Channel, RetrieveSingleParams, RetrieveSingleParams> {
+    private readonly cfg;
     readonly writer: Writer;
-    constructor(frameClient: framer.Client, retriever: Retriever, client: UnaryClient, writer: Writer);
+    readonly store: query.Table<Key, Channel>;
+    constructor(cfg: ClientConfig);
     /**
      * Creates a single channel with the given properties.
-     *
      * @param name - A human-readable name for the channel.
      * @param rate - The rate of the channel. This only applies to fixed rate channels.
      * @param dataType - The data type for the samples stored in the channel.
@@ -160,37 +188,30 @@ export declare class Client {
     /**
      * Creates multiple channels with the given properties. The order of the channels
      * returned is guaranteed to match the order of the channels passed in.
-     *
-     * @param channels - An array of channel properties to create.
-     * For each channel, the following properties should be considered:
-     *
+     * @param channels - An array of channel properties to create. For each channel, the
+     * following properties should be considered:
      * @param name - A human-readable name for the channel.
      * @param rate - The rate of the channel. This only applies to fixed rate channels. If
      * the 'index' parameter is specified or 'isIndex' is set to true, this parameter will
      * be ignored.
      * @param dataType - The data type for the samples stored in the channel.
      * @param index - The key of the index channel that this channel should be associated
-     * with. An 'index' channel is a channel that stores timestamps for other channels. Refer
-     * to the Synnax documentation (https://docs.synnaxlabs.com) for more information. The
-     * index channel must have already been created. This field does not need to be specified
-     * if the channel is an index channel, or the channel is a fixed rate channel. If this
-     * value is specified, the 'rate' parameter will be ignored.
-     * @param isIndex - Set to true if the channel is an index channel, and false otherwise.
-     * Index channels must have a data type of `DataType.TIMESTAMP`.
-     *
-     * @param channels
+     * with. An 'index' channel is a channel that stores timestamps for other channels.
+     * Refer to the Synnax documentation (https://docs.synnaxlabs.com) for more
+     * information. The index channel must have already been created. This field does not
+     * need to be specified if the channel is an index channel, or the channel is a fixed
+     * rate channel. If this value is specified, the 'rate' parameter will be ignored.
+     * @param isIndex - Set to true if the channel is an index channel, and false
+     * otherwise. Index channels must have a data type of `DataType.TIMESTAMP`.
      */
     create(channels: New[], options?: CreateOptions): Promise<Channel[]>;
     /**
      * Retrieves a channel from the database using the given key or name.
-     *
-     * @param params - The key or name of the channel to retrieve.
      * @param options - Optional parameters to control the retrieval process.
-     * @param options.dataTypes - Limits the query to only channels with the specified data
-     * type.
-     * @param options.notDataTypes - Limits the query to only channels without the specified
+     * @param options.dataTypes - Limits the query to only channels with the specified
      * data type.
-     *
+     * @param options.notDataTypes - Limits the query to only channels without the
+     * specified data type.
      * @returns The retrieved channel.
      * @throws {NotFoundError} if the channel does not exist in the cluster.
      * @throws {MultipleFoundError} is only thrown if the channel is retrieved by name,
@@ -207,29 +228,46 @@ export declare class Client {
     /**
      * Retrieves multiple channels from the database using the provided keys or the
      * provided names.
-     *
-     * @param params - The keys or the names of the channels to retrieve. Note that
-     * this method does not support mixing keys and names in the same call.
+     * @param params - The keys or the names of the channels to retrieve. Note that this
+     * method does not support mixing keys and names in the same call.
      * @param options - Optional parameters to control the retrieval process.
-     * @param options.dataTypes - Limits the query to only channels with the specified data
-     * type.
-     * @param options.notDataTypes - Limits the query to only channels without the specified
-     *
+     * @param options.dataTypes - Limits the query to only channels with the specified
+     * data type.
+     * @param options.notDataTypes - Limits the query to only channels without the
+     * specified
      */
-    retrieve(params: Params, options?: RetrieveOptions): Promise<Channel[]>;
+    retrieve(params: Key | string, options?: RetrieveOptions): Promise<Channel>;
+    retrieve(params: PrimitiveParams | Payload[], options?: RetrieveOptions): Promise<Channel[]>;
+    retrieve(params: RetrieveSingleParams): Promise<Channel>;
     retrieve(params: RetrieveRequest): Promise<Channel[]>;
-    /***
-     * Deletes channels from the database using the given keys or names.
-     * @param params - The keys or names of the channels to delete.
-     */
-    delete(params: Params): Promise<void>;
-    rename(key: Key, name: string): Promise<void>;
-    rename(keys: Key[], names: string[]): Promise<void>;
-    createDebouncedBatchRetriever(deb?: CrudeTimeSpan): Retriever;
+    /** * Deletes channels from the database using the given keys or names. */
+    delete(params: Params, opts?: query.WriteOptions): Promise<void>;
+    rename(key: Key, name: string, opts?: query.WriteOptions): Promise<void>;
+    rename(keys: Key[], names: string[], opts?: query.WriteOptions): Promise<void>;
+    /** Renames the cached channel, skipping when absent. Returns a rollback. */
+    private renameThrough;
     sugar(payload: Payload): Channel;
     sugar(payloads: Payload[]): Channel[];
     retrieveGroup(): Promise<group.Group>;
+    /** Rebuilds a cached channel with its cached status attached. */
+    private compose;
+    private composeAlias;
+    /** Fetches aliases under the range for keys the alias store has no entry for. */
+    private ensureAliases;
+    /** Fetches channel payloads. Missing channels are omitted, not thrown. */
+    private execRetrieve;
+    private fetchSingle;
+    /**
+     * Resolves literal names against the record store, fetching only the names it
+     * cannot resolve. A name matching two stored channels is ambiguous, which only
+     * a cluster running without name validation can produce, so the whole request
+     * falls through to the cluster. Returns null when the store cannot be trusted
+     * to answer any part of the request.
+     */
+    private resolveNames;
+    private fetchRequest;
 }
+/** @returns whether the channel computes its samples from an expression. */
 export declare const isCalculated: ({ virtual, expression }: Payload) => boolean;
 export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/src/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,EAEL,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,QAAQ,EACR,KAAK,WAAW,EAChB,MAAM,EAEN,KAAK,UAAU,EAChB,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAKL,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,eAAe,EACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,KAAK,GAAG,EAER,KAAK,IAAI,EACT,KAAK,GAAG,EAER,KAAK,SAAS,EACd,KAAK,OAAO,EAEb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAG3C,UAAU,aAAa;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AACjD,eAAO,MAAM,mBAAmB,sBAAsB,CAAC;AAEvD;;;;;;;;GAQG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuB;IACpD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;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;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;gBAEpB,EACV,QAAQ,EACR,IAAI,EACJ,WAAe,EACf,GAAO,EACP,OAAe,EACf,KAAS,EACT,QAAgB,EAChB,OAAe,EACf,WAAW,EACX,KAAK,EACL,MAAM,EAAE,UAAU,EAClB,UAAe,EACf,UAAe,GAChB,EAAE,GAAG,GAAG;QACP,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,YAAY,CAAC;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC;QACpB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;KAC1B;IAgBD,OAAO,KAAK,MAAM,GAIjB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAcrB;IAED,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,QAAQ,CAAC,EAAE,CAE5B;IAED;;;;;;OAMG;IACG,IAAI,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAIpD;;;;;OAKG;IACG,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAGpE;AAMD;;;;GAIG;AACH,qBAAa,MAAM;IACjB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAErE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAoB1E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAE/E;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAEvE,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAsB3D;;;OAGG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAC7C,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzD,6BAA6B,CAC3B,GAAG,GAAE,aAAyC,GAC7C,SAAS;IAMZ,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAChC,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;IAQ/B,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;CAS5C;AAED,eAAO,MAAM,YAAY,GAAI,yBAAyB,OAAO,KAAG,OAClC,CAAC"}
+{"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,EAEL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,QAAQ,EAIR,KAAK,WAAW,EAEhB,KAAK,UAAU,EAEhB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAEL,KAAK,MAAM,EACX,KAAK,eAAe,EAErB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,KAAK,GAAG,EAER,KAAK,IAAI,EACT,KAAK,GAAG,EAER,KAAK,SAAS,EAEd,KAAK,OAAO,EAGb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AACjD,eAAO,MAAM,mBAAmB,sBAAsB,CAAC;AAEvD,UAAU,aAAa;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;;GAMG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAuB;IACnD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,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,mFAAmF;IACnF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,sFAAsF;IACtF,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC;IAC1C,iCAAiC;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;gBAEpB,EACV,QAAQ,EACR,IAAI,EACJ,WAAe,EACf,GAAO,EACP,OAAe,EACf,KAAS,EACT,QAAgB,EAChB,OAAe,EACf,WAAW,EACX,KAAK,EACL,MAAM,EAAE,UAAU,EAClB,UAAe,EACf,UAAe,EACf,WAA2C,GAC5C,EAAE,GAAG,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAA;KAAE;IAoBxC,OAAO,KAAK,MAAM,GAIjB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAmBrB;IAED,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,8CAA8C;IAC9C,IAAI,UAAU,IAAI,QAAQ,CAAC,EAAE,CAE5B;IAED;;;OAGG;IACG,IAAI,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAIpD;;;OAGG;IACG,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAGpE;AAED,8CAA8C;AAC9C,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;iBAc3B,CAAC;AACH,oDAAoD;AACpD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE/D,mEAAmE;AACnE,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC,CAAC;AAQjF,+EAA+E;AAC/E,MAAM,MAAM,oBAAoB,GAAG;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,GAAG,CAAA;CAAE,CAAC;AAwHvE;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,KAAK,CAAC,SAAS,CACzC,OAAO,gBAAgB,EACvB,GAAG,EACH,OAAO,EACP,OAAO,EACP,oBAAoB,EACpB,oBAAoB,CACrB;IACC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBAE9B,GAAG,EAAE,YAAY;IAyE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAErE;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAqB1E;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAE/E;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAE3E,QAAQ,CACZ,MAAM,EAAE,eAAe,GAAG,OAAO,EAAE,EACnC,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEf,QAAQ,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAExD,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAuC3D,0EAA0E;IACpE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,GAAE,KAAK,CAAC,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBpE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IACxE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBpF,4EAA4E;IAC5E,OAAO,CAAC,aAAa;IAMrB,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAChC,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;IAQ/B,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAU3C,iEAAiE;IACjE,OAAO,CAAC,OAAO;IAWf,OAAO,CAAC,YAAY;IASpB,iFAAiF;YACnE,aAAa;IAiB3B,0EAA0E;YAC5D,YAAY;YA0BZ,WAAW;IAqBzB;;;;;;OAMG;YACW,YAAY;YAiBZ,YAAY;CAe3B;AAED,4EAA4E;AAC5E,eAAO,MAAM,YAAY,GAAI,yBAAyB,OAAO,KAAG,OAClC,CAAC"}

package/dist/src/channel/external.d.ts

@@ -1,6 +1,5 @@
 export * from './client';
 export * from './payload';
-export * from './retriever';
 export * from './types.gen';
 export * from './writer';
 //# sourceMappingURL=external.d.ts.map

package/dist/src/channel/external.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"external.d.ts","sourceRoot":"","sources":["../../../src/channel/external.ts"],"names":[],"mappings":"AASA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"external.d.ts","sourceRoot":"","sources":["../../../src/channel/external.ts"],"names":[],"mappings":"AASA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC"}

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

@@ -1,23 +1,30 @@
 import { z } from 'zod';
 import { Key, Name, Payload } from './types.gen';
+import { ParamAnalysisResult } from '../util/retrieve';
+/** One or many channels, named by key or by name. */
 export type PrimitiveParams = Key | Name | Key[] | Name[];
+/** Zod schema for {@link Params}, resolving every form to a key array. */
 export declare const paramsZ: z.ZodUnion<readonly [z.ZodUnion<[z.ZodArray<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>, z.ZodPipe<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>, z.ZodTransform<number[], number>>]>, z.ZodUnion<[z.ZodArray<z.ZodString>, z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>]>, z.ZodPipe<z.ZodUnion<[z.ZodArray<z.ZodObject<{
-    key: z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>;
+    key: z.ZodDefault<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>;
     name: z.ZodString;
-    leaseholder: z.ZodInt;
-    dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>]>;
-    isIndex: z.ZodBoolean;
-    index: z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>;
+    leaseholder: z.ZodDefault<z.ZodInt>;
+    dataType: z.ZodUnion<readonly [z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodPipe<z.ZodObject<{
+        value: z.ZodString;
+    }, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').DataType, {
+        value: string;
+    }>>]>;
+    isIndex: z.ZodDefault<z.ZodBoolean>;
+    index: z.ZodDefault<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>;
     alias: z.ZodOptional<z.ZodString>;
     virtual: z.ZodDefault<z.ZodBoolean>;
     internal: z.ZodDefault<z.ZodBoolean>;
     expression: z.ZodDefault<z.ZodString>;
-    operations: z.ZodOptional<z.ZodPipe<z.ZodNullable<z.ZodArray<z.ZodObject<{
+    operations: z.ZodDefault<z.ZodArray<z.ZodObject<{
         type: z.ZodEnum<{
-            none: "none";
             min: "min";
             max: "max";
             avg: "avg";
+            none: "none";
             derivative: "derivative";
         }>;
         resetChannel: z.ZodDefault<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>;
@@ -26,41 +33,37 @@ export declare const paramsZ: z.ZodUnion<readonly [z.ZodUnion<[z.ZodArray<z.ZodU
         }, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, {
             value: bigint;
         }>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, bigint>>, z.ZodCustom<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeSpan>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').TimeStamp, import('@synnaxlabs/x').TimeStamp>, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeStamp>>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').Rate, import('@synnaxlabs/x').Rate>, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').Rate>>]>>;
-    }, z.core.$strip>>>, z.ZodTransform<{
-        type: "none" | "min" | "max" | "avg" | "derivative";
-        resetChannel: number;
-        duration: import('@synnaxlabs/x').TimeSpan;
-    }[] | undefined, {
-        type: "none" | "min" | "max" | "avg" | "derivative";
-        resetChannel: number;
-        duration: import('@synnaxlabs/x').TimeSpan;
-    }[] | null>>>;
-    concurrency: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof import('@synnaxlabs/x/dist/src/control/types.gen').Concurrency>>>;
-    status: z.ZodOptional<import('@synnaxlabs/x/dist/src/status/types.gen').StatusZodObject<z.ZodNever, z.ZodEnum<{
-        success: "success";
+    }, z.core.$strip>>>;
+    concurrency: z.ZodDefault<z.ZodEnum<typeof import('@synnaxlabs/x/dist/src/control/types.gen.js').Concurrency>>;
+    status: z.ZodOptional<import('..').StatusZodObject<z.ZodNever, z.ZodEnum<{
         error: "error";
+        success: "success";
         info: "info";
         warning: "warning";
         loading: "loading";
         disabled: "disabled";
     }>>>;
 }, z.core.$strip>>, z.ZodPipe<z.ZodObject<{
-    key: z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>;
+    key: z.ZodDefault<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>;
     name: z.ZodString;
-    leaseholder: z.ZodInt;
-    dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>]>;
-    isIndex: z.ZodBoolean;
-    index: z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>;
+    leaseholder: z.ZodDefault<z.ZodInt>;
+    dataType: z.ZodUnion<readonly [z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodPipe<z.ZodObject<{
+        value: z.ZodString;
+    }, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').DataType, {
+        value: string;
+    }>>]>;
+    isIndex: z.ZodDefault<z.ZodBoolean>;
+    index: z.ZodDefault<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>;
     alias: z.ZodOptional<z.ZodString>;
     virtual: z.ZodDefault<z.ZodBoolean>;
     internal: z.ZodDefault<z.ZodBoolean>;
     expression: z.ZodDefault<z.ZodString>;
-    operations: z.ZodOptional<z.ZodPipe<z.ZodNullable<z.ZodArray<z.ZodObject<{
+    operations: z.ZodDefault<z.ZodArray<z.ZodObject<{
         type: z.ZodEnum<{
-            none: "none";
             min: "min";
             max: "max";
             avg: "avg";
+            none: "none";
             derivative: "derivative";
         }>;
         resetChannel: z.ZodDefault<z.ZodUnion<[z.ZodUInt32, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>;
@@ -69,19 +72,11 @@ export declare const paramsZ: z.ZodUnion<readonly [z.ZodUnion<[z.ZodArray<z.ZodU
         }, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, {
             value: bigint;
         }>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, bigint>>, z.ZodCustom<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeSpan>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').TimeStamp, import('@synnaxlabs/x').TimeStamp>, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeStamp>>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').Rate, import('@synnaxlabs/x').Rate>, z.ZodTransform<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').Rate>>]>>;
-    }, z.core.$strip>>>, z.ZodTransform<{
-        type: "none" | "min" | "max" | "avg" | "derivative";
-        resetChannel: number;
-        duration: import('@synnaxlabs/x').TimeSpan;
-    }[] | undefined, {
-        type: "none" | "min" | "max" | "avg" | "derivative";
-        resetChannel: number;
-        duration: import('@synnaxlabs/x').TimeSpan;
-    }[] | null>>>;
-    concurrency: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof import('@synnaxlabs/x/dist/src/control/types.gen').Concurrency>>>;
-    status: z.ZodOptional<import('@synnaxlabs/x/dist/src/status/types.gen').StatusZodObject<z.ZodNever, z.ZodEnum<{
-        success: "success";
+    }, z.core.$strip>>>;
+    concurrency: z.ZodDefault<z.ZodEnum<typeof import('@synnaxlabs/x/dist/src/control/types.gen.js').Concurrency>>;
+    status: z.ZodOptional<import('..').StatusZodObject<z.ZodNever, z.ZodEnum<{
         error: "error";
+        success: "success";
         info: "info";
         warning: "warning";
         loading: "loading";
@@ -97,20 +92,20 @@ export declare const paramsZ: z.ZodUnion<readonly [z.ZodUnion<[z.ZodArray<z.ZodU
     virtual: boolean;
     internal: boolean;
     expression: string;
-    alias?: string | undefined;
-    operations?: {
-        type: "none" | "min" | "max" | "avg" | "derivative";
+    operations: {
+        type: "min" | "max" | "avg" | "none" | "derivative";
         resetChannel: number;
         duration: import('@synnaxlabs/x').TimeSpan;
-    }[] | undefined;
-    concurrency?: import('@synnaxlabs/x/dist/src/control/types.gen').Concurrency | undefined;
+    }[];
+    concurrency: import('@synnaxlabs/x/dist/src/control/types.gen.js').Concurrency;
+    alias?: string | undefined;
     status?: {
         key: string;
         name: string;
         variant: "error" | "success" | "info" | "warning" | "loading" | "disabled";
         message: string;
+        description: string;
         time: import('@synnaxlabs/x').TimeStamp;
-        description?: string | undefined;
         labels?: {
             key: string;
             name: string;
@@ -128,20 +123,20 @@ export declare const paramsZ: z.ZodUnion<readonly [z.ZodUnion<[z.ZodArray<z.ZodU
     virtual: boolean;
     internal: boolean;
     expression: string;
-    alias?: string | undefined;
-    operations?: {
-        type: "none" | "min" | "max" | "avg" | "derivative";
+    operations: {
+        type: "min" | "max" | "avg" | "none" | "derivative";
         resetChannel: number;
         duration: import('@synnaxlabs/x').TimeSpan;
-    }[] | undefined;
-    concurrency?: import('@synnaxlabs/x/dist/src/control/types.gen').Concurrency | undefined;
+    }[];
+    concurrency: import('@synnaxlabs/x/dist/src/control/types.gen.js').Concurrency;
+    alias?: string | undefined;
     status?: {
         key: string;
         name: string;
         variant: "error" | "success" | "info" | "warning" | "loading" | "disabled";
         message: string;
+        description: string;
         time: import('@synnaxlabs/x').TimeStamp;
-        description?: string | undefined;
         labels?: {
             key: string;
             name: string;
@@ -159,20 +154,20 @@ export declare const paramsZ: z.ZodUnion<readonly [z.ZodUnion<[z.ZodArray<z.ZodU
     virtual: boolean;
     internal: boolean;
     expression: string;
-    alias?: string | undefined;
-    operations?: {
-        type: "none" | "min" | "max" | "avg" | "derivative";
+    operations: {
+        type: "min" | "max" | "avg" | "none" | "derivative";
         resetChannel: number;
         duration: import('@synnaxlabs/x').TimeSpan;
-    }[] | undefined;
-    concurrency?: import('@synnaxlabs/x/dist/src/control/types.gen').Concurrency | undefined;
+    }[];
+    concurrency: import('@synnaxlabs/x/dist/src/control/types.gen.js').Concurrency;
+    alias?: string | undefined;
     status?: {
         key: string;
         name: string;
         variant: "error" | "success" | "info" | "warning" | "loading" | "disabled";
         message: string;
+        description: string;
         time: import('@synnaxlabs/x').TimeStamp;
-        description?: string | undefined;
         labels?: {
             key: string;
             name: string;
@@ -181,7 +176,21 @@ export declare const paramsZ: z.ZodUnion<readonly [z.ZodUnion<[z.ZodArray<z.ZodU
         details?: unknown;
     } | undefined;
 }[]>>]>;
+/** Anything that names one or many channels. */
 export type Params = PrimitiveParams | Payload | Payload[];
+/**
+ * Rewrites a channel name into a valid identifier, replacing every other character with
+ * an underscore and prefixing a leading digit.
+ */
 export declare const escapeInvalidName: (name: string, changeEmptyToUnderscore?: boolean) => string;
+/** @returns the key of the status that reports on the given channel. */
 export declare const statusKey: (channel: Key) => string;
+/**
+ * Resolves channel params into a normalized array, reporting whether the caller named
+ * one channel or many, and whether by key or by name.
+ */
+export declare const analyzeParams: (channels: Params) => ParamAnalysisResult<Key | Name, {
+    number: "keys";
+    string: "names";
+}>;
 //# sourceMappingURL=payload.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../src/channel/payload.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,KAAK,GAAG,EAER,KAAK,IAAI,EAGT,KAAK,OAAO,EAEb,MAAM,qBAAqB,CAAC;AAG7B,MAAM,MAAM,eAAe,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;AAE1D,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAIlB,CAAC;AACH,MAAM,MAAM,MAAM,GAAG,eAAe,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC;AAM3D,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,EAAE,iCAA+B,WAW9E,CAAC;AAEF,eAAO,MAAM,SAAS,GAAI,SAAS,GAAG,KAAG,MACC,CAAC"}
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../src/channel/payload.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,KAAK,GAAG,EAER,KAAK,IAAI,EAGT,KAAK,OAAO,EAEb,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,iBAAiB,CAAC;AAEzB,qDAAqD;AACrD,MAAM,MAAM,eAAe,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;AAE1D,0EAA0E;AAC1E,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAIlB,CAAC;AACH,gDAAgD;AAChD,MAAM,MAAM,MAAM,GAAG,eAAe,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC;AAM3D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,EAAE,iCAA+B,WAW9E,CAAC;AAEF,wEAAwE;AACxE,eAAO,MAAM,SAAS,GAAI,SAAS,GAAG,KAAG,MAAyC,CAAC;AAEnF;;;GAGG;AACH,eAAO,MAAM,aAAa,GACxB,UAAU,MAAM,KACf,mBAAmB,CAAC,GAAG,GAAG,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAQrE,CAAC"}