@togatherlabs/shared-utils 1.0.0

package/README.md

@@ -0,0 +1 @@
+# togather-shared-utils

package/dist/commitlint.config.d.ts

@@ -0,0 +1,3 @@
+import type { UserConfig } from '@commitlint/types';
+declare const config: UserConfig;
+export default config;

package/dist/commitlint.config.js

@@ -0,0 +1,91 @@
+// This config follows the project guidelines
+// (https://docs.google.com/document/d/1psbMtN-PIF4oBbNc_pW_mtDPPAa_yPdV_apf-wq5spM/edit?tab=t.0)
+const config = {
+    extends: ['@commitlint/config-conventional'],
+    rules: {
+        'scope-empty': [2, 'never'],
+        'scope-max-length': [2, 'always', 20],
+        // Subject rules
+        'subject-max-length': [2, 'always', 50],
+        'subject-case': [2, 'always', 'sentence-case'],
+        'subject-full-stop': [2, 'never', '.'],
+        // Body rules
+        'body-empty': [0],
+        'body-max-line-length': [2, 'always', 72],
+        // Footer (optional)
+        'footer-max-line-length': [2, 'always', 72],
+    },
+    prompt: {
+        settings: {
+            enableMultipleScopes: false,
+        },
+        messages: {
+            skip: ':skip (press enter to skip)',
+            max: 'Max %d characters',
+            min: 'Min %d characters',
+            emptyWarning: 'This field cannot be empty',
+            upperLimitWarning: 'Character limit exceeded',
+            lowerLimitWarning: 'Too few characters',
+        },
+        questions: {
+            type: {
+                description: "Select the type of change you're committing:",
+                enum: {
+                    feat: {
+                        description: '✨ A new feature',
+                        title: 'Feature',
+                        emoji: '✨',
+                    },
+                    fix: {
+                        description: '🐛 A bug fix',
+                        title: 'Bug Fix',
+                        emoji: '🐛',
+                    },
+                    docs: {
+                        description: '📚 Documentation only changes',
+                        title: 'Documentation',
+                        emoji: '📚',
+                    },
+                    style: {
+                        description: '💅 Changes that do not affect code meaning (formatting, etc.)',
+                        title: 'Style',
+                        emoji: '💅',
+                    },
+                    refactor: {
+                        description: '🔧 Code change that neither fixes a bug nor adds a feature',
+                        title: 'Refactor',
+                        emoji: '🔧',
+                    },
+                    test: {
+                        description: '✅ Adding or updating tests',
+                        title: 'Test',
+                        emoji: '✅',
+                    },
+                    chore: {
+                        description: '🛠  Maintenance tasks (e.g., tooling, dependencies)',
+                        title: 'Chore',
+                        emoji: '🛠',
+                    },
+                    perf: { description: '⚡ Performance improvement', title: 'Performance', emoji: '⚡' },
+                    build: {
+                        description: '🏗 Build system or dependency changes',
+                        title: 'Build',
+                        emoji: '🏗',
+                    },
+                    ci: { description: '🔁 CI/CD configuration', title: 'CI', emoji: '🔁' },
+                    revert: { description: '⏪ Reverts a previous commit', title: 'Revert', emoji: '⏪' },
+                },
+            },
+            scope: {
+                description: 'Scope of this change (e.g., auth, ui, api)',
+            },
+            subject: {
+                description: 'Write a short, imperative description (max 50 chars, e.g., Add login validation)',
+            },
+            body: {
+                description: 'Provide a detailed description of what changed, why, and how (optional)',
+            },
+        },
+    },
+};
+export default config;

package/dist/src/constants/index.d.ts

@@ -0,0 +1 @@
+export * from './sample';

package/dist/src/constants/index.js

@@ -0,0 +1 @@
+export * from './sample';

package/dist/src/constants/sample.d.ts

@@ -0,0 +1,3 @@
+export declare const SAMPLE: {
+    Char: string;
+};

package/dist/src/constants/sample.js

@@ -0,0 +1,3 @@
+export const SAMPLE = {
+    Char: 'A'
+};

package/dist/src/helpers/formatDate.d.ts

@@ -0,0 +1 @@
+export declare function formatDate(date: Date, locale?: string): string;

package/dist/src/helpers/formatDate.js

@@ -0,0 +1,10 @@
+export function formatDate(date, locale = 'en-IN') {
+    if (!(date instanceof Date) || isNaN(date.getTime())) {
+        throw new Error('Invalid Date');
+    }
+    return date.toLocaleDateString(locale, {
+        year: 'numeric',
+        month: 'short',
+        day: 'numeric',
+    });
+}

package/dist/src/helpers/index.d.ts

@@ -0,0 +1 @@
+export * from './formatDate';

package/dist/src/helpers/index.js

@@ -0,0 +1 @@
+export * from './formatDate';

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './helpers';
+export * from './constants';
+export * from './types';

package/dist/src/index.js

@@ -0,0 +1,3 @@
+export * from './helpers';
+export * from './constants';
+export * from './types';

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

@@ -0,0 +1 @@
+export * from './user';

package/dist/src/types/index.js

@@ -0,0 +1 @@
+export * from './user';

package/dist/src/types/user.d.ts

@@ -0,0 +1,5 @@
+export interface UserDTO {
+    id: string;
+    name: string;
+    email: string;
+}

package/dist/src/types/user.js

@@ -0,0 +1 @@
+export {};

package/dist/tests/unit/constants/sample.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/unit/constants/sample.test.js

@@ -0,0 +1,7 @@
+import { describe, it, expect } from 'vitest';
+import * as constants from '../../../src/constants/sample';
+describe('sample constants', () => {
+    it('should export constants correctly', () => {
+        expect(constants).toBeDefined();
+    });
+});

package/dist/tests/unit/helpers/formatDate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/unit/helpers/formatDate.test.js

@@ -0,0 +1,18 @@
+import { describe, it, expect } from 'vitest';
+import { formatDate } from '../../../src/helpers/formatDate';
+describe('formatDate helper', () => {
+    it('should format a valid date correctly', () => {
+        const date = new Date('2025-10-14T00:00:00Z');
+        const formatted = formatDate(date);
+        expect(formatted).toBe('14 Oct 2025');
+    });
+    it('should format date in custom locale', () => {
+        const date = new Date('2025-10-14T00:00:00Z');
+        const formatted = formatDate(date, 'en-US');
+        expect(formatted).toMatch(/Oct/);
+    });
+    it('should throw an error for invalid date', () => {
+        // @ts-expect-error testing invalid date
+        expect(() => formatDate('not-a-date')).toThrowError('Invalid Date');
+    });
+});

package/dist/tests/unit/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/unit/index.test.js

@@ -0,0 +1,8 @@
+import { describe, it, expect } from 'vitest';
+import * as utils from '../../src';
+describe('index.ts', () => {
+    it('should export all modules correctly', () => {
+        expect(utils).toBeDefined();
+        expect(utils.formatDate).toBeInstanceOf(Function); // Example for a helper
+    });
+});

package/dist/vitest.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/dist/vitest.config.js

@@ -0,0 +1,17 @@
+import { defineConfig } from "vitest/config";
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: "node",
+        coverage: {
+            provider: "v8",
+            reporter: ["text", "json", "html"],
+            exclude: [
+                "**/node_modules/**",
+                "**/dist/**",
+                "**/*.config.*",
+                "**/commitlint.*", // Exclude config files
+            ],
+        },
+    },
+});

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@togatherlabs/shared-utils",
+  "version": "1.0.0",
+  "description": "Shared utility functions, constants, and types for ToGather microservices",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "shared",
+    "utils",
+    "togather",
+    "microservices"
+  ],
+  "author": "toGather team",
+  "license": "ISC",
+  "devDependencies": {
+    "@biomejs/biome": "^2.2.6",
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
+    "@commitlint/cz-commitlint": "^20.1.0",
+    "@commitlint/types": "^20.0.0",
+    "@types/node": "^24.7.2",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/ui": "^3.2.4",
+    "commitizen": "^4.3.1",
+    "husky": "^9.1.7",
+    "inquirer": "^9.3.8",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/cz-commitlint"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "format": "biome format .",
+    "format:fix": "biome format --write .",
+    "check": "biome check .",
+    "check:fix": "biome check --write .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui",
+    "commit": "git-cz",
+    "package:patch": "pnpm version patch",
+    "package:publish": "pnpm publish --access public",
+    "release": "pnpm build && git add . && pnpm commit && pnpm package:patch && git push --follow-tags && pnpm package:publish"
+  }
+}