@brt-innovation/aether 1.3.0 → 1.3.1

package/README.dev.md

@@ -34,7 +34,11 @@ git checkout main
 git pull origin main
 ```
 
-### 4. Bump Version
+### 4. Update README.md
+
+Update the README.md file to include the latest changes.
+
+### 5. Bump Version
 
 Update the package version. This command updates `package.json`, `package-lock.json`, creates a git commit, and adds a git tag.
 
@@ -48,7 +52,7 @@ Examples:
 - `npm version minor` (1.0.0 -> 1.1.0)
 - `npm version major` (1.0.0 -> 2.0.0)
 
-### 5. Publish
+### 6. Publish
 
 Publish the package to the registry.
 

package/README.md

@@ -128,6 +128,50 @@ app.onError(onAppError);
 
 ---
 
+### Dayjs Utilities
+
+Common date/time utilities pre-configured with `dayjs`, `utc`, and `timezone` plugins. `Asia/Bangkok` is used as the default timezone for BKK specific functions.
+
+**Import**
+
+```ts
+import {
+  startOfDayBkk,
+  endOfDayBkk,
+  startOfDayBkkToUtc,
+  endOfDayBkkToUtc,
+  convertUtcToBkk,
+  convertBkkToUtc,
+  formatDate,
+  bkkTimezone,
+} from '@brt-innovation/aether';
+```
+
+**Available Functions**
+
+- `bkkTimezone`: Constant `'Asia/Bangkok'`.
+- `startOfDayBkk(date)`: Returns the start of the day (00:00:00) in Bangkok timezone as a `Date` object.
+- `endOfDayBkk(date)`: Returns the end of the day (23:59:59.999) in Bangkok timezone as a `Date` object.
+- `startOfDayBkkToUtc(date)`: Returns the start of the day in Bangkok, converted to UTC as a `Date` object.
+- `endOfDayBkkToUtc(date)`: Returns the end of the day in Bangkok, converted to UTC as a `Date` object.
+- `convertUtcToBkk(date)`: Converts a UTC date to Bangkok time (Date object with BKK wall time).
+- `convertBkkToUtc(date)`: Converts a Bangkok date to UTC.
+- `formatDate(date, options)`: Formats a date string or object.
+  - `options.format`: Format string (default: `'YYYY-MM-DD HH:mm:ss'`)
+  - `options.timezone`: Target timezone (default: `'UTC'`, options: `'UTC'`, `'Asia/Bangkok'`)
+
+**Example**
+
+```ts
+import { formatDate, startOfDayBkk, bkkTimezone } from '@brt-innovation/aether';
+
+const now = new Date();
+const bkkStart = startOfDayBkk(now);
+const formatted = formatDate(now, { timezone: bkkTimezone, format: 'DD/MM/YYYY' });
+```
+
+---
+
 ## License
 
 UNLICENSED - Internal use only for BRT Innovation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brt-innovation/aether",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Shared utilities and middlewares for Aether microservices",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -17,7 +17,8 @@
   },
   "scripts": {
     "build": "tsup src/index.ts --dts --tsconfig tsconfig.json",
-    "test": "vitest",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "prepare": "npm run build",