@gobrand/tiempo 2.1.3 → 2.2.0

package/README.md

@@ -4,7 +4,7 @@
 [![CI](https://github.com/go-brand/tiempo/actions/workflows/ci.yml/badge.svg)](https://github.com/go-brand/tiempo/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Lightweight utility functions for converting between UTC and timezone-aware datetimes using the [Temporal API](https://tc39.es/proposal-temporal/docs/).
+Lightweight utilities for timezones and datetimes with the [Temporal API](https://tc39.es/proposal-temporal/docs/).
 
 ## Installation
 
@@ -18,7 +18,7 @@ yarn add @gobrand/tiempo
 
 ## Why tiempo?
 
-The Temporal API is already designed for timezone conversions, but it requires understanding its various methods and objects. `tiempo` provides a simple, focused API for the most common use case: converting between UTC ISO strings (from your backend) and timezone-aware ZonedDateTime objects (for your frontend).
+The Temporal API is powerful but requires understanding its various methods and objects. `tiempo` provides intuitive utilities for common datetime tasks: timezone conversions, formatting, start/end calculations, and comparisons. Whether you're converting UTC strings from your backend or formatting dates for display, tiempo makes working with timezones straightforward.
 
 **Perfect for:**
 - Social media scheduling apps

package/dist/chunk-ANLD6IWG.js

@@ -0,0 +1,13 @@
+// src/getToday.ts
+import { Temporal } from "@js-temporal/polyfill";
+function getToday(timezone) {
+  if (timezone) {
+    return Temporal.Now.zonedDateTimeISO(timezone).toPlainDate();
+  }
+  return Temporal.Now.plainDateISO();
+}
+
+export {
+  getToday
+};
+//# sourceMappingURL=chunk-ANLD6IWG.js.map

package/dist/chunk-ANLD6IWG.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/getToday.ts"],"sourcesContent":["import { Temporal } from '@js-temporal/polyfill';\n\n/**\n * Get today's date in the system's local timezone or a specified timezone.\n *\n * @param timezone - Optional IANA timezone identifier (e.g., \"America/Asuncion\", \"Europe/Madrid\") or \"UTC\"\n * @returns A Temporal.PlainDate representing today's date\n *\n * @example\n * ```typescript\n * // Get today in local timezone\n * const today = getToday();\n *\n * // Get today in Madrid\n * const todayInMadrid = getToday(\"Europe/Madrid\");\n *\n * // Get today in UTC\n * const todayUtc = getToday(\"UTC\");\n * ```\n */\nexport function getToday(timezone?: \"UTC\" | string): Temporal.PlainDate {\n  if (timezone) {\n    return Temporal.Now.zonedDateTimeISO(timezone).toPlainDate();\n  }\n  return Temporal.Now.plainDateISO();\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AAoBlB,SAAS,SAAS,UAA+C;AACtE,MAAI,UAAU;AACZ,WAAO,SAAS,IAAI,iBAAiB,QAAQ,EAAE,YAAY;AAAA,EAC7D;AACA,SAAO,SAAS,IAAI,aAAa;AACnC;","names":[]}

package/dist/getToday.d.ts

@@ -0,0 +1,21 @@
+import { Temporal } from '@js-temporal/polyfill';
+/**
+ * Get today's date in the system's local timezone or a specified timezone.
+ *
+ * @param timezone - Optional IANA timezone identifier (e.g., "America/Asuncion", "Europe/Madrid") or "UTC"
+ * @returns A Temporal.PlainDate representing today's date
+ *
+ * @example
+ * ```typescript
+ * // Get today in local timezone
+ * const today = getToday();
+ *
+ * // Get today in Madrid
+ * const todayInMadrid = getToday("Europe/Madrid");
+ *
+ * // Get today in UTC
+ * const todayUtc = getToday("UTC");
+ * ```
+ */
+export declare function getToday(timezone?: "UTC" | string): Temporal.PlainDate;
+//# sourceMappingURL=getToday.d.ts.map

package/dist/getToday.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getToday.d.ts","sourceRoot":"","sources":["../src/getToday.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC,SAAS,CAKtE"}

package/dist/getToday.js

@@ -0,0 +1,7 @@
+import {
+  getToday
+} from "./chunk-ANLD6IWG.js";
+export {
+  getToday
+};
+//# sourceMappingURL=getToday.js.map

package/dist/getToday.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/getToday.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getToday.test.d.ts.map

package/dist/getToday.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getToday.test.d.ts","sourceRoot":"","sources":["../src/getToday.test.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export { toZonedTime } from './toZonedTime';
 export { toUtc } from './toUtc';
 export { toUtcString } from './toUtcString';
 export { format, type FormatOptions } from './format';
+export { getToday } from './getToday';
 export { startOfDay } from './startOfDay';
 export { endOfDay } from './endOfDay';
 export { startOfWeek } from './startOfWeek';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -1,6 +1,12 @@
+import {
+  toUtcString
+} from "./chunk-DMKGJY4N.js";
 import {
   toZonedTime
 } from "./chunk-KD5GEHUA.js";
+import {
+  isBefore
+} from "./chunk-IPJUERCK.js";
 import {
   isSameDay
 } from "./chunk-RW3C2677.js";
@@ -19,9 +25,6 @@ import {
 import {
   toUtc
 } from "./chunk-GPAFAHKJ.js";
-import {
-  toUtcString
-} from "./chunk-DMKGJY4N.js";
 import {
   endOfDay
 } from "./chunk-CUMB4776.js";
@@ -38,12 +41,12 @@ import "./chunk-AVGNRINZ.js";
 import {
   format
 } from "./chunk-2G5RJGPR.js";
+import {
+  getToday
+} from "./chunk-ANLD6IWG.js";
 import {
   isAfter
 } from "./chunk-BBNNR2QH.js";
-import {
-  isBefore
-} from "./chunk-IPJUERCK.js";
 import "./chunk-MJSZNWCV.js";
 export {
   endOfDay,
@@ -51,6 +54,7 @@ export {
   endOfWeek,
   endOfYear,
   format,
+  getToday,
   isAfter,
   isBefore,
   isSameDay,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gobrand/tiempo",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "Lightweight utility functions for converting between UTC and timezone-aware datetimes using the Temporal API",
   "private": false,
   "publishConfig": {