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

package/dist/es/models/api/IAuditUpdateRequest.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IAuditUpdateRequest.js.map

package/dist/es/models/api/IAuditUpdateRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IAuditUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationAuditEntry } from \"../IAuthenticationAuditEntry.js\";\n\n/**\n * Update an authentication audit entry.\n */\nexport interface IAuditUpdateRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The audit entry id.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: Partial<Omit<IAuthenticationAuditEntry, \"id\" | \"dateCreated\">>;\n}\n"]}

package/dist/es/models/authAuditEvent.js

@@ -1,49 +0,0 @@
-// Copyright 2026 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Supported authentication audit events.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const AuthAuditEvent = {
-    /**
-     * Login success.
-     */
-    LoginSuccess: "login-success",
-    /**
-     * Login failure.
-     */
-    LoginFailure: "login-failure",
-    /**
-     * Logout.
-     */
-    Logout: "logout",
-    /**
-     * Token refreshed.
-     */
-    TokenRefreshed: "token-refreshed",
-    /**
-     * Account created.
-     */
-    AccountCreated: "account-created",
-    /**
-     * Account deleted.
-     */
-    AccountDeleted: "account-deleted",
-    /**
-     * Account updated.
-     */
-    AccountUpdated: "account-updated",
-    /**
-     * Account locked.
-     */
-    AccountLocked: "account-locked",
-    /**
-     * Account unlocked.
-     */
-    AccountUnlocked: "account-unlocked",
-    /**
-     * Password changed.
-     */
-    PasswordChanged: "password-changed"
-};
-//# sourceMappingURL=authAuditEvent.js.map

package/dist/es/models/authAuditEvent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"authAuditEvent.js","sourceRoot":"","sources":["../../../src/models/authAuditEvent.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B;;OAEG;IACH,YAAY,EAAE,eAAe;IAE7B;;OAEG;IACH,YAAY,EAAE,eAAe;IAE7B;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,aAAa,EAAE,gBAAgB;IAE/B;;OAEG;IACH,eAAe,EAAE,kBAAkB;IAEnC;;OAEG;IACH,eAAe,EAAE,kBAAkB;CAC1B,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Supported authentication audit events.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuthAuditEvent = {\n\t/**\n\t * Login success.\n\t */\n\tLoginSuccess: \"login-success\",\n\n\t/**\n\t * Login failure.\n\t */\n\tLoginFailure: \"login-failure\",\n\n\t/**\n\t * Logout.\n\t */\n\tLogout: \"logout\",\n\n\t/**\n\t * Token refreshed.\n\t */\n\tTokenRefreshed: \"token-refreshed\",\n\n\t/**\n\t * Account created.\n\t */\n\tAccountCreated: \"account-created\",\n\n\t/**\n\t * Account deleted.\n\t */\n\tAccountDeleted: \"account-deleted\",\n\n\t/**\n\t * Account updated.\n\t */\n\tAccountUpdated: \"account-updated\",\n\n\t/**\n\t * Account locked.\n\t */\n\tAccountLocked: \"account-locked\",\n\n\t/**\n\t * Account unlocked.\n\t */\n\tAccountUnlocked: \"account-unlocked\",\n\n\t/**\n\t * Password changed.\n\t */\n\tPasswordChanged: \"password-changed\"\n} as const;\n\n/**\n * Supported authentication audit event values.\n */\nexport type AuthAuditEvent = (typeof AuthAuditEvent)[keyof typeof AuthAuditEvent];\n"]}

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

@@ -1,59 +0,0 @@
-import type { IComponent } from "@3sixty/core";
-import type { AuthAuditEvent } from "./authAuditEvent.js";
-import type { IAuthenticationAuditEntry } from "./IAuthenticationAuditEntry.js";
-/**
- * Contract definition for authentication audit component.
- */
-export interface IAuthenticationAuditComponent extends IComponent {
-    /**
-     * 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/models/IAuthenticationAuditEntry.d.ts

@@ -1,50 +0,0 @@
-import type { AuthAuditEvent } from "./authAuditEvent.js";
-/**
- * Contract definition for authentication audit entry.
- */
-export interface IAuthenticationAuditEntry {
-    /**
-     * The unique identifier for the audit entry.
-     */
-    id: string;
-    /**
-     * The audit event that occurred.
-     */
-    event: AuthAuditEvent | string;
-    /**
-     * The timestamp of the audit entry in ISO 8601 format.
-     */
-    dateCreated: string;
-    /**
-     * The actor identifier, could be e-mail, username, or other unique identifier.
-     */
-    actorId?: string;
-    /**
-     * The node identifier associated with the audit entry, if applicable.
-     */
-    nodeId?: string;
-    /**
-     * The organization identifier associated with the audit entry, if applicable.
-     */
-    organizationId?: string;
-    /**
-     * The tenant identifier associated with the audit entry, if applicable.
-     */
-    tenantId?: string;
-    /**
-     * The hashed IP addresses of the client.
-     */
-    ipAddressHashes?: string[];
-    /**
-     * The user agent string of the client.
-     */
-    userAgent?: string;
-    /**
-     * The correlation ID for request tracing.
-     */
-    correlationId?: string;
-    /**
-     * Additional data related to the audit entry, such as IP address, user agent, etc.
-     */
-    data?: unknown;
-}

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

@@ -1,13 +0,0 @@
-/**
- * Configuration for an authentication rate limited action.
- */
-export interface IAuthenticationRateActionConfig {
-    /**
-     * Maximum number of failed attempts allowed per window.
-     */
-    maxAttempts: number;
-    /**
-     * Rate limit window duration in minutes.
-     */
-    windowMinutes: number;
-}

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

@@ -1,46 +0,0 @@
-import type { IComponent } from "@3sixty/core";
-import type { IAuthenticationRateActionConfig } from "./IAuthenticationRateActionConfig.js";
-/**
- * Contract definition for authentication rate component.
- */
-export interface IAuthenticationRateComponent extends IComponent {
-    /**
-     * 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 service has been started.
-     */
-    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 service has been stopped.
-     */
-    stop(nodeLoggingComponentType?: string): Promise<void>;
-    /**
-     * 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>;
-    /**
-     * 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 result of the rate check.
-     */
-    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/dist/types/models/api/IAuditCreateRequest.d.ts

@@ -1,10 +0,0 @@
-import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
-/**
- * Create an authentication audit entry.
- */
-export interface IAuditCreateRequest {
-    /**
-     * The body of the request.
-     */
-    body: Omit<IAuthenticationAuditEntry, "id" | "dateCreated">;
-}

package/dist/types/models/api/IAuditGetRequest.d.ts

@@ -1,14 +0,0 @@
-/**
- * Get an authentication audit entry by id.
- */
-export interface IAuditGetRequest {
-    /**
-     * The path parameters for the request.
-     */
-    pathParams: {
-        /**
-         * The audit entry id.
-         */
-        id: string;
-    };
-}

package/dist/types/models/api/IAuditGetResponse.d.ts

@@ -1,10 +0,0 @@
-import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
-/**
- * Response from getting an authentication audit entry.
- */
-export interface IAuditGetResponse {
-    /**
-     * The response body.
-     */
-    body: IAuthenticationAuditEntry;
-}

package/dist/types/models/api/IAuditQueryRequest.d.ts

@@ -1,47 +0,0 @@
-import type { AuthAuditEvent } from "../authAuditEvent.js";
-/**
- * Query authentication audit entries.
- */
-export interface IAuditQueryRequest {
-    /**
-     * The query parameters for the request.
-     */
-    query?: {
-        /**
-         * The actor identifier to filter by.
-         */
-        actorId?: string;
-        /**
-         * The organization identifier to filter by.
-         */
-        organizationId?: string;
-        /**
-         * The tenant identifier to filter by.
-         */
-        tenantId?: string;
-        /**
-         * The node identifier to filter by.
-         */
-        nodeId?: string;
-        /**
-         * The event to filter by.
-         */
-        event?: AuthAuditEvent | string;
-        /**
-         * The inclusive start date for filtering, in ISO 8601 format.
-         */
-        startDate?: string;
-        /**
-         * The inclusive end date for filtering, in ISO 8601 format.
-         */
-        endDate?: string;
-        /**
-         * The pagination cursor.
-         */
-        cursor?: string;
-        /**
-         * The maximum number of results to return.
-         */
-        limit?: string;
-    };
-}

package/dist/types/models/api/IAuditQueryResponse.d.ts

@@ -1,19 +0,0 @@
-import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
-/**
- * Response from querying authentication audit entries.
- */
-export interface IAuditQueryResponse {
-    /**
-     * The response body.
-     */
-    body: {
-        /**
-         * The returned audit entries.
-         */
-        entries: IAuthenticationAuditEntry[];
-        /**
-         * The cursor to retrieve the next page, if any.
-         */
-        cursor?: string;
-    };
-}

package/dist/types/models/api/IAuditRemoveRequest.d.ts

@@ -1,14 +0,0 @@
-/**
- * Remove an authentication audit entry.
- */
-export interface IAuditRemoveRequest {
-    /**
-     * The path parameters for the request.
-     */
-    pathParams: {
-        /**
-         * The audit entry id.
-         */
-        id: string;
-    };
-}

package/dist/types/models/api/IAuditUpdateRequest.d.ts

@@ -1,19 +0,0 @@
-import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
-/**
- * Update an authentication audit entry.
- */
-export interface IAuditUpdateRequest {
-    /**
-     * The path parameters for the request.
-     */
-    pathParams: {
-        /**
-         * The audit entry id.
-         */
-        id: string;
-    };
-    /**
-     * The body of the request.
-     */
-    body: Partial<Omit<IAuthenticationAuditEntry, "id" | "dateCreated">>;
-}

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

@@ -1,49 +0,0 @@
-/**
- * Supported authentication audit events.
- */
-export declare const AuthAuditEvent: {
-    /**
-     * Login success.
-     */
-    readonly LoginSuccess: "login-success";
-    /**
-     * Login failure.
-     */
-    readonly LoginFailure: "login-failure";
-    /**
-     * Logout.
-     */
-    readonly Logout: "logout";
-    /**
-     * Token refreshed.
-     */
-    readonly TokenRefreshed: "token-refreshed";
-    /**
-     * Account created.
-     */
-    readonly AccountCreated: "account-created";
-    /**
-     * Account deleted.
-     */
-    readonly AccountDeleted: "account-deleted";
-    /**
-     * Account updated.
-     */
-    readonly AccountUpdated: "account-updated";
-    /**
-     * Account locked.
-     */
-    readonly AccountLocked: "account-locked";
-    /**
-     * Account unlocked.
-     */
-    readonly AccountUnlocked: "account-unlocked";
-    /**
-     * Password changed.
-     */
-    readonly PasswordChanged: "password-changed";
-};
-/**
- * Supported authentication audit event values.
- */
-export type AuthAuditEvent = (typeof AuthAuditEvent)[keyof typeof AuthAuditEvent];

package/docs/reference/interfaces/IAuditCreateRequest.md

@@ -1,11 +0,0 @@
-# Interface: IAuditCreateRequest
-
-Create an authentication audit entry.
-
-## Properties
-
-### body {#body}
-
-> **body**: `Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>
-
-The body of the request.

package/docs/reference/interfaces/IAuditGetRequest.md

@@ -1,17 +0,0 @@
-# Interface: IAuditGetRequest
-
-Get an authentication audit entry by id.
-
-## Properties
-
-### pathParams {#pathparams}
-
-> **pathParams**: `object`
-
-The path parameters for the request.
-
-#### id
-
-> **id**: `string`
-
-The audit entry id.

package/docs/reference/interfaces/IAuditGetResponse.md

@@ -1,11 +0,0 @@
-# Interface: IAuditGetResponse
-
-Response from getting an authentication audit entry.
-
-## Properties
-
-### body {#body}
-
-> **body**: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)
-
-The response body.

package/docs/reference/interfaces/IAuditQueryRequest.md

@@ -1,65 +0,0 @@
-# Interface: IAuditQueryRequest
-
-Query authentication audit entries.
-
-## Properties
-
-### query? {#query}
-
-> `optional` **query?**: `object`
-
-The query parameters for the request.
-
-#### actorId?
-
-> `optional` **actorId?**: `string`
-
-The actor identifier to filter by.
-
-#### organizationId?
-
-> `optional` **organizationId?**: `string`
-
-The organization identifier to filter by.
-
-#### tenantId?
-
-> `optional` **tenantId?**: `string`
-
-The tenant identifier to filter by.
-
-#### nodeId?
-
-> `optional` **nodeId?**: `string`
-
-The node identifier to filter by.
-
-#### event?
-
-> `optional` **event?**: `string`
-
-The event to filter by.
-
-#### startDate?
-
-> `optional` **startDate?**: `string`
-
-The inclusive start date for filtering, in ISO 8601 format.
-
-#### endDate?
-
-> `optional` **endDate?**: `string`
-
-The inclusive end date for filtering, in ISO 8601 format.
-
-#### cursor?
-
-> `optional` **cursor?**: `string`
-
-The pagination cursor.
-
-#### limit?
-
-> `optional` **limit?**: `string`
-
-The maximum number of results to return.

package/docs/reference/interfaces/IAuditQueryResponse.md

@@ -1,23 +0,0 @@
-# Interface: IAuditQueryResponse
-
-Response from querying authentication audit entries.
-
-## Properties
-
-### body {#body}
-
-> **body**: `object`
-
-The response body.
-
-#### entries
-
-> **entries**: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)[]
-
-The returned audit entries.
-
-#### cursor?
-
-> `optional` **cursor?**: `string`
-
-The cursor to retrieve the next page, if any.

package/docs/reference/interfaces/IAuditRemoveRequest.md

@@ -1,17 +0,0 @@
-# Interface: IAuditRemoveRequest
-
-Remove an authentication audit entry.
-
-## Properties
-
-### pathParams {#pathparams}
-
-> **pathParams**: `object`
-
-The path parameters for the request.
-
-#### id
-
-> **id**: `string`
-
-The audit entry id.

package/docs/reference/interfaces/IAuditUpdateRequest.md

@@ -1,25 +0,0 @@
-# Interface: IAuditUpdateRequest
-
-Update an authentication audit entry.
-
-## Properties
-
-### pathParams {#pathparams}
-
-> **pathParams**: `object`
-
-The path parameters for the request.
-
-#### id
-
-> **id**: `string`
-
-The audit entry id.
-
-***
-
-### body {#body}
-
-> **body**: `Partial`\<`Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>\>
-
-The body of the request.