@leancodepl/api-date-utils 8.5.0 → 8.6.0

package/README.md

@@ -0,0 +1,64 @@
+# @leancodepl/api-date-utils
+
+Utilities for parsing and working with API date types.
+
+## Installation
+
+```bash
+npm install @leancodepl/api-date-utils
+# or
+yarn add @leancodepl/api-date-utils
+```
+
+## API
+
+### `parseApiTimeSpan(timespan)`
+
+Parses ApiTimeSpan string into structured time components.
+
+**Parameters:**
+
+- `timespan: ApiTimeSpan` - The ApiTimeSpan string to parse
+
+**Returns:** Object with sign and time component values
+
+## Usage Examples
+
+### Basic Parsing
+
+```typescript
+import { parseApiTimeSpan } from "@leancodepl/api-date-utils"
+
+const result = parseApiTimeSpan("1.23:45:67.890")
+console.log(result.values.hours) // 23
+console.log(result.values.days) // 1
+console.log(result.sign) // undefined (positive)
+```
+
+### Negative TimeSpan
+
+```typescript
+import { parseApiTimeSpan } from "@leancodepl/api-date-utils"
+
+const result = parseApiTimeSpan("-2.10:30:45.123")
+console.log(result.sign) // '-'
+console.log(result.values.days) // 2
+console.log(result.values.hours) // 10
+console.log(result.values.minutes) // 30
+console.log(result.values.milliseconds) // 123
+```
+
+### Duration Calculations
+
+```typescript
+import { parseApiTimeSpan } from "@leancodepl/api-date-utils"
+
+const calculateTotalMilliseconds = (timespan: ApiTimeSpan) => {
+    const parsed = parseApiTimeSpan(timespan)
+    const { days, hours, minutes, seconds, milliseconds } = parsed.values
+
+    const total = days * 86400000 + hours * 3600000 + minutes * 60000 + seconds * 1000 + milliseconds
+
+    return parsed.sign === "-" ? -total : total
+}
+```

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const parseIntMatched = (value)=>parseInt(value != null ? value : "0");
+/**
+ * Parses ApiTimeSpan string into structured time components.
+ * 
+ * Extracts sign, days, hours, minutes, seconds, and milliseconds from
+ * ApiTimeSpan string format using regex pattern matching.
+ * 
+ * @param timespan - The ApiTimeSpan string to parse
+ * @returns Object with sign and time component values
+ * @example
+ * ```typescript
+ * const result = parseApiTimeSpan('1.23:45:67.890');
+ * console.log(result.values.hours); // 23
+ * ```
+ */ function parseApiTimeSpan(timespan) {
+    /**
+     * This regex returns tuple of matched strings (either of string type or undefined) and default match function parameters
+     * following [timeSpan, sign, days, hours, minutes, seconds, milliseconds, index of search at which the result was found, input (search string), groups] schema
+     */ const matched = timespan.match(/^(-)?([0-9]+)?\.?([0-9]{2}):([0-9]{2}):([0-9]{2})\.?([0-9]{3})?$/);
+    return {
+        sign: matched == null ? void 0 : matched[1],
+        values: {
+            days: parseIntMatched(matched == null ? void 0 : matched[2]),
+            hours: parseIntMatched(matched == null ? void 0 : matched[3]),
+            minutes: parseIntMatched(matched == null ? void 0 : matched[4]),
+            seconds: parseIntMatched(matched == null ? void 0 : matched[5]),
+            milliseconds: parseIntMatched(matched == null ? void 0 : matched[6])
+        }
+    };
+}
+
+exports.parseApiTimeSpan = parseApiTimeSpan;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.esm.js

@@ -0,0 +1,32 @@
+const parseIntMatched = (value)=>parseInt(value != null ? value : "0");
+/**
+ * Parses ApiTimeSpan string into structured time components.
+ * 
+ * Extracts sign, days, hours, minutes, seconds, and milliseconds from
+ * ApiTimeSpan string format using regex pattern matching.
+ * 
+ * @param timespan - The ApiTimeSpan string to parse
+ * @returns Object with sign and time component values
+ * @example
+ * ```typescript
+ * const result = parseApiTimeSpan('1.23:45:67.890');
+ * console.log(result.values.hours); // 23
+ * ```
+ */ function parseApiTimeSpan(timespan) {
+    /**
+     * This regex returns tuple of matched strings (either of string type or undefined) and default match function parameters
+     * following [timeSpan, sign, days, hours, minutes, seconds, milliseconds, index of search at which the result was found, input (search string), groups] schema
+     */ const matched = timespan.match(/^(-)?([0-9]+)?\.?([0-9]{2}):([0-9]{2}):([0-9]{2})\.?([0-9]{3})?$/);
+    return {
+        sign: matched == null ? void 0 : matched[1],
+        values: {
+            days: parseIntMatched(matched == null ? void 0 : matched[2]),
+            hours: parseIntMatched(matched == null ? void 0 : matched[3]),
+            minutes: parseIntMatched(matched == null ? void 0 : matched[4]),
+            seconds: parseIntMatched(matched == null ? void 0 : matched[5]),
+            milliseconds: parseIntMatched(matched == null ? void 0 : matched[6])
+        }
+    };
+}
+
+export { parseApiTimeSpan };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@leancodepl/api-date-utils",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "license": "Apache-2.0",
   "dependencies": {
-    "@leancodepl/api-date": "8.5.0"
+    "@leancodepl/api-date": "8.6.0"
   },
   "publishConfig": {
     "access": "public",
@@ -36,11 +36,6 @@
     "name": "LeanCode",
     "url": "https://leancode.co"
   },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md"
-  ],
   "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib/parseApiTimeSpan";

package/src/lib/parseApiTimeSpan.d.ts

@@ -0,0 +1,25 @@
+import type { ApiTimeSpan } from "@leancodepl/api-date";
+/**
+ * Parses ApiTimeSpan string into structured time components.
+ *
+ * Extracts sign, days, hours, minutes, seconds, and milliseconds from
+ * ApiTimeSpan string format using regex pattern matching.
+ *
+ * @param timespan - The ApiTimeSpan string to parse
+ * @returns Object with sign and time component values
+ * @example
+ * ```typescript
+ * const result = parseApiTimeSpan('1.23:45:67.890');
+ * console.log(result.values.hours); // 23
+ * ```
+ */
+export declare function parseApiTimeSpan(timespan: ApiTimeSpan): {
+    sign: any;
+    values: {
+        days: number;
+        hours: number;
+        minutes: number;
+        seconds: number;
+        milliseconds: number;
+    };
+};