@zauru-sdk/common 1.0.120 → 2.0.1

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.1](https://github.com/intuitiva/zauru-typescript-sdk/compare/v2.0.0...v2.0.1) (2024-09-27)
+
+**Note:** Version bump only for package @zauru-sdk/common
+
+
+
+
+
+# [2.0.0](https://github.com/intuitiva/zauru-typescript-sdk/compare/v1.0.120...v2.0.0) (2024-09-27)
+
+**Note:** Version bump only for package @zauru-sdk/common
+
+
+
+
+
 ## [1.0.120](https://github.com/intuitiva/zauru-typescript-sdk/compare/v1.0.119...v1.0.120) (2024-09-26)
 
 **Note:** Version bump only for package @zauru-sdk/common

package/dist/common.d.ts

@@ -163,3 +163,40 @@ export declare function calculateTimeDifference(timestamp: string): {
     minutes: number;
     label: string;
 };
+/**
+ * Creates a unique code with a compact date format in uppercase.
+ *
+ * @param {string | null} suffix - An optional prefix to add to the code.
+ * @returns {string} A unique code consisting of a timestamp and an optional suffix.
+ *
+ * @example
+ * // Without suffix
+ * createCode(null); // Returns something like "1A2B3C4D"
+ *
+ * @example
+ * // With suffix
+ * createCode("INV"); // Returns something like "INV-1A2B3C4D"
+ */
+export declare function createCode(suffix: string | null): string;
+/**
+ * Parses a code generated by createCode function to extract its components.
+ *
+ * @param {string} code - The code to parse.
+ * @returns {Object} An object containing the parsed date and suffix (if any).
+ * @property {Date} date - The date represented by the timestamp in the code.
+ * @property {string | null} suffix - The suffix of the code, if present; otherwise null.
+ *
+ * @example
+ * // Parsing a code without suffix
+ * parseCode("1A2B3C4D");
+ * // Returns { date: Date object, suffix: null }
+ *
+ * @example
+ * // Parsing a code with suffix
+ * parseCode("INV-1A2B3C4D");
+ * // Returns { date: Date object, suffix: "INV" }
+ */
+export declare function parseCode(code: string): {
+    date: Date;
+    suffix: string | null;
+};

package/dist/esm/common.js

@@ -20,6 +20,8 @@ exports.capitalLetter = capitalLetter;
 exports.handlePossibleAxiosErrors = handlePossibleAxiosErrors;
 exports.createPostgresUrl = createPostgresUrl;
 exports.calculateTimeDifference = calculateTimeDifference;
+exports.createCode = createCode;
+exports.parseCode = parseCode;
 const moment_1 = __importDefault(require("moment"));
 require("moment-timezone");
 const types_1 = require("@zauru-sdk/types");
@@ -601,3 +603,53 @@ function calculateTimeDifference(timestamp) {
         label: `${hours > 0 ? `${hours} ${hours > 1 ? "horas" : "hora"}` : ""}${hours > 0 && minutes > 0 ? " y " : ""}${minutes > 0 ? `${minutes} ${minutes > 1 ? "minutos" : "minuto"}` : ""}.`,
     };
 }
+/**
+ * Creates a unique code with a compact date format in uppercase.
+ *
+ * @param {string | null} suffix - An optional prefix to add to the code.
+ * @returns {string} A unique code consisting of a timestamp and an optional suffix.
+ *
+ * @example
+ * // Without suffix
+ * createCode(null); // Returns something like "1A2B3C4D"
+ *
+ * @example
+ * // With suffix
+ * createCode("INV"); // Returns something like "INV-1A2B3C4D"
+ */
+function createCode(suffix) {
+    const timestamp = Math.floor(Date.now() / 1000)
+        .toString(36)
+        .toUpperCase(); // Timestamp in base 36 and converted to uppercase
+    const code = `${timestamp}`;
+    return suffix ? `${suffix}-${code}` : code;
+}
+/**
+ * Parses a code generated by createCode function to extract its components.
+ *
+ * @param {string} code - The code to parse.
+ * @returns {Object} An object containing the parsed date and suffix (if any).
+ * @property {Date} date - The date represented by the timestamp in the code.
+ * @property {string | null} suffix - The suffix of the code, if present; otherwise null.
+ *
+ * @example
+ * // Parsing a code without suffix
+ * parseCode("1A2B3C4D");
+ * // Returns { date: Date object, suffix: null }
+ *
+ * @example
+ * // Parsing a code with suffix
+ * parseCode("INV-1A2B3C4D");
+ * // Returns { date: Date object, suffix: "INV" }
+ */
+function parseCode(code) {
+    // Check if the code has a suffix
+    const hasSuffix = code.includes("-") && isNaN(Number(code.split("-")[0]));
+    const [suffixOrTimestamp, timestamp] = code.split("-");
+    const dateTimestamp = hasSuffix ? timestamp : suffixOrTimestamp;
+    const date = new Date(parseInt(dateTimestamp, 36) * 1000); // Convert the timestamp back to milliseconds
+    return {
+        date: date,
+        suffix: hasSuffix ? suffixOrTimestamp : null, // Only return the suffix if it exists
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zauru-sdk/common",
-  "version": "1.0.120",
+  "version": "2.0.1",
   "description": "Funciones de uso común en el desarrollo de webapps en Zauru",
   "main": "./dist/esm/index.js",
   "module": "./dist/esm/index.js",
@@ -20,9 +20,9 @@
   },
   "dependencies": {
     "@remix-run/node": "^2.8.1",
-    "@zauru-sdk/types": "^1.0.120",
+    "@zauru-sdk/types": "^2.0.0",
     "moment": "^2.30.1",
     "moment-timezone": "^0.5.45"
   },
-  "gitHead": "5c8b84d1723fc1342ecd45b49df51d4d96682f75"
+  "gitHead": "fb18e2974e5ec5a211f60966948ece0e8d902547"
 }

package/src/common.ts

@@ -684,3 +684,58 @@ export function calculateTimeDifference(timestamp: string): {
     }${minutes > 0 ? `${minutes} ${minutes > 1 ? "minutos" : "minuto"}` : ""}.`,
   };
 }
+
+/**
+ * Creates a unique code with a compact date format in uppercase.
+ *
+ * @param {string | null} suffix - An optional prefix to add to the code.
+ * @returns {string} A unique code consisting of a timestamp and an optional suffix.
+ *
+ * @example
+ * // Without suffix
+ * createCode(null); // Returns something like "1A2B3C4D"
+ *
+ * @example
+ * // With suffix
+ * createCode("INV"); // Returns something like "INV-1A2B3C4D"
+ */
+export function createCode(suffix: string | null): string {
+  const timestamp = Math.floor(Date.now() / 1000)
+    .toString(36)
+    .toUpperCase(); // Timestamp in base 36 and converted to uppercase
+  const code = `${timestamp}`;
+
+  return suffix ? `${suffix}-${code}` : code;
+}
+
+/**
+ * Parses a code generated by createCode function to extract its components.
+ *
+ * @param {string} code - The code to parse.
+ * @returns {Object} An object containing the parsed date and suffix (if any).
+ * @property {Date} date - The date represented by the timestamp in the code.
+ * @property {string | null} suffix - The suffix of the code, if present; otherwise null.
+ *
+ * @example
+ * // Parsing a code without suffix
+ * parseCode("1A2B3C4D");
+ * // Returns { date: Date object, suffix: null }
+ *
+ * @example
+ * // Parsing a code with suffix
+ * parseCode("INV-1A2B3C4D");
+ * // Returns { date: Date object, suffix: "INV" }
+ */
+export function parseCode(code: string) {
+  // Check if the code has a suffix
+  const hasSuffix = code.includes("-") && isNaN(Number(code.split("-")[0]));
+  const [suffixOrTimestamp, timestamp] = code.split("-");
+
+  const dateTimestamp = hasSuffix ? timestamp : suffixOrTimestamp;
+  const date = new Date(parseInt(dateTimestamp, 36) * 1000); // Convert the timestamp back to milliseconds
+
+  return {
+    date: date,
+    suffix: hasSuffix ? suffixOrTimestamp : null, // Only return the suffix if it exists
+  };
+}