@xeno-js/shared 0.1.0

package/dist/shared/types/auth.types.d.ts

@@ -0,0 +1,106 @@
+import type { Guid, Optional } from './common.types';
+/**
+ * @file auth.types.ts
+ * @description Defines types related to authentication and authorization.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+/**
+ * @description An interface representing the claims associated with an authenticated user. This typically includes standard claims such as 'sub' (subject) and 'email', as well as any additional claims that may be relevant to the application's authorization logic.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface AuthClaims {
+    /**
+     * The unique identifier for the user (subject).
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly sub: string;
+    /**
+     * The user's email
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly email: Optional<string>;
+    readonly name: Optional<string>;
+    /**
+     * The tenant ID associated with the user, if applicable. This is useful in multi-tenant applications to identify which tenant the user belongs to.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly tenantId: Optional<string>;
+    /**
+     * An array of roles assigned to the user. This can be used for role-based access control (RBAC) to determine what actions the user is authorized to perform.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly roles: Optional<string[]>;
+    /**
+     * An array of permissions assigned to the user. This can be used for permission-based access control to determine what specific operations the user is authorized to perform.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly permissions: Optional<string[]>;
+}
+/**
+ * @description An interface representing the context of an authenticated user, including their unique identifier and tenant ID. This context can be used throughout the application to enforce authorization rules and access control based on the user's identity and associated claims.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export interface UserContext {
+    /**
+     * The unique identifier for the user (subject).
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly userId: Optional<Guid>;
+    /**
+     * The tenant ID associated with the user, if applicable. This is useful in multi-tenant applications to identify which tenant the user belongs to.
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly tenantId: Optional<Guid>;
+}
+export interface Session {
+    readonly accessToken: string;
+    readonly refreshToken: string;
+    readonly expiresAt: Optional<number>;
+    readonly user: AuthClaims;
+}
+export type Provider = 'apple' | 'discord' | 'facebook' | 'github' | 'gitlab' | 'google' | 'linkedin' | 'linkedin_oidc' | 'spotify';
+//# sourceMappingURL=auth.types.d.ts.map

package/dist/shared/types/auth.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.types.d.ts","sourceRoot":"","sources":["../../../src/shared/types/auth.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEpD;;;;;;;;;KASK;AAEL;;;;;;;;KAQK;AACL,MAAM,WAAW,UAAU;IACzB;;;;;;;;OAQG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IAEpB;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAEhC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAE/B;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACnC;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;IAClC;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;CACzC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;IAE/B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;CAClC;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACpC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;CAC1B;AAED,MAAM,MAAM,QAAQ,GAChB,OAAO,GACP,SAAS,GACT,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,eAAe,GACf,SAAS,CAAA"}

package/dist/shared/types/auth.types.js

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

package/dist/shared/types/auth.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.types.js","sourceRoot":"","sources":["../../../src/shared/types/auth.types.ts"],"names":[],"mappings":""}

package/dist/shared/types/cache.types.d.ts

@@ -0,0 +1,64 @@
+import type { Optional } from './common.types';
+/**
+ * @description An interface representing cacheable options, which includes properties for cache key, TTL, and bypass flags. This allows query handlers to determine how to cache the results of the query based on the provided options.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface ICacheableOptions {
+    /**
+     * @description A unique key under which to save the result. Must include parameters (e.g., `travel-intents:tenant-123:page-1`).
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly cacheKey: string;
+    /**
+     * @description Time to live for the cache entry in seconds. Optional; if omitted, a default TTL defined in the caching layer will be used. Must be a positive integer if provided.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly ttl: Optional<number>;
+    /**
+     * @description If true, indicates that the cache should be bypassed for this request. Similar to consistentRead but less semantically explicit.
+     * If both bypassCache and consistentRead are provided, consistentRead takes precedence.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly bypassCache: Optional<boolean>;
+    /**
+     * @description (Optional) If true, indicates that a consistent read is required, bypassing the cache. Similar to bypassCache but more semantically explicit.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly consistentRead: Optional<boolean>;
+    /**
+     * @description (Optional) If true, indicates that the cache entry is scoped to the current user. This is useful for multi-tenant applications where cached data should be isolated per user or tenant.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly isUserScoped: boolean;
+}
+//# sourceMappingURL=cache.types.d.ts.map

package/dist/shared/types/cache.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.types.d.ts","sourceRoot":"","sources":["../../../src/shared/types/cache.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAE9C;;;;;;;;KAQK;AACL,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IAEzB;;;;;;;;OAQG;IACH,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IAEvC;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IAE1C;;;;;;;;OAQG;IACH,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;CAC/B"}

package/dist/shared/types/cache.types.js

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

package/dist/shared/types/cache.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.types.js","sourceRoot":"","sources":["../../../src/shared/types/cache.types.ts"],"names":[],"mappings":""}

package/dist/shared/types/common.types.d.ts

@@ -0,0 +1,213 @@
+/**
+ * @description Represents a value that may be `null`.
+ * Prefer this over `T | null` in all public APIs so intent is self-documenting.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Nullable<T> = T | null;
+/**
+ * @description Represents a value that may be `undefined`.
+ * Prefer this over `T | undefined` in all public APIs.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Optional<T> = T | undefined;
+/**
+ * @description Represents a value that may be either `null` or `undefined`.
+ * Use when a value is absent regardless of the reason.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Maybe<T> = T | null | undefined;
+/**
+ * @description Represents a concrete (instantiable) class.
+ * Used by IoC containers and auto-wiring utilities to bind concrete implementations.
+ *
+ * @template T  The instance type produced by `new`.
+ * @template TArgs  Constructor parameter tuple; defaults to `any[]`.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Constructor<T, TArgs extends Dictionary[] = Dictionary[]> = new (...args: TArgs) => T;
+/**
+ * @description Represents an abstract class that cannot be instantiated directly.
+ * Used for binding abstract base classes in the IoC container without requiring
+ * a concrete constructor signature.
+ *
+ * @template T  The instance type produced by subclasses.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type AbstractConstructor<T> = abstract new (...args: Dictionary[]) => T;
+/**
+ * @description A plain-object dictionary with string keys and uniform value type.
+ * Prefer over `{ [key: string]: V }` for self-documenting intent.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Dictionary<V = unknown> = Record<string, V>;
+/**
+ * @description Produces a new type with only the keys `K` made required;
+ * all other keys retain their original optionality.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type RequireKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+/**
+ * @description Produces a new type where property `K` is overridden with type `V`.
+ * Useful for narrowing a property inside a generic base type.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Override<T, K extends keyof T, V> = Omit<T, K> & Record<K, V>;
+/**
+ * @description Extracts only the keys of `T` whose values are assignable to `V`.
+ *
+ * @example
+ * type StringKeys = KeysOfType<{ a: string; b: number; c: string }, string>;
+ * // => 'a' | 'c'
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type KeysOfType<T, V> = {
+    [K in keyof T]: T[K] extends V ? K : never;
+}[keyof T];
+/**
+ * @description Generic factory function that produces a value of type `T`.
+ *
+ * `TArgs` defaults to an empty tuple for zero-argument factories, enabling
+ * usage both as a plain provider (`Factory<T>`) and as a parameterised
+ * creator (`Factory<T, [config: MyConfig]>`).
+ *
+ * @template T     The type of the value produced.
+ * @template TArgs Tuple of constructor/factory argument types.
+ *
+ * @example
+ * // Zero-argument factory
+ * const makeLogger: Factory<ILoggerService> = () => new ConsoleLogger();
+ *
+ * // Parameterised factory
+ * const makeRepo: Factory<IRepository<Entity>, [tx: Transaction]> =
+ *   (tx) => new DrizzleRepository(tx);
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Factory<T, TArgs extends unknown[] = []> = (...args: TArgs) => T;
+/**
+ * @description Async variant of `Factory<T, TArgs>`.
+ * Use when the construction process involves I/O (e.g. DB pool acquisition).
+ *
+ * @template T     The type of the resolved value.
+ * @template TArgs Tuple of factory argument types.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type AsyncFactory<T, TArgs extends unknown[] = []> = (...args: TArgs) => Promise<T>;
+/**
+ * @description Delegate used by application-layer services to perform lazy,
+ * symbol-keyed dependency resolution without coupling to the concrete container.
+ *
+ * This is the **only** sanctioned way to resolve dependencies at runtime outside
+ * of constructor injection. Never inject the raw IoC container into services.
+ *
+ * @template T  Narrows the return type at each call site.
+ *
+ * @example
+ * class NexusMediator {
+ *   constructor(private readonly resolve: Resolver) {}
+ *
+ *   send<TResult>(command: ICommand): Promise<TResult> {
+ *     const handler = this.resolve<ICommandHandler<typeof command, TResult>>(
+ *       command.resolverToken,
+ *     );
+ *     return handler.execute(command);
+ *   }
+ * }
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Resolver<T = unknown> = (token: symbol) => T;
+/**
+ * @description Async variant of `Resolver` for containers that resolve
+ * dependencies asynchronously (e.g. lazy module loading, remote config).
+ *
+ * @template T  Narrows the resolved type at each call site.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type AsyncResolver = <T>(token: symbol) => Promise<T>;
+/**
+ * @description Represents a globally unique identifier (GUID/UUID) as a string.
+ * The format is typically 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type Guid = `${string}-${string}-${string}-${string}-${string}`;
+/**
+ * @description Represents a function that performs setup or configuration
+ * based on the provided options of type `T`.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type SetupAction<T, E = undefined> = (options: T, config: E) => void;
+//# sourceMappingURL=common.types.d.ts.map

package/dist/shared/types/common.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.types.d.ts","sourceRoot":"","sources":["../../../src/shared/types/common.types.ts"],"names":[],"mappings":"AAEA;;;;;;;;;KASK;AACL,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAElC;;;;;;;;;KASK;AACL,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;AAEvC;;;;;;;;;KASK;AACL,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;AAG3C;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,KAAK,SAAS,UAAU,EAAE,GAAG,UAAU,EAAE,IAAI,KAAK,GAAG,IAAI,EAAE,KAAK,KAAK,CAAC,CAAA;AAEjG;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAA;AAI9E;;;;;;;;;KASK;AACL,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AAEvD;;;;;;;;;KASK;AACL,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAEjF;;;;;;;;;KASK;AACL,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAEzE;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK;CAC3C,CAAC,MAAM,CAAC,CAAC,CAAA;AAIV;;;;;;;;;;;;;;;;;;;;;;;KAuBK;AACL,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,KAAK,SAAS,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,CAAC,CAAA;AAE5E;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,KAAK,SAAS,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAI1F;;;;;;;;;;;;;;;;;;;;;;;;;;KA0BK;AACL,MAAM,MAAM,QAAQ,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,CAAA;AAExD;;;;;;;;;;;KAWK;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAI5D;;;;;;;;;KASK;AACL,MAAM,MAAM,IAAI,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAA;AAEtE;;;;;;;;;KASK;AACL,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,CAAA"}

package/dist/shared/types/common.types.js

@@ -0,0 +1,3 @@
+// ─── Nullability ─────────────────────────────────────────────────────────────
+export {};
+//# sourceMappingURL=common.types.js.map

package/dist/shared/types/common.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../../src/shared/types/common.types.ts"],"names":[],"mappings":"AAAA,gFAAgF"}

package/dist/shared/types/http.types.d.ts

@@ -0,0 +1,188 @@
+import type { Dictionary, Maybe, Optional } from './common.types';
+/**
+ * @description Supported HTTP methods.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+/**
+ * @description Header map used by agnostic HTTP clients.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type HttpHeaders = Dictionary<Optional<string | string[]>>;
+/**
+ * @description Query string value accepted by the HTTP contract.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type HttpQueryValue = Maybe<string | number | boolean>;
+/**
+ * @description Agnostic contract used to execute HTTP calls independently
+ * from concrete transport libraries (fetch, axios, undici, etc.).
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export type HttpOptions = 'url' | 'method' | 'body';
+/**
+ * @description Base Request options accepted by the agnostic HTTP client.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export interface HttpBaseRequest {
+    /** @description Optional query string parameters.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly query?: Optional<Dictionary<HttpQueryValue>>;
+    /** @description Optional request headers.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly headers?: Optional<HttpHeaders>;
+    /** @description Optional abort signal used to cancel the request.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly signal: Optional<AbortSignal>;
+    /** @description Optional request timeout in milliseconds.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly timeoutMs?: Optional<number>;
+    /**
+     * @description Optional response type for the request.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly responseType?: Optional<HttpResponseType>;
+}
+/**
+ * @description Represents the structure of an HTTP response.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export type HttpResponseType = 'json' | 'blob' | 'text' | 'arraybuffer';
+/**
+ * @description Request options accepted by the agnostic HTTP client.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface HttpRequest<TBody = unknown> extends HttpBaseRequest {
+    /** @description HTTP method used for the outgoing call.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly method: HttpMethod;
+    /** @description Optional request body.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly body?: Optional<TBody>;
+    /** @description Absolute or relative target URL.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly url?: string;
+}
+/**
+ * @description Normalized response returned by an agnostic HTTP client.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export interface HttpResponse<TData = unknown> {
+    /** @description HTTP status code returned by the server.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly status: number;
+    /** @description Indicates if the response status is in the 2xx range.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly ok: boolean;
+    /** @description Response headers normalized as a dictionary.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly headers: HttpHeaders;
+    /** @description Parsed response payload.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly data: TData;
+}
+export interface CookieOptions {
+    path?: Optional<string>;
+    maxAge?: Optional<number>;
+    sameSite?: Optional<'lax' | 'strict' | 'none' | boolean>;
+    secure?: boolean;
+    domain?: Optional<string>;
+}
+//# sourceMappingURL=http.types.d.ts.map

package/dist/shared/types/http.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.types.d.ts","sourceRoot":"","sources":["../../../src/shared/types/http.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEjE;;;;;;;;KAQK;AACL,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;AAEzF;;;;;;;;KAQK;AACL,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC,CAAA;AAEjE;;;;;;;;KAQK;AACL,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;AAE7D;;;;;;;;;KASK;AACL,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;AAEnD;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAA;IAErD;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAA;IAExC;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAA;IAEtC;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAErC;;;;;;;OAOG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAA;CACnD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAA;AAEvE;;;;;;;;KAQK;AACL,MAAM,WAAW,WAAW,CAAC,KAAK,GAAG,OAAO,CAAE,SAAQ,eAAe;IACnE;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;IAE3B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;IAE/B;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;;KAQK;AACL,MAAM,WAAW,YAAY,CAAC,KAAK,GAAG,OAAO;IAC3C;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IAEvB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAA;IAEpB;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;IAE7B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACvB,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;IACxD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;CAC1B"}

package/dist/shared/types/http.types.js

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

package/dist/shared/types/http.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.types.js","sourceRoot":"","sources":["../../../src/shared/types/http.types.ts"],"names":[],"mappings":""}

package/dist/shared/types/index.d.ts

@@ -0,0 +1,10 @@
+export type * from './api-response.types';
+export type * from './auth.types';
+export type * from './auth-policy.types';
+export type * from './cache.types';
+export type * from './common.types';
+export type * from './http.types';
+export type * from './injection-token.types';
+export type * from './metadata.types';
+export type * from './pagination.types';
+//# sourceMappingURL=index.d.ts.map

package/dist/shared/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/shared/types/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,sBAAsB,CAAA;AACzC,mBAAmB,cAAc,CAAA;AACjC,mBAAmB,qBAAqB,CAAA;AACxC,mBAAmB,eAAe,CAAA;AAClC,mBAAmB,gBAAgB,CAAA;AACnC,mBAAmB,cAAc,CAAA;AACjC,mBAAmB,yBAAyB,CAAA;AAC5C,mBAAmB,kBAAkB,CAAA;AACrC,mBAAmB,oBAAoB,CAAA"}

package/dist/shared/types/index.js

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

package/dist/shared/types/index.js.map

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