@leancodepl/api-date-utils 8.4.0 → 8.5.1

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.js

@@ -1,7 +1,20 @@
 'use strict';
 
 const parseIntMatched = (value)=>parseInt(value != null ? value : "0");
-function parseApiTimeSpan(timespan) {
+/**
+ * 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

package/index.esm.js

@@ -1,5 +1,18 @@
 const parseIntMatched = (value)=>parseInt(value != null ? value : "0");
-function parseApiTimeSpan(timespan) {
+/**
+ * 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

package/package.json

@@ -1,20 +1,52 @@
 {
   "name": "@leancodepl/api-date-utils",
-  "version": "8.4.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
   "dependencies": {
-    "@leancodepl/api-date": "8.4.0"
+    "@leancodepl/api-date": "8.5.1"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leancodepl/js_corelibrary.git",
+    "directory": "packages/cqrs-clients/custom-types/date/api-date-utils"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "Utility functions for API date parsing and validation",
+  "keywords": [
+    "date",
+    "parsing",
+    "validation",
+    "api",
+    "utilities",
+    "typescript",
+    "javascript",
+    "leancode"
+  ],
+  "author": {
+    "name": "LeanCode",
+    "url": "https://leancode.co"
+  },
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "module": "./index.esm.js",
-      "types": "./index.esm.d.ts",
+      "types": "./index.d.ts",
       "import": "./index.cjs.mjs",
       "default": "./index.cjs.js"
     }
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/src/lib/parseApiTimeSpan.d.ts

@@ -1,4 +1,18 @@
 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: {

package/index.esm.d.ts

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