@vielzeug/tempo 1.0.2

package/dist/types.d.ts

@@ -0,0 +1,93 @@
+import { Temporal } from '@js-temporal/polyfill';
+export type TimeInput = Temporal.Instant | Temporal.PlainDate | Temporal.PlainDateTime | Temporal.ZonedDateTime;
+export type RelativeTimeInput = Temporal.Instant | Temporal.ZonedDateTime;
+/** Discriminant for the {@link parse} `as` parameter. Controls the expected return type. */
+export type ParseAs = 'instant' | 'plain-date' | 'plain-datetime' | 'zoned';
+export type DateTimeDisambiguation = 'compatible' | 'earlier' | 'later' | 'reject';
+/**
+ * Base timezone option. Does NOT include `prefer` (disambiguation) — that only applies
+ * to `PlainDateTime` inputs and is intentionally scoped to APIs where it is meaningful
+ * (see {@link ShiftOptions} and {@link DifferenceOptions}).
+ */
+export interface TimeOptions {
+    tz?: string;
+}
+/**
+ * Options for DST-sensitive operations that accept `PlainDateTime` inputs.
+ * `prefer` controls how ambiguous wall-clock times (e.g. during DST fall-back) are resolved.
+ * It is silently ignored for `Instant` and `ZonedDateTime` inputs.
+ */
+export interface DisambiguationOptions {
+    prefer?: DateTimeDisambiguation;
+}
+export interface ShiftOptions extends DisambiguationOptions, TimeOptions {
+}
+export interface DifferenceOptions extends DisambiguationOptions, TimeOptions {
+    largestUnit?: Temporal.DateTimeUnit;
+    roundingIncrement?: number;
+    roundingMode?: Temporal.RoundingMode;
+    smallestUnit?: Temporal.DateTimeUnit;
+}
+export type FormatPattern = 'date-only' | 'long' | 'medium' | 'short' | 'time-only';
+/**
+ * Options for {@link format} and {@link formatRange}.
+ *
+ * `intl` and `pattern` are mutually exclusive — enforced at compile time.
+ */
+export type FormatOptions = {
+    intl: Intl.DateTimeFormatOptions;
+    locale?: Intl.LocalesArgument;
+    pattern?: never;
+    tz?: string;
+} | {
+    intl?: never;
+    locale?: Intl.LocalesArgument;
+    pattern?: FormatPattern;
+    tz?: string;
+};
+export interface RelativeFormatOptions {
+    base?: RelativeTimeInput;
+    locale?: Intl.LocalesArgument;
+    numeric?: Intl.RelativeTimeFormatNumeric;
+    style?: Intl.RelativeTimeFormatStyle;
+}
+export interface DurationFormatOptions {
+    locale?: Intl.LocalesArgument;
+    style?: 'digital' | 'long' | 'narrow' | 'short';
+}
+/** Master set of all temporal units recognised by tempo. */
+export type TempoUnit = 'day' | 'hour' | 'microsecond' | 'millisecond' | 'minute' | 'month' | 'nanosecond' | 'second' | 'week' | 'year';
+/** Calendar-significant units (not sub-day). Used internally by CALENDAR_UNITS set. */
+export type CalendarUnit = Extract<TempoUnit, 'day' | 'month' | 'week' | 'year'>;
+export type BoundaryUnit = Exclude<TempoUnit, 'microsecond' | 'millisecond' | 'nanosecond' | 'second'>;
+export type WeekStartDay = 1 | 2 | 3 | 4 | 5 | 6 | 7;
+export interface BoundaryOptions extends TimeOptions {
+    weekStartsOn?: WeekStartDay;
+}
+export interface CompareOptions extends TimeOptions {
+    unit?: BoundaryUnit;
+    weekStartsOn?: WeekStartDay;
+}
+/** Structured output of {@link timeDiff}. Excludes sub-millisecond units. */
+export type TimeDiffUnit = Exclude<TempoUnit, 'microsecond' | 'nanosecond'>;
+export type TimeDiffResult = {
+    unit: TimeDiffUnit;
+    value: number;
+};
+type RecurrenceBase = {
+    frequency: 'daily' | 'monthly' | 'weekly' | 'yearly';
+    interval?: number;
+};
+/**
+ * Rule governing {@link recurrence} generation.
+ * Either `count` or `until` (or both) must be provided — enforced at the type level.
+ */
+export type RecurrenceRule = RecurrenceBase & ({
+    count: number;
+    until?: TimeInput;
+} | {
+    count?: number;
+    until: TimeInput;
+});
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAIjD,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;AAChH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;AAE1E,4FAA4F;AAC5F,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,YAAY,GAAG,gBAAgB,GAAG,OAAO,CAAC;AAI5E,MAAM,MAAM,sBAAsB,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEnF;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,YAAa,SAAQ,qBAAqB,EAAE,WAAW;CAAG;AAE3E,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB,EAAE,WAAW;IAC3E,WAAW,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;IACrC,YAAY,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;CACtC;AAID,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AAEpF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,IAAI,CAAC,qBAAqB,CAAC;IAAC,MAAM,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,GACjG;IAAE,IAAI,CAAC,EAAE,KAAK,CAAC;IAAC,MAAM,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC;IAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1F,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,MAAM,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC;IAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,yBAAyB,CAAC;IACzC,KAAK,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC;CACtC;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC;IAC9B,KAAK,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACjD;AAID,4DAA4D;AAC5D,MAAM,MAAM,SAAS,GACnB,KAAK,GAAG,MAAM,GAAG,aAAa,GAAG,aAAa,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAElH,uFAAuF;AACvF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC;AAIjF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,aAAa,GAAG,aAAa,GAAG,YAAY,GAAG,QAAQ,CAAC,CAAC;AACvG,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAErD,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAID,6EAA6E;AAC7E,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,aAAa,GAAG,YAAY,CAAC,CAAC;AAC5E,MAAM,MAAM,cAAc,GAAG;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAInE,KAAK,cAAc,GAAG;IACpB,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,cAAc,GACzC,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@vielzeug/tempo",
+  "version": "1.0.2",
+  "description": "Date and time utilities — timezone conversion, DST-safe arithmetic, and Intl formatting",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "scripts": {
+    "build": "vite build && pnpm run build:bundle && pnpm run build:types",
+    "build:types": "tsc -p tsconfig.declarations.json",
+    "fix": "eslint --fix src",
+    "lint": "eslint src",
+    "prepublishOnly": "pnpm run build",
+    "preview": "vite preview",
+    "test": "vitest",
+    "build:bundle": "vite build --config vite.bundle.config.ts"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.0",
+    "typescript": "~6.0.3",
+    "vite": "^8.1.3",
+    "vitest": "^4.1.9"
+  },
+  "dependencies": {
+    "@js-temporal/polyfill": "^0.5.1"
+  }
+}