first commit

danielsum · danielsum · commit 5b7c40db29f7 · 2025-01-27T02:03:11.000+01:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,11 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "import/extensions": ["error", "always"] // Enforce explicit extensions
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
 .pnpm-debug.log*
+.idea
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
-# utils
-Lib Utils for your project
+# Up Utils
+
+A collection of TypeScript utility functions and helpers for Up Toolkit system.
+
+## Installation
+
+```bash
+npm i @uptoolkit/js-utils
+```
+
+## Usage
+
+You can use and import these functions into your own project. 
+
+````typescript
+import { uuid } from '@uptoolkit/js-utils';
+````
+
+## Functions
+
+- `uuid()`: Generate a random UUID.
+
+## License
+
+MIT
diff --git a/ignore_list.txt b/ignore_list.txt
@@ -0,0 +1,4 @@
+dist/*
+node_modules/*
+package-lock.json
+yarn.lock
diff --git a/jest.config.ts b/jest.config.ts
@@ -0,0 +1,11 @@
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/tests/**/*.test.ts'],
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov'],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1'
+  }
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,43 @@
+{
+  "name": "@uptoolkit/js-utils",
+  "version": "1.0.0",
+  "description": "Lib utils for your next project",
+  "author": "Daniel Sum <daniel@wearerebel.org>",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src --format esm,cjs --dts && tsc-alias",
+    "test": "ts-node -r tsconfig-paths/register node_modules/.bin/jest",
+    "format:check": "prettier --check .",
+    "format": "prettier --write .",
+    "test:watch": "jest --watch"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "prettier": "^3.4.2",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.10",
+    "tsconfig-paths": "^4.2.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "clsx": "^2.1.1",
+    "tailwind-merge": "^2.6.0",
+    "uuid": "^11.0.5"
+  },
+  "type": "module"
+}
diff --git a/prettier_config.json b/prettier_config.json
@@ -0,0 +1,10 @@
+{
+  "semi": true,                // Add a semicolon at the end of statements
+  "singleQuote": true,         // Use single quotes instead of double quotes
+  "trailingComma": "es5",      // Add trailing commas where possible (e.g., objects, arrays)
+  "tabWidth": 2,               // Indent with 2 spaces
+  "useTabs": false,            // Indent using spaces, not tabs
+  "arrowParens": "always",     // Always include parentheses for arrow functions
+  "bracketSpacing": true,      // Add spaces between brackets in object literals
+  "endOfLine": "lf"            // Enforce Unix-style line endings
+}
diff --git a/publish.sh b/publish.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# Run the build script
+echo "Building the package..."
+npm run build
+
+# Check if the build was successful
+if [ $? -ne 0 ]; then
+  echo "Build failed. Exiting."
+  exit 1
+fi
+
+# Publish the package
+echo "Publishing the package to npm..."
+npm publish
+
+# Check if publish was successful
+if [ $? -ne 0 ]; then
+  echo "Publish failed. Exiting."
+  exit 1
+fi
+
+echo "Package published successfully!"
diff --git a/src/core/index.ts b/src/core/index.ts
@@ -0,0 +1,17 @@
+// Fix an issue that might happend with the BigInt type
+// @ts-ignore
+if (typeof BigInt.prototype.toJSON === 'undefined') {
+    // @ts-ignore
+    BigInt.prototype.toJSON = function () {
+      return this.toString();
+    };
+  }
+
+  /**
+   * Return the Version of Up
+   * 
+   * @returns string
+   */
+  export function UpVersion(){
+    return process.env.UP_VERSION; 
+  }
diff --git a/src/date/humanDate.ts b/src/date/humanDate.ts
@@ -0,0 +1,7 @@
+export function humanizeDate(date: string) {
+    return (
+      new Date(date).toLocaleDateString() +
+      ' ' +
+      new Date(date).toLocaleTimeString()
+    );
+  }
diff --git a/src/date/index.ts b/src/date/index.ts
@@ -0,0 +1 @@
+export * from "./humanDate.js";
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,5 @@
+export * from "./core/index.js";
+export * from './str/index.js';
+export * from './date/index.js';
+export * from './mixins/index.js';
+export * from './types/index.js';
diff --git a/src/mixins/index.ts b/src/mixins/index.ts
@@ -0,0 +1,68 @@
+import { createMD5Hash } from "../str/index.js";
+
+// Define a type for the constructor
+type Constructor<T = {}> = new (...args: any[]) => T;
+
+// Create mixin functions that take a base class and return an extended class
+export function withFullName<TBase extends Constructor>(Base: TBase) {
+  return class extends Base {
+    firstName?: string;
+    lastName?: string;
+    email!: string;
+
+    getFullName(): string {
+      if (!this.firstName && !this.lastName) {
+        return this.email;
+      }
+
+      if (this.firstName && !this.lastName) {
+        return this.firstName;
+      }
+
+      if (!this.firstName && this.lastName) {
+        return this.lastName;
+      }
+
+      return `${this.firstName} ${this.lastName}`;
+    }
+
+    getFormattedFirstName(): string {
+      if (!this.firstName) return '';
+      return this.firstName.toLowerCase().replace(/^\w/, c => c.toUpperCase());
+    }
+
+    getFormattedLastName(): string {
+      if (!this.lastName) return '';
+      return this.lastName.toLowerCase().replace(/^\w/, c => c.toUpperCase());
+    }
+  };
+}
+
+export function withGravatar<TBase extends Constructor>(Base: TBase) {
+  return class extends Base {
+    email!: string;
+
+    getGravatar(
+      size: number = 80,
+      defaultImage: string = 'mm',
+      rating: string = 'g',
+      asImage: boolean = false,
+      imgAttributes: Record<string, string> = {},
+      alt: string = ''
+    ): string {
+      const email = this.email.toLowerCase().trim();
+      const hash = createMD5Hash(email);
+      const baseUrl = `https://www.gravatar.com/avatar/${hash}?s=${size}&d=${defaultImage}&r=${rating}`;
+
+      if (!asImage) {
+        return baseUrl;
+      }
+
+      const attributes = Object.entries(imgAttributes)
+        .map(([key, value]) => `${key}="${value}"`)
+        .join(' ');
+
+      return `<img alt={alt} src="${baseUrl}" className={}>`;
+    }
+  };
+}
diff --git a/src/str/cn.ts b/src/str/cn.ts
@@ -0,0 +1,13 @@
+import clsx from "clsx";
+import {ClassValue} from "clsx";
+import {twMerge} from "tailwind-merge";
+
+/**
+ * ClassName merging
+ *
+ * @param inputs
+ * @returns
+ */
+export function cn(...inputs: ClassValue[]) {
+    return twMerge(clsx(inputs));
+}
diff --git a/src/str/createMD5Hash.ts b/src/str/createMD5Hash.ts
@@ -0,0 +1,12 @@
+import { createHash } from 'crypto';
+
+/**
+ * Create MD5 hash from string
+ * @param str Input string to hash
+ * @returns MD5 hash string
+ */
+export function createMD5Hash(str: string): string {
+  return createHash('md5')
+    .update(str)
+    .digest('hex');
+}
diff --git a/src/str/createSlug.ts b/src/str/createSlug.ts
@@ -0,0 +1,8 @@
+export function createSlug(input: string): string {
+  return input
+    .trim()
+    .toLowerCase()
+    .replace(/[^\w\s-]/g, '') // Remove special characters
+    .replace(/\s+/g, '-') // Replace spaces with dashes
+    .replace(/-+/g, '-'); // Replace multiple dashes with single dash
+}
diff --git a/src/str/formatBytes.ts b/src/str/formatBytes.ts
@@ -0,0 +1,17 @@
+export function formatBytes(
+    bytes: number,
+    opts: {
+      decimals?: number;
+      sizeType?: 'accurate' | 'normal';
+    } = {}
+  ) {
+    const { decimals = 0, sizeType = 'normal' } = opts;
+  
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB'];
+    const accurateSizes = ['Bytes', 'KiB', 'MiB', 'GiB', 'TiB'];
+    if (bytes === 0) return '0 Byte';
+    const i = Math.floor(Math.log(bytes) / Math.log(1024));
+    return `${(bytes / Math.pow(1024, i)).toFixed(decimals)} ${
+      sizeType === 'accurate' ? accurateSizes[i] ?? 'Bytest' : sizes[i] ?? 'Bytes'
+    }`;
+  }
diff --git a/src/str/generateRandomString.ts b/src/str/generateRandomString.ts
@@ -0,0 +1,12 @@
+export function generateRandomString(length: number): string {
+    const characters =
+      'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    let result = '';
+  
+    for (let i = 0; i < length; i++) {
+      const randomIndex = Math.floor(Math.random() * characters.length);
+      result += characters.charAt(randomIndex);
+    }
+  
+    return result;
+}
diff --git a/src/str/index.ts b/src/str/index.ts
@@ -0,0 +1,5 @@
+export * from './uuid.js';
+export * from './generateRandomString.js';
+export * from './createSlug.js';
+export * from './cn.js';
+export * from './createMD5Hash.js';
diff --git a/src/str/uuid.ts b/src/str/uuid.ts
@@ -0,0 +1,5 @@
+import {v4} from "uuid";
+
+export function uuid() {
+    return v4();
+}
diff --git a/src/types/Team.ts b/src/types/Team.ts
@@ -0,0 +1,8 @@
+class BaseTeam<User> {
+    constructor(
+        public name: string,
+        public members: User[]
+    ) {}
+}
+
+
diff --git a/src/types/User.ts b/src/types/User.ts
diff --git a/src/types/index.ts b/src/types/index.ts
diff --git a/tests/str/createSlug.test.ts b/tests/str/createSlug.test.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tsup.config.ts b/tsup.config.ts
diff --git a/yarn.lock b/yarn.lock
