@synnaxlabs/pluto 0.43.1 → 0.44.1

package/dist/src/flux/aether/streamer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamer.d.ts","sourceRoot":"","sources":["../../../../src/flux/aether/streamer.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,KAAK,aAAa,EAA4B,MAAM,eAAe,CAAC;AAE7E,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAiBvC,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,CAAC,YAAY,CAAC;IACjC,YAAY,CAAC,EAAE,aAAa,CAAC;CAC9B;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA8C;IACvE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAE3B;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAkC;IACzE,OAAO,CAAC,YAAY,CAAoC;gBAE5C,EAAE,WAAW,EAAE,YAAgB,EAAE,EAAE,YAAY;IAU3D,OAAO,CAAC,YAAY;IAkBd,KAAK;YAIG,gBAAgB;IAQxB,cAAc,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBvE,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,IAAI;CAa9E"}

package/dist/src/flux/aether/streamer.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=streamer.spec.d.ts.map

package/dist/src/flux/aether/streamer.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamer.spec.d.ts","sourceRoot":"","sources":["../../../../src/flux/aether/streamer.spec.ts"],"names":[],"mappings":""}

package/dist/src/flux/aether/types.d.ts

@@ -0,0 +1,13 @@
+import { channel, framer } from '@synnaxlabs/client';
+import { Destructor, observe } from '@synnaxlabs/x';
+export interface FrameHandler extends observe.Handler<framer.Frame> {
+}
+export interface Subscriber {
+    channel: channel.Name;
+    handler: FrameHandler;
+    onOpen?: () => void;
+}
+export interface ListenerAdder {
+    (subscriber: Subscriber): Destructor;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/flux/aether/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/flux/aether/types.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAE9D,MAAM,WAAW,YAAa,SAAQ,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;CAAG;AAEtE,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC;IACtB,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAAC;CACtC"}

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

@@ -0,0 +1,12 @@
+export * from './aether/listeners';
+export * from './aether/params';
+export * from './aether/types';
+export * from './Context';
+export * from './form';
+export * from './list';
+export * from './listeners';
+export * from './Provider';
+export * from './result';
+export * from './retrieve';
+export * from './update';
+//# sourceMappingURL=external.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"external.d.ts","sourceRoot":"","sources":["../../../src/flux/external.ts"],"names":[],"mappings":"AASA,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}

package/dist/src/flux/form.d.ts

@@ -0,0 +1,112 @@
+import { z } from 'zod';
+import { FetchOptions, Params } from './aether/params';
+import { Result } from './result';
+import { CreateRetrieveArgs } from './retrieve';
+import { CreateUpdateArgs } from './update';
+import { Form } from '../form';
+/**
+ * Configuration arguments for creating a form query.
+ *
+ * @template FormParams The type of parameters for the form query
+ * @template DataSchema The Zod schema type for form validation
+ */
+export interface CreateFormArgs<FormParams extends Params, DataSchema extends z.ZodObject> extends CreateRetrieveArgs<FormParams, z.infer<DataSchema> | null>, CreateUpdateArgs<FormParams, z.infer<DataSchema>> {
+    /** Zod schema for form validation */
+    schema: DataSchema;
+    /** Default values to use when creating new forms */
+    initialValues: z.infer<DataSchema>;
+}
+/**
+ * Return type for the form hook, providing form management utilities.
+ *
+ * @template DataSchema The Zod schema type for form validation
+ */
+export type UseFormReturn<DataSchema extends z.ZodObject> = Omit<Result<z.infer<DataSchema>>, "data"> & {
+    /** Form management utilities for binding inputs and validation */
+    form: Form.UseReturn<DataSchema>;
+    /** Function to save the current form values */
+    save: (opts?: FetchOptions) => void;
+};
+/**
+ * Arguments passed to the afterSave callback.
+ *
+ * @template FormParams The type of parameters for the form query
+ * @template Z The Zod schema type for form validation
+ */
+export interface AfterSaveArgs<FormParams extends Params, Z extends z.ZodObject> {
+    /** The form management utilities */
+    form: Form.UseReturn<Z>;
+    /** The current form parameters */
+    params: FormParams;
+}
+/**
+ * Arguments for using a form hook.
+ *
+ * @template FormParams The type of parameters for the form query
+ * @template Z The Zod schema type for form validation
+ */
+export interface UseFormArgs<FormParams extends Params, Z extends z.ZodObject> extends Pick<Form.UseArgs<Z>, "sync" | "onHasTouched" | "mode"> {
+    /** Initial values for the form fields */
+    initialValues?: z.infer<Z>;
+    /** Whether to automatically save form changes */
+    autoSave?: boolean;
+    /** Parameters for the form query */
+    params: FormParams;
+    /** Callback function called after successful save */
+    afterSave?: (args: AfterSaveArgs<FormParams, Z>) => void;
+}
+/**
+ * Form hook function signature.
+ *
+ * @template FormParams The type of parameters for the form query
+ * @template Z The Zod schema type for form validation
+ */
+export interface UseForm<FormParams extends Params, Z extends z.ZodObject> {
+    (args: UseFormArgs<FormParams, Z>): UseFormReturn<Z>;
+}
+/**
+ * Creates a form query hook that combines data fetching, form management, and real-time updates.
+ *
+ * This function creates a React hook that automatically handles:
+ * - Data fetching with loading states
+ * - Form validation using Zod schemas
+ * - Automatic form saving and persistence
+ * - Real-time synchronization with server state
+ * - Error handling and user feedback
+ *
+ * @template FormParams The type of parameters for the form query
+ * @template Schema The Zod schema type for form validation
+ * @param config Configuration object with form schema, update function, and query settings
+ * @returns A React hook for managing the form
+ *
+ * @example
+ * ```typescript
+ * const userSchema = z.object({
+ *   name: z.string().min(1),
+ *   email: z.string().email(),
+ *   age: z.number().optional()
+ * });
+ *
+ * const useUserForm = createForm({
+ *   name: "user",
+ *   schema: userSchema,
+ *   initialValues: { name: "", email: "", age: undefined },
+ *   retrieve: async ({ params, client }) => {
+ *     return await client.users.retrieve(params.userId);
+ *   },
+ *   update: async ({ value, params, client }) => {
+ *     await client.users.update(params.userId, value);
+ *   }
+ * });
+ *
+ * // Usage in component
+ * const { form, save, variant } = useUserForm({
+ *   params: { userId: 123 },
+ *   afterSave: ({ form }) => {
+ *     console.log("User saved:", form.value());
+ *   }
+ * });
+ * ```
+ */
+export declare const createForm: <FormParams extends Params, Schema extends z.ZodObject>({ name, schema, retrieve, listeners, update, initialValues: baseInitialValues, }: CreateFormArgs<FormParams, Schema>) => UseForm<FormParams, Schema>;
+//# sourceMappingURL=form.d.ts.map

package/dist/src/flux/form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../src/flux/form.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAA8B,KAAK,MAAM,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAkB,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAgB,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAI9B;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAC7B,UAAU,SAAS,MAAM,EACzB,UAAU,SAAS,CAAC,CAAC,SAAS,CAC9B,SAAQ,kBAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,EAChE,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACnD,qCAAqC;IACrC,MAAM,EAAE,UAAU,CAAC;IACnB,oDAAoD;IACpD,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,CAAC,CAAC,SAAS,IAAI,IAAI,CAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,EAC3B,MAAM,CACP,GAAG;IACF,kEAAkE;IAClE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACjC,+CAA+C;IAC/C,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CACrC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,UAAU,SAAS,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,SAAS;IAC7E,oCAAoC;IACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACxB,kCAAkC;IAClC,MAAM,EAAE,UAAU,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,UAAU,SAAS,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,SAAS,CAC3E,SAAQ,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,MAAM,CAAC;IAC/D,yCAAyC;IACzC,aAAa,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,iDAAiD;IACjD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,MAAM,EAAE,UAAU,CAAC;IACnB,qDAAqD;IACrD,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;CAC1D;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO,CAAC,UAAU,SAAS,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,SAAS;IACvE,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;CACtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,eAAO,MAAM,UAAU,GAAI,UAAU,SAAS,MAAM,EAAE,MAAM,SAAS,CAAC,CAAC,SAAS,EAAE,kFAO/E,cAAc,CAAC,UAAU,EAAE,MAAM,CAAC,KAAG,OAAO,CAAC,UAAU,EAAE,MAAM,CA8EjE,CAAC"}

package/dist/src/flux/form.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=form.spec.d.ts.map

package/dist/src/flux/form.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.spec.d.ts","sourceRoot":"","sources":["../../../src/flux/form.spec.tsx"],"names":[],"mappings":""}

package/dist/src/flux/index.d.ts

@@ -0,0 +1,2 @@
+export * as Flux from './external';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/flux/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/flux/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC"}

package/dist/src/flux/list.d.ts

@@ -0,0 +1,251 @@
+import { Synnax as Client } from '@synnaxlabs/client';
+import { compare, CrudeTimeSpan, Destructor, MultiSeries, record } from '@synnaxlabs/x';
+import { flux } from './aether';
+import { FetchOptions, Params } from './aether/params';
+import { Result } from './result';
+import { CreateRetrieveArgs } from './retrieve';
+import { state } from '../state';
+/**
+ * Function interface for getting items from a list by key(s).
+ *
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+interface GetItem<K extends record.Key, E extends record.Keyed<K>> {
+    /** Get a single item by key, returns undefined if not found */
+    (key: K): E | undefined;
+    /** Get multiple items by an array of keys */
+    (keys: K[]): E[];
+}
+/**
+ * Options for async list operations.
+ */
+interface AsyncListOptions extends FetchOptions {
+    /**
+     * How to modify the list when new data is retrieved. In append mode, new entries
+     * will be added to the end of the list. In replace mode, the list will be replaced
+     * with the new data.
+     */
+    mode?: "append" | "replace";
+}
+/**
+ * Return type for the list hook, providing comprehensive list management utilities.
+ *
+ * @template RetrieveParams The type of parameters for the retrieve operation
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+export type UseListReturn<RetrieveParams extends Params, K extends record.Key, E extends record.Keyed<K>> = Omit<Result<K[]>, "data"> & {
+    /** Function to trigger a list retrieval operation (fire-and-forget) */
+    retrieve: (params: state.SetArg<RetrieveParams, Partial<RetrieveParams>>, options?: AsyncListOptions) => void;
+    /** Function to trigger a list retrieval operation and await the result */
+    retrieveAsync: (params: state.SetArg<RetrieveParams, Partial<RetrieveParams>>, options?: AsyncListOptions) => Promise<void>;
+    /** Array of keys for the items currently in the list */
+    data: K[];
+    /** Function to get items by key, with automatic lazy loading */
+    getItem: GetItem<K, E>;
+    /** Function to subscribe to changes for specific items */
+    subscribe: (callback: () => void, key: K) => Destructor;
+};
+/**
+ * Arguments for retrieving a single item by key.
+ *
+ * @template RetrieveParams The type of parameters for the retrieve operation
+ * @template K The type of the key (must be a record key)
+ */
+export interface RetrieveByKeyArgs<RetrieveParams extends Params, K extends record.Key> {
+    /** Parameters for the retrieve operation */
+    params: Partial<RetrieveParams>;
+    /** The key of the item to retrieve */
+    key: K;
+    /** The Synnax client instance */
+    client: Client;
+}
+/**
+ * Configuration arguments for creating a list query.
+ *
+ * @template RetrieveParams The type of parameters for the retrieve operation
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+export interface CreateListArgs<RetrieveParams extends Params, K extends record.Key, E extends record.Keyed<K>> extends Omit<CreateRetrieveArgs<RetrieveParams, E[]>, "listeners"> {
+    /** Function to retrieve a single item by key for lazy loading */
+    retrieveByKey: (args: RetrieveByKeyArgs<RetrieveParams, K>) => Promise<E | undefined>;
+    /** Optional listeners for real-time list updates */
+    listeners?: ListListenerConfig<RetrieveParams, K, E>[];
+}
+/**
+ * Arguments for using a list hook.
+ *
+ * @template RetrieveParams The type of parameters for the retrieve operation
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+export interface UseListArgs<RetrieveParams extends Params, K extends record.Key, E extends record.Keyed<K>> {
+    /** Initial parameters for the list query */
+    initialParams?: RetrieveParams;
+    /** Optional filter function to apply to items */
+    filter?: (item: E) => boolean;
+    /** Optional function to sort the list */
+    sort?: compare.Comparator<E>;
+    /** Debounce time for retrieve operations */
+    retrieveDebounce?: CrudeTimeSpan;
+}
+/**
+ * List hook function signature.
+ *
+ * @template RetrieveParams The type of parameters for the retrieve operation
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+export interface UseList<RetrieveParams extends Params, K extends record.Key, E extends record.Keyed<K>> {
+    (args?: UseListArgs<RetrieveParams, K, E>): UseListReturn<RetrieveParams, K, E>;
+}
+type ListChangeMode = "prepend" | "append" | "replace";
+interface ListenerOnChangeOptions {
+    mode?: ListChangeMode;
+}
+/**
+ * Extra arguments passed to list listener handlers.
+ *
+ * @template RetrieveParams The type of parameters for the retrieve operation
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+export interface ListListenerExtraArgs<RetrieveParams extends Params, K extends record.Key, E extends record.Keyed<K>> {
+    changed: MultiSeries;
+    /** The current retrieve parameters */
+    params: RetrieveParams;
+    /** The Synnax client instance */
+    client: Client;
+    /** Function to update a specific item in the list */
+    onChange: (key: K, e: state.SetArg<E | null>, opts?: ListenerOnChangeOptions) => void;
+    /** Function to remove an item from the list */
+    onDelete: (key: K) => void;
+}
+/**
+ * Configuration for a list listener that handles real-time updates.
+ *
+ * @template RetrieveParams The type of parameters for the retrieve operation
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+export interface ListListenerConfig<RetrieveParams extends Params, K extends record.Key, E extends record.Keyed<K>> {
+    /** The channel to listen to for real-time updates */
+    channel: string;
+    /** The function to call when a new value is received from the channel */
+    onChange: flux.ListenerHandler<MultiSeries, ListListenerExtraArgs<RetrieveParams, K, E>>;
+}
+/**
+ * Creates a list query hook that provides comprehensive list management with real-time updates.
+ *
+ * This function creates a React hook that handles:
+ * - List data retrieval with loading states
+ * - Individual item lazy loading
+ * - Real-time synchronization with server state
+ * - Pagination and infinite scrolling support
+ * - Item filtering and search
+ * - Optimistic updates and error handling
+ * - Subscribe to individual item changes
+ *
+ * @template P The type of parameters for the list query
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ * @param config Configuration object with list retrieval functions and settings
+ * @returns A React hook for managing the list
+ *
+ * @example
+ * ```typescript
+ * interface UserListParams extends Params {
+ *   department?: string;
+ *   searchTerm?: string;
+ *   offset?: number;
+ *   limit?: number;
+ * }
+ *
+ * interface User {
+ *   id: number;
+ *   name: string;
+ *   email: string;
+ *   department: string;
+ * }
+ *
+ * const useUserList = createList<UserListParams, number, User>({
+ *   name: "users",
+ *   retrieve: async ({ params, client }) => {
+ *     return await client.users.list(params);
+ *   },
+ *   retrieveByKey: async ({ key, client }) => {
+ *     return await client.users.get(key);
+ *   },
+ *   listeners: [
+ *     {
+ *       channel: "user_updates",
+ *       onChange: ({ changed, onChange, onDelete }) => {
+ *         const updates = changed.get("user_updates");
+ *         updates.forEach(update => {
+ *           if (update.deleted) {
+ *             onDelete(update.id);
+ *           } else {
+ *             onChange(update.id, update);
+ *           }
+ *         });
+ *       }
+ *     }
+ *   ]
+ * });
+ *
+ * // Usage in component
+ * const { data, getItem, retrieve, variant } = useUserList({
+ *   initialParams: { department: "engineering" },
+ *   filter: (user) => user.name.includes("John")
+ * });
+ *
+ * // Get individual user (lazy loaded if not in cache)
+ * const user = getItem(123);
+ *
+ * // Load more users
+ * retrieve({ offset: data.length, limit: 10 }, { mode: "append" });
+ * ```
+ */
+export declare const createList: <P extends Params, K extends record.Key, E extends record.Keyed<K>>({ name, listeners, retrieve, retrieveByKey, }: CreateListArgs<P, K, E>) => UseList<P, K, E>;
+/**
+ * Arguments for the useListItem hook.
+ *
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ */
+export interface UseListItemArgs<K extends record.Key, E extends record.Keyed<K>> extends Pick<UseListReturn<Params, K, E>, "subscribe" | "getItem"> {
+    /** The key of the item to retrieve and subscribe to */
+    key: K;
+}
+/**
+ * Hook for subscribing to and retrieving individual items from a list.
+ *
+ * This hook provides a way to efficiently track individual items from a list
+ * with automatic re-rendering when the item changes. It uses React's
+ * useSyncExternalStore to provide optimal performance.
+ *
+ * @template K The type of the key (must be a record key)
+ * @template E The type of the entity (must be keyed by K)
+ * @param args Configuration object with key and list utilities
+ * @returns The current item data, or undefined if not found
+ *
+ * @example
+ * ```typescript
+ * const userList = useUserList();
+ * const user = useListItem({
+ *   key: userId,
+ *   subscribe: userList.subscribe,
+ *   getItem: userList.getItem
+ * });
+ *
+ * // Component will re-render when this specific user changes
+ * if (user) {
+ *   return <div>{user.name} - {user.email}</div>;
+ * }
+ * ```
+ */
+export declare const useListItem: <K extends record.Key, E extends record.Keyed<K>>({ key, subscribe, getItem, }: UseListItemArgs<K, E>) => E | undefined;
+export {};
+//# sourceMappingURL=list.d.ts.map

package/dist/src/flux/list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/flux/list.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EACL,OAAO,EACP,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,WAAW,EAEhB,KAAK,MAAM,EAEZ,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAIL,KAAK,MAAM,EAEZ,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAQ1D,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC;;;;;GAKG;AACH,UAAU,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,+DAA+D;IAC/D,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IACxB,6CAA6C;IAC7C,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,UAAU,gBAAiB,SAAQ,YAAY;IAC7C;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CACvB,cAAc,SAAS,MAAM,EAC7B,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,GAAG;IAC9B,uEAAuE;IACvE,QAAQ,EAAE,CACR,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,EAC7D,OAAO,CAAC,EAAE,gBAAgB,KACvB,IAAI,CAAC;IACV,0EAA0E;IAC1E,aAAa,EAAE,CACb,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,EAC7D,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,wDAAwD;IACxD,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,gEAAgE;IAChE,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvB,0DAA0D;IAC1D,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,GAAG,EAAE,CAAC,KAAK,UAAU,CAAC;CACzD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB,CAChC,cAAc,SAAS,MAAM,EAC7B,CAAC,SAAS,MAAM,CAAC,GAAG;IAEpB,4CAA4C;IAC5C,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAChC,sCAAsC;IACtC,GAAG,EAAE,CAAC,CAAC;IACP,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc,CAC7B,cAAc,SAAS,MAAM,EAC7B,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CACzB,SAAQ,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC;IAClE,iEAAiE;IACjE,aAAa,EAAE,CAAC,IAAI,EAAE,iBAAiB,CAAC,cAAc,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IACtF,oDAAoD;IACpD,SAAS,CAAC,EAAE,kBAAkB,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;CACxD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAC1B,cAAc,SAAS,MAAM,EAC7B,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAEzB,4CAA4C;IAC5C,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,iDAAiD;IACjD,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC;IAC9B,yCAAyC;IACzC,IAAI,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC7B,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,aAAa,CAAC;CAClC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CACtB,cAAc,SAAS,MAAM,EAC7B,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAEzB,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CACjF;AAED,KAAK,cAAc,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEvD,UAAU,uBAAuB;IAC/B,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB,CACpC,cAAc,SAAS,MAAM,EAC7B,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAEzB,OAAO,EAAE,WAAW,CAAC;IACrB,sCAAsC;IACtC,MAAM,EAAE,cAAc,CAAC;IACvB,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IACtF,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB,CACjC,cAAc,SAAS,MAAM,EAC7B,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAEzB,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,QAAQ,EAAE,IAAI,CAAC,eAAe,CAC5B,WAAW,EACX,qBAAqB,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC,CAC5C,CAAC;CACH;AAkBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,eAAO,MAAM,UAAU,GACpB,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,+CAKjE,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAG,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAwO3C,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAC9E,SAAQ,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAClE,uDAAuD;IACvD,GAAG,EAAE,CAAC,CAAC;CACR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,8BAI1E,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,kBAIrB,CAAC"}

package/dist/src/flux/list.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=list.spec.d.ts.map

package/dist/src/flux/list.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.spec.d.ts","sourceRoot":"","sources":["../../../src/flux/list.spec.tsx"],"names":[],"mappings":""}

package/dist/src/flux/listeners.d.ts

@@ -0,0 +1,4 @@
+import { MultiSeries } from '@synnaxlabs/x';
+import { flux } from './aether';
+export declare const useListener: (listeners: flux.ListenerSpec<MultiSeries, {}> | flux.ListenerSpec<MultiSeries, {}>[]) => void;
+//# sourceMappingURL=listeners.d.ts.map

package/dist/src/flux/listeners.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listeners.d.ts","sourceRoot":"","sources":["../../../src/flux/listeners.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AAGjD,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAIrC,eAAO,MAAM,WAAW,GACtB,WAAW,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC,EAAE,KACnF,IAOF,CAAC"}

package/dist/src/flux/listeners.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=listeners.spec.d.ts.map

package/dist/src/flux/listeners.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listeners.spec.d.ts","sourceRoot":"","sources":["../../../src/flux/listeners.spec.tsx"],"names":[],"mappings":""}

package/dist/src/flux/result.d.ts

@@ -0,0 +1,101 @@
+import { status } from '@synnaxlabs/x';
+import { state } from '../state';
+/**
+ * The result of a query operation that can be in one of three states:
+ * - `loading` - Data is currently being fetched from the server
+ * - `error` - An error occurred while fetching data, or while handling values provided
+ *   to a listener
+ * - `success` - Data was successfully fetched and is available in the `data` field
+ *
+ * @template Data The type of data being retrieved, must extend state.State
+ *
+ * @example
+ * ```typescript
+ * const result: Result<User[]> = {
+ *   variant: "success",
+ *   data: [{ id: 1, name: "John" }],
+ *   error: null,
+ *   message: "Retrieved users"
+ * };
+ * ```
+ */
+export type Result<Data extends state.State> = {
+    variant: "error";
+    status: status.Status<status.ExceptionDetails, "error">;
+    data: null;
+    listenersMounted: boolean;
+} | {
+    variant: "success";
+    status: status.Status<undefined, "success">;
+    data: Data;
+    listenersMounted: boolean;
+} | {
+    variant: "loading";
+    status: status.Status<undefined, "loading">;
+    data: null | Data;
+    listenersMounted: boolean;
+};
+/**
+ * Factory function to create a loading result state.
+ *
+ * @template Data The type of data being retrieved
+ * @param name The name of the resource being retrieved (used in status messages)
+ * @param op The operation being performed (e.g., "retrieving", "updating")
+ * @param data Optional existing data to preserve during loading
+ * @returns A Result object in loading state
+ *
+ * @example
+ * ```typescript
+ * const loadingResult = pendingResult<User[]>("users", "retrieving");
+ * // Returns: { variant: "loading", data: null, error: null, message: "Retrieving users" }
+ * ```
+ */
+export declare const pendingResult: <Data extends state.State>(name: string, op: string, data: Data | null, listenersMounted: boolean) => Result<Data>;
+/**
+ * Factory function to create a success result state.
+ *
+ * @template Data The type of data being retrieved
+ * @param name The name of the resource being retrieved (used in status messages)
+ * @param op The operation that was performed (e.g., "retrieved", "updated")
+ * @param data The successfully retrieved data
+ * @returns A Result object in success state
+ *
+ * @example
+ * ```typescript
+ * const successResult = successResult<User[]>("users", "retrieved", userList);
+ * // Returns: { variant: "success", data: userList, error: null, message: "Retrieved users" }
+ * ```
+ */
+export declare const successResult: <Data extends state.State>(name: string, op: string, data: Data, listenersMounted: boolean) => Result<Data>;
+/**
+ * Factory function to create an error result state.
+ *
+ * @template Data The type of data being retrieved
+ * @param name The name of the resource being retrieved (used in status messages)
+ * @param op The operation that failed (e.g., "retrieve", "update")
+ * @param error The error that occurred
+ * @returns A Result object in error state
+ *
+ * @example
+ * ```typescript
+ * const errorResult = errorResult<User[]>("users", "retrieve", new Error("Network error"));
+ * // Returns: { variant: "error", data: null, error: Error, message: "Failed to retrieve users" }
+ * ```
+ */
+export declare const errorResult: <Data extends state.State>(name: string, op: string, error: unknown, listenersMounted: boolean) => Result<Data>;
+/**
+ * Factory function to create an error result for operations that require a connected client.
+ *
+ * @template Data The type of data being retrieved
+ * @param name The name of the resource being retrieved
+ * @param opName The operation that cannot be performed
+ * @returns A Result object in error state with a DisconnectedError
+ *
+ * @example
+ * ```typescript
+ * const result = nullClientResult<User[]>("users", "retrieve");
+ * // Returns error result with message: "Cannot retrieve users because no cluster is connected."
+ * ```
+ */
+export declare const nullClientResult: <Data extends state.State>(name: string, opName: string, listenersMounted: boolean) => Result<Data>;
+//# sourceMappingURL=result.d.ts.map

package/dist/src/flux/result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../../../src/flux/result.ts"],"names":[],"mappings":"AAUA,OAAO,EAAY,MAAM,EAAE,MAAM,eAAe,CAAC;AAEjD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,MAAM,CAAC,IAAI,SAAS,KAAK,CAAC,KAAK,IACvC;IACE,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACxD,IAAI,EAAE,IAAI,CAAC;IACX,gBAAgB,EAAE,OAAO,CAAC;CAC3B,GACD;IACE,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC5C,IAAI,EAAE,IAAI,CAAC;IACX,gBAAgB,EAAE,OAAO,CAAC;CAC3B,GACD;IACE,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC5C,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEN;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,GAAI,IAAI,SAAS,KAAK,CAAC,KAAK,EACpD,MAAM,MAAM,EACZ,IAAI,MAAM,EACV,MAAM,IAAI,GAAG,IAAI,EACjB,kBAAkB,OAAO,KACxB,MAAM,CAAC,IAAI,CAQZ,CAAC;AAEH;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,GAAI,IAAI,SAAS,KAAK,CAAC,KAAK,EACpD,MAAM,MAAM,EACZ,IAAI,MAAM,EACV,MAAM,IAAI,EACV,kBAAkB,OAAO,KACxB,MAAM,CAAC,IAAI,CAQZ,CAAC;AAEH;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,GAAI,IAAI,SAAS,KAAK,CAAC,KAAK,EAClD,MAAM,MAAM,EACZ,IAAI,MAAM,EACV,OAAO,OAAO,EACd,kBAAkB,OAAO,KACxB,MAAM,CAAC,IAAI,CAKZ,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,GAAI,IAAI,SAAS,KAAK,CAAC,KAAK,EACvD,MAAM,MAAM,EACZ,QAAQ,MAAM,EACd,kBAAkB,OAAO,KACxB,MAAM,CAAC,IAAI,CAMX,CAAC"}

package/dist/src/flux/result.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=result.spec.d.ts.map

package/dist/src/flux/result.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.spec.d.ts","sourceRoot":"","sources":["../../../src/flux/result.spec.tsx"],"names":[],"mappings":""}