@laboverwire/stitch-wasm 0.1.0

package/stitch_wasm.d.ts

@@ -0,0 +1,765 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class ConnectOptions {
+    free(): void;
+    [Symbol.dispose](): void;
+    addBackupUrl(url: string): void;
+    addUserProperty(key: string, value: string): void;
+    clearBackupUrls(): void;
+    clearUserProperties(): void;
+    clearWill(): void;
+    getBackupUrls(): string[];
+    constructor();
+    setWill(will: WillMessage): void;
+    get authenticationMethod(): string | undefined;
+    set authenticationMethod(value: string | null | undefined);
+    cleanStart: boolean;
+    keepAlive: number;
+    get maximumPacketSize(): number | undefined;
+    set maximumPacketSize(value: number | null | undefined);
+    protocolVersion: number;
+    get receiveMaximum(): number | undefined;
+    set receiveMaximum(value: number | null | undefined);
+    get requestProblemInformation(): boolean | undefined;
+    set requestProblemInformation(value: boolean | null | undefined);
+    get requestResponseInformation(): boolean | undefined;
+    set requestResponseInformation(value: boolean | null | undefined);
+    get sessionExpiryInterval(): number | undefined;
+    set sessionExpiryInterval(value: number | null | undefined);
+    set authenticationData(value: Uint8Array);
+    set password(value: Uint8Array);
+    get topicAliasMaximum(): number | undefined;
+    set topicAliasMaximum(value: number | null | undefined);
+    get username(): string | undefined;
+    set username(value: string | null | undefined);
+}
+
+export class Cursor {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    count(): number;
+    hasMore(): boolean;
+    /**
+     * Returns up to N items from the cursor as an array.
+     *
+     * # Errors
+     * Returns an error if serialization fails.
+     */
+    nextBatch(size: number): any;
+    /**
+     * Returns the next item from the cursor.
+     *
+     * # Errors
+     * Returns an error if serialization fails.
+     */
+    nextItem(): any;
+    position(): number;
+    reset(): void;
+}
+
+export class Database {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Adds a foreign key constraint.
+     *
+     * # Errors
+     * This function does not currently return errors but the signature allows for future validation.
+     */
+    addForeignKey(source_entity: string, source_field: string, target_entity: string, target_field: string, on_delete: string): void;
+    /**
+     * Adds a foreign key constraint and persists to storage.
+     *
+     * # Errors
+     * Returns an error if storage fails.
+     */
+    addForeignKeyAsync(source_entity: string, source_field: string, target_entity: string, target_field: string, on_delete: string): Promise<void>;
+    /**
+     * Adds an index on the specified fields and backfills from existing records (sync, memory only).
+     *
+     * # Errors
+     * Returns an error if the backend is not memory-based or backfill fails.
+     */
+    addIndex(entity: string, fields: string[]): void;
+    /**
+     * Adds an index on the specified fields and backfills from existing records (async).
+     *
+     * # Errors
+     * Returns an error if the storage operation fails during backfill.
+     */
+    addIndexAsync(entity: string, fields: string[]): Promise<void>;
+    /**
+     * Adds a NOT NULL constraint on the specified field.
+     *
+     * # Errors
+     * This function does not currently return errors but the signature allows for future validation.
+     */
+    addNotNull(entity: string, field: string): void;
+    /**
+     * Adds a NOT NULL constraint and persists to storage.
+     *
+     * # Errors
+     * Returns an error if storage fails.
+     */
+    addNotNullAsync(entity: string, field: string): Promise<void>;
+    /**
+     * Adds a relationship definition for eager loading.
+     *
+     * # Errors
+     * This function does not currently return errors but the signature allows for future validation.
+     */
+    addRelationship(source_entity: string, field: string, target_entity: string): void;
+    /**
+     * Adds a relationship definition and persists to storage.
+     *
+     * # Errors
+     * Returns an error if storage fails.
+     */
+    addRelationshipAsync(source_entity: string, field: string, target_entity: string): Promise<void>;
+    /**
+     * Adds a schema definition for an entity (sync, memory backend only).
+     *
+     * # Errors
+     * Returns an error if the schema definition is invalid.
+     */
+    addSchema(entity: string, schema_js: any): void;
+    /**
+     * Adds a schema definition for an entity and persists to storage.
+     *
+     * # Errors
+     * Returns an error if the schema definition is invalid or storage fails.
+     */
+    addSchemaAsync(entity: string, schema_js: any): Promise<void>;
+    /**
+     * Adds a unique constraint on the specified fields.
+     *
+     * # Errors
+     * This function does not currently return errors but the signature allows for future validation.
+     */
+    addUniqueConstraint(entity: string, fields: string[]): void;
+    /**
+     * Adds a unique constraint and persists to storage.
+     *
+     * # Errors
+     * Returns an error if storage fails.
+     */
+    addUniqueConstraintAsync(entity: string, fields: string[]): Promise<void>;
+    /**
+     * Counts records matching optional filters, using indexes when available.
+     *
+     * # Errors
+     * Returns an error if options are invalid or the storage operation fails.
+     */
+    count(entity: string, options: any): Promise<number>;
+    /**
+     * # Errors
+     * Returns an error if options are invalid or the backend is not memory-based.
+     */
+    countSync(entity: string, options: any): number;
+    /**
+     * Creates a new record in the specified entity.
+     *
+     * # Errors
+     * Returns an error if validation fails or the storage operation fails.
+     */
+    create(entity: string, data: any): Promise<any>;
+    /**
+     * # Errors
+     * Returns an error if validation fails or the backend is not memory-based.
+     */
+    createSync(entity: string, data: any): any;
+    /**
+     * Creates a cursor for streaming iteration over records.
+     *
+     * # Errors
+     * Returns an error if options are invalid or the storage operation fails.
+     */
+    cursor(entity: string, options: any): Promise<Cursor>;
+    /**
+     * Deletes a record by entity and ID.
+     *
+     * # Errors
+     * Returns an error if the record is not found or foreign key constraints prevent deletion.
+     */
+    delete(entity: string, id: string): Promise<void>;
+    /**
+     * # Errors
+     * Returns an error if the record is not found, foreign key constraints prevent deletion, or the backend is not memory-based.
+     */
+    deleteSync(entity: string, id: string): void;
+    /**
+     * Executes a database operation based on an MQTT-style topic.
+     *
+     * # Errors
+     * Returns an error if the topic is invalid or the operation fails.
+     */
+    execute(topic: string, payload: any): Promise<any>;
+    /**
+     * # Errors
+     * Returns `JsValue` if the database is currently borrowed.
+     */
+    getConsumerGroup(group_name: string): any;
+    /**
+     * Gets the schema definition for an entity.
+     *
+     * # Errors
+     * Returns an error if serialization fails.
+     */
+    getSchema(entity: string): any;
+    /**
+     * # Errors
+     * Returns `JsValue` if the database is currently borrowed.
+     */
+    getSubscriptionInfo(sub_id: string): any;
+    /**
+     * # Errors
+     * Returns `JsValue` if the database is currently borrowed.
+     */
+    heartbeat(sub_id: string): boolean;
+    isMemoryBackend(): boolean;
+    /**
+     * Lists records from an entity with optional filtering, sorting, and pagination.
+     *
+     * # Errors
+     * Returns an error if options are invalid or the storage operation fails.
+     */
+    list(entity: string, options: any): Promise<any>;
+    listConstraints(entity: string): any;
+    /**
+     * # Errors
+     * Returns `JsValue` if the database is currently borrowed.
+     */
+    listConsumerGroups(): any;
+    listRelationships(entity: string): any;
+    /**
+     * # Errors
+     * Returns an error if options are invalid or the backend is not memory-based.
+     */
+    listSync(entity: string, options: any): any;
+    constructor();
+    static openEncrypted(db_name: string, passphrase: string): Promise<Database>;
+    static openPersistent(db_name: string): Promise<Database>;
+    /**
+     * Reads a record by entity and ID.
+     *
+     * # Errors
+     * Returns an error if the record is not found or deserialization fails.
+     */
+    read(entity: string, id: string): Promise<any>;
+    /**
+     * # Errors
+     * Returns an error if the record is not found or the backend is not memory-based.
+     */
+    readSync(entity: string, id: string): any;
+    /**
+     * Reads a record with related entities eagerly loaded.
+     *
+     * # Errors
+     * Returns an error if the record is not found or includes cannot be loaded.
+     */
+    readWithIncludes(entity: string, id: string, includes: any): Promise<any>;
+    /**
+     * # Errors
+     * Returns `JsValue` if the database is currently borrowed.
+     */
+    subscribe(pattern: string, entity: string | null | undefined, callback: Function): string;
+    /**
+     * # Errors
+     * Returns `JsValue` if the database is currently borrowed.
+     */
+    subscribeShared(pattern: string, entity: string | null | undefined, group: string, mode: string, callback: Function): string;
+    /**
+     * # Errors
+     * Returns `JsValue` if the database is currently borrowed.
+     */
+    unsubscribe(sub_id: string): boolean;
+    /**
+     * Updates an existing record with new field values.
+     *
+     * # Errors
+     * Returns an error if the record is not found or validation fails.
+     */
+    update(entity: string, id: string, fields: any): Promise<any>;
+    /**
+     * # Errors
+     * Returns an error if the record is not found, validation fails, or the backend is not memory-based.
+     */
+    updateSync(entity: string, id: string, fields: any): any;
+}
+
+export class MessageProperties {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    getUserProperties(): Array<any>;
+    readonly contentType: string | undefined;
+    readonly correlationData: Uint8Array | undefined;
+    readonly messageExpiryInterval: number | undefined;
+    readonly payloadFormatIndicator: boolean | undefined;
+    readonly responseTopic: string | undefined;
+    readonly subscriptionIdentifiers: Uint32Array;
+}
+
+export class MqttClient {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * # Errors
+     * Returns an error if connection fails.
+     */
+    connect(url: string): Promise<void>;
+    /**
+     * # Errors
+     * Returns an error if connection fails.
+     */
+    connectBroadcastChannel(channelName: string): Promise<void>;
+    /**
+     * # Errors
+     * Returns an error if connection fails.
+     */
+    connectMessagePort(port: MessagePort): Promise<void>;
+    /**
+     * # Errors
+     * Returns an error if connection fails.
+     */
+    connectMessagePortWithOptions(port: MessagePort, config: ConnectOptions): Promise<void>;
+    /**
+     * # Errors
+     * Returns an error if connection fails.
+     */
+    connectWithOptions(url: string, config: ConnectOptions): Promise<void>;
+    destroy(): void;
+    /**
+     * # Errors
+     * Returns an error if disconnect fails.
+     */
+    disconnect(): Promise<void>;
+    enableAutoReconnect(enabled: boolean): void;
+    isBrowserOnline(): boolean;
+    isConnected(): boolean;
+    isReconnecting(): boolean;
+    constructor(clientId: string);
+    onAuthChallenge(callback: Function): void;
+    onConnect(callback: Function): void;
+    onConnectivityChange(callback: Function): void;
+    onDisconnect(callback: Function): void;
+    onError(callback: Function): void;
+    onReconnectFailed(callback: Function): void;
+    onReconnecting(callback: Function): void;
+    /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
+     */
+    publish(topic: string, payload: Uint8Array): Promise<void>;
+    /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
+     */
+    publishQos1(topic: string, payload: Uint8Array, callback: Function): Promise<number>;
+    /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
+     */
+    publishQos2(topic: string, payload: Uint8Array, callback: Function): Promise<number>;
+    /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
+     */
+    publishWithOptions(topic: string, payload: Uint8Array, options: PublishOptions): Promise<void>;
+    /**
+     * # Errors
+     * Returns an error if no auth method is set or send fails.
+     */
+    respondAuth(authData: Uint8Array): void;
+    setReconnectOptions(options: ReconnectOptions): void;
+    /**
+     * # Errors
+     * Returns an error if not connected or subscribe fails.
+     */
+    subscribe(topic: string): Promise<number>;
+    /**
+     * # Errors
+     * Returns an error if not connected or subscribe fails.
+     */
+    subscribeWithCallback(topic: string, callback: Function): Promise<number>;
+    /**
+     * # Errors
+     * Returns an error if not connected or subscribe fails.
+     */
+    subscribeWithOptions(topic: string, callback: Function, options: SubscribeOptions): Promise<number>;
+    /**
+     * # Errors
+     * Returns an error if not connected or unsubscribe fails.
+     */
+    unsubscribe(topic: string): Promise<number>;
+}
+
+export class PublishOptions {
+    free(): void;
+    [Symbol.dispose](): void;
+    addUserProperty(key: string, value: string): void;
+    clearUserProperties(): void;
+    constructor();
+    get contentType(): string | undefined;
+    set contentType(value: string | null | undefined);
+    get messageExpiryInterval(): number | undefined;
+    set messageExpiryInterval(value: number | null | undefined);
+    get payloadFormatIndicator(): boolean | undefined;
+    set payloadFormatIndicator(value: boolean | null | undefined);
+    qos: number;
+    get responseTopic(): string | undefined;
+    set responseTopic(value: string | null | undefined);
+    retain: boolean;
+    set correlationData(value: Uint8Array);
+    get topicAlias(): number | undefined;
+    set topicAlias(value: number | null | undefined);
+}
+
+export class ReconnectOptions {
+    free(): void;
+    [Symbol.dispose](): void;
+    static disabled(): ReconnectOptions;
+    constructor();
+    backoffFactor: number;
+    enabled: boolean;
+    initialDelayMs: number;
+    get maxAttempts(): number | undefined;
+    set maxAttempts(value: number | null | undefined);
+    maxDelayMs: number;
+}
+
+/**
+ * Reactive state-sync store, browser flavour. Construct with [`create_store`],
+ * call [`Store::initialize`] once, then issue CRUD calls.
+ */
+export class Store {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Defer memory-bus notifications until [`Store::end_batch`]; rapid bursts
+     * collapse to one event per `(scope, entity)`.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    beginBatch(): void;
+    /**
+     * Clear a scope from the in-memory cache. Equivalent to TS `clearScope`.
+     *
+     * # Errors
+     * Returns an error if the operation fails.
+     */
+    clearScope(scope_id: string): Promise<void>;
+    /**
+     * Unsubscribe from a scope's remote topics and clear it from the active
+     * scope if it was current.
+     *
+     * # Errors
+     * Returns an error if the operation fails.
+     */
+    closeScope(scope_id: string): Promise<void>;
+    /**
+     * Current remote connection status as a string (`"Offline"`,
+     * `"Connecting"`, `"Connected"`, `"Disconnected"`, `"Error"`). `"Offline"`
+     * when no remote is configured.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    connectionStatus(): string;
+    /**
+     * Insert a row into `entity` under `scopeId`. Returns the new row's id.
+     *
+     * # Errors
+     * Returns an error if the write fails.
+     */
+    create(entity: string, scope_id: string, data: any, tag?: string | null): Promise<string>;
+    /**
+     * Delete a row. No-op if absent.
+     *
+     * # Errors
+     * Returns an error if the write fails.
+     */
+    delete(entity: string, id: string, tag?: string | null): Promise<void>;
+    /**
+     * Disconnect the remote, close persistence, and abort background tasks.
+     *
+     * # Errors
+     * Returns an error if the operation fails.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Disconnect the remote client. Memory and persistence are unaffected.
+     *
+     * # Errors
+     * Returns an error if the disconnect fails.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Flush the batch opened by [`Store::begin_batch`].
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    endBatch(): void;
+    /**
+     * Count of rows of `entity` within `scopeId`.
+     *
+     * # Errors
+     * Returns an error if the read fails.
+     */
+    getChildCount(entity: string, scope_id: string): number;
+    /**
+     * Snapshot of all rows for `entity` within `scopeId`. Equivalent to TS
+     * `getSnapshot`.
+     *
+     * # Errors
+     * Returns an error if the read fails.
+     */
+    getSnapshot(entity: string, scope_id: string): any;
+    /**
+     * Snapshot of `entity` within `scopeId` as an object keyed by row id.
+     *
+     * # Errors
+     * Returns an error if the read fails.
+     */
+    getSnapshotAsMap(entity: string, scope_id: string): any;
+    /**
+     * Change token for `(scopeId, entity)`: increments on every mutation and on
+     * scope load, and resets to `0` when the scope is cleared or replaced by
+     * loading another scope. Top-level (global) entities are versioned under the
+     * empty scope. Lets the JS layer cache snapshots and re-fetch whenever this
+     * differs from the last seen value (referential stability for React).
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    getVersion(scope_id: string, entity: string): number;
+    /**
+     * `true` if durable IndexedDB persistence is configured.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    hasPersistence(): boolean;
+    /**
+     * `true` if remote sync is configured.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    hasRemote(): boolean;
+    /**
+     * Open the store (in-memory + persistence) and, when a remote is
+     * configured, connect to the broker. Idempotent.
+     *
+     * # Errors
+     * Returns an error if the underlying database fails to open.
+     */
+    initialize(): Promise<void>;
+    /**
+     * `true` while the remote client is between connections.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    isReconnecting(): boolean;
+    /**
+     * List rows of `entity`, optionally filtered/sorted. `filter` is
+     * `{ scopeId?, sort?: [{ field, direction }], projection?: [string] }`.
+     *
+     * # Errors
+     * Returns an error if the read fails or `filter` is malformed.
+     */
+    list(entity: string, filter: any): Promise<any>;
+    /**
+     * List all root entities across scopes, optionally sorted (`[{ field,
+     * direction }]`).
+     *
+     * # Errors
+     * Returns an error if the read fails or `sort` is malformed.
+     */
+    listRootEntities(sort: any): Promise<any>;
+    /**
+     * Load a scope's rows into the in-memory cache from caller-supplied data,
+     * `{ entity: [records] }`, replacing any currently-loaded scope. Equivalent
+     * to TS `loadScope`.
+     *
+     * # Errors
+     * Returns an error if `data` is malformed or the load fails.
+     */
+    loadScope(scope_id: string, data: any): Promise<void>;
+    /**
+     * Number of offline-queued mutations buffered for `scopeId` (the
+     * authenticated user's pending writes). `0` when no remote/queue is
+     * configured.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    pendingMutationCount(scope_id: string): Promise<number>;
+    /**
+     * Read a single row from the in-memory cache, or `null` if absent.
+     *
+     * # Errors
+     * Returns an error if the read fails.
+     */
+    read(entity: string, id: string): any;
+    /**
+     * Read a row straight from durable persistence, bypassing the in-memory
+     * cache. Returns `null` if absent. Falls back to memory when the store has
+     * no persistence configured.
+     *
+     * # Errors
+     * Returns an error if the read fails.
+     */
+    readLocalState(entity: string, id: string): Promise<any>;
+    /**
+     * `true` once [`Store::initialize`] has completed.
+     */
+    ready(): boolean;
+    /**
+     * Reconnect the remote client, optionally with a fresh JWT ticket or
+     * fresh username + password.
+     *
+     * # Errors
+     * Returns an error if no remote is configured or the reconnect fails.
+     */
+    reconnect(server_url: string, ticket?: string | null, username?: string | null, password?: string | null): Promise<void>;
+    /**
+     * Switch the active scope, loading its rows from persistence into the
+     * in-memory cache. Use after reopening a persistent store to rehydrate a
+     * scope's snapshot.
+     *
+     * # Errors
+     * Returns an error if the load fails.
+     */
+    replaceScope(scope_id: string): Promise<void>;
+    /**
+     * Send an arbitrary MQTT request and await the broker's response.
+     *
+     * # Errors
+     * Returns an error if no remote is configured or the request fails.
+     */
+    request(topic: string, payload: any): Promise<any>;
+    /**
+     * Disconnect, clear auth + sync state. Persistence and the offline queue
+     * stay alive; drop the store to fully reset.
+     *
+     * # Errors
+     * Returns an error if the operation fails.
+     */
+    resetForLogout(): Promise<void>;
+    /**
+     * Set (or clear, with `null`/`undefined`) the authenticated user. Offline
+     * writes are scoped to this user and are dropped while it is unset, so call
+     * this before issuing writes you want queued for replay.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    setAuthenticatedUser(user_id?: string | null): void;
+    /**
+     * Register a callback fired when the broker rejects the session
+     * (`MQTT_DISCONNECT_AUTH_FAILURE`). Use it to clear cached auth and route
+     * the user to re-login. No-op if no remote is configured.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    setSessionInvalidHandler(callback: Function): void;
+    /**
+     * Subscribe to remote connection-status changes; the callback receives the
+     * status string. Returns an unsubscribe function (a no-op when no remote is
+     * configured).
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    subscribeToConnectionStatus(callback: Function): any;
+    /**
+     * Subscribe to mutations for `entity`. The callback receives
+     * `(data | null, op)` where `op` is `"insert" | "update" | "delete"`.
+     * Returns an unsubscribe function.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    subscribeToEntity(entity: string, callback: Function): any;
+    /**
+     * Subscribe to mutations for `(scopeId, entity)`. The callback takes no
+     * args (a "scope changed" signal). Returns an unsubscribe function.
+     *
+     * # Errors
+     * Returns an error if the store is not initialized.
+     */
+    subscribeToScope(scope_id: string, entity: string, callback: Function): any;
+    /**
+     * Partial-update a row.
+     *
+     * # Errors
+     * Returns an error if the write fails.
+     */
+    update(entity: string, id: string, fields: any, tag?: string | null): Promise<void>;
+    /**
+     * Upsert into persistence directly, bypassing memory and remote.
+     *
+     * # Errors
+     * Returns an error if the write fails.
+     */
+    updateLocalState(entity: string, id: string, fields: any): Promise<void>;
+}
+
+export class SubscribeOptions {
+    free(): void;
+    [Symbol.dispose](): void;
+    constructor();
+    noLocal: boolean;
+    qos: number;
+    retainAsPublished: boolean;
+    retainHandling: number;
+    get subscriptionIdentifier(): number | undefined;
+    set subscriptionIdentifier(value: number | null | undefined);
+}
+
+export class WillMessage {
+    free(): void;
+    [Symbol.dispose](): void;
+    constructor(topic: string, payload: Uint8Array);
+    get contentType(): string | undefined;
+    set contentType(value: string | null | undefined);
+    get messageExpiryInterval(): number | undefined;
+    set messageExpiryInterval(value: number | null | undefined);
+    qos: number;
+    get responseTopic(): string | undefined;
+    set responseTopic(value: string | null | undefined);
+    retain: boolean;
+    topic: string;
+    get willDelayInterval(): number | undefined;
+    set willDelayInterval(value: number | null | undefined);
+}
+
+/**
+ * Build an unopened [`Store`] from a config object
+ * (`{ entities, scope: { rootEntity, childEntities, scopeField } }`).
+ *
+ * Pass an optional second argument to enable durable IndexedDB persistence
+ * and/or remote MQTT-over-WebSocket sync:
+ * `{ persistence: { dbName, passphrase? }, remote: { url, clientId?, ticket?, username?, password? } }`.
+ * With a persistence `passphrase` the store is AES-GCM encrypted. `remote.url`
+ * must be a `ws://`/`wss://` endpoint; `remote.ticket` is a JWT used for MQTT v5
+ * enhanced auth, and `remote.username` + `remote.password` drive classic MQTT
+ * password auth when the broker isn't in JWT mode (ticket takes precedence).
+ * `initialize` then connects and live
+ * mutations flow through `subscribeToEntity`/`getSnapshot`. Omit the argument
+ * for an in-memory store.
+ *
+ * # Errors
+ * Returns an error if the config or options object is malformed.
+ */
+export function createStore(config: any, options: any): Store;
+
+export function init(): void;