@agranom/boykom-common 1.0.0

package/README.md

@@ -0,0 +1,46 @@
+# Boykom Common Library
+
+A shared library containing reusable utilities, enums, models, and constants for Boykom projects.
+
+## Installation
+
+```bash
+npm install @agranom/boykom-common
+```
+
+## Usage
+
+```typescript
+// Import specific utilities, enums, models, or constants
+import { capitalizeFirstLetter, truncateString } from '@agranom/boykom-common';
+
+// Use imported items
+const capitalized = capitalizeFirstLetter('hello');
+const truncated = truncateString('This is a long text', 10);
+```
+
+## Development
+
+### Setup
+
+```bash
+# Install dependencies
+npm install
+
+# Build the library
+npm run build
+```
+
+### Publishing
+
+```bash
+# Login to npm (if not already logged in)
+npm login
+
+# Publish the package
+npm publish
+```
+
+## License
+
+MIT

package/dist/constants/api.constants.d.ts

@@ -0,0 +1,25 @@
+/**
+ * API constants
+ */
+/**
+ * API endpoints
+ */
+export declare const API_ENDPOINTS: {
+    readonly AUTH: {
+        readonly LOGIN: "/auth/login";
+        readonly REGISTER: "/auth/register";
+        readonly LOGOUT: "/auth/logout";
+    };
+    readonly USER: {
+        readonly PROFILE: "/user/profile";
+        readonly UPDATE: "/user/update";
+    };
+    readonly GROCERY: {
+        readonly LIST: "/grocery/list";
+        readonly ITEM: "/grocery/item";
+    };
+    readonly RECIPE: {
+        readonly LIST: "/recipe/list";
+        readonly ITEM: "/recipe/item";
+    };
+};

package/dist/constants/api.constants.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * API constants
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_ENDPOINTS = void 0;
+/**
+ * API endpoints
+ */
+exports.API_ENDPOINTS = {
+    AUTH: {
+        LOGIN: '/auth/login',
+        REGISTER: '/auth/register',
+        LOGOUT: '/auth/logout',
+    },
+    USER: {
+        PROFILE: '/user/profile',
+        UPDATE: '/user/update',
+    },
+    GROCERY: {
+        LIST: '/grocery/list',
+        ITEM: '/grocery/item',
+    },
+    RECIPE: {
+        LIST: '/recipe/list',
+        ITEM: '/recipe/item',
+    },
+};

package/dist/constants/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Constants for Boykom projects
+ */
+export * from './api.constants';

package/dist/constants/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Constants for Boykom projects
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api.constants"), exports);

package/dist/enums/app-routes.enum.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Application routes enum
+ */
+export declare enum AppRoutes {
+    HOME = "/",
+    LOGIN = "/login",
+    REGISTER = "/register",
+    PROFILE = "/profile",
+    SETTINGS = "/settings",
+    GROCERY = "/grocery",
+    RECIPE = "/recipe"
+}

package/dist/enums/app-routes.enum.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppRoutes = void 0;
+/**
+ * Application routes enum
+ */
+var AppRoutes;
+(function (AppRoutes) {
+    AppRoutes["HOME"] = "/";
+    AppRoutes["LOGIN"] = "/login";
+    AppRoutes["REGISTER"] = "/register";
+    AppRoutes["PROFILE"] = "/profile";
+    AppRoutes["SETTINGS"] = "/settings";
+    AppRoutes["GROCERY"] = "/grocery";
+    AppRoutes["RECIPE"] = "/recipe";
+})(AppRoutes || (exports.AppRoutes = AppRoutes = {}));

package/dist/enums/grocery-event-types.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum GroceryEventTypes {
+    Add = 1,
+    Move = 2,
+    Delete = 3
+}

package/dist/enums/grocery-event-types.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroceryEventTypes = void 0;
+var GroceryEventTypes;
+(function (GroceryEventTypes) {
+    GroceryEventTypes[GroceryEventTypes["Add"] = 1] = "Add";
+    GroceryEventTypes[GroceryEventTypes["Move"] = 2] = "Move";
+    GroceryEventTypes[GroceryEventTypes["Delete"] = 3] = "Delete";
+})(GroceryEventTypes || (exports.GroceryEventTypes = GroceryEventTypes = {}));

package/dist/enums/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Enums for Boykom projects
+ */
+export * from './grocery-event-types.enum';

package/dist/enums/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Enums for Boykom projects
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./grocery-event-types.enum"), exports);

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Boykom Common Library
+ *
+ * This library contains reusable utilities, enums, models, and constants
+ * for Boykom projects.
+ */
+export * from './utils';
+export * from './enums';

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * Boykom Common Library
+ *
+ * This library contains reusable utilities, enums, models, and constants
+ * for Boykom projects.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Re-export all modules
+__exportStar(require("./utils"), exports);
+__exportStar(require("./enums"), exports);

package/dist/models/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Models for Boykom projects
+ */
+export * from './user.model';

package/dist/models/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Models for Boykom projects
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./user.model"), exports);

package/dist/models/user.model.d.ts

@@ -0,0 +1,23 @@
+/**
+ * User model
+ */
+/**
+ * User interface representing a user in the system
+ */
+export interface User {
+    id: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * User creation data interface
+ */
+export interface CreateUserData {
+    email: string;
+    firstName: string;
+    lastName: string;
+    password: string;
+}

package/dist/models/user.model.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * User model
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Utility functions for Boykom projects
+ */
+export * from './retry.util';

package/dist/utils/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Utility functions for Boykom projects
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./retry.util"), exports);

package/dist/utils/retry.util.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Options for configuring the retry behavior
+ */
+export interface RetryOptions {
+    /** Maximum number of retry attempts */
+    maxAttempts?: number;
+    /** Delay between retries in milliseconds */
+    delayMs?: number;
+    /** Whether to use exponential backoff for delays (doubles delay each retry) */
+    useExponentialBackoff?: boolean;
+    /** Function to call on each retry attempt */
+    onRetry?: (error: any, attempt: number) => void;
+}
+/**
+ * Executes an async function and retries it up to N times until it succeeds
+ *
+ * @param fn - Async function to execute
+ * @param options - Retry options
+ * @returns Promise with the result of the function
+ * @throws The last error encountered if all retry attempts fail
+ */
+export declare function retry<T>(fn: () => Promise<T>, options: RetryOptions): Promise<T>;

package/dist/utils/retry.util.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retry = retry;
+/**
+ * Executes an async function and retries it up to N times until it succeeds
+ *
+ * @param fn - Async function to execute
+ * @param options - Retry options
+ * @returns Promise with the result of the function
+ * @throws The last error encountered if all retry attempts fail
+ */
+async function retry(fn, options) {
+    const { maxAttempts = 3, delayMs = 1000, useExponentialBackoff = false, onRetry } = options;
+    let lastError;
+    for (let attempt = 1; attempt <= maxAttempts; attempt++) {
+        try {
+            return await fn();
+        }
+        catch (error) {
+            lastError = error;
+            if (attempt < maxAttempts) {
+                if (onRetry) {
+                    onRetry(error, attempt);
+                }
+                const currentDelay = useExponentialBackoff ? delayMs * Math.pow(2, attempt - 1) : delayMs;
+                await new Promise((resolve) => setTimeout(resolve, currentDelay));
+            }
+        }
+    }
+    throw lastError;
+}

package/dist/utils/string.util.d.ts

@@ -0,0 +1,16 @@
+/**
+ * String utility functions
+ */
+/**
+ * Capitalizes the first letter of a string
+ * @param str - The string to capitalize
+ * @returns The capitalized string
+ */
+export declare function capitalizeFirstLetter(str: string): string;
+/**
+ * Truncates a string to a specified length and adds an ellipsis if truncated
+ * @param str - The string to truncate
+ * @param maxLength - The maximum length of the string
+ * @returns The truncated string
+ */
+export declare function truncateString(str: string, maxLength: number): string;

package/dist/utils/string.util.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * String utility functions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capitalizeFirstLetter = capitalizeFirstLetter;
+exports.truncateString = truncateString;
+/**
+ * Capitalizes the first letter of a string
+ * @param str - The string to capitalize
+ * @returns The capitalized string
+ */
+function capitalizeFirstLetter(str) {
+    if (!str || str.length === 0) {
+        return str;
+    }
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+/**
+ * Truncates a string to a specified length and adds an ellipsis if truncated
+ * @param str - The string to truncate
+ * @param maxLength - The maximum length of the string
+ * @returns The truncated string
+ */
+function truncateString(str, maxLength) {
+    if (!str || str.length <= maxLength) {
+        return str;
+    }
+    return str.slice(0, maxLength) + '...';
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@agranom/boykom-common",
+  "version": "1.0.0",
+  "description": "Boykom Common Library",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "lint": "eslint --ext .ts src",
+    "clean": "rimraf dist",
+    "setup": "node install.js"
+  },
+  "keywords": [
+    "boykom",
+    "utils",
+    "common"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/agranom/boykom-common"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.11",
+    "@typescript-eslint/eslint-plugin": "^5.57.1",
+    "@typescript-eslint/parser": "^5.57.1",
+    "eslint": "^8.38.0",
+    "jest": "^29.5.0",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
+  }
+}