@xyo-network/react-node 2.81.10 → 2.83.0

package/dist/browser/index.d.ts

@@ -1,5 +1,101 @@
-export * from './components/index.js';
-export * from './hooks/index.js';
+import { FlexBoxProps } from '@xylabs/react-flexbox';
+import { NodeInstance } from '@xyo-network/node-model';
+import React from 'react';
+import { DrawerProps } from '@mui/material';
+import { WithChildren } from '@xylabs/react-shared';
+import { Logger } from '@xylabs/logger';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { ModuleInstance, ModuleFilterOptions, ModuleFilter, ModuleDescription } from '@xyo-network/module-model';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import * as _xyo_network_account_model from '@xyo-network/account-model';
+import * as _xylabs_object from '@xylabs/object';
 export * from '@xyo-network/react-node-context';
 export * from '@xyo-network/react-node-provider';
-//# sourceMappingURL=index.d.ts.map
+
+interface NodeBoxProps extends FlexBoxProps {
+    node?: string | WeakRef<NodeInstance>;
+    variant?: 'description';
+}
+declare const NodeBox: React.FC<NodeBoxProps>;
+
+interface NodeDrawerProps extends WithChildren, Omit<DrawerProps, 'open'> {
+}
+declare const NodeDrawer: React.FC<NodeDrawerProps>;
+
+type ModuleFromNodeConfig<T extends ModuleInstance = ModuleInstance> = ModuleFilterOptions<T> & {
+    logger?: Logger;
+    node?: NodeInstance | string;
+};
+declare const useModuleFromNodeConfigLogger: (config?: ModuleFromNodeConfig) => Logger | undefined;
+
+declare const useProvidedNode: () => [NodeInstance | null | undefined];
+
+declare const useWeakProvidedNode: () => [WeakRef<NodeInstance> | null | undefined];
+
+declare const useModuleFilterOptions: (config?: ModuleFromNodeConfig) => {
+    direction: _xyo_network_module_model.Direction | undefined;
+    identity: _xylabs_object.TypeCheck<_xyo_network_module_model.ModuleInstance<_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 & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>> | undefined;
+    maxDepth: number | undefined;
+};
+
+declare const useModuleFromNode: <T extends ModuleInstance | void = void>(nameOrAddressOrInstance?: string | (T extends ModuleInstance ? T : ModuleInstance) | undefined, config?: T extends ModuleInstance ? ModuleFromNodeConfig<T> : ModuleFromNodeConfig | undefined) => [(T extends ModuleInstance ? T : ModuleInstance) | undefined, Error | undefined];
+
+declare const useModulesFromNode: (filter?: ModuleFilter, config?: ModuleFromNodeConfig) => [ModuleInstance[] | undefined, Error | undefined];
+
+declare const useNode: (config?: ModuleFromNodeConfig | undefined) => [NodeInstance | undefined, Error | undefined];
+
+declare const useNodeConfigNodeField: (config?: ModuleFromNodeConfig | undefined) => [string | undefined, NodeInstance | undefined];
+
+declare const useNodeDescription: (config?: ModuleFromNodeConfig | undefined) => [ModuleDescription | undefined, Error | undefined];
+
+declare const useNodeFromNode: (nameOrAddressOrInstance?: string | NodeInstance, config?: ModuleFromNodeConfig) => [NodeInstance | undefined, Error | undefined];
+
+declare const useNodesFromNode: (filter?: ModuleFilter, config?: ModuleFromNodeConfig) => [NodeInstance[] | null | undefined, Error | undefined];
+
+type WeakModuleFromNodeConfig = ModuleFilterOptions & {
+    logger?: Logger;
+    node?: WeakRef<NodeInstance> | string;
+};
+declare const useWeakModuleFromNodeConfigLogger: (config?: WeakModuleFromNodeConfig) => Logger | undefined;
+
+declare const useWeakModuleFilterOptions: (config?: WeakModuleFromNodeConfig) => {
+    direction: _xyo_network_module_model.Direction | undefined;
+    identity: _xylabs_object.TypeCheck<_xyo_network_module_model.ModuleInstance<_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 & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>> | undefined;
+    maxDepth: number | undefined;
+};
+
+declare const useWeakModuleFromNode: <T extends ModuleInstance | void = void>(nameOrAddressOrInstance?: string | (T extends ModuleInstance ? T : ModuleInstance) | undefined, config?: WeakModuleFromNodeConfig) => [WeakRef<T extends ModuleInstance ? T : ModuleInstance> | undefined, Error | undefined];
+
+declare const useWeakModulesFromNode: (filter?: ModuleFilter, config?: ModuleFromNodeConfig) => [WeakRef<ModuleInstance>[] | undefined, Error | undefined];
+
+declare const useWeakNodeConfigNodeField: (config?: WeakModuleFromNodeConfig | undefined) => [string | undefined, WeakRef<NodeInstance> | undefined];
+
+declare const useWeakNodeDescription: (config?: WeakModuleFromNodeConfig | undefined) => [ModuleDescription | undefined, Error | undefined];
+
+declare const useWeakNodeFromNode: (nameOrAddressOrInstance?: string | NodeInstance, config?: WeakModuleFromNodeConfig) => [WeakRef<NodeInstance> | undefined, Error | undefined];
+
+export { type ModuleFromNodeConfig, NodeBox, type NodeBoxProps, NodeDrawer, type NodeDrawerProps, type WeakModuleFromNodeConfig, useModuleFilterOptions, useModuleFromNode, useModuleFromNodeConfigLogger, useModulesFromNode, useNode, useNodeConfigNodeField, useNodeDescription, useNodeFromNode, useNodesFromNode, useProvidedNode, useWeakModuleFilterOptions, useWeakModuleFromNode, useWeakModuleFromNodeConfigLogger, useWeakModulesFromNode, useWeakNodeConfigNodeField, useWeakNodeDescription, useWeakNodeFromNode, useWeakProvidedNode };