@3sixty/api-auth-entity-storage-service 0.20.0-next.0 → 0.20.0-next.1

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

@@ -1,25 +0,0 @@
-import type { IEntityStorageAuthenticationRateServiceConfig } from "./IEntityStorageAuthenticationRateServiceConfig.js";
-/**
- * Options for the EntityStorageAuthenticationRateService constructor.
- */
-export interface IEntityStorageAuthenticationRateServiceConstructorOptions {
-    /**
-     * The entity storage for authentication rate entries.
-     * @default authentication-rate-entry
-     */
-    authenticationRateEntryStorageType?: string;
-    /**
-     * The task scheduler component type.
-     * @default task-scheduler
-     */
-    taskSchedulerComponentType?: string;
-    /**
-     * The platform component type, used to run the periodic cleanup per tenant.
-     * @default platform
-     */
-    platformComponentType?: string;
-    /**
-     * The configuration for the authentication rate service.
-     */
-    config?: IEntityStorageAuthenticationRateServiceConfig;
-}

package/dist/types/routes/entityStorageAuthenticationAuditRoutes.d.ts

@@ -1,54 +0,0 @@
-import type { IAuditCreateRequest, IAuditGetRequest, IAuditGetResponse, IAuditQueryRequest, IAuditQueryResponse, IAuditRemoveRequest, IAuditUpdateRequest } from "@3sixty/api-auth-entity-storage-models";
-import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@3sixty/api-models";
-/**
- * The tag to associate with the routes.
- */
-export declare const tagsAuthenticationAudit: ITag[];
-/**
- * The REST routes for authentication audit.
- * @param baseRouteName Prefix to prepend to the paths.
- * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
- * @returns The generated routes.
- */
-export declare function generateRestRoutesAuthenticationAudit(baseRouteName: string, componentName: string): IRestRoute[];
-/**
- * Create an authentication audit entry.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @param baseRouteName The base route name to use for the location header.
- * @returns The response object with additional http response properties.
- */
-export declare function authenticationAuditCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditCreateRequest, baseRouteName: string): Promise<ICreatedResponse>;
-/**
- * Get an authentication audit entry.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-export declare function authenticationAuditGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditGetRequest): Promise<IAuditGetResponse>;
-/**
- * Update an authentication audit entry.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-export declare function authenticationAuditUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditUpdateRequest): Promise<INoContentResponse>;
-/**
- * Remove an authentication audit entry.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-export declare function authenticationAuditRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditRemoveRequest): Promise<INoContentResponse>;
-/**
- * Query authentication audit entries.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-export declare function authenticationAuditQuery(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditQueryRequest): Promise<IAuditQueryResponse>;

package/dist/types/services/entityStorageAuthenticationAuditService.d.ts

@@ -1,72 +0,0 @@
-import type { AuthAuditEvent, IAuthenticationAuditComponent, IAuthenticationAuditEntry } from "@3sixty/api-auth-entity-storage-models";
-import type { IEntityStorageAuthenticationAuditServiceConstructorOptions } from "../models/IEntityStorageAuthenticationAuditServiceConstructorOptions.js";
-/**
- * Implementation of the authentication audit component using entity storage.
- */
-export declare class EntityStorageAuthenticationAuditService implements IAuthenticationAuditComponent {
-    /**
-     * Runtime name for the class.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Create a new instance of EntityStorageAuthenticationAuditService.
-     * @param options The dependencies for the identity connector.
-     */
-    constructor(options?: IEntityStorageAuthenticationAuditServiceConstructorOptions);
-    /**
-     * Returns the class name of the component.
-     * @returns The class name of the component.
-     */
-    className(): string;
-    /**
-     * Create a new audit entry.
-     * @param entry The audit entry to be logged.
-     * @returns The unique identifier of the created audit entry.
-     */
-    create(entry: Omit<IAuthenticationAuditEntry, "id" | "dateCreated">): Promise<string>;
-    /**
-     * Get an audit entry by id.
-     * @param id The unique identifier of the audit entry.
-     * @returns The audit entry.
-     */
-    get(id: string): Promise<IAuthenticationAuditEntry>;
-    /**
-     * Update an audit entry.
-     * @param id The unique identifier of the audit entry to update.
-     * @param entry The fields to update on the audit entry.
-     * @returns A promise that resolves when the audit entry has been updated.
-     */
-    update(id: string, entry: Partial<Omit<IAuthenticationAuditEntry, "id" | "dateCreated">>): Promise<void>;
-    /**
-     * Remove an audit entry.
-     * @param id The unique identifier of the audit entry to remove.
-     * @returns A promise that resolves when the audit entry has been removed.
-     */
-    remove(id: string): Promise<void>;
-    /**
-     * Query the audit entries.
-     * @param options The query options.
-     * @param options.actorId The actor identifier to filter the audit entries, optional.
-     * @param options.organizationId The organization identifier to filter the audit entries, optional.
-     * @param options.tenantId The tenant identifier to filter the audit entries, optional.
-     * @param options.nodeId The node identifier to filter the audit entries, optional.
-     * @param options.event The audit event to filter the audit entries, optional.
-     * @param options.startDate The start date to filter the audit entries, optional.
-     * @param options.endDate The end date to filter the audit entries, optional.
-     * @param cursor The cursor for pagination.
-     * @param limit The maximum number of entries to return.
-     * @returns The audit entries.
-     */
-    query(options?: {
-        actorId?: string;
-        organizationId?: string;
-        tenantId?: string;
-        nodeId?: string;
-        event?: AuthAuditEvent | string;
-        startDate?: string;
-        endDate?: string;
-    }, cursor?: string, limit?: number): Promise<{
-        entries: IAuthenticationAuditEntry[];
-        cursor?: string;
-    }>;
-}

package/dist/types/services/entityStorageAuthenticationRateService.d.ts

@@ -1,60 +0,0 @@
-import type { IAuthenticationRateActionConfig, IAuthenticationRateComponent } from "@3sixty/api-auth-entity-storage-models";
-import type { IEntityStorageAuthenticationRateServiceConstructorOptions } from "../models/IEntityStorageAuthenticationRateServiceConstructorOptions.js";
-/**
- * Implementation of the authentication rate component using entity storage.
- */
-export declare class EntityStorageAuthenticationRateService implements IAuthenticationRateComponent {
-    /**
-     * Runtime name for the class.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Create a new instance of EntityStorageAuthenticationRateService.
-     * @param options The constructor options.
-     */
-    constructor(options?: IEntityStorageAuthenticationRateServiceConstructorOptions);
-    /**
-     * Register or update rate-limit configuration for an action.
-     * @param action The action name.
-     * @param config The action configuration.
-     * @returns A promise that resolves when the action configuration has been stored.
-     */
-    registerAction(action: string, config: IAuthenticationRateActionConfig): Promise<void>;
-    /**
-     * Unregister rate-limit configuration for an action.
-     * @param action The action name.
-     * @returns A promise that resolves when the action configuration has been removed.
-     */
-    unregisterAction(action: string): Promise<void>;
-    /**
-     * Returns the class name of the component.
-     * @returns The class name of the component.
-     */
-    className(): string;
-    /**
-     * The service needs to be started when the application is initialized.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns A promise that resolves when the periodic cleanup task has been registered.
-     */
-    start(nodeLoggingComponentType?: string): Promise<void>;
-    /**
-     * The component needs to be stopped when the node is closed.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns A promise that resolves when the periodic cleanup task has been removed.
-     */
-    stop(nodeLoggingComponentType?: string): Promise<void>;
-    /**
-     * Check the authentication rate for a given action and identifier.
-     * @param action The action to be checked.
-     * @param identifier The identifier to be checked.
-     * @returns The rate entry id.
-     */
-    check(action: string, identifier: string): Promise<string>;
-    /**
-     * Clear the authentication rate entry for the given action and identifier.
-     * @param action The action to clear.
-     * @param identifier The identifier to clear.
-     * @returns A promise that resolves when the rate entry has been removed.
-     */
-    clear(action: string, identifier: string): Promise<void>;
-}

package/docs/reference/classes/AuthenticationAuditEntry.md

@@ -1,101 +0,0 @@
-# Class: AuthenticationAuditEntry
-
-Class defining the storage for authentication audit entries.
-
-## Constructors
-
-### Constructor
-
-> **new AuthenticationAuditEntry**(): `AuthenticationAuditEntry`
-
-#### Returns
-
-`AuthenticationAuditEntry`
-
-## Properties
-
-### id {#id}
-
-> **id**: `string`
-
-The unique identifier for the audit entry.
-
-***
-
-### dateCreated {#datecreated}
-
-> **dateCreated**: `string`
-
-The timestamp of the audit entry in ISO 8601 format.
-
-***
-
-### event {#event}
-
-> **event**: `string`
-
-The audit event that occurred.
-
-***
-
-### actorId? {#actorid}
-
-> `optional` **actorId?**: `string`
-
-The actor identifier, could be e-mail, username, or other unique identifier.
-
-***
-
-### nodeId? {#nodeid}
-
-> `optional` **nodeId?**: `string`
-
-The node identifier associated with the audit entry, if applicable.
-
-***
-
-### organizationId? {#organizationid}
-
-> `optional` **organizationId?**: `string`
-
-The organization identifier associated with the audit entry, if applicable.
-
-***
-
-### tenantId? {#tenantid}
-
-> `optional` **tenantId?**: `string`
-
-The tenant identifier associated with the audit entry, if applicable.
-
-***
-
-### ipAddressHashes? {#ipaddresshashes}
-
-> `optional` **ipAddressHashes?**: `string`[]
-
-The hashed IP addresses of the client.
-
-***
-
-### userAgent? {#useragent}
-
-> `optional` **userAgent?**: `string`
-
-The user agent string of the client.
-
-***
-
-### correlationId? {#correlationid}
-
-> `optional` **correlationId?**: `string`
-
-The correlation ID for request tracing.
-
-***
-
-### data? {#data}
-
-> `optional` **data?**: `unknown`
-
-Additional data related to the audit entry, such as IP address, user agent, etc.

package/docs/reference/classes/AuthenticationRateEntry.md

@@ -1,37 +0,0 @@
-# Class: AuthenticationRateEntry
-
-Class defining the storage for authentication rate entries.
-
-## Constructors
-
-### Constructor
-
-> **new AuthenticationRateEntry**(): `AuthenticationRateEntry`
-
-#### Returns
-
-`AuthenticationRateEntry`
-
-## Properties
-
-### id {#id}
-
-> **id**: `string`
-
-The id for the rate entry.
-
-***
-
-### timestamps {#timestamps}
-
-> **timestamps**: `string`[]
-
-Array of ISO date strings representing timestamps of failed attempts.
-
-***
-
-### dateModified {#datemodified}
-
-> **dateModified**: `string`
-
-Last modification time in ISO date format.

package/docs/reference/classes/EntityStorageAuthenticationAuditService.md

@@ -1,241 +0,0 @@
-# Class: EntityStorageAuthenticationAuditService
-
-Implementation of the authentication audit component using entity storage.
-
-## Implements
-
-- `IAuthenticationAuditComponent`
-
-## Constructors
-
-### Constructor
-
-> **new EntityStorageAuthenticationAuditService**(`options?`): `EntityStorageAuthenticationAuditService`
-
-Create a new instance of EntityStorageAuthenticationAuditService.
-
-#### Parameters
-
-##### options?
-
-[`IEntityStorageAuthenticationAuditServiceConstructorOptions`](../interfaces/IEntityStorageAuthenticationAuditServiceConstructorOptions.md)
-
-The dependencies for the identity connector.
-
-#### Returns
-
-`EntityStorageAuthenticationAuditService`
-
-## Properties
-
-### CLASS\_NAME {#class_name}
-
-> `readonly` `static` **CLASS\_NAME**: `string`
-
-Runtime name for the class.
-
-## Methods
-
-### className() {#classname}
-
-> **className**(): `string`
-
-Returns the class name of the component.
-
-#### Returns
-
-`string`
-
-The class name of the component.
-
-#### Implementation of
-
-`IAuthenticationAuditComponent.className`
-
-***
-
-### create() {#create}
-
-> **create**(`entry`): `Promise`\<`string`\>
-
-Create a new audit entry.
-
-#### Parameters
-
-##### entry
-
-`Omit`\<`IAuthenticationAuditEntry`, `"id"` \| `"dateCreated"`\>
-
-The audit entry to be logged.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The unique identifier of the created audit entry.
-
-#### Implementation of
-
-`IAuthenticationAuditComponent.create`
-
-***
-
-### get() {#get}
-
-> **get**(`id`): `Promise`\<`IAuthenticationAuditEntry`\>
-
-Get an audit entry by id.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the audit entry.
-
-#### Returns
-
-`Promise`\<`IAuthenticationAuditEntry`\>
-
-The audit entry.
-
-#### Implementation of
-
-`IAuthenticationAuditComponent.get`
-
-***
-
-### update() {#update}
-
-> **update**(`id`, `entry`): `Promise`\<`void`\>
-
-Update an audit entry.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the audit entry to update.
-
-##### entry
-
-`Partial`\<`Omit`\<`IAuthenticationAuditEntry`, `"id"` \| `"dateCreated"`\>\>
-
-The fields to update on the audit entry.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the audit entry has been updated.
-
-#### Implementation of
-
-`IAuthenticationAuditComponent.update`
-
-***
-
-### remove() {#remove}
-
-> **remove**(`id`): `Promise`\<`void`\>
-
-Remove an audit entry.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the audit entry to remove.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the audit entry has been removed.
-
-#### Implementation of
-
-`IAuthenticationAuditComponent.remove`
-
-***
-
-### query() {#query}
-
-> **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuthenticationAuditEntry`[]; `cursor?`: `string`; \}\>
-
-Query the audit entries.
-
-#### Parameters
-
-##### options?
-
-The query options.
-
-###### actorId?
-
-`string`
-
-The actor identifier to filter the audit entries, optional.
-
-###### organizationId?
-
-`string`
-
-The organization identifier to filter the audit entries, optional.
-
-###### tenantId?
-
-`string`
-
-The tenant identifier to filter the audit entries, optional.
-
-###### nodeId?
-
-`string`
-
-The node identifier to filter the audit entries, optional.
-
-###### event?
-
-`string`
-
-The audit event to filter the audit entries, optional.
-
-###### startDate?
-
-`string`
-
-The start date to filter the audit entries, optional.
-
-###### endDate?
-
-`string`
-
-The end date to filter the audit entries, optional.
-
-##### cursor?
-
-`string`
-
-The cursor for pagination.
-
-##### limit?
-
-`number`
-
-The maximum number of entries to return.
-
-#### Returns
-
-`Promise`\<\{ `entries`: `IAuthenticationAuditEntry`[]; `cursor?`: `string`; \}\>
-
-The audit entries.
-
-#### Implementation of
-
-`IAuthenticationAuditComponent.query`