@formkit/tempo 0.0.19 → 0.1.0

package/dist/sameHour.mjs

@@ -0,0 +1,11 @@
+// src/sameHour.ts
+import { date } from "./date.mjs";
+function sameHour(inputDateA, inputDateB) {
+  const a = date(inputDateA);
+  const b = date(inputDateB);
+  return a.getHours() === b.getHours();
+}
+export {
+  sameHour
+};
+//# sourceMappingURL=sameHour.mjs.map

package/dist/sameHour.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sameHour.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Checks if two date objects refer to the same time hour. Ignores date.\n * @param inputDateA - First date to compare\n * @param inputDateB - Second date to compare\n */\nexport function sameHour(inputDateA: DateInput, inputDateB: DateInput) {\n  const a = date(inputDateA)\n  const b = date(inputDateB)\n  return a.getHours() === b.getHours()\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAQd,SAAS,SAAS,YAAuB,YAAuB;AACrE,QAAM,IAAI,KAAK,UAAU;AACzB,QAAM,IAAI,KAAK,UAAU;AACzB,SAAO,EAAE,SAAS,MAAM,EAAE,SAAS;AACrC;","names":[]}

package/dist/sameMinute.d.ts

@@ -0,0 +1,10 @@
+import { DateInput } from './types.js';
+
+/**
+ * Checks if two date objects refer to the same time minutes. Ignores date.
+ * @param inputDateA - First date to compare
+ * @param inputDateB - Second date to compare
+ */
+declare function sameMinute(inputDateA: DateInput, inputDateB: DateInput): boolean;
+
+export { sameMinute };

package/dist/sameMinute.mjs

@@ -0,0 +1,11 @@
+// src/sameMinute.ts
+import { date } from "./date.mjs";
+function sameMinute(inputDateA, inputDateB) {
+  const a = date(inputDateA);
+  const b = date(inputDateB);
+  return a.getMinutes() === b.getMinutes();
+}
+export {
+  sameMinute
+};
+//# sourceMappingURL=sameMinute.mjs.map

package/dist/sameMinute.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sameMinute.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Checks if two date objects refer to the same time minutes. Ignores date.\n * @param inputDateA - First date to compare\n * @param inputDateB - Second date to compare\n */\nexport function sameMinute(inputDateA: DateInput, inputDateB: DateInput) {\n  const a = date(inputDateA)\n  const b = date(inputDateB)\n  return a.getMinutes() === b.getMinutes()\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAQd,SAAS,WAAW,YAAuB,YAAuB;AACvE,QAAM,IAAI,KAAK,UAAU;AACzB,QAAM,IAAI,KAAK,UAAU;AACzB,SAAO,EAAE,WAAW,MAAM,EAAE,WAAW;AACzC;","names":[]}

package/dist/sameSecond.d.ts

@@ -0,0 +1,10 @@
+import { DateInput } from './types.js';
+
+/**
+ * Checks if two date objects refer to the same time seconds. Ignores date.
+ * @param inputDateA - First date to compare
+ * @param inputDateB - Second date to compare
+ */
+declare function sameSecond(inputDateA: DateInput, inputDateB: DateInput): boolean;
+
+export { sameSecond };

package/dist/sameSecond.mjs

@@ -0,0 +1,11 @@
+// src/sameSecond.ts
+import { date } from "./date.mjs";
+function sameSecond(inputDateA, inputDateB) {
+  const a = date(inputDateA);
+  const b = date(inputDateB);
+  return a.getSeconds() === b.getSeconds();
+}
+export {
+  sameSecond
+};
+//# sourceMappingURL=sameSecond.mjs.map

package/dist/sameSecond.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sameSecond.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Checks if two date objects refer to the same time seconds. Ignores date.\n * @param inputDateA - First date to compare\n * @param inputDateB - Second date to compare\n */\nexport function sameSecond(inputDateA: DateInput, inputDateB: DateInput) {\n  const a = date(inputDateA)\n  const b = date(inputDateB)\n  return a.getSeconds() === b.getSeconds()\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAQd,SAAS,WAAW,YAAuB,YAAuB;AACvE,QAAM,IAAI,KAAK,UAAU;AACzB,QAAM,IAAI,KAAK,UAAU;AACzB,SAAO,EAAE,WAAW,MAAM,EAAE,WAAW;AACzC;","names":[]}

package/dist/sameYear.d.ts

@@ -0,0 +1,10 @@
+import { DateInput } from './types.js';
+
+/**
+ * Checks if two date objects refer to the same year.
+ * @param inputDateA - First date to compare
+ * @param inputDateB - Second date to compare
+ */
+declare function sameYear(inputDateA: DateInput, inputDateB: DateInput): boolean;
+
+export { sameYear };

package/dist/sameYear.mjs

@@ -0,0 +1,11 @@
+// src/sameYear.ts
+import { date } from "./date.mjs";
+function sameYear(inputDateA, inputDateB) {
+  const a = date(inputDateA);
+  const b = date(inputDateB);
+  return a.getFullYear() === b.getFullYear();
+}
+export {
+  sameYear
+};
+//# sourceMappingURL=sameYear.mjs.map

package/dist/sameYear.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sameYear.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Checks if two date objects refer to the same year.\n * @param inputDateA - First date to compare\n * @param inputDateB - Second date to compare\n */\nexport function sameYear(inputDateA: DateInput, inputDateB: DateInput) {\n  const a = date(inputDateA)\n  const b = date(inputDateB)\n  return a.getFullYear() === b.getFullYear()\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAQd,SAAS,SAAS,YAAuB,YAAuB;AACrE,QAAM,IAAI,KAAK,UAAU;AACzB,QAAM,IAAI,KAAK,UAAU;AACzB,SAAO,EAAE,YAAY,MAAM,EAAE,YAAY;AAC3C;","names":[]}

package/dist/types.d.ts

@@ -0,0 +1,143 @@
+/**
+ * The date format used as an input value. Either a date or an ISO8601 string.
+ */
+type DateInput = Date | string;
+/**
+ * Format parts with text names use these descriptors:
+ */
+type NamedFormatOption = "long" | "short" | "narrow";
+/**
+ * A registry of named format parts. Each type of part has every option.
+ */
+interface NamedFormats {
+    weekday: Record<string, NamedFormatOption>;
+    month: Record<string, NamedFormatOption>;
+    dayPeriod: Record<string, NamedFormatOption>;
+}
+/**
+ * Internal format for "pieces" of a date form. Each part represents a single
+ * logical grouping, like "month", or "seconds".
+ */
+interface Part {
+    /**
+     * An object of partName to partValue For example:
+     * ```js
+     * { hour: '2-digit' }
+     * ```
+     */
+    option: FormatPattern[1];
+    /**
+     * The name of the part, these must be valid parts of a date format as
+     * specified in Intl.DateTimeFormatPartTypes. Valid values are:
+     * day, dayPeriod, era, hour, literal, minute, month, second, timeZoneName,
+     * weekday, year
+     */
+    partName: Intl.DateTimeFormatPartTypes;
+    /**
+     * The value of a given part. For example "2-digit", or "narrow".
+     */
+    partValue: string;
+    /**
+     * The string token that represents the regex. For example "YYYY".
+     */
+    token: string;
+    /**
+     * A regular expression if the above token.
+     */
+    pattern: RegExp;
+    /**
+     * Does this part require a the hour12 clock.
+     */
+    hour12: boolean;
+}
+/**
+ * A date part with an actual value applied.
+ */
+type FilledPart = Part & {
+    value: string;
+};
+/**
+ * A tuple describing a given formatting token.
+ */
+type FormatPattern = [
+    pattern: FormatToken | string,
+    option: Partial<Record<Intl.DateTimeFormatPartTypes, string>>,
+    exp?: RegExp
+];
+/**
+ * Possible options for a format style.
+ */
+type FormatStyle = "full" | "long" | "medium" | "short";
+/**
+ * Possible objects for the dateStyle and timeStyle.
+ */
+type FormatStyleObj = {
+    date: FormatStyle;
+    time: FormatStyle;
+} | {
+    date: FormatStyle;
+} | {
+    time: FormatStyle;
+};
+type Format = FormatStyle | FormatStyleObj | string;
+/**
+ * A union of all available formatting tokens.
+ */
+type FormatToken = "YYYY" | "YY" | "MMMM" | "MMM" | "MM" | "M" | "DD" | "D" | "dddd" | "ddd" | "d" | "mm" | "m" | "ss" | "s" | "HH" | "H" | "hh" | "h" | "a" | "A" | "ZZ" | "Z";
+interface ParseOptions {
+    /**
+     * A string representing a date.
+     */
+    date: string;
+    /**
+     * The format that should be used to parse the date. This is a string composed
+     * of tokens.
+     */
+    format: Format;
+    /**
+     * The locale used to parse the date.
+     */
+    locale: string;
+    /**
+     * A function that can be used to filter out parts of the format. This is
+     * useful when using the native Intl formats like
+     * `{ date: 'full', time: 'full' }` and not wanting to keep all the parts of
+     * the given format.
+     */
+    partFilter?: (part: Part) => boolean;
+    /**
+     * The behavior to use when a date overflows a given month. For example, if
+     * the date to parse is February 29, 2023 — there is no 29th day of February.
+     * In this case overflow "forward" would result in March 1, 2023, "backward"
+     * would result in February 28, 2023, and "throw" would throw an error.
+     */
+    dateOverflow?: "forward" | "backward" | "throw";
+}
+interface FormatOptions {
+    /**
+     * A date object or ISO 8601 string.
+     */
+    date: DateInput;
+    /**
+     * A format string or object.
+     */
+    format: Format;
+    /**
+     * A locale or en by default.
+     */
+    locale?: string;
+    /**
+     * Whether or not to escape literals.
+     */
+    genitive?: boolean;
+    /**
+     * A function to filter parts.
+     */
+    tz?: string;
+    /**
+     * A function to filter parts.
+     */
+    partFilter?: (part: Part) => boolean;
+}
+
+export type { DateInput, FilledPart, Format, FormatOptions, FormatPattern, FormatStyle, FormatStyleObj, FormatToken, NamedFormatOption, NamedFormats, ParseOptions, Part };

package/dist/types.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

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

package/dist/tzDate.d.ts

@@ -0,0 +1,15 @@
+import { DateInput } from './types.js';
+
+/**
+ * Creates a date object for the input date at the given timezone. For example
+ * `tzDate("2017-05-06T12:00", "Europe/Amsterdam")` will return a date object
+ * for 2017-05-06T10:00:00Z since 12:00 in Amsterdam is 10:00Z.
+ *
+ * If given a Date object it will use local time and convert it to the given
+ * timezone, thus "changing" the date.
+ * @param inputDate - An iso8601 date string with no timezone
+ * @param tz - A timezone string
+ */
+declare function tzDate(inputDate: DateInput, tz: string): Date;
+
+export { tzDate };

package/dist/tzDate.mjs

@@ -0,0 +1,12 @@
+// src/tzDate.ts
+import { offset } from "./offset.mjs";
+import { applyOffset } from "./applyOffset.mjs";
+import { date } from "./date.mjs";
+function tzDate(inputDate, tz) {
+  const d = date(inputDate);
+  return applyOffset(d, offset(d, tz));
+}
+export {
+  tzDate
+};
+//# sourceMappingURL=tzDate.mjs.map

package/dist/tzDate.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/tzDate.ts"],"sourcesContent":["import { offset } from \"./offset\"\nimport { applyOffset } from \"./applyOffset\"\nimport { date } from \"./date\"\nimport { DateInput } from \"./types\"\n\n/**\n * Creates a date object for the input date at the given timezone. For example\n * `tzDate(\"2017-05-06T12:00\", \"Europe/Amsterdam\")` will return a date object\n * for 2017-05-06T10:00:00Z since 12:00 in Amsterdam is 10:00Z.\n *\n * If given a Date object it will use local time and convert it to the given\n * timezone, thus \"changing\" the date.\n * @param inputDate - An iso8601 date string with no timezone\n * @param tz - A timezone string\n */\nexport function tzDate(inputDate: DateInput, tz: string) {\n  const d = date(inputDate)\n  return applyOffset(d, offset(d, tz))\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAAS,mBAAmB;AAC5B,SAAS,YAAY;AAad,SAAS,OAAO,WAAsB,IAAY;AACvD,QAAM,IAAI,KAAK,SAAS;AACxB,SAAO,YAAY,GAAG,OAAO,GAAG,EAAE,CAAC;AACrC;","names":[]}

package/dist/weekEnd.d.ts

@@ -0,0 +1,12 @@
+import { DateInput } from './types.js';
+
+/**
+ * Returns a Date object for the last day at the last second of the given week.
+ * Defaults to Sunday as the first day of the week:
+ * 0 = Sunday ... 6 = Saturday
+ * @param inputDate - Gets the last day of the week
+ * @param startOfWeekDay - The first day of the week
+ */
+declare function weekEnd(inputDate: DateInput, startOfWeekDay?: number): Date;
+
+export { weekEnd };

package/dist/weekEnd.mjs

@@ -0,0 +1,12 @@
+// src/weekEnd.ts
+import { weekStart } from "./weekStart.mjs";
+function weekEnd(inputDate, startOfWeekDay = 0) {
+  const d = weekStart(inputDate, startOfWeekDay);
+  d.setDate(d.getDate() + 6);
+  d.setHours(23, 59, 59);
+  return d;
+}
+export {
+  weekEnd
+};
+//# sourceMappingURL=weekEnd.mjs.map

package/dist/weekEnd.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/weekEnd.ts"],"sourcesContent":["import { weekStart } from \"./weekStart\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Returns a Date object for the last day at the last second of the given week.\n * Defaults to Sunday as the first day of the week:\n * 0 = Sunday ... 6 = Saturday\n * @param inputDate - Gets the last day of the week\n * @param startOfWeekDay - The first day of the week\n */\nexport function weekEnd(inputDate: DateInput, startOfWeekDay = 0): Date {\n  const d = weekStart(inputDate, startOfWeekDay)\n  d.setDate(d.getDate() + 6)\n  d.setHours(23, 59, 59)\n  return d\n}\n"],"mappings":";AAAA,SAAS,iBAAiB;AAUnB,SAAS,QAAQ,WAAsB,iBAAiB,GAAS;AACtE,QAAM,IAAI,UAAU,WAAW,cAAc;AAC7C,IAAE,QAAQ,EAAE,QAAQ,IAAI,CAAC;AACzB,IAAE,SAAS,IAAI,IAAI,EAAE;AACrB,SAAO;AACT;","names":[]}

package/dist/weekStart.d.ts

@@ -0,0 +1,12 @@
+import { DateInput } from './types.js';
+
+/**
+ * Returns a Date object for start of the given week. Defaults to Sunday as the
+ * first day of the week:
+ * 0 = Sunday ... 6 = Saturday
+ * @param inputDate - A string or Date object
+ * @param startOfWeekDay - Determines which day of the week is the first
+ */
+declare function weekStart(inputDate: DateInput, startOfWeekDay?: number): Date;
+
+export { weekStart };

package/dist/weekStart.mjs

@@ -0,0 +1,15 @@
+// src/weekStart.ts
+import { date } from "./date.mjs";
+function weekStart(inputDate, startOfWeekDay = 0) {
+  const d = date(inputDate);
+  let diff = startOfWeekDay - d.getDay();
+  if (diff > 0)
+    diff = diff - 7;
+  d.setDate(d.getDate() + diff);
+  d.setHours(0, 0, 0);
+  return d;
+}
+export {
+  weekStart
+};
+//# sourceMappingURL=weekStart.mjs.map

package/dist/weekStart.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/weekStart.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Returns a Date object for start of the given week. Defaults to Sunday as the\n * first day of the week:\n * 0 = Sunday ... 6 = Saturday\n * @param inputDate - A string or Date object\n * @param startOfWeekDay - Determines which day of the week is the first\n */\nexport function weekStart(inputDate: DateInput, startOfWeekDay = 0): Date {\n  const d = date(inputDate)\n  let diff = startOfWeekDay - d.getDay()\n  if (diff > 0) diff = diff - 7\n  d.setDate(d.getDate() + diff)\n  d.setHours(0, 0, 0)\n  return d\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAUd,SAAS,UAAU,WAAsB,iBAAiB,GAAS;AACxE,QAAM,IAAI,KAAK,SAAS;AACxB,MAAI,OAAO,iBAAiB,EAAE,OAAO;AACrC,MAAI,OAAO;AAAG,WAAO,OAAO;AAC5B,IAAE,QAAQ,EAAE,QAAQ,IAAI,IAAI;AAC5B,IAAE,SAAS,GAAG,GAAG,CAAC;AAClB,SAAO;AACT;","names":[]}

package/dist/yearDays.d.ts

@@ -0,0 +1,9 @@
+import { DateInput } from './types.js';
+
+/**
+ * Get the number of days in the given date’s year.
+ * @param inputDate - A string or Date object
+ */
+declare function yearDays(inputDate: DateInput): number;
+
+export { yearDays };

package/dist/yearDays.mjs

@@ -0,0 +1,10 @@
+// src/yearDays.ts
+import { date } from "./date.mjs";
+function yearDays(inputDate) {
+  const d = date(inputDate);
+  return (new Date(d.getFullYear() + 1, 0, 0).getTime() - new Date(d.getFullYear(), 0, 0).getTime()) / 864e5;
+}
+export {
+  yearDays
+};
+//# sourceMappingURL=yearDays.mjs.map

package/dist/yearDays.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/yearDays.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Get the number of days in the given date’s year.\n * @param inputDate - A string or Date object\n */\nexport function yearDays(inputDate: DateInput): number {\n  const d = date(inputDate)\n  return (\n    (new Date(d.getFullYear() + 1, 0, 0).getTime() -\n      new Date(d.getFullYear(), 0, 0).getTime()) /\n    86400000\n  )\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAOd,SAAS,SAAS,WAA8B;AACrD,QAAM,IAAI,KAAK,SAAS;AACxB,UACG,IAAI,KAAK,EAAE,YAAY,IAAI,GAAG,GAAG,CAAC,EAAE,QAAQ,IAC3C,IAAI,KAAK,EAAE,YAAY,GAAG,GAAG,CAAC,EAAE,QAAQ,KAC1C;AAEJ;","names":[]}

package/dist/yearEnd.d.ts

@@ -0,0 +1,9 @@
+import { DateInput } from './types.js';
+
+/**
+ * Returns a Date object for the with the input date set to the end of the current year.
+ * @param inputDate - A string or Date object
+ */
+declare function yearEnd(inputDate: DateInput): Date;
+
+export { yearEnd };

package/dist/yearEnd.mjs

@@ -0,0 +1,13 @@
+// src/yearEnd.ts
+import { date } from "./date.mjs";
+function yearEnd(inputDate) {
+  const d = date(inputDate);
+  d.setMonth(11);
+  d.setDate(31);
+  d.setHours(23, 59, 59, 999);
+  return d;
+}
+export {
+  yearEnd
+};
+//# sourceMappingURL=yearEnd.mjs.map

package/dist/yearEnd.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/yearEnd.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Returns a Date object for the with the input date set to the end of the current year.\n * @param inputDate - A string or Date object\n */\nexport function yearEnd(inputDate: DateInput): Date {\n  const d = date(inputDate);\n\n  d.setMonth(11);\n  d.setDate(31);\n  d.setHours(23, 59, 59, 999);\n\n  return d;\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAOd,SAAS,QAAQ,WAA4B;AAClD,QAAM,IAAI,KAAK,SAAS;AAExB,IAAE,SAAS,EAAE;AACb,IAAE,QAAQ,EAAE;AACZ,IAAE,SAAS,IAAI,IAAI,IAAI,GAAG;AAE1B,SAAO;AACT;","names":[]}

package/dist/yearStart.d.ts

@@ -0,0 +1,9 @@
+import { DateInput } from './types.js';
+
+/**
+ * Returns a Date object for the with the input date set to the start of the current year.
+ * @param inputDate - A string or Date object
+ */
+declare function yearStart(inputDate: DateInput): Date;
+
+export { yearStart };

package/dist/yearStart.mjs

@@ -0,0 +1,13 @@
+// src/yearStart.ts
+import { date } from "./date.mjs";
+function yearStart(inputDate) {
+  const d = date(inputDate);
+  d.setMonth(0);
+  d.setDate(1);
+  d.setHours(0, 0, 0);
+  return d;
+}
+export {
+  yearStart
+};
+//# sourceMappingURL=yearStart.mjs.map

package/dist/yearStart.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/yearStart.ts"],"sourcesContent":["import { date } from \"./date\"\nimport type { DateInput } from \"./types\"\n\n/**\n * Returns a Date object for the with the input date set to the start of the current year.\n * @param inputDate - A string or Date object\n */\nexport function yearStart(inputDate: DateInput): Date {\n  const d = date(inputDate)\n\n  d.setMonth(0)\n  d.setDate(1)\n  d.setHours(0, 0, 0)\n\n  return d\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAOd,SAAS,UAAU,WAA4B;AACpD,QAAM,IAAI,KAAK,SAAS;AAExB,IAAE,SAAS,CAAC;AACZ,IAAE,QAAQ,CAAC;AACX,IAAE,SAAS,GAAG,GAAG,CAAC;AAElB,SAAO;AACT;","names":[]}

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@formkit/tempo",
-  "version": "0.0.19",
+  "version": "0.1.0",
   "description": "The easiest way to work with dates in JavaScript and TypeScript.",
   "type": "module",
   "main": "dist/index.cjs",
   "types": "dist/index.d.cts",
+  "browser": "dist/bundle.mjs",
+  "unpkg": "dist/bundle.mjs",
   "exports": {
     ".": {
       "import": {
@@ -14,6 +16,10 @@
       "require": {
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
+      },
+      "browser": {
+        "types": "./dist/bundle.d.ts",
+        "default": "./dist/bundle.mjs"
       }
     }
   },
@@ -37,6 +43,7 @@
     "@types/node": "^20.11.10",
     "bumpp": "^9.3.0",
     "bytes-iec": "^3.1.1",
+    "esbuild-plugin-file-path-extensions": "^2.0.0",
     "publint": "^0.2.7",
     "size-limit": "^11.0.2",
     "tsup": "^8.0.1",