@leancodepl/api-date-dayjs 8.4.0 → 8.5.1

package/README.md

@@ -0,0 +1,152 @@
+# @leancodepl/api-date-dayjs
+
+Date conversion utilities using Day.js for API date types.
+
+## Installation
+
+```bash
+npm install @leancodepl/api-date-dayjs
+# or
+yarn add @leancodepl/api-date-dayjs
+```
+
+## API
+
+### `fromApiDate(date)`
+
+Converts ApiDateOnly to Day.js object.
+
+**Parameters:**
+
+- `date: ApiDateOnly` - The API date string to convert
+
+**Returns:** Day.js object
+
+### `toApiDate(date)`
+
+Converts Day.js object to ApiDateOnly.
+
+**Parameters:**
+
+- `date: dayjs.Dayjs` - The Day.js object to convert
+
+**Returns:** ApiDateOnly string
+
+### `fromApiTime(time)`
+
+Converts ApiTimeOnly to Day.js object.
+
+**Parameters:**
+
+- `time: ApiTimeOnly` - The API time string to convert
+
+**Returns:** Day.js object
+
+### `toApiTime(time)`
+
+Converts Day.js object to ApiTimeOnly.
+
+**Parameters:**
+
+- `time: dayjs.Dayjs` - The Day.js object to convert
+
+**Returns:** ApiTimeOnly string
+
+### `fromApiDateTimeOffset(datetime)`
+
+Converts ApiDateTimeOffset to Day.js object.
+
+**Parameters:**
+
+- `datetime: ApiDateTimeOffset` - The API datetime with offset string to convert
+
+**Returns:** Day.js object
+
+### `toApiDateTimeOffset(time)`
+
+Converts Day.js object to ApiDateTimeOffset.
+
+**Parameters:**
+
+- `time: dayjs.Dayjs` - The Day.js object to convert
+
+**Returns:** ApiDateTimeOffset string
+
+### `fromApiTimeSpan(timeSpan)`
+
+Converts ApiTimeSpan to Day.js duration.
+
+**Parameters:**
+
+- `timeSpan: ApiTimeSpan` - The API timespan string to convert
+
+**Returns:** Day.js duration object
+
+### `toApiTimeSpan(duration)`
+
+Converts Day.js duration to ApiTimeSpan.
+
+**Parameters:**
+
+- `duration: duration.Duration` - The Day.js duration object to convert
+
+**Returns:** ApiTimeSpan string
+
+### `dropLocalOffset(time)`
+
+Utility to remove local timezone offset from Day.js object.
+
+**Parameters:**
+
+- `time: dayjs.Dayjs` - The Day.js object to process
+
+**Returns:** Day.js object with UTC offset but keeping local time
+
+## Usage Examples
+
+### Date Conversion
+
+```typescript
+import { fromApiDate, toApiDate } from "@leancodepl/api-date-dayjs"
+import dayjs from "dayjs"
+
+const apiDate = "2023-12-25"
+const dayjsDate = fromApiDate(apiDate)
+console.log(dayjsDate.format("YYYY-MM-DD")) // '2023-12-25'
+
+const convertedBack = toApiDate(dayjsDate)
+console.log(convertedBack) // '2023-12-25'
+```
+
+### Time Conversion
+
+```typescript
+import { fromApiTime, toApiTime } from "@leancodepl/api-date-dayjs"
+
+const apiTime = "14:30:00"
+const dayjsTime = fromApiTime(apiTime)
+const convertedBack = toApiTime(dayjsTime)
+console.log(convertedBack) // '14:30:00'
+```
+
+### DateTime with Offset
+
+```typescript
+import { fromApiDateTimeOffset, toApiDateTimeOffset } from "@leancodepl/api-date-dayjs"
+
+const apiDateTime = "2023-12-25T14:30:00+01:00"
+const dayjsDateTime = fromApiDateTimeOffset(apiDateTime)
+const convertedBack = toApiDateTimeOffset(dayjsDateTime)
+console.log(convertedBack) // '2023-12-25T14:30:00+01:00'
+```
+
+### Timezone Handling
+
+```typescript
+import { dropLocalOffset } from "@leancodepl/api-date-dayjs"
+import dayjs from "dayjs"
+
+const localDate = dayjs("2023-12-25T14:30:00")
+const utcDate = dropLocalOffset(localDate)
+console.log(utcDate.format()) // Date without local offset
+```

package/package.json

@@ -1,25 +1,56 @@
 {
   "name": "@leancodepl/api-date-dayjs",
-  "version": "8.4.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
   "dependencies": {
-    "@leancodepl/api-date": "8.4.0",
-    "@leancodepl/api-date-utils": "8.4.0",
+    "@leancodepl/api-date": "8.5.1",
+    "@leancodepl/api-date-utils": "8.5.1",
     "dayjs": ">=1.9.0"
   },
   "devDependencies": {
     "timezone-mock": "1.3.6"
   },
+  "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-dayjs"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "Day.js integration for API date type conversion",
+  "keywords": [
+    "date",
+    "dayjs",
+    "api",
+    "conversion",
+    "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/date/fromApiDate.d.ts

@@ -1,4 +1,20 @@
 import dayjs from "dayjs";
 import type { ApiDateOnly } from "@leancodepl/api-date";
+/**
+ * Converts ApiDateOnly to Day.js object.
+ *
+ * Parses API date string format to Day.js object with support
+ * for optional parameters. Uses Day.js constructor internally.
+ *
+ * @param date - The API date string to convert
+ * @returns Day.js object or undefined if date is undefined
+ * @example
+ * ```typescript
+ * import { fromApiDate } from '@leancodepl/api-date-dayjs';
+ *
+ * const dayjsDate = fromApiDate('2023-12-25');
+ * console.log(dayjsDate.format('YYYY-MM-DD')); // '2023-12-25'
+ * ```
+ */
 export declare function fromApiDate(date: ApiDateOnly): dayjs.Dayjs;
 export declare function fromApiDate(date: ApiDateOnly | undefined): dayjs.Dayjs | undefined;

package/src/lib/date/toApiDate.d.ts

@@ -1,4 +1,21 @@
 import dayjs from "dayjs";
 import type { ApiDateOnly } from "@leancodepl/api-date";
+/**
+ * Converts Day.js object to ApiDateOnly.
+ *
+ * Formats Day.js object to API date string format with support
+ * for optional parameters. Uses Day.js format function internally.
+ *
+ * @param date - The Day.js object to convert
+ * @returns ApiDateOnly string or undefined if date is undefined
+ * @example
+ * ```typescript
+ * import { toApiDate } from '@leancodepl/api-date-dayjs';
+ * import dayjs from 'dayjs';
+ *
+ * const apiDate = toApiDate(dayjs('2023-12-25'));
+ * console.log(apiDate); // '2023-12-25'
+ * ```
+ */
 export declare function toApiDate(date: dayjs.Dayjs): ApiDateOnly;
 export declare function toApiDate(date: dayjs.Dayjs | undefined): ApiDateOnly | undefined;

package/index.esm.d.ts

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