@twin.org/identity-authentication 0.0.2-next.6

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

@@ -0,0 +1,20 @@
+import type { IVerifiableCredentialAuthenticationGeneratorConfig } from "./IVerifiableCredentialAuthenticationGeneratorConfig";
+/**
+ * Options for the verifiable credential authentication generator constructor.
+ */
+export interface IVerifiableCredentialAuthenticationGeneratorConstructorOptions {
+    /**
+     * The type of identity connector to use.
+     * @default identity
+     */
+    identityConnectorType?: string;
+    /**
+     * The type of logging component to use.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration for the verifiable credential authentication generator.
+     */
+    config: IVerifiableCredentialAuthenticationGeneratorConfig;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Configuration for the Verifiable Credential Authentication Processor.
+ */
+export interface IVerifiableCredentialAuthenticationProcessorConfig {
+    /**
+     * The time-to-live (TTL) for token in seconds.
+     * @default 60 (1 minute)
+     */
+    tokenTtlInSeconds?: number;
+}

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

@@ -0,0 +1,20 @@
+import type { IVerifiableCredentialAuthenticationProcessorConfig } from "./IVerifiableCredentialAuthenticationProcessorConfig";
+/**
+ * Options for the verifiable credential authentication processor constructor.
+ */
+export interface IVerifiableCredentialAuthenticationProcessorConstructorOptions {
+    /**
+     * The type of identity connector to use.
+     * @default identity
+     */
+    identityConnectorType?: string;
+    /**
+     * The type of logging component to use.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration for the verifiable credential authentication processor.
+     */
+    config?: IVerifiableCredentialAuthenticationProcessorConfig;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * The LD Contexts concerning Identity Authentication.
+ */
+export declare const IdentityAuthenticationContexts: {
+    /**
+     * The Identity Authentication LD Context.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/identity-authentication";
+};
+/**
+ * The LD Contexts concerning Identity Authentication.
+ */
+export type IdentityAuthenticationContexts = (typeof IdentityAuthenticationContexts)[keyof typeof IdentityAuthenticationContexts];

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

@@ -0,0 +1,13 @@
+/**
+ * The types of Identity Authentication data.
+ */
+export declare const IdentityAuthenticationTypes: {
+    /**
+     * Represents action request.
+     */
+    readonly ActionRequest: "ActionRequest";
+};
+/**
+ * The types of Identity Authentication data.
+ */
+export type IdentityAuthenticationTypes = (typeof IdentityAuthenticationTypes)[keyof typeof IdentityAuthenticationTypes];

package/dist/types/verifiableCredentialAuthenticationGenerator.d.ts

@@ -0,0 +1,32 @@
+import type { IAuthenticationGenerator } from "@twin.org/api-models";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IHttpHeaders } from "@twin.org/web";
+import type { IVerifiableCredentialAuthenticationGeneratorConstructorOptions } from "./models/IVerifiableCredentialAuthenticationGeneratorConstructorOptions";
+/**
+ * Class performing verifiable credential authentication generation.
+ */
+export declare class VerifiableCredentialAuthenticationGenerator implements IAuthenticationGenerator {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of VerifiableCredentialAuthenticationGenerator.
+     * @param options The options for the service.
+     */
+    constructor(options: IVerifiableCredentialAuthenticationGeneratorConstructorOptions);
+    /**
+     * The component needs to be started when the node is initialized.
+     * @param nodeIdentity The identity of the node starting the component.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @returns Nothing.
+     */
+    start(nodeIdentity: string, nodeLoggingComponentType: string | undefined): Promise<void>;
+    /**
+     * Adds authentication information to the request headers.
+     * @param requestHeaders The request headers to add authentication information to.
+     * @param authData Optional authentication data passed from the request.
+     * @returns A promise that resolves when the authentication information has been added.
+     */
+    addAuthentication(requestHeaders: IHttpHeaders, authData: IJsonLdNodeObject): Promise<void>;
+}

package/dist/types/verifiableCredentialAuthenticationProcessor.d.ts

@@ -0,0 +1,35 @@
+import type { IBaseRoute, IBaseRouteProcessor, IHttpRequestIdentity, IHttpResponse, IHttpServerRequest } from "@twin.org/api-models";
+import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "./models/IVerifiableCredentialAuthenticationProcessorConstructorOptions";
+/**
+ * Handle a JWT token in the authorization header and verify the credential.
+ */
+export declare class VerifiableCredentialAuthenticationProcessor implements IBaseRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of AuthCookiePreProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions);
+    /**
+     * Features supported by this processor.
+     * If a route has any of these features listed, this processor will be run for that route.
+     * If this is not implemented, the processor will run for all routes.
+     * @returns The features supported by this processor.
+     */
+    features(): string[];
+    /**
+     * Pre process the REST request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param requestIdentity The identity context for the request.
+     * @param processorState The state handed through the processors.
+     * @returns Nothing
+     */
+    pre(request: IHttpServerRequest, response: IHttpResponse, route: IBaseRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+        [id: string]: unknown;
+    }): Promise<void>;
+}

package/docs/changelog.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.0.2-next.6](https://github.com/twinfoundation/identity/compare/identity-authentication-v0.0.2-next.5...identity-authentication-v0.0.2-next.6) (2025-09-23)
+
+
+### Features
+
+* add identity authentication module ([33fb5cc](https://github.com/twinfoundation/identity/commit/33fb5cc409ff11aba273b13c8d83724b0b0daa53))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## @twin.org/identity-authentication - Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/identity-authentication - Examples

package/docs/reference/classes/VerifiableCredentialAuthenticationGenerator.md

@@ -0,0 +1,103 @@
+# Class: VerifiableCredentialAuthenticationGenerator
+
+Class performing verifiable credential authentication generation.
+
+## Implements
+
+- `IAuthenticationGenerator`
+
+## Constructors
+
+### Constructor
+
+> **new VerifiableCredentialAuthenticationGenerator**(`options`): `VerifiableCredentialAuthenticationGenerator`
+
+Create a new instance of VerifiableCredentialAuthenticationGenerator.
+
+#### Parameters
+
+##### options
+
+[`IVerifiableCredentialAuthenticationGeneratorConstructorOptions`](../interfaces/IVerifiableCredentialAuthenticationGeneratorConstructorOptions.md)
+
+The options for the service.
+
+#### Returns
+
+`VerifiableCredentialAuthenticationGenerator`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IAuthenticationGenerator.CLASS_NAME`
+
+## Methods
+
+### start()
+
+> **start**(`nodeIdentity`, `nodeLoggingComponentType`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeIdentity
+
+`string`
+
+The identity of the node starting the component.
+
+##### nodeLoggingComponentType
+
+The node logging component type.
+
+`undefined` | `string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IAuthenticationGenerator.start`
+
+***
+
+### addAuthentication()
+
+> **addAuthentication**(`requestHeaders`, `authData`): `Promise`\<`void`\>
+
+Adds authentication information to the request headers.
+
+#### Parameters
+
+##### requestHeaders
+
+`IHttpHeaders`
+
+The request headers to add authentication information to.
+
+##### authData
+
+`IJsonLdNodeObject`
+
+Optional authentication data passed from the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the authentication information has been added.
+
+#### Implementation of
+
+`IAuthenticationGenerator.addAuthentication`

package/docs/reference/classes/VerifiableCredentialAuthenticationProcessor.md

@@ -0,0 +1,107 @@
+# Class: VerifiableCredentialAuthenticationProcessor
+
+Handle a JWT token in the authorization header and verify the credential.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new VerifiableCredentialAuthenticationProcessor**(`options?`): `VerifiableCredentialAuthenticationProcessor`
+
+Create a new instance of AuthCookiePreProcessor.
+
+#### Parameters
+
+##### options?
+
+[`IVerifiableCredentialAuthenticationProcessorConstructorOptions`](../interfaces/IVerifiableCredentialAuthenticationProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`VerifiableCredentialAuthenticationProcessor`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IBaseRouteProcessor.CLASS_NAME`
+
+## Methods
+
+### features()
+
+> **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Implementation of
+
+`IBaseRouteProcessor.features`
+
+***
+
+### pre()
+
+> **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+The route to process.
+
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
+
+The identity context for the request.
+
+##### processorState
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`

package/docs/reference/index.md

@@ -0,0 +1,24 @@
+# @twin.org/identity-authentication
+
+## Classes
+
+- [VerifiableCredentialAuthenticationGenerator](classes/VerifiableCredentialAuthenticationGenerator.md)
+- [VerifiableCredentialAuthenticationProcessor](classes/VerifiableCredentialAuthenticationProcessor.md)
+
+## Interfaces
+
+- [IIdentityAuthenticationActionRequest](interfaces/IIdentityAuthenticationActionRequest.md)
+- [IVerifiableCredentialAuthenticationGeneratorConfig](interfaces/IVerifiableCredentialAuthenticationGeneratorConfig.md)
+- [IVerifiableCredentialAuthenticationGeneratorConstructorOptions](interfaces/IVerifiableCredentialAuthenticationGeneratorConstructorOptions.md)
+- [IVerifiableCredentialAuthenticationProcessorConfig](interfaces/IVerifiableCredentialAuthenticationProcessorConfig.md)
+- [IVerifiableCredentialAuthenticationProcessorConstructorOptions](interfaces/IVerifiableCredentialAuthenticationProcessorConstructorOptions.md)
+
+## Type Aliases
+
+- [IdentityAuthenticationContexts](type-aliases/IdentityAuthenticationContexts.md)
+- [IdentityAuthenticationTypes](type-aliases/IdentityAuthenticationTypes.md)
+
+## Variables
+
+- [IdentityAuthenticationContexts](variables/IdentityAuthenticationContexts.md)
+- [IdentityAuthenticationTypes](variables/IdentityAuthenticationTypes.md)

package/docs/reference/interfaces/IIdentityAuthenticationActionRequest.md

@@ -0,0 +1,35 @@
+# Interface: IIdentityAuthenticationActionRequest
+
+The JSON-LD definition for a action request.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/identity-authentication"`
+
+The JSON-LD context.
+
+***
+
+### type
+
+> **type**: `"ActionRequest"`
+
+The type of the request.
+
+***
+
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The node identity.
+
+***
+
+### action
+
+> **action**: `string`
+
+The action.

package/docs/reference/interfaces/IVerifiableCredentialAuthenticationGeneratorConfig.md

@@ -0,0 +1,25 @@
+# Interface: IVerifiableCredentialAuthenticationGeneratorConfig
+
+Configuration for the Verifiable Credential Authentication Generator.
+
+## Properties
+
+### tokenTtlInSeconds?
+
+> `optional` **tokenTtlInSeconds**: `number`
+
+The time-to-live (TTL) for token in seconds.
+
+#### Default
+
+```ts
+60 (1 minute)
+```
+
+***
+
+### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The id of the identity method to use when creating/verifying tokens.

package/docs/reference/interfaces/IVerifiableCredentialAuthenticationGeneratorConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: IVerifiableCredentialAuthenticationGeneratorConstructorOptions
+
+Options for the verifiable credential authentication generator constructor.
+
+## Properties
+
+### identityConnectorType?
+
+> `optional` **identityConnectorType**: `string`
+
+The type of identity connector to use.
+
+#### Default
+
+```ts
+identity
+```
+
+***
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The type of logging component to use.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### config
+
+> **config**: [`IVerifiableCredentialAuthenticationGeneratorConfig`](IVerifiableCredentialAuthenticationGeneratorConfig.md)
+
+The configuration for the verifiable credential authentication generator.

package/docs/reference/interfaces/IVerifiableCredentialAuthenticationProcessorConfig.md

@@ -0,0 +1,17 @@
+# Interface: IVerifiableCredentialAuthenticationProcessorConfig
+
+Configuration for the Verifiable Credential Authentication Processor.
+
+## Properties
+
+### tokenTtlInSeconds?
+
+> `optional` **tokenTtlInSeconds**: `number`
+
+The time-to-live (TTL) for token in seconds.
+
+#### Default
+
+```ts
+60 (1 minute)
+```

package/docs/reference/interfaces/IVerifiableCredentialAuthenticationProcessorConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: IVerifiableCredentialAuthenticationProcessorConstructorOptions
+
+Options for the verifiable credential authentication processor constructor.
+
+## Properties
+
+### identityConnectorType?
+
+> `optional` **identityConnectorType**: `string`
+
+The type of identity connector to use.
+
+#### Default
+
+```ts
+identity
+```
+
+***
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The type of logging component to use.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IVerifiableCredentialAuthenticationProcessorConfig`](IVerifiableCredentialAuthenticationProcessorConfig.md)
+
+The configuration for the verifiable credential authentication processor.

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

@@ -0,0 +1,5 @@
+# Type Alias: IdentityAuthenticationContexts
+
+> **IdentityAuthenticationContexts** = *typeof* [`IdentityAuthenticationContexts`](../variables/IdentityAuthenticationContexts.md)\[keyof *typeof* [`IdentityAuthenticationContexts`](../variables/IdentityAuthenticationContexts.md)\]
+
+The LD Contexts concerning Identity Authentication.

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

@@ -0,0 +1,5 @@
+# Type Alias: IdentityAuthenticationTypes
+
+> **IdentityAuthenticationTypes** = *typeof* [`IdentityAuthenticationTypes`](../variables/IdentityAuthenticationTypes.md)\[keyof *typeof* [`IdentityAuthenticationTypes`](../variables/IdentityAuthenticationTypes.md)\]
+
+The types of Identity Authentication data.

package/docs/reference/variables/IdentityAuthenticationContexts.md

@@ -0,0 +1,13 @@
+# Variable: IdentityAuthenticationContexts
+
+> `const` **IdentityAuthenticationContexts**: `object`
+
+The LD Contexts concerning Identity Authentication.
+
+## Type Declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/identity-authentication"` = `"https://schema.twindev.org/identity-authentication"`
+
+The Identity Authentication LD Context.

package/docs/reference/variables/IdentityAuthenticationTypes.md

@@ -0,0 +1,13 @@
+# Variable: IdentityAuthenticationTypes
+
+> `const` **IdentityAuthenticationTypes**: `object`
+
+The types of Identity Authentication data.
+
+## Type Declaration
+
+### ActionRequest
+
+> `readonly` **ActionRequest**: `"ActionRequest"` = `"ActionRequest"`
+
+Represents action request.

package/locales/en.json

@@ -0,0 +1,15 @@
+{
+	"error": {
+		"verifiableCredentialAuthenticationGenerator": {
+			"missingNodeIdentity": "The authenticator can not generate a token without a node identity"
+		},
+		"verifiableCredentialAuthenticationProcessor": {
+			"tokenFailed": "Failed to verify token",
+			"tokenNoCredential": "The token does not contain a verifiable credential",
+			"tokenNoIssuer": "The token does not contain an issuer",
+			"tokenMissingIssuanceDate": "The token is missing the 'issuanceDate' field for issuer \"{issuer}\"",
+			"tokenExpired": "The token has expired for issuer \"{issuer}\"",
+			"tokenMissingSubject": "The token is missing the 'credentialSubject' field for issuer \"{issuer}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@twin.org/identity-authentication",
+	"version": "0.0.2-next.6",
+	"description": "Authentication components implemented using identity",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/identity.git",
+		"directory": "packages/identity-authentication"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/identity-models": "0.0.2-next.6",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}