npm - @twin.org/node-core - Versions diffs - 0.0.3-next.9 → 0.9.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (230) hide show

package/docs/reference/functions/bootstrapAuth.md DELETED Viewed

@@ -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`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-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 DELETED Viewed

@@ -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`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-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 DELETED Viewed

@@ -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`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-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/bootstrapNodeAdminUser.md DELETED Viewed

@@ -1,35 +0,0 @@
-# Function: bootstrapNodeAdminUser()
-> **bootstrapNodeAdminUser**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-Bootstrap the user.
-## Parameters
-### engineCore
-`IEngineCore`
-The engine core for the node.
-### context
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-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/bootstrapNodeId.md DELETED Viewed

@@ -1,35 +0,0 @@
-# Function: bootstrapNodeId()
-> **bootstrapNodeId**(`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`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-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/bootstrapSynchronisedStorage.md DELETED Viewed

@@ -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`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-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/bootstrapTenantId.md DELETED Viewed

@@ -1,35 +0,0 @@
-# Function: bootstrapTenantId()
-> **bootstrapTenantId**(`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`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-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/getFeatures.md DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -1,25 +0,0 @@
-# Variable: NodeFeatures
-> `const` **NodeFeatures**: `object`
-The features that can be enabled on the node.
-## Type Declaration
-### NodeId
-> `readonly` **NodeId**: `"node-identity"` = `"node-identity"`
-NodeId - generates an identity for the node if not provided in config.
-### NodeAdminUser
-> `readonly` **NodeAdminUser**: `"node-admin-user"` = `"node-admin-user"`
-NodeAdminUser - generates an admin user for the node if not provided in config.
-### NodeWallet
-> `readonly` **NodeWallet**: `"node-wallet"` = `"node-wallet"`
-NodeWallet - generates wallets for any identities that need them.

package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md DELETED Viewed

@@ -1,3 +0,0 @@
-# Variable: SYNCHRONISED\_STORAGE\_BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID
-> `const` **SYNCHRONISED\_STORAGE\_BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID**: `"synchronised-storage-blob-encryption"` = `"synchronised-storage-blob-encryption"`

package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md DELETED Viewed

@@ -1,3 +0,0 @@
-# Variable: VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID
-> `const` **VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID**: `"node-authentication-assertion"` = `"node-authentication-assertion"`