@dexyn/common-library 1.0.5 → 1.0.8

package/api/apiClientUtils.d.ts

@@ -0,0 +1,25 @@
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+export interface ApiOptions {
+    method?: HttpMethod;
+    headers?: Record<string, string>;
+    body?: unknown;
+}
+/**
+ * A functional API client that requires a base URL upon creation.
+ * Provides utility functions for making HTTP requests with query parameters,
+ * custom HTTP methods, headers, and request bodies.
+ */
+export declare const createApiClient: (basePath: string) => {
+    get: <T>(endpoint: string, queryParameters?: Record<string, string | number | boolean | null | undefined>) => Promise<T>;
+    post: <T>(endpoint: string, body?: unknown) => Promise<T>;
+    put: <T>(endpoint: string, body?: unknown) => Promise<T>;
+    delete: <T>(endpoint: string) => Promise<T>;
+};
+export declare const ApiClientUtils: {
+    createApiClient: (basePath: string) => {
+        get: <T>(endpoint: string, queryParameters?: Record<string, string | number | boolean | null | undefined>) => Promise<T>;
+        post: <T>(endpoint: string, body?: unknown) => Promise<T>;
+        put: <T>(endpoint: string, body?: unknown) => Promise<T>;
+        delete: <T>(endpoint: string) => Promise<T>;
+    };
+};

package/api/apiClientUtils.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClientUtils = exports.createApiClient = void 0;
+/**
+ * A functional API client that requires a base URL upon creation.
+ * Provides utility functions for making HTTP requests with query parameters,
+ * custom HTTP methods, headers, and request bodies.
+ */
+const createApiClient = (basePath) => {
+    if (!basePath) {
+        throw new Error('Base path is required');
+    }
+    const sanitizedBasePath = basePath.replace(/\/$/, '');
+    const request = async (endpoint, options = {}, queryParameters = {}) => {
+        const { method = 'GET', headers, body } = options;
+        // Construct query string from queryParameters
+        const queryString = new URLSearchParams(Object.entries(queryParameters).reduce((acc, [key, value]) => {
+            if (value !== undefined) {
+                acc[key] = String(value);
+            }
+            return acc;
+        }, {})).toString();
+        // Append query string to endpoint if queryParameters exist
+        const url = queryString ? `${sanitizedBasePath}/${endpoint}?${queryString}` : `${sanitizedBasePath}/${endpoint}`;
+        if (method === 'GET' && body) {
+            throw new Error('GET requests cannot have a body');
+        }
+        const requestBody = body ? JSON.stringify(body) : undefined;
+        const response = await fetch(url, {
+            method,
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+            body: requestBody,
+        });
+        if (!response.ok) {
+            const errorData = await response.json();
+            throw new Error(`Request failed with status ${response.status}: ${JSON.stringify(errorData)}`);
+        }
+        return await response.json();
+    };
+    return {
+        get: (endpoint, queryParameters = {}) => request(endpoint, { method: 'GET' }, queryParameters),
+        post: (endpoint, body) => request(endpoint, { method: 'POST', body }),
+        put: (endpoint, body) => request(endpoint, { method: 'PUT', body }),
+        delete: (endpoint) => request(endpoint, { method: 'DELETE' }),
+    };
+};
+exports.createApiClient = createApiClient;
+exports.ApiClientUtils = { createApiClient: exports.createApiClient };

package/date/dateUtils.d.ts

@@ -8,4 +8,8 @@
  * DateFormatter.formatTime(new Date("2024-12-03T10:30:00"), "en-US", { hour: "2-digit", minute: "2-digit" });
  * // Output: "10:30 AM"
  */
-export declare function formatDateTime(date: Date, locale?: string, options?: Intl.DateTimeFormatOptions): string;
+declare function formatDateTime(date: Date, locale?: string, options?: Intl.DateTimeFormatOptions): string;
+declare const DateUtils: {
+    formatDateTime: typeof formatDateTime;
+};
+export { DateUtils };

package/date/dateUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatDateTime = formatDateTime;
+exports.DateUtils = void 0;
 /**
  * Formats a date as a time string.
  * @param date The `Date` object to format.
@@ -14,3 +14,7 @@ exports.formatDateTime = formatDateTime;
 function formatDateTime(date, locale = "en-US", options = { hour: "numeric", minute: "numeric", second: "numeric" }) {
     return new Intl.DateTimeFormat(locale, options).format(date);
 }
+const DateUtils = {
+    formatDateTime
+};
+exports.DateUtils = DateUtils;

package/index.d.ts

@@ -0,0 +1,7 @@
+import { ErrorResult, StandardError, Result, ErrorName } from "./result/resultUtils";
+export { ResultUtils } from "./result/resultUtils";
+export { HttpResultUtils } from "./result/httpResultUtils";
+export { DateUtils } from "./date/dateUtils";
+export { ValidationUtils } from "./validation/validationUtils";
+export { ApiClientUtils } from "./api/apiClientUtils";
+export type { ErrorResult, StandardError, Result, ErrorName };

package/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClientUtils = exports.ValidationUtils = exports.DateUtils = exports.HttpResultUtils = exports.ResultUtils = void 0;
+var resultUtils_1 = require("./result/resultUtils");
+Object.defineProperty(exports, "ResultUtils", { enumerable: true, get: function () { return resultUtils_1.ResultUtils; } });
+var httpResultUtils_1 = require("./result/httpResultUtils");
+Object.defineProperty(exports, "HttpResultUtils", { enumerable: true, get: function () { return httpResultUtils_1.HttpResultUtils; } });
+var dateUtils_1 = require("./date/dateUtils");
+Object.defineProperty(exports, "DateUtils", { enumerable: true, get: function () { return dateUtils_1.DateUtils; } });
+var validationUtils_1 = require("./validation/validationUtils");
+Object.defineProperty(exports, "ValidationUtils", { enumerable: true, get: function () { return validationUtils_1.ValidationUtils; } });
+var apiClientUtils_1 = require("./api/apiClientUtils");
+Object.defineProperty(exports, "ApiClientUtils", { enumerable: true, get: function () { return apiClientUtils_1.ApiClientUtils; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dexyn/common-library",
-  "version": "1.0.5",
+  "version": "1.0.8",
   "main": "index.js",
   "repository": {
     "type": "git",

package/result/httpResultUtils.d.ts

@@ -1,10 +1,13 @@
 import { ErrorResult } from "./resultUtils";
-export declare const HttpResult: {
-    Accepted: () => {
-        status: number;
-    };
-    BadRequest: (error: ErrorResult) => {
-        status: number;
-        jsonBody: string;
-    };
+declare function Accepted(): {
+    status: number;
 };
+declare function BadRequest(error: ErrorResult): {
+    status: number;
+    jsonBody: string;
+};
+export declare const HttpResultUtils: {
+    Accepted: typeof Accepted;
+    BadRequest: typeof BadRequest;
+};
+export {};

package/result/httpResultUtils.js

@@ -1,18 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpResult = void 0;
-const createHTTPResult = () => {
-    function Accepted() {
-        return {
-            status: 202,
-        };
-    }
-    function BadRequest(error) {
-        return {
-            status: 400,
-            jsonBody: JSON.stringify(error)
-        };
-    }
-    return { Accepted, BadRequest };
-};
-exports.HttpResult = createHTTPResult();
+exports.HttpResultUtils = void 0;
+function Accepted() {
+    return {
+        status: 202,
+    };
+}
+function BadRequest(error) {
+    return {
+        status: 400,
+        jsonBody: JSON.stringify(error)
+    };
+}
+exports.HttpResultUtils = { Accepted, BadRequest };

package/result/resultUtils.d.ts

@@ -26,4 +26,9 @@ export declare function toResult<T>(data: T): Result<T>;
 export declare function errorToErrorResult(error: Error): ErrorResult;
 export type ErrorName = "UnhandledError" | "Duplicate" | "NotFound" | "ApiError" | "ValidationError";
 export declare function toErrorResult(name: ErrorName, message: string, details?: Record<string, unknown>, code?: string, statusCode?: number): ErrorResult;
-export {};
+declare const ResultUtils: {
+    toResult: typeof toResult;
+    errorToErrorResult: typeof errorToErrorResult;
+    toErrorResult: typeof toErrorResult;
+};
+export { ResultUtils };

package/result/resultUtils.js

@@ -1,6 +1,7 @@
 "use strict";
 // ResultUtils type for consistent responses
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultUtils = void 0;
 exports.toResult = toResult;
 exports.errorToErrorResult = errorToErrorResult;
 exports.toErrorResult = toErrorResult;
@@ -24,6 +25,13 @@ function toErrorResult(name, message, details, code, statusCode) {
             code: code,
             details: details,
             statusCode: statusCode,
-            timestamp: (0, dateUtils_1.formatDateTime)(new Date())
+            timestamp: dateUtils_1.DateUtils.formatDateTime(new Date())
         } };
 }
+// Export everything as a single constant object
+const ResultUtils = {
+    toResult,
+    errorToErrorResult,
+    toErrorResult,
+};
+exports.ResultUtils = ResultUtils;

package/validation/validationUtils.d.ts

@@ -1,4 +1,23 @@
+import { z } from "zod";
+export declare const numberIdSchema: z.ZodObject<{
+    id: z.ZodEffects<z.ZodNumber, number, unknown>;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+}, {
+    id?: unknown;
+}>;
 export declare function formatZodErrorsToString(errors: {
     path: (string | number)[];
     message: string;
 }[]): string;
+declare const ValidationUtils: {
+    numberIdSchema: z.ZodObject<{
+        id: z.ZodEffects<z.ZodNumber, number, unknown>;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+    }, {
+        id?: unknown;
+    }>;
+    formatZodErrorsToString: typeof formatZodErrorsToString;
+};
+export { ValidationUtils };

package/validation/validationUtils.js

@@ -1,8 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationUtils = exports.numberIdSchema = void 0;
 exports.formatZodErrorsToString = formatZodErrorsToString;
+const zod_1 = require("zod");
+exports.numberIdSchema = zod_1.z.object({
+    id: zod_1.z.preprocess((val) => {
+        // Convert strings and numbers to a number
+        if (typeof val === 'string' || typeof val === 'number') {
+            return Number(val);
+        }
+        throw new Error("Unsupported type for id"); // Explicitly throw for unsupported types
+    }, zod_1.z.number().positive({
+        message: 'must be a positive number',
+    })),
+});
 function formatZodErrorsToString(errors) {
     return errors
         .map((err) => `${err.path.join(".")}: ${err.message}`)
         .join("\n");
 }
+const ValidationUtils = {
+    numberIdSchema: exports.numberIdSchema,
+    formatZodErrorsToString,
+};
+exports.ValidationUtils = ValidationUtils;

package/validation/numberIdSchema.d.ts

@@ -1,11 +0,0 @@
-import { z } from "zod";
-export declare const idSchema: z.ZodObject<{
-    id: z.ZodEffects<z.ZodNumber, number, unknown>;
-}, "strip", z.ZodTypeAny, {
-    id: number;
-}, {
-    id?: unknown;
-}>;
-export interface IdPayload {
-    id: number;
-}

package/validation/numberIdSchema.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.idSchema = void 0;
-const zod_1 = require("zod");
-exports.idSchema = zod_1.z.object({
-    id: zod_1.z.preprocess((val) => {
-        // Convert strings and numbers to a number
-        if (typeof val === 'string' || typeof val === 'number') {
-            return Number(val);
-        }
-        throw new Error("Unsupported type for id"); // Explicitly throw for unsupported types
-    }, zod_1.z.number().positive({
-        message: 'must be a positive number',
-    })),
-});