@xyo-network/react-standard-node 2.81.10 → 2.83.0

package/dist/browser/index.d.ts

@@ -1,5 +1,332 @@
-export * from './components/index.js';
-export * from './contexts/index.js';
-export * from './hooks/index.js';
-export * from './lib/index.js';
-//# sourceMappingURL=index.d.ts.map
+import { WithChildren } from '@xylabs/react-shared';
+import * as React from 'react';
+import React__default from 'react';
+import * as _xyo_network_react_shared from '@xyo-network/react-shared';
+import { ContextExState } from '@xyo-network/react-shared';
+import { Address } from '@xylabs/hex';
+import { MemoryNode } from '@xyo-network/node-memory';
+import { WalletInstance } from '@xyo-network/wallet-model';
+import * as _xyo_network_sentinel_memory from '@xyo-network/sentinel-memory';
+import { MemorySentinel } from '@xyo-network/sentinel-memory';
+import * as _xyo_network_sentinel_model from '@xyo-network/sentinel-model';
+import { SentinelConfig } from '@xyo-network/sentinel-model';
+import * as _xyo_network_node_model from '@xyo-network/node-model';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { AttachableModuleInstance } from '@xyo-network/module-model';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import * as _xylabs_object from '@xylabs/object';
+import * as _xyo_network_account_model from '@xyo-network/account-model';
+import { AccountInstance } from '@xyo-network/account-model';
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin';
+import { AttachableWitnessInstance } from '@xyo-network/witness-model';
+import * as _xyo_network_archivist_model from '@xyo-network/archivist-model';
+import { StorageArchivist, StorageArchivistConfigSchema, StorageArchivistConfig } from '@xyo-network/archivist-storage';
+
+interface ActiveStandardNodeProps extends WithChildren {
+    nodeNameOrAddress?: string;
+}
+declare const ActiveStandardNode: React__default.FC<ActiveStandardNodeProps>;
+
+interface StandardNodesState extends ContextExState {
+    findAddressByName?: (name?: string) => Address | undefined;
+    nodes?: MemoryNode[];
+}
+
+declare const StandardNodesContext: React.Context<StandardNodesState & _xyo_network_react_shared.ContextExState>;
+
+interface StandardNodesProviderProps extends WithChildren {
+    defaultRemoteNodes?: StandardNodesState['nodes'];
+    wallet?: WalletInstance | null;
+}
+declare const StandardNodesProvider: React__default.FC<StandardNodesProviderProps>;
+declare const StandardNodesProviderWithWallet: React__default.FC<Omit<StandardNodesProviderProps, 'wallet'>>;
+
+declare const useStandardNodes: (required?: boolean) => Omit<StandardNodesState & _xyo_network_react_shared.ContextExState, "provided">;
+
+declare const useActiveNodeAddress: (networkName?: string) => Lowercase<string> | undefined;
+
+interface MemoryNodeBuilderConfig {
+    name?: string;
+    node?: MemoryNode;
+}
+declare class MemoryNodeBuilder {
+    private _node;
+    get node(): MemoryNode<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            archivist?: string;
+        } & {
+            schema: "network.xyo.node.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_node_model.NodeModuleEventData>;
+    static create({ name, node }: MemoryNodeBuilderConfig, account?: AccountInstance): Promise<MemoryNodeBuilder>;
+    addArchivist(account: AccountInstance, moduleName?: string, namespace?: string): Promise<void>;
+    addArchivistMemory(moduleName?: string, account?: AccountInstance): Promise<void>;
+    addArchivistStorage(account: AccountInstance, moduleName?: string, namespace?: string): Promise<void>;
+    addBridge(apiDomain: string, moduleName?: string, account?: AccountInstance): Promise<void>;
+    addSentinel(config: SentinelConfig, account: AccountInstance): Promise<_xyo_network_sentinel_memory.MemorySentinel<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: _xyo_network_sentinel_model.SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: _xyo_network_sentinel_model.Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_sentinel_model.SentinelModuleEventData<_xyo_network_sentinel_model.SentinelInstance<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: _xyo_network_sentinel_model.SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: _xyo_network_sentinel_model.Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_sentinel_model.SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>>>;
+    addWitnesses(pluginSetResolver: PayloadSetPluginResolver, witnesses?: (() => Promise<AttachableWitnessInstance>)[]): Promise<void>;
+    attach(mod: AttachableModuleInstance, external?: boolean, safeAttach?: boolean): Promise<void>;
+    private witnessCleanup;
+}
+
+declare class SentinelBuilder {
+    private config;
+    private account;
+    private _sentinel;
+    protected constructor(config: SentinelConfig, account: AccountInstance);
+    get sentinel(): MemorySentinel<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: _xyo_network_sentinel_model.SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: _xyo_network_sentinel_model.Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_sentinel_model.SentinelModuleEventData<_xyo_network_sentinel_model.SentinelInstance<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: _xyo_network_sentinel_model.SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: _xyo_network_sentinel_model.Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_sentinel_model.SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>>;
+    static create(config: SentinelConfig, account: AccountInstance): Promise<SentinelBuilder>;
+    buildSentinel(): Promise<MemorySentinel<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: _xyo_network_sentinel_model.SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: _xyo_network_sentinel_model.Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_sentinel_model.SentinelModuleEventData<_xyo_network_sentinel_model.SentinelInstance<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: _xyo_network_sentinel_model.SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: _xyo_network_sentinel_model.Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_sentinel_model.SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>>>;
+    private buildParams;
+}
+
+interface ArchivistBuilderConfig {
+    name?: string;
+    namespace?: string;
+}
+declare class StorageArchivistBuilder {
+    private config;
+    private account;
+    private node?;
+    private _archivist;
+    private remoteArchivist;
+    protected constructor(config: ArchivistBuilderConfig, account: AccountInstance, node?: MemoryNode | undefined);
+    get archivist(): StorageArchivist<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            parents?: _xyo_network_archivist_model.ArchivistParents;
+            requireAllParents?: boolean;
+            schema: "network.xyo.archivist.storage.config";
+            storage?: _xyo_network_archivist_model.ArchivistStorage;
+            storeParentReads?: boolean;
+        } & {
+            maxEntries?: number;
+            maxEntrySize?: number;
+            namespace?: string;
+            persistAccount?: boolean;
+            schema: StorageArchivistConfigSchema;
+            type?: "local" | "session" | "page";
+        }, "schema"> & {
+            schema: "network.xyo.archivist.storage.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_archivist_model.ArchivistModuleEventData>;
+    static create(config: ArchivistBuilderConfig, account: AccountInstance, node: MemoryNode): Promise<StorageArchivistBuilder>;
+    buildArchivist(): Promise<StorageArchivist<_xylabs_object.BaseParamsFields & {
+        account?: AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            parents?: _xyo_network_archivist_model.ArchivistParents;
+            requireAllParents?: boolean;
+            schema: "network.xyo.archivist.storage.config";
+            storage?: _xyo_network_archivist_model.ArchivistStorage;
+            storeParentReads?: boolean;
+        } & {
+            maxEntries?: number;
+            maxEntrySize?: number;
+            namespace?: string;
+            persistAccount?: boolean;
+            schema: StorageArchivistConfigSchema;
+            type?: "local" | "session" | "page";
+        }, "schema"> & {
+            schema: "network.xyo.archivist.storage.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_archivist_model.ArchivistModuleEventData>>;
+    buildConfig(): StorageArchivistConfig;
+    findParentArchivist(): Promise<_xyo_network_archivist_model.ArchivistInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            parents?: _xyo_network_archivist_model.ArchivistParents;
+            requireAllParents?: boolean;
+            schema: "network.xyo.archivist.config";
+            storage?: _xyo_network_archivist_model.ArchivistStorage;
+            storeParentReads?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.archivist.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_archivist_model.ArchivistModuleEventData, {
+        schema: string;
+    } & _xyo_network_payload_model.PayloadFields> | undefined>;
+}
+
+declare const BuildStandardNodes: (wallet: WalletInstance, onNodeBuilt?: (node: MemoryNode) => void) => Promise<MemoryNode[]>;
+
+declare const GlobalNodeOffsetPath = "15";
+declare const RemoteNodeOffsetPaths: Record<string, string>;
+declare const RemoteNodeArchivistOffsetPaths: Record<string, Record<string, string>>;
+
+declare const GlobalNode = "GlobalNode";
+declare const RootStorageArchivist = "RootStorageArchivist";
+
+export { ActiveStandardNode, type ActiveStandardNodeProps, type ArchivistBuilderConfig, BuildStandardNodes, GlobalNode, GlobalNodeOffsetPath, MemoryNodeBuilder, type MemoryNodeBuilderConfig, RemoteNodeArchivistOffsetPaths, RemoteNodeOffsetPaths, RootStorageArchivist, SentinelBuilder, StandardNodesContext, StandardNodesProvider, type StandardNodesProviderProps, StandardNodesProviderWithWallet, type StandardNodesState, StorageArchivistBuilder, useActiveNodeAddress, useStandardNodes };