@xeno-js/shared 0.1.0

package/dist/domain/contracts/context/irequest-context.contracts.d.ts

@@ -0,0 +1,68 @@
+import type { Optional } from '../../../shared';
+import type { Identity, NetworkContext } from './context_types';
+export interface IBaseAccessor<TCtx> extends IContextAccessor<TCtx>, IIdentityAccessor, INetworkContextAccessor {
+}
+/**
+ * @description The IRequestContext interface is a contract that defines the structure and behavior of a request context within the application. It provides methods for executing asynchronous functions with the current user's identity context and retrieving the current user's identity information. This interface is essential for managing user identity and ensuring that identity-related data is properly propagated throughout the application.
+ *
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export interface IIdentityAccessor {
+    /**
+     * Retrieves the current user's identity information, including user ID, roles, and correlation ID. This method can be used to access identity data outside of the context of an asynchronous function, allowing for synchronous access to identity information when needed.
+     * @returns An object representing the current user's identity, containing properties such as user ID, roles, and correlation ID. This information can be used for authentication and authorization purposes throughout the application.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    getIdentity(): Optional<Identity>;
+}
+/**
+ * @description The IServiceScopeAccessor interface is a contract that defines the structure and behavior of a service scope accessor within the application. It provides a method for retrieving the current service scope, which allows for managing dependencies during the execution of a request. This interface is essential for ensuring that services are properly scoped and disposed of after the request is processed.
+ *
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export interface IContextAccessor<TCtx> {
+    /**
+     * Retrieves the current context, which can include information about the identity of the user or system executing the request, as well as network and tracing contexts for observability. This method allows for synchronous access to context-related data when needed.
+     * @returns An object representing the current context, containing properties such as identity, network, and tracing contexts. This information can be used for managing execution context and ensuring that context-related data is accessible when needed.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    getContext(): Optional<TCtx>;
+}
+/**
+ * @description The IContextAccessor interface is a contract that defines the structure and behavior of a context accessor within the application. It provides a method for retrieving the current context, which can include information about the identity of the user or system executing the request, as well as network and tracing contexts for observability. This interface is essential for managing execution context and ensuring that context-related data is accessible when needed.
+ *
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export interface INetworkContextAccessor {
+    /**
+     * Retrieves the current network context, which can include information about the request ID, correlation ID, and other network-related data. This method allows for synchronous access to network context-related data when needed.
+     * @returns An object representing the current network context, containing properties such as request ID, correlation ID, and other network-related data. This information can be used for managing execution context and ensuring that network context-related data is accessible when needed.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    getNetworkContext(): Optional<NetworkContext>;
+}
+//# sourceMappingURL=irequest-context.contracts.d.ts.map

package/dist/domain/contracts/context/irequest-context.contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"irequest-context.contracts.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/context/irequest-context.contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAExC,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAE/D,MAAM,WAAW,aAAa,CAAC,IAAI,CACjC,SAAQ,gBAAgB,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,uBAAuB;CAAG;AAE/E;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;OAQG;IACH,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAA;CAClC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI;IACpC;;;;;;;;OAQG;IACH,UAAU,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAA;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;OAQG;IACH,iBAAiB,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAA;CAC9C"}

package/dist/domain/contracts/context/irequest-context.contracts.js

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

package/dist/domain/contracts/context/irequest-context.contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irequest-context.contracts.js","sourceRoot":"","sources":["../../../../src/domain/contracts/context/irequest-context.contracts.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/controllers/icontroller.contracts.d.ts

@@ -0,0 +1,25 @@
+import type { ResponseDto } from '../../../shared';
+/**
+ * @fileoverview IController defines the interface for controllers in the application. A controller is responsible for handling incoming requests, processing them, and returning appropriate responses. The IController interface ensures that all controllers adhere to a consistent structure, making it easier to manage and maintain the application's request handling logic. Each controller must implement the handle method, which takes an incoming request and returns a response, typically as a promise to accommodate asynchronous operations.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface IController<TRequest = unknown, TResponse = unknown> {
+    /**
+     * Handles an incoming request and returns a response.
+     * @param request - The incoming request object.
+     * @returns A promise that resolves to a ResponseDto containing the response object.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    handle(request: TRequest): Promise<ResponseDto<TResponse>>;
+}
+//# sourceMappingURL=icontroller.contracts.d.ts.map

package/dist/domain/contracts/controllers/icontroller.contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icontroller.contracts.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/controllers/icontroller.contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAE3C;;;;;;;;KAQK;AACL,MAAM,WAAW,WAAW,CAAC,QAAQ,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO;IAClE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAA;CAC3D"}

package/dist/domain/contracts/controllers/icontroller.contracts.js

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

package/dist/domain/contracts/controllers/icontroller.contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icontroller.contracts.js","sourceRoot":"","sources":["../../../../src/domain/contracts/controllers/icontroller.contracts.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/controllers/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './icontroller.contracts';
+//# sourceMappingURL=index.d.ts.map

package/dist/domain/contracts/controllers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/controllers/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,yBAAyB,CAAA"}

package/dist/domain/contracts/controllers/index.js

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

package/dist/domain/contracts/controllers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/domain/contracts/controllers/index.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/cqrs_types/icommand.types.d.ts

@@ -0,0 +1,30 @@
+import type { IRequest } from './irequest.types';
+/**
+ * @fileoverview Defines the ICommand interface for base requests in a CQRS architecture.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+/**
+ * @description An interface representing a base request in a CQRS architecture. This interface can be implemented by both command and query requests, as it includes common properties such as the request type, timestamp, and a unique token for identification.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface ICommand<TResponse = unknown> extends IRequest<TResponse> {
+    /** @description An optional property to specify the expected response type of the command, which can be used for type inference and validation in command handlers.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly $type?: TResponse;
+}
+//# sourceMappingURL=icommand.types.d.ts.map

package/dist/domain/contracts/cqrs/cqrs_types/icommand.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icommand.types.d.ts","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/icommand.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAEhD;;;;;;;;KAQK;AAEL;;;;;;;;KAQK;AACL,MAAM,WAAW,QAAQ,CAAC,SAAS,GAAG,OAAO,CAAE,SAAQ,QAAQ,CAAC,SAAS,CAAC;IACxE;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC3B"}

package/dist/domain/contracts/cqrs/cqrs_types/icommand.types.js

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

package/dist/domain/contracts/cqrs/cqrs_types/icommand.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icommand.types.js","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/icommand.types.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/cqrs_types/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './icommand.types';
+export type * from './iquery.types';
+export type * from './irequest.types';
+//# sourceMappingURL=index.d.ts.map

package/dist/domain/contracts/cqrs/cqrs_types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,kBAAkB,CAAA;AACrC,mBAAmB,gBAAgB,CAAA;AACnC,mBAAmB,kBAAkB,CAAA"}

package/dist/domain/contracts/cqrs/cqrs_types/index.js

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

package/dist/domain/contracts/cqrs/cqrs_types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/index.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/cqrs_types/iquery.types.d.ts

@@ -0,0 +1,32 @@
+import type { ICacheableOptions } from '../../../../shared';
+import type { IRequest } from './irequest.types';
+/**
+ * @fileoverview Defines the IQuery interface for query requests in a CQRS architecture.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+/**
+ * @description An interface representing a paginated query request, which extends the IQuery interface and includes pagination parameters.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface IQuery<TResponse = unknown> extends IRequest<TResponse> {
+    /**
+     * @description Cache options for the query, including cache key, TTL, and bypass flags.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly cacheOptions: ICacheableOptions;
+}
+//# sourceMappingURL=iquery.types.d.ts.map

package/dist/domain/contracts/cqrs/cqrs_types/iquery.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iquery.types.d.ts","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/iquery.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAEjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAEhD;;;;;;;;KAQK;AAEL;;;;;;;;KAQK;AACL,MAAM,WAAW,MAAM,CAAC,SAAS,GAAG,OAAO,CAAE,SAAQ,QAAQ,CAAC,SAAS,CAAC;IACtE;;;;;;;OAOG;IACH,QAAQ,CAAC,YAAY,EAAE,iBAAiB,CAAA;CACzC"}

package/dist/domain/contracts/cqrs/cqrs_types/iquery.types.js

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

package/dist/domain/contracts/cqrs/cqrs_types/iquery.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iquery.types.js","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/iquery.types.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/cqrs_types/irequest.types.d.ts

@@ -0,0 +1,30 @@
+import type { RequestType } from '../../../../shared';
+/**
+ * @fileoverview Defines the IRequest interface for requests in a CQRS architecture.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface IRequest<TResponse = unknown> {
+    readonly $type?: TResponse;
+    /** @description The intent of the request, which can be used to describe the purpose or action associated with the request.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly intent: string;
+    /** @description The type of the request, which can be used to distinguish between different kinds of requests (e.g., command, query).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly type: RequestType;
+}
+//# sourceMappingURL=irequest.types.d.ts.map

package/dist/domain/contracts/cqrs/cqrs_types/irequest.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"irequest.types.d.ts","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/irequest.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAE3C;;;;;;;;KAQK;AACL,MAAM,WAAW,QAAQ,CAAC,SAAS,GAAG,OAAO;IAC3C,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;CAC3B"}

package/dist/domain/contracts/cqrs/cqrs_types/irequest.types.js

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

package/dist/domain/contracts/cqrs/cqrs_types/irequest.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irequest.types.js","sourceRoot":"","sources":["../../../../../src/domain/contracts/cqrs/cqrs_types/irequest.types.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/ihandler.contracts.d.ts

@@ -0,0 +1,30 @@
+import type { ResultType } from '../../results/result.types';
+import type { IRequest } from './cqrs_types';
+/**
+ * An interface representing a handler for processing requests in a CQRS (Command Query Responsibility Segregation) pattern.
+ * This interface defines a method for handling a request and returning a response, which can be used for both commands and queries.
+ * @template TRequest - The type of the request that the handler will process.
+ * @template TResponse - The type of the response that the handler will return after processing the request.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface IHandler<TRequest extends IRequest<TResponse>, TResponse> {
+    /**
+     * Handles a request and returns a response. This method is asynchronous and returns a Promise.
+     * @param request - The request to be handled, of type TRequest.
+     * @param signal - An optional AbortSignal to allow cancellation of the request.
+     * @returns A Promise that resolves to a response of type TResponse.
+     * @throws An error if the request handling fails or is aborted.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    handle(request: TRequest, signal: AbortSignal): Promise<ResultType<TResponse>>;
+}
+//# sourceMappingURL=ihandler.contracts.d.ts.map

package/dist/domain/contracts/cqrs/ihandler.contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ihandler.contracts.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/ihandler.contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAE5C;;;;;;;;;;;KAWK;AACL,MAAM,WAAW,QAAQ,CAAC,QAAQ,SAAS,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS;IACvE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;CAC/E"}

package/dist/domain/contracts/cqrs/ihandler.contracts.js

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

package/dist/domain/contracts/cqrs/ihandler.contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ihandler.contracts.js","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/ihandler.contracts.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/imediator.contracts.d.ts

@@ -0,0 +1,41 @@
+import type { ResultType } from '../../results/result.types';
+import type { ICommand } from './cqrs_types/icommand.types';
+import type { IQuery } from './cqrs_types/iquery.types';
+/**
+ * An interface representing a mediator in the CQRS (Command Query Responsibility Segregation) pattern. The mediator is responsible for sending commands and executing queries by delegating them to the appropriate handlers.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface IMediator {
+    /**
+     * Sends a command to the appropriate handler and returns a response.
+     * @param request The command object to be executed.
+     * @param signal An optional AbortSignal to allow cancellation of the command.
+     * @returns A promise that resolves to the response from the handler.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    send<TResponse>(request: ICommand<TResponse>, signal: AbortSignal): Promise<ResultType<TResponse>>;
+    /**
+     * Executes a query and returns the result.
+     * @param request The query object to be executed.
+     * @param signal An optional AbortSignal to allow cancellation of the query.
+     * @returns A promise that resolves to the result of the query.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    query<TResponse>(request: IQuery<TResponse>, signal: AbortSignal): Promise<ResultType<TResponse>>;
+}
+//# sourceMappingURL=imediator.contracts.d.ts.map

package/dist/domain/contracts/cqrs/imediator.contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"imediator.contracts.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/imediator.contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAEvD;;;;;;;;KAQK;AACL,MAAM,WAAW,SAAS;IACxB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IAElG;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;CAClG"}

package/dist/domain/contracts/cqrs/imediator.contracts.js

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

package/dist/domain/contracts/cqrs/imediator.contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"imediator.contracts.js","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/imediator.contracts.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/index.d.ts

@@ -0,0 +1,5 @@
+export type * from './cqrs_types/index';
+export type * from './ihandler.contracts';
+export type * from './imediator.contracts';
+export type * from './ipipeline-behavior.contracts';
+//# sourceMappingURL=index.d.ts.map

package/dist/domain/contracts/cqrs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,oBAAoB,CAAA;AACvC,mBAAmB,sBAAsB,CAAA;AACzC,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,gCAAgC,CAAA"}

package/dist/domain/contracts/cqrs/index.js

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

package/dist/domain/contracts/cqrs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/index.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/cqrs/ipipeline-behavior.contracts.d.ts

@@ -0,0 +1,42 @@
+import type { ResultType } from '../../results/result.types';
+import type { IRequest } from './cqrs_types';
+/**
+ * @description A delegate function type that represents the next step in the pipeline behavior. It returns a promise that resolves to a ResultType, which can be either a successful result or an error. This delegate is used to invoke the next behavior in the pipeline or the actual request handler, allowing for a chain of behaviors to be executed in a structured manner.
+ *
+ * @template TResult - The type of the result that the delegate will return when invoked. This allows for flexibility in defining the expected output of the next step in the pipeline, which can be tailored to the specific needs of the request being processed.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Delegate<TResult> = () => Promise<ResultType<TResult>>;
+/**
+ * @description An interface representing a pipeline behavior in a CQRS architecture. Pipeline behaviors are used to implement cross-cutting concerns such as logging, validation, and error handling in a structured manner. Each behavior can perform specific actions before and after invoking the next step in the pipeline, allowing for a modular and reusable approach to handling requests.
+ *
+ * @template TInput - The type of the input request that the pipeline behavior will handle. This allows for type safety and ensures that the behavior can work with specific types of requests, which can be defined based on the application's needs.
+ * @template TResult - The type of the result that the pipeline behavior will return after processing the request. This allows for flexibility in defining the expected output of the behavior, which can be tailored to the specific requirements of the request being handled.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface IPipelineBehavior<TInput extends IRequest<TResult>, TResult> {
+    /**
+     * @description Handles the processing of a request within the pipeline. This method is responsible for executing any pre-processing logic, invoking the next behavior in the pipeline, and performing any post-processing logic. It ensures that the request is handled in a structured manner, allowing for cross-cutting concerns to be applied consistently.
+     * @param request - The input request to be processed by the pipeline behavior.
+     * @param next - A delegate function representing the next step in the pipeline. Invoking this delegate will pass control to the next behavior or the actual request handler.
+     * @returns A promise that resolves to a ResultType, which can be either a successful result or an error.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    handle(request: TInput, next: Delegate<TResult>): Promise<ResultType<TResult>>;
+}
+//# sourceMappingURL=ipipeline-behavior.contracts.d.ts.map

package/dist/domain/contracts/cqrs/ipipeline-behavior.contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipipeline-behavior.contracts.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/ipipeline-behavior.contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAE5C;;;;;;;;;;KAUK;AACL,MAAM,MAAM,QAAQ,CAAC,OAAO,IAAI,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;AAElE;;;;;;;;;;;KAWK;AACL,MAAM,WAAW,iBAAiB,CAAC,MAAM,SAAS,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO;IAC1E;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;CAC/E"}

package/dist/domain/contracts/cqrs/ipipeline-behavior.contracts.js

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

package/dist/domain/contracts/cqrs/ipipeline-behavior.contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipipeline-behavior.contracts.js","sourceRoot":"","sources":["../../../../src/domain/contracts/cqrs/ipipeline-behavior.contracts.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/datasources/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './iread-datasource.contracts';
+export type * from './iremote-datasource.contracts';
+export type * from './iwrite-datasource.contracts';
+//# sourceMappingURL=index.d.ts.map

package/dist/domain/contracts/datasources/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/datasources/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,+BAA+B,CAAA"}

package/dist/domain/contracts/datasources/index.js

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

package/dist/domain/contracts/datasources/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/domain/contracts/datasources/index.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/datasources/iread-datasource.contracts.d.ts

@@ -0,0 +1,41 @@
+import type { Optional, UserContext } from '../../../shared';
+import type { IDisposable } from '../disposables';
+/**
+ * @description Interface representing a data source for performing database operations. This interface defines the contract for executing SQL queries against a database, including methods for finding records based on filters and unique identifiers. The IReadDataSource interface is designed to be implemented by classes that provide specific data access logic, allowing for separation of concerns and easier testing.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface IReadDataSource<TDto> extends IDisposable {
+    /**
+     * @description Finds entities. This method takes an optional AbortSignal for cancellation. It returns a promise that resolves to an array of entities. The implementation of this method is responsible for constructing the appropriate query and handling any necessary data transformations before returning the results.
+     * @param ctx The context of the authenticated user, which may be used for authorization and auditing purposes.
+     * @param signal An optional AbortSignal to allow cancellation of the query operation.
+     * @returns A promise that resolves to an array of objects representing the rows returned by the query.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    findAll(ctx: UserContext, signal: Optional<AbortSignal>): Promise<TDto[]>;
+    /**
+     * @description Finds an entity by its unique identifier. This method takes an optional AbortSignal for cancellation. It returns a promise that resolves to the entity if found, or null if not found. The implementation of this method is responsible for constructing the appropriate query and handling any necessary data transformations before returning the result.
+     * @param id The unique identifier of the entity to retrieve.
+     * @param ctx The context of the authenticated user, which may be used for authorization and auditing purposes.
+     * @param signal An optional AbortSignal to allow cancellation of the query operation.
+     * @returns A promise that resolves to an object representing the row returned by the query.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    findById(id: string | number, ctx: UserContext, signal: Optional<AbortSignal>): Promise<Optional<TDto>>;
+}
+//# sourceMappingURL=iread-datasource.contracts.d.ts.map

package/dist/domain/contracts/datasources/iread-datasource.contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iread-datasource.contracts.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/datasources/iread-datasource.contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD;;;;;;;;KAQK;AACL,MAAM,WAAW,eAAe,CAAC,IAAI,CAAE,SAAQ,WAAW;IACxD;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IAEzE;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,GAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;CAC3B"}

package/dist/domain/contracts/datasources/iread-datasource.contracts.js

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

package/dist/domain/contracts/datasources/iread-datasource.contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iread-datasource.contracts.js","sourceRoot":"","sources":["../../../../src/domain/contracts/datasources/iread-datasource.contracts.ts"],"names":[],"mappings":""}

package/dist/domain/contracts/datasources/iremote-datasource.contracts.d.ts

@@ -0,0 +1,73 @@
+import type { HttpBaseRequest } from '../../../shared';
+import type { ResultType } from '../../results/result.types';
+/**
+ * @description Contract for a remote data source that defines the method for fetching data from a remote endpoint. This interface abstracts the details of how the data is fetched, allowing for different implementations (e.g., using different HTTP clients or protocols) while providing a consistent method signature for fetching data.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export interface IRemoteDataSource {
+    /** @description Fetches data from a remote endpoint using the specified HTTP method and request options. The method returns a ResultType that encapsulates either the successful response data or an error, providing a consistent way to handle both success and failure cases.
+     *
+     * @param endpoint - The URL or endpoint from which to fetch data.
+     * @param request - The request options for the remote call.
+     * @returns A Promise that resolves to a ResultType containing either the successful response data or an error if the request fails.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    get<TResponse>(endpoint: string, request: HttpBaseRequest): Promise<ResultType<TResponse>>;
+    /** @description Sends data to a remote endpoint using the specified HTTP method and request options. The method returns a ResultType that encapsulates either the successful response data or an error, providing a consistent way to handle both success and failure cases.
+     *
+     * @param endpoint - The URL or endpoint to which to send data.
+     * @param request - The request options for the remote call.
+     * @returns A Promise that resolves to a ResultType containing either the successful response data or an error if the request fails.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    post<TResponse, TBody = unknown>(endpoint: string, body: TBody, request: HttpBaseRequest): Promise<ResultType<TResponse>>;
+    /** @description Updates data at a remote endpoint using the specified HTTP method and request options. The method returns a ResultType that encapsulates either the successful response data or an error, providing a consistent way to handle both success and failure cases.
+     *
+     * @param endpoint - The URL or endpoint at which to update data.
+     * @param request - The request options for the remote call.
+     * @returns A Promise that resolves to a ResultType containing either the successful response data or an error if the request fails.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    put<TResponse, TBody = unknown>(endpoint: string, body: TBody, request: HttpBaseRequest): Promise<ResultType<TResponse>>;
+    /** @description Patches data at a remote endpoint using the specified HTTP method and request options. The method returns a ResultType that encapsulates either the successful response data or an error, providing a consistent way to handle both success and failure cases.
+     *
+     * @param endpoint - The URL or endpoint at which to patch data.
+     * @param request - The request options for the remote call.
+     * @returns A Promise that resolves to a ResultType containing either the successful response data or an error if the request fails.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    patch<TResponse, TBody = unknown>(endpoint: string, body: TBody, request: HttpBaseRequest): Promise<ResultType<TResponse>>;
+    /** @description Deletes data from a remote endpoint using the specified HTTP method and request options. The method returns a ResultType that encapsulates either the successful response data or an error, providing a consistent way to handle both success and failure cases.
+     *
+     * @param endpoint - The URL or endpoint from which to delete data.
+     * @param request - The request options for the remote call.
+     * @returns A Promise that resolves to a ResultType containing either the successful response data or an error if the request fails.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    delete<TResponse>(endpoint: string, request: HttpBaseRequest): Promise<ResultType<TResponse>>;
+}
+//# sourceMappingURL=iremote-datasource.contracts.d.ts.map

package/dist/domain/contracts/datasources/iremote-datasource.contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iremote-datasource.contracts.d.ts","sourceRoot":"","sources":["../../../../src/domain/contracts/datasources/iremote-datasource.contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAE5D;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IAE1F;;;;;;;;;;OAUG;IACH,IAAI,CAAC,SAAS,EAAE,KAAK,GAAG,OAAO,EAC7B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,SAAS,EAAE,KAAK,GAAG,OAAO,EAC5B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,EAAE,KAAK,GAAG,OAAO,EAC9B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;CAC9F"}

package/dist/domain/contracts/datasources/iremote-datasource.contracts.js

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

package/dist/domain/contracts/datasources/iremote-datasource.contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iremote-datasource.contracts.js","sourceRoot":"","sources":["../../../../src/domain/contracts/datasources/iremote-datasource.contracts.ts"],"names":[],"mappings":""}