@synnaxlabs/client 0.26.7 → 0.27.0

package/api-extractor.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../configs/api-extractor/api-extractor.json",
+  "projectFolder": ".",
+  "docModel": {
+    "projectFolderUrl": "https://github.com/synnaxlabs/synnax/tree/main/client/ts"
+  }
+}

package/dist/access/client.d.ts

@@ -1,7 +1,6 @@
 import { UnaryClient } from '@synnaxlabs/freighter';
 import { Key, NewPolicyPayload, Policy } from './payload';
 import { IDPayload } from '../ontology/payload';
-
 export declare class Client {
     private readonly client;
     constructor(client: UnaryClient);

package/dist/access/payload.d.ts

@@ -1,6 +1,5 @@
 import { z } from 'zod';
 import { ontology } from '../ontology';
-
 export declare const keyZ: z.ZodString;
 export type Key = z.infer<typeof keyZ>;
 export type Params = Key | Key[];

package/dist/auth/auth.d.ts

@@ -1,7 +1,6 @@
 import { Middleware, UnaryClient } from '@synnaxlabs/freighter';
 import { z } from 'zod';
 import { user } from '../user';
-
 export declare const insecureCredentialsZ: z.ZodObject<{
     username: z.ZodString;
     password: z.ZodString;

package/dist/channel/client.d.ts

@@ -7,7 +7,6 @@ import { Writer } from './writer';
 import { framer } from '../framer';
 import { ontology } from '../ontology';
 import { group } from '../ontology/group';
-
 interface CreateOptions {
     retrieveIfNameExists?: boolean;
 }
@@ -64,7 +63,12 @@ export declare class Channel {
      * should not be relied upon in the current version of Synnax.
      */
     readonly alias: string | undefined;
-    constructor({ dataType, rate, name, leaseholder, key, isIndex, index, internal, frameClient, alias, }: NewPayload & {
+    /**
+     * Whether the channel is virtual. Virtual channels do not store any data in the
+     * database, but can still be used for streaming purposes.
+     */
+    readonly virtual: boolean;
+    constructor({ dataType, rate, name, leaseholder, key, isIndex, index, internal, virtual, frameClient, alias, }: NewPayload & {
         frameClient?: framer.Client;
         density?: CrudeDensity;
     });

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,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,QAAQ,EACR,KAAK,WAAW,EAChB,IAAI,EACJ,KAAK,SAAS,EACd,KAAK,UAAU,EAChB,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EACL,KAAK,GAAG,EACR,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,OAAO,EAEb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAKL,KAAK,eAAe,EACpB,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;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAGzC,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;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;;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,QAAgB,EAChB,WAAW,EACX,KAAK,GACN,EAAE,UAAU,GAAG;QACd,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,YAAY,CAAC;KACxB;IAaD,OAAO,KAAK,MAAM,GAIjB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAWrB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,QAAQ,CAAC,EAAE,CAE5B;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;AAUD;;;;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;IAIzE;;;OAGG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOvC,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;IAMzD,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;IAKP,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;CAU5C"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/channel/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,QAAQ,EACR,KAAK,WAAW,EAChB,IAAI,EACJ,KAAK,SAAS,EACd,KAAK,UAAU,EAChB,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EACL,KAAK,GAAG,EACR,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,OAAO,EAEb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAKL,KAAK,eAAe,EACpB,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;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAGzC,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;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEd,EACV,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,WAAe,EACf,GAAO,EACP,OAAe,EACf,KAAS,EACT,QAAgB,EAChB,OAAe,EACf,WAAW,EACX,KAAK,GACN,EAAE,UAAU,GAAG;QACd,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,YAAY,CAAC;KACxB;IAcD,OAAO,KAAK,MAAM,GAIjB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAWrB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,QAAQ,CAAC,EAAE,CAE5B;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;AAUD;;;;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;IAIzE;;;OAGG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOvC,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;IAMzD,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;IAKP,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;CAU5C"}

package/dist/channel/creator.d.ts

@@ -1,6 +1,5 @@
 import { UnaryClient } from '@synnaxlabs/freighter';
 import { NewPayload, Payload } from './payload';
-
 export declare class Creator {
     private static readonly ENDPOINT;
     private readonly client;

package/dist/channel/payload.d.ts

@@ -1,7 +1,6 @@
 import { DataType, Rate } from '@synnaxlabs/x/telem';
 import { z } from 'zod';
 import { ontology } from '../ontology';
-
 export declare const keyZ: z.ZodNumber;
 export type Key = number;
 export type Keys = number[];
@@ -19,9 +18,11 @@ export declare const payload: z.ZodObject<{
     index: z.ZodNumber;
     isIndex: z.ZodBoolean;
     internal: z.ZodBoolean;
+    virtual: z.ZodBoolean;
     alias: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     leaseholder: number;
+    virtual: boolean;
     isIndex: boolean;
     internal: boolean;
     name: string;
@@ -32,6 +33,7 @@ export declare const payload: z.ZodObject<{
     alias?: string | undefined;
 }, {
     leaseholder: number;
+    virtual: boolean;
     isIndex: boolean;
     internal: boolean;
     name: string;
@@ -51,6 +53,7 @@ export declare const newPayload: z.ZodObject<z.objectUtil.extendShape<{
     index: z.ZodNumber;
     isIndex: z.ZodBoolean;
     internal: z.ZodBoolean;
+    virtual: z.ZodBoolean;
     alias: z.ZodOptional<z.ZodString>;
 }, {
     key: z.ZodOptional<z.ZodNumber>;

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,qBAAqB,CAAC;AACrD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUlB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQrB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD,eAAO,MAAM,mBAAmB,EAAgB,QAAQ,CAAC,YAAY,CAAC;AAEtE,eAAO,MAAM,UAAU,QAAS,GAAG,KAAG,QAAQ,CAAC,EACsB,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,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWlB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQrB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD,eAAO,MAAM,mBAAmB,EAAgB,QAAQ,CAAC,YAAY,CAAC;AAEtE,eAAO,MAAM,UAAU,QAAS,GAAG,KAAG,QAAQ,CAAC,EACsB,CAAC"}

package/dist/channel/retriever.d.ts

@@ -3,7 +3,6 @@ import { DataType } from '@synnaxlabs/x/telem';
 import { z } from 'zod';
 import { Key, KeyOrName, Params, Payload } from './payload';
 import { ParamAnalysisResult } from '../util/retrieve';
-
 declare const reqZ: z.ZodObject<{
     leaseholder: z.ZodOptional<z.ZodNumber>;
     keys: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;

package/dist/channel/writer.d.ts

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