@twin.org/node-core 0.0.3-next.6 → 0.0.3-next.60

package/dist/types/commands/vaultKeyImport.d.ts

@@ -0,0 +1,29 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionVaultKeyImport(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for importing a vault key.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.identity The DID to import the vault key for.
+ * @param params.keyId The ID of the key to import.
+ * @param params.keyType The type of key to import.
+ * @param params.privateKeyHex The private key in hexadecimal format.
+ * @returns A promise that resolves when the key has been imported into the vault.
+ */
+export declare function vaultKeyImport(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+    keyType?: string;
+    keyId?: string;
+    privateKeyHex?: string;
+}): Promise<void>;

package/dist/types/defaults.d.ts

@@ -1,8 +1,36 @@
+/**
+ * Default verification method fragment ID for attestation.
+ */
 export declare const ATTESTATION_VERIFICATION_METHOD_ID = "attestation-assertion";
+/**
+ * Default verification method fragment ID for immutable proofs.
+ */
 export declare const IMMUTABLE_PROOF_VERIFICATION_METHOD_ID = "immutable-proof-assertion";
+/**
+ * Default vault key ID for blob storage encryption.
+ */
 export declare const BLOB_STORAGE_ENCRYPTION_KEY_ID = "blob-encryption";
-export declare const SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID = "synchronised-storage-blob-encryption";
-export declare const VC_AUTHENTICATION_VERIFICATION_METHOD_ID = "node-authentication-assertion";
+/**
+ * Default verification method fragment ID for trust assertions.
+ */
+export declare const TRUST_VERIFICATION_METHOD_ID = "trust-assertion";
+/**
+ * Default vault key ID used for signing authentication tokens.
+ */
 export declare const AUTH_SIGNING_KEY_ID = "auth-signing";
+/**
+ * Feature tag identifying the DID context ID handler.
+ */
 export declare const CONTEXT_ID_HANDLER_FEATURE_DID = "did";
+/**
+ * Feature tag identifying the tenant context ID handler.
+ */
 export declare const CONTEXT_ID_HANDLER_FEATURE_TENANT = "tenant";
+/**
+ * Get the default environment variables for the node.
+ * @param envPrefix The environment variable prefix.
+ * @returns The default environment variables.
+ */
+export declare function getEnvDefaults(envPrefix: string): {
+    [key: string]: string;
+};

package/dist/types/index.d.ts

@@ -1,9 +1,14 @@
-export * from "./bootstrap.js";
 export * from "./builders/engineEnvBuilder.js";
 export * from "./builders/engineServerEnvBuilder.js";
 export * from "./builders/extensionsBuilder.js";
+export * from "./cli.js";
 export * from "./defaults.js";
+export * from "./models/cliCommandParamType.js";
 export * from "./models/ICacheMetadata.js";
+export * from "./models/ICliArgs.js";
+export * from "./models/ICliCommand.js";
+export * from "./models/ICliCommandDefinition.js";
+export * from "./models/ICliCommandDefinitionParam.js";
 export * from "./models/IEngineEnvironmentVariables.js";
 export * from "./models/IEngineServerEnvironmentVariables.js";
 export * from "./models/IModuleProtocol.js";
@@ -13,8 +18,10 @@ export * from "./models/INodeEnvironmentVariables.js";
 export * from "./models/INodeOptions.js";
 export * from "./models/IProtocolHandlerResult.js";
 export * from "./models/moduleProtocol.js";
-export * from "./models/nodeExtensionMethods.js";
-export * from "./models/nodeFeatures.js";
+export * from "./models/nodeExtensionInitialiseEngineMethod.js";
+export * from "./models/nodeExtensionInitialiseEngineServerMethod.js";
+export * from "./models/nodeExtensionInitialiseMethod.js";
+export * from "./models/nodeExtensionShutdownMethod.js";
 export * from "./node.js";
-export * from "./server.js";
+export * from "./start.js";
 export * from "./utils.js";

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

@@ -0,0 +1,20 @@
+/**
+ * Parsed command line arguments passed to the CLI.
+ */
+export interface ICliArgs {
+    /**
+     * The path of the node executable.
+     */
+    nodePath?: string;
+    /**
+     * The path of the script to execute.
+     */
+    scriptPath?: string;
+    /**
+     * The command line options.
+     */
+    options?: {
+        key: string;
+        value: string;
+    }[];
+}

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

@@ -0,0 +1,17 @@
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+import type { ICliCommandDefinition } from "./ICliCommandDefinition.js";
+/**
+ * A resolved CLI command ready for execution, pairing a definition with its populated parameters.
+ */
+export interface ICliCommand {
+    /**
+     * The command to execute.
+     */
+    definition: ICliCommandDefinition;
+    /**
+     * The params to execute the command with.
+     */
+    params: {
+        [id: string]: CliCommandParamType;
+    };
+}

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

@@ -0,0 +1,46 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+import type { ICliCommandDefinitionParam } from "./ICliCommandDefinitionParam.js";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
+/**
+ * Static definition of a CLI command including its name, parameters, and execution action.
+ */
+export interface ICliCommandDefinition {
+    /**
+     * The command name.
+     */
+    command: string;
+    /**
+     * The command description.
+     */
+    description: string;
+    /**
+     * An example invocation string shown in help output.
+     */
+    example: string;
+    /**
+     * The params available for the command.
+     */
+    params: ICliCommandDefinitionParam[];
+    /**
+     * The method to execute for the command.
+     */
+    action: (engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+        [id: string]: CliCommandParamType;
+    }) => Promise<unknown>;
+    /**
+     * Indicates whether the engine needs to be started before executing the command.
+     * @default true
+     */
+    requiresEngineStarted?: boolean;
+    /**
+     * Indicates whether the engine needs the node identity to be set if configured to use.
+     * @default true
+     */
+    requiresNodeIdentity?: boolean;
+    /**
+     * Indicates whether the engine needs the organization identity to be set.
+     * @default true
+     */
+    requiresOrgIdentity?: boolean;
+}

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

@@ -0,0 +1,35 @@
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+/**
+ * Definition of a single parameter accepted by a CLI command.
+ */
+export interface ICliCommandDefinitionParam {
+    /**
+     * The param key.
+     */
+    key: string;
+    /**
+     * The param type.
+     */
+    type: "string" | "number" | "boolean";
+    /**
+     * Possible options for the param.
+     */
+    options?: string[];
+    /**
+     * The extended type e.g. hex etc.
+     */
+    extendedType?: string;
+    /**
+     * Whether the param is required.
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * The default value of the param.
+     */
+    defaultValue?: CliCommandParamType;
+    /**
+     * The param description.
+     */
+    description: string;
+}

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

@@ -6,6 +6,10 @@ export interface IEngineEnvironmentVariables {
      * Start the engine in debug mode.
      */
     debug?: string;
+    /**
+     * Start the engine in silent mode.
+     */
+    silent?: string;
     /**
      * The root directory for storing items like state file.
      */
@@ -18,14 +22,6 @@ export interface IEngineEnvironmentVariables {
      * Is multi-tenant support enabled, defaults to false.
      */
     tenantEnabled?: string;
-    /**
-     * A tenant id to use as a default for the node.
-     */
-    tenantId?: string;
-    /**
-     * A tenant api key to use as a default for the node.
-     */
-    tenantApiKey?: string;
     /**
      * The type of the entity storage to create, comma separate for more than one connector.
      * values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
@@ -94,7 +90,7 @@ export interface IEngineEnvironmentVariables {
     /**
      * GCP Firestore endpoint.
      */
-    gcpFirestoreApiEndpoint?: string;
+    gcpFirestoreEndpoint?: string;
     /**
      * GCP Firestore project id.
      */
@@ -192,10 +188,6 @@ export interface IEngineEnvironmentVariables {
      * The default blob storage connector to use, defaults to the first one in the list.
      */
     blobStorageConnectorDefault?: string;
-    /**
-     * Blog storage connector which has public access.
-     */
-    blobStorageConnectorPublic?: string;
     /**
      * Enable encryption for the blob storage.
      */
@@ -204,11 +196,6 @@ export interface IEngineEnvironmentVariables {
      * The id of the encryption key for the blob storage.
      */
     blobStorageEncryptionKeyId?: string;
-    /**
-     * A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
-     * If encryption is enabled but a key is not provided one will be generated.
-     */
-    blobStorageSymmetricEncryptionKey?: string;
     /**
      * A prefix for all the blobs in blob-storage, can be empty.
      */
@@ -273,6 +260,10 @@ export interface IEngineEnvironmentVariables {
      * The type of the default vault connector: entity-storage, hashicorp.
      */
     vaultConnector?: string;
+    /**
+     * Prefix to prepend to entries in the vault.
+     */
+    vaultPrefix?: string;
     /**
      * Hashicorp Vault token.
      */
@@ -285,6 +276,18 @@ export interface IEngineEnvironmentVariables {
      * The type of logging task connector, can be a comma separated list: console, entity-storage.
      */
     loggingConnector?: string;
+    /**
+     * The batch size for the logging task, set to 1 for no batching.
+     */
+    loggingBatchSize?: string;
+    /**
+     * The batch flush interval in seconds for the logging task, how often to flush the logs when using batching, defaults to 5 seconds.
+     */
+    loggingBatchFlushIntervalSeconds?: string;
+    /**
+     * A list of components to exclude from logging, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
+     */
+    loggingSilentComponents?: string;
     /**
      * The type of event bus connector: local.
      */
@@ -318,7 +321,7 @@ export interface IEngineEnvironmentVariables {
      */
     awsSesEndpoint?: string;
     /**
-     * The applications for the push notifications JSON stringified array of IAwsApplicationSettings.
+     * The applications for the push notifications reference a separate json with @json: prefix.
      */
     awsMessagingPushNotificationApplications?: string;
     /**
@@ -337,6 +340,34 @@ export interface IEngineEnvironmentVariables {
      * The type of telemetry connector: entity-storage.
      */
     telemetryConnector?: string;
+    /**
+     * The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.
+     */
+    openTelemetryMeterName?: string;
+    /**
+     * The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.
+     */
+    openTelemetryMeterVersion?: string;
+    /**
+     * The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.
+     */
+    openTelemetryReader?: string;
+    /**
+     * The port to use for the Open Telemetry Prometheus metrics server, only required if using open-telemetry as telemetry connector and prometheus as reader, defaults to 9464.
+     */
+    openTelemetryPrometheusPort?: string;
+    /**
+     * Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
+     */
+    telemetryMetricsCollectorIntervalSeconds?: string;
+    /**
+     * The type of telemetry metrics producers, can be a comma separated list: system, process.
+     */
+    telemetryMetricsProducers?: string;
+    /**
+     * Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
+     */
+    telemetryMetricsProducerMaxHistory?: string;
     /**
      * The type of faucet connector: entity-storage, iota.
      */
@@ -349,18 +380,26 @@ export interface IEngineEnvironmentVariables {
      * The type of NFT connector: entity-storage, iota.
      */
     nftConnector?: string;
+    /**
+     * The NFT deployed package id, for custom deployments.
+     */
+    nftPackageId?: string;
+    /**
+     * The type of notarization connector: entity-storage, iota.
+     */
+    notarizationConnector?: string;
     /**
      * The type of identity connector: entity-storage, iota.
      */
     identityConnector?: string;
     /**
-     * The type of identity resolver connector: entity-storage, iota.
+     * The index of the wallet address to use, defaults to 0.
      */
-    identityResolverConnector?: string;
+    identityWalletAddressIndex?: string;
     /**
-     * The type of verifiable storage connector: entity-storage, iota.
+     * The type of identity resolver connector: entity-storage, iota.
      */
-    verifiableStorageConnector?: string;
+    identityResolverConnector?: string;
     /**
      * IOTA Faucet Endpoint.
      */
@@ -389,6 +428,10 @@ export interface IEngineEnvironmentVariables {
      * IOTA Gas Station Authentication Token.
      */
     iotaGasStationAuthToken?: string;
+    /**
+     * The IOTA Identity deployed package id, for custom deployments.
+     */
+    iotaIdentityPackageId?: string;
     /**
      * Universal Resolver Endpoint.
      */
@@ -421,6 +464,10 @@ export interface IEngineEnvironmentVariables {
      * The type of the default data extractor, can be a comma separated list: json-path.
      */
     dataExtractorConnectors?: string;
+    /**
+     * Enable the task scheduler regardless of which other components are active, defaults to false.
+     */
+    taskSchedulerEnabled?: string;
     /**
      * Is the auditable item graph enabled, defaults to false.
      */
@@ -434,131 +481,157 @@ export interface IEngineEnvironmentVariables {
      */
     documentManagementEnabled?: string;
     /**
-     * Is the synchronised storage enabled, defaults to false.
+     * Enable the federated catalogue, defaults to false, automatically enabled if remote endpoint, filters or dataspace is enabled.
      */
-    synchronisedStorageEnabled?: string;
+    federatedCatalogueEnabled?: string;
     /**
-     * Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
+     * Federated catalog filters, command separated list of filters to add.
      */
-    synchronisedStorageTrustedUrl?: string;
+    federatedCatalogueFilters?: string;
     /**
-     * The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
-     * This only required if using a custom verifiable storage item, otherwise it will default to the network name.
+     * Federated catalog remote endpoint, if set will use a REST client instead of local service.
      */
-    synchronisedStorageVerifiableStorageKeyId?: string;
+    federatedCatalogueRemoteEndpoint?: string;
     /**
-     * The key from the vault which is used to encrypt the synchronised storage blobs.
-     * Only required for trusted nodes, as regular nodes will request from the trusted nodes.
-     * Defaults to synchronised-storage-blob-encryption
+     * The trust generators to add to the factory, comma separated list.
      */
-    synchronisedStorageBlobStorageEncryptionKeyId?: string;
+    trustGenerators?: string;
     /**
-     * The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
-     * Only required for trusted nodes, as regular nodes will not write encrypted data.
+     * The trust verifiers to add to the factory, comma separated list.
      */
-    synchronisedStorageBlobStorageKey?: string;
+    trustVerifiers?: string;
     /**
-     * How often to check for entity updates in minutes.
-     * @default 5
+     * The verification method to use for trust identities.
+     * Defaults to trust-assertion.
      */
-    synchronisedStorageEntityUpdateIntervalMinutes?: string;
+    trustVerificationMethodId?: string;
     /**
-     * Interval to perform consolidation of changesets, only used if this is a trusted node.
-     * @default 60
+     * The trust time to live for generating JWTs.
+     * Defaults to undefined for never expiring.
      */
-    synchronisedStorageConsolidationIntervalMinutes?: string;
+    trustJwtTtlSeconds?: string;
     /**
-     * The number of entities to process in a single consolidation batch, only used if this is a trusted node.
-     * @default 1000
+     * The allow lists for the trust identity verifier, comma separated list of identities.
      */
-    synchronisedStorageConsolidationBatchSize?: string;
+    trustIdentitiesAllow?: string;
     /**
-     * The maximum number of consolidations to keep in storage, only used if this is a trusted node.
-     * @default 5
+     * The deny lists for the trust identity verifier, comma separated list of identities.
      */
-    synchronisedStorageMaxConsolidations?: string;
+    trustIdentitiesDeny?: string;
     /**
-     * Is the federated catalogue enabled, defaults to false.
+     * Path under which the rights management service is mounted (single source
+     * of truth). The same value drives:
+     * - the server route mount (via engine config)
+     * - the PNP service's callback URL builder (`buildCallbackUrl`)
+     * - the PNP rest-client's pathPrefix (consumer side)
+     * Defaults to `rights-management`. Set when deploying behind a reverse proxy
+     * with path rewriting, K8s ingress with path-based routing, or any custom
+     * mount point.
      */
-    federatedCatalogueEnabled?: string;
+    rightsManagementCallbackPath?: string;
     /**
-     * Federated catalog filters, command separated list of filters to add.
+     * The rights management policy information sources to add to the factory.
      */
-    federatedCatalogueFilters?: string;
+    rightsManagementPolicyInformationSources?: string;
     /**
-     * Is the rights management enabled, defaults to false.
+     * The rights management policy negotiators sources to add to the factory.
      */
-    rightsManagementEnabled?: string;
+    rightsManagementPolicyNegotiators?: string;
     /**
-     * What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
+     * The rights management policy requesters to add to the factory.
      */
-    rightsManagementBaseCallbackUrl?: string;
+    rightsManagementPolicyRequesters?: string;
     /**
-     * The rights management configuration which includes the information sources modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy execution actions to add to the factory.
      */
-    rightsManagementInformationSources?: string;
+    rightsManagementPolicyExecutionActions?: string;
     /**
-     * The rights management configuration which includes the negotiator modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy enforcement processors to add to the factory.
      */
-    rightsManagementNegotiators?: string;
+    rightsManagementPolicyEnforcementProcessors?: string;
     /**
-     * The rights management configuration which includes the requester modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy arbiters to add to the factory.
      */
-    rightsManagementRequesters?: string;
+    rightsManagementPolicyArbiters?: string;
     /**
-     * The rights management configuration which includes the execution actions modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy obligation enforcers to add to the factory.
      */
-    rightsManagementExecutionActions?: string;
+    rightsManagementPolicyObligationEnforcers?: string;
     /**
-     * The rights management configuration which includes the enforcement processor modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * Is the dataspace enabled, defaults to false.
      */
-    rightsManagementEnforcementProcessors?: string;
+    dataspaceEnabled?: string;
     /**
-     * The rights management configuration which includes the arbiter modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+     * @default 10
      */
-    rightsManagementArbiters?: string;
+    dataspaceRetainActivityLogsFor?: string;
     /**
-     * The rights management configuration which includes the offer modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The interval for cleaning up the activity logs.
+     * @default 60
      */
-    rightsManagementOffers?: string;
+    dataspaceActivityLogsCleanupInterval?: string;
     /**
-     * Are background tasks enabled, defaults to false.
+     * The data plane path for PULL transfers (path only, not full URL).
+     * Will be combined with public origin.
+     * Required if PULL transfers should be supported.
+     * Example: "dataspace/entities"
      */
-    backgroundTasksEnabled?: string;
+    dataspaceDataPlanePath?: string;
     /**
-     * Is the task scheduler enabled, defaults to false.
+     * Are the health components enabled, defaults to false.
      */
-    taskSchedulerEnabled?: string;
+    healthEnabled?: string;
     /**
-     * Is the data space connector enabled, defaults to false.
+     * The interval in seconds for performing health checks, defaults to 60.
      */
-    dataSpaceConnectorEnabled?: string;
+    healthIntervalSeconds?: string;
     /**
-     * The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
-     * @default 10
+     * The interval in seconds for performing health checks at startup, defaults to 2.
+     * This allows components that take a long time to initialize to be healthy before the first health check is performed.
      */
-    dataSpaceConnectorRetainActivityLogsFor?: string;
+    healthStartupIntervalSeconds?: string;
     /**
-     * The interval for cleaning up the activity logs.
-     * @default 60
+     * The type of the automation action to create, comma separate for more than one connector.
+     * values: fetch
+     */
+    automationActionTypes?: string;
+    /**
+     * The default mutex timeout in milliseconds, used when no component-specific timeout is set, defaults to 5000.
+     */
+    mutexTimeoutMsDefault?: string;
+    /**
+     * The mutex timeout in milliseconds for the auditable item graph component.
+     */
+    auditableItemGraphMutexTimeoutMs?: string;
+    /**
+     * The mutex timeout in milliseconds for the auditable item stream component.
+     */
+    auditableItemStreamMutexTimeoutMs?: string;
+    /**
+     * The mutex timeout in milliseconds for the federated catalogue component.
+     */
+    federatedCatalogueMutexTimeoutMs?: string;
+    /**
+     * The mutex timeout in milliseconds for the document management component.
+     */
+    documentManagementMutexTimeoutMs?: string;
+    /**
+     * The mutex timeout in milliseconds for the logging component.
+     */
+    loggingMutexTimeoutMs?: string;
+    /**
+     * The mutex timeout in milliseconds for the memory entity storage connector.
      */
-    dataSpaceConnectorActivityLogsCleanUpInterval?: string;
+    entityStorageMemoryMutexTimeoutMs?: string;
     /**
-     * Enable verifiable credential authentication for the API.
+     * The mutex timeout in milliseconds for the file entity storage connector.
      */
-    vcAuthenticationEnabled?: string;
+    entityStorageFileMutexTimeoutMs?: string;
     /**
-     * Verifiable credential assertion for node to node communication.
-     * Defaults to node-authentication-assertion.
+     * The mutex timeout in milliseconds for the rights management component.
      */
-    vcAuthenticationVerificationMethodId?: string;
+    rightsManagementMutexTimeoutMs?: string;
     /**
      * A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
      */

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

@@ -27,6 +27,10 @@ export interface IEngineServerEnvironmentVariables extends IEngineEnvironmentVar
      * The CORS headers to expose.
      */
     httpExposedHeaders?: string;
+    /**
+     * The public origin URL for the API e.g. https://api.example.com:1234
+     */
+    publicOrigin?: string;
     /**
      * The type of auth admin processor to use on the API: entity-storage.
      */
@@ -39,6 +43,10 @@ export interface IEngineServerEnvironmentVariables extends IEngineEnvironmentVar
      * The id of the key in the vault to use for signing in auth operations.
      */
     authSigningKeyId?: string;
+    /**
+     * The HTTP header name used to pass the API key on requests, defaults to x-api-key.
+     */
+    authApiKeyHeader?: string;
     /**
      * Additional MIME type processors to include, comma separated.
      */