@synnaxlabs/client 0.2.1 → 0.13.6

package/dist/client.d.ts

@@ -0,0 +1,73 @@
+import { TimeSpan, TimeStamp } from "@synnaxlabs/x";
+import { z } from "zod";
+import { auth } from './auth';
+import { channel } from './channel';
+import { connection } from './connection';
+import { framer } from './framer';
+import { label } from './label';
+import { ontology } from './ontology';
+import { ranger } from './ranger';
+import { workspace } from './workspace';
+export declare const synnaxPropsZ: z.ZodObject<{
+    host: z.ZodString;
+    port: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+    username: z.ZodOptional<z.ZodString>;
+    password: z.ZodOptional<z.ZodString>;
+    connectivityPollFrequency: z.ZodDefault<z.ZodUnion<[z.ZodEffects<z.ZodType<Number, z.ZodTypeDef, Number>, TimeSpan, Number>, z.ZodEffects<z.ZodNumber, TimeSpan, number>, z.ZodType<TimeSpan, z.ZodTypeDef, TimeSpan>]>>;
+    secure: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    host: string;
+    port: string | number;
+    connectivityPollFrequency: TimeSpan;
+    secure: boolean;
+    username?: string | undefined;
+    password?: string | undefined;
+}, {
+    host: string;
+    port: string | number;
+    username?: string | undefined;
+    password?: string | undefined;
+    connectivityPollFrequency?: number | Number | TimeSpan | undefined;
+    secure?: boolean | undefined;
+}>;
+export type SynnaxProps = z.input<typeof synnaxPropsZ>;
+export type ParsedSynnaxProps = z.output<typeof synnaxPropsZ>;
+/**
+ * Client to perform operations against a Synnax cluster.
+ *
+ * @property channel - Channel client for creating and retrieving channels.
+ * @property data - Data client for reading and writing telemetry.
+ * @property connectivity - Client for retrieving connectivity information.
+ * @property ontology - Client for querying the cluster's ontology.
+ */
+export default class Synnax {
+    private readonly transport;
+    readonly createdAt: TimeStamp;
+    readonly telem: framer.Client;
+    readonly ranges: ranger.Client;
+    readonly channels: channel.Client;
+    readonly auth: auth.Client | undefined;
+    readonly connectivity: connection.Checker;
+    readonly ontology: ontology.Client;
+    readonly props: ParsedSynnaxProps;
+    readonly workspaces: workspace.Client;
+    readonly labels: label.Client;
+    static readonly connectivity: typeof connection.Checker;
+    /**
+     * @param props.host - Hostname of a node in the cluster.
+     * @param props.port - Port of the node in the cluster.
+     * @param props.username - Username for authentication. Not required if the
+     * cluster is insecure.
+     * @param props.password - Password for authentication. Not required if the
+     * cluster is insecure.
+     * @param props.connectivityPollFrequency - Frequency at which to poll the
+     * cluster for connectivity information. Defaults to 5 seconds.
+     * @param props.secure - Whether to connect to the cluster using TLS. The cluster
+     * must be configured to support TLS. Defaults to false.
+     *
+     * A Synnax client must be closed when it is no longer needed. This will stop
+     * the client from polling the cluster for connectivity information.
+     */
+    constructor(props: SynnaxProps);
+    close(): void;
+}