@dexyn/common-library 1.0.2 → 1.0.3

package/.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Build and Publish to NPM
+
+on:
+  push:
+    branches:
+      - master  # Trigger on pushes to the `main` branch
+  workflow_dispatch: # Allow manual triggering
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Step 1: Check out the code
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Step 2: Set up Node.js
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'  # Specify Node.js version
+          registry-url: 'https://registry.npmjs.org/'
+
+      # Step 3: Install dependencies
+      - name: Install dependencies
+        run: npm ci
+
+      # Step 4: Build the library
+      - name: Build the library
+        run: npm run build
+
+      # Step 5: Publish to NPM
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/package.json

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

package/package/dist/date/dateUtils.d.ts

@@ -1,11 +0,0 @@
-/**
- * Formats a date as a time string.
- * @param date The `Date` object to format.
- * @param locale The locale for formatting. Defaults to "en-US".
- * @param options Additional time formatting options.
- * @returns The formatted time string.
- * @example
- * 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;

package/package/dist/date/dateUtils.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatDateTime = formatDateTime;
-/**
- * Formats a date as a time string.
- * @param date The `Date` object to format.
- * @param locale The locale for formatting. Defaults to "en-US".
- * @param options Additional time formatting options.
- * @returns The formatted time string.
- * @example
- * DateFormatter.formatTime(new Date("2024-12-03T10:30:00"), "en-US", { hour: "2-digit", minute: "2-digit" });
- * // Output: "10:30 AM"
- */
-function formatDateTime(date, locale = "en-US", options = { hour: "numeric", minute: "numeric", second: "numeric" }) {
-    return new Intl.DateTimeFormat(locale, options).format(date);
-}

package/package/dist/result/httpResultUtils.d.ts

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

package/package/dist/result/httpResultUtils.js

@@ -1,18 +0,0 @@
-"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();

package/package/dist/result/resultUtils.d.ts

@@ -1,29 +0,0 @@
-type SuccessResult<T> = {
-    success: true;
-    data: T;
-};
-export type ErrorResult = {
-    success: false;
-    error: StandardError;
-};
-export interface StandardError {
-    name: string;
-    message: string;
-    code?: string;
-    statusCode?: number;
-    details?: Record<string, unknown>;
-    timestamp?: string;
-    stack?: string;
-}
-export type Result<T> = SuccessResult<T> | ErrorResult;
-/**
- * Converts a promise into a ResultUtils type, wrapping its success and error outcomes.
- *
- * @param data - Data to be wrapped in ResultUtils type
- * @returns A ResultUtils<T, E> representing the outcome of the promise.
- */
-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 {};

package/package/dist/result/resultUtils.js

@@ -1,29 +0,0 @@
-"use strict";
-// ResultUtils type for consistent responses
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toResult = toResult;
-exports.errorToErrorResult = errorToErrorResult;
-exports.toErrorResult = toErrorResult;
-const dateUtils_1 = require("../date/dateUtils");
-/**
- * Converts a promise into a ResultUtils type, wrapping its success and error outcomes.
- *
- * @param data - Data to be wrapped in ResultUtils type
- * @returns A ResultUtils<T, E> representing the outcome of the promise.
- */
-function toResult(data) {
-    return { success: true, data: data };
-}
-function errorToErrorResult(error) {
-    return { success: false, error: error };
-}
-function toErrorResult(name, message, details, code, statusCode) {
-    return { success: false, error: {
-            name: name,
-            message: message,
-            code: code,
-            details: details,
-            statusCode: statusCode,
-            timestamp: (0, dateUtils_1.formatDateTime)(new Date())
-        } };
-}

package/package/dist/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/package/dist/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',
-    })),
-});

package/package/dist/validation/validationUtils.d.ts

@@ -1,4 +0,0 @@
-export declare function formatZodErrorsToString(errors: {
-    path: (string | number)[];
-    message: string;
-}[]): string;

package/package/dist/validation/validationUtils.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatZodErrorsToString = formatZodErrorsToString;
-function formatZodErrorsToString(errors) {
-    return errors
-        .map((err) => `${err.path.join(".")}: ${err.message}`)
-        .join("\n");
-}