@twin.org/node-core 0.0.2-next.9 → 0.0.3-next.10

package/dist/types/bootstrap.d.ts

@@ -1,59 +0,0 @@
-import type { IEngineCore, IEngineCoreContext, IEngineState } from "@twin.org/engine-models";
-import { type IEngineServerConfig } from "@twin.org/engine-server-types";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
-import { NodeFeatures } from "./models/nodeFeatures";
-/**
- * Bootstrap the application.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- */
-export declare function bootstrap(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables): Promise<void>;
-/**
- * Bootstrap the node creating any necessary resources.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node. The features that are enabled on the node.
- */
-export declare function bootstrapNodeIdentity(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the user.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapNodeUser(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the immutable proof verification methods.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapImmutableProofMethod(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the keys for blob encryption.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapBlobEncryption(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the JWT signing key.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapAuth(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the synchronised storage blob encryption and verification methods.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapSynchronisedStorage(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;

package/dist/types/models/nodeFeatures.d.ts

@@ -1,21 +0,0 @@
-/**
- * The features that can be enabled on the node.
- */
-export declare const NodeFeatures: {
-    /**
-     * NodeIdentity - generates an identity for the node if not provided in config.
-     */
-    readonly NodeIdentity: "node-identity";
-    /**
-     * NodeUser - generates a user for the node if not provided in config.
-     */
-    readonly NodeUser: "node-user";
-    /**
-     * NodeWallet - generates a wallet for the node and funds it when there is a faucet available.
-     */
-    readonly NodeWallet: "node-wallet";
-};
-/**
- * The features that can be enabled on the node.
- */
-export type NodeFeatures = (typeof NodeFeatures)[keyof typeof NodeFeatures];

package/dist/types/server.d.ts

@@ -1,17 +0,0 @@
-import { Engine } from "@twin.org/engine";
-import { type IEngineState } from "@twin.org/engine-models";
-import { EngineServer } from "@twin.org/engine-server";
-import type { IEngineServerConfig } from "@twin.org/engine-server-types";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
-import type { INodeOptions } from "./models/INodeOptions";
-/**
- * Start the engine server.
- * @param nodeOptions Optional run options for the engine server.
- * @param engineServerConfig The configuration for the engine server.
- * @param envVars The environment variables.
- * @returns The engine server.
- */
-export declare function start(nodeOptions: INodeOptions | undefined, engineServerConfig: IEngineServerConfig, envVars: INodeEnvironmentVariables): Promise<{
-    engine: Engine<IEngineServerConfig, IEngineState>;
-    server: EngineServer;
-} | undefined>;

package/docs/reference/functions/bootstrap.md

@@ -1,29 +0,0 @@
-# Function: bootstrap()
-
-> **bootstrap**(`engineCore`, `context`, `envVars`): `Promise`\<`void`\>
-
-Bootstrap the application.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapAuth.md

@@ -1,35 +0,0 @@
-# Function: bootstrapAuth()
-
-> **bootstrapAuth**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the JWT signing key.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-### features
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapBlobEncryption.md

@@ -1,35 +0,0 @@
-# Function: bootstrapBlobEncryption()
-
-> **bootstrapBlobEncryption**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the keys for blob encryption.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-### features
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapImmutableProofMethod.md

@@ -1,35 +0,0 @@
-# Function: bootstrapImmutableProofMethod()
-
-> **bootstrapImmutableProofMethod**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the immutable proof verification methods.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-### features
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapNodeIdentity.md

@@ -1,35 +0,0 @@
-# Function: bootstrapNodeIdentity()
-
-> **bootstrapNodeIdentity**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the node creating any necessary resources.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-### features
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node. The features that are enabled on the node.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapNodeUser.md

@@ -1,35 +0,0 @@
-# Function: bootstrapNodeUser()
-
-> **bootstrapNodeUser**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the user.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-### features
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapSynchronisedStorage.md

@@ -1,35 +0,0 @@
-# Function: bootstrapSynchronisedStorage()
-
-> **bootstrapSynchronisedStorage**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the synchronised storage blob encryption and verification methods.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-### features
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/getFeatures.md

@@ -1,19 +0,0 @@
-# Function: getFeatures()
-
-> **getFeatures**(`env`): [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-Get the features that are enabled on the node.
-
-## Parameters
-
-### env
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-## Returns
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node.

package/docs/reference/type-aliases/NodeFeatures.md

@@ -1,5 +0,0 @@
-# Type Alias: NodeFeatures
-
-> **NodeFeatures** = *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\[keyof *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\]
-
-The features that can be enabled on the node.

package/docs/reference/variables/NodeFeatures.md

@@ -1,25 +0,0 @@
-# Variable: NodeFeatures
-
-> `const` **NodeFeatures**: `object`
-
-The features that can be enabled on the node.
-
-## Type Declaration
-
-### NodeIdentity
-
-> `readonly` **NodeIdentity**: `"node-identity"` = `"node-identity"`
-
-NodeIdentity - generates an identity for the node if not provided in config.
-
-### NodeUser
-
-> `readonly` **NodeUser**: `"node-user"` = `"node-user"`
-
-NodeUser - generates a user for the node if not provided in config.
-
-### NodeWallet
-
-> `readonly` **NodeWallet**: `"node-wallet"` = `"node-wallet"`
-
-NodeWallet - generates a wallet for the node and funds it when there is a faucet available.