@antcde/vue-utils 0.2.28-rc.2 → 0.2.28-rc.4

package/dist/types/index.d.ts

@@ -1,4 +1,7 @@
 export { type DateFormatPreset, formatDate, type FormatDateOptions, formatDateRange, type FormatDateRangeOptions } from './formatDate';
+export { formatRefreshLabel, type RefreshTranslate } from './refreshLabel';
+export { browserZone, buildScheduleRule, defaultScheduleSpec, describeRefresh, parseScheduleRule, type RefreshDescription, SCHEDULE_DAYS, type ScheduleFreq, type ScheduleMonthly, type ScheduleNth, type ScheduleSpec, weekdayOf, } from './refreshSchedule';
+export { nextOccurrences, type ScheduleOccurrence } from './refreshScheduleOccurrences';
 export { TASK_PRIORITIES, taskPriorityColor, taskPriorityIcon } from './taskPriority';
 export { useAntColorMode, type UseAntColorModeOptions, type UseAntColorModeReturn } from './useAntColorMode';
 export { useAntI18n, type UseAntI18nReturn } from './useAntI18n';

package/dist/types/refreshLabel.d.ts

@@ -0,0 +1,14 @@
+import { RefreshDescription } from './refreshSchedule';
+/** vue-i18n's `t(key, named, plural)`, wrapped so each app passes its own. */
+export type RefreshTranslate = (key: string, named: Record<string, unknown>, plural?: number) => string;
+/**
+ * "Refreshed every 2 weeks on Monday at 06:00" (AAD-1111). The phrasing is shared; the
+ * strings are the caller's, under `prefix`: `interval.{300|86400|604800}`, `hourly`,
+ * `daily`, `weekly`, `monthlyDay`, `monthlyNth` (plural on `count`), `nth.{first…last}`,
+ * `ordinal.{one|two|few|other}`, `inZone`, `custom`, `customNext`.
+ */
+export declare function formatRefreshLabel(description: RefreshDescription, options: {
+    t: RefreshTranslate;
+    locale: string;
+    prefix: string;
+}): string;

package/dist/types/refreshSchedule.d.ts

@@ -0,0 +1,45 @@
+import { TriggerRefreshPolicy, TriggerRefreshPreset } from '@antcde/connect-ts';
+export type ScheduleFreq = 'hourly' | 'daily' | 'weekly' | 'monthly';
+/** 1–4, or -1 for "last". */
+export type ScheduleNth = 1 | 2 | 3 | 4 | -1;
+export type ScheduleMonthly = {
+    day: number;
+} | {
+    nth: ScheduleNth;
+    weekday: number;
+};
+export interface ScheduleSpec {
+    freq: ScheduleFreq;
+    interval: number;
+    /** 0 = Monday … 6 = Sunday. Weekly only. */
+    weekdays: number[];
+    /** Monthly only. */
+    monthly: ScheduleMonthly | null;
+    /** `HH:mm`; null for hourly, which counts from the start date's midnight. */
+    time: string | null;
+    /** `YYYY-MM-DD`: the anchor that makes "every 2 weeks" land on the right weeks. */
+    startDate: string;
+    /** IANA zone. */
+    timezone: string;
+}
+export type RefreshDescription = {
+    kind: 'interval';
+    preset: TriggerRefreshPreset;
+} | {
+    kind: 'schedule';
+    spec: ScheduleSpec;
+    foreignZone: boolean;
+} | {
+    kind: 'custom';
+    nextRefreshAt: string | null;
+};
+export declare const SCHEDULE_DAYS: readonly ["MO", "TU", "WE", "TH", "FR", "SA", "SU"];
+export declare function browserZone(): string;
+/** Weekly on Monday at 06:00 from today, in the browser's zone. */
+export declare function defaultScheduleSpec(today?: Date): ScheduleSpec;
+/** Monday-based weekday of a `YYYY-MM-DD` date. */
+export declare function weekdayOf(date: string): number;
+export declare function buildScheduleRule(spec: ScheduleSpec): string;
+export declare function parseScheduleRule(text: string | null | undefined): ScheduleSpec | null;
+/** A refresh policy as parts each app phrases in its own language. */
+export declare function describeRefresh(policy: TriggerRefreshPolicy | null | undefined, viewerZone?: string): RefreshDescription | null;

package/dist/types/refreshScheduleOccurrences.d.ts

@@ -0,0 +1,15 @@
+import { ScheduleSpec } from './refreshSchedule';
+export interface ScheduleOccurrence {
+    /** The real moment. */
+    at: Date;
+    /** The same moment as wall time in the schedule's zone, in UTC fields: format it with `timeZone: 'UTC'`. */
+    wall: Date;
+}
+/**
+ * The next refresh points of a schedule.
+ *
+ * ⚠️ rrule.js applies TZID relative to the HOST's zone, so the same rule gave different
+ * instants on machines in different zones. It runs on floating wall times here instead,
+ * and Intl turns each into a real instant in the schedule's own zone.
+ */
+export declare function nextOccurrences(spec: ScheduleSpec, count?: number, from?: Date): ScheduleOccurrence[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antcde/vue-utils",
   "type": "module",
-  "version": "0.2.28-rc.2",
+  "version": "0.2.28-rc.4",
   "description": "Helper to use ANT Comms in Vue 3",
   "author": "CollaborAll",
   "exports": {
@@ -22,6 +22,8 @@
     "build": "pnpm clean && vite build",
     "build:watch": "vite build --watch",
     "type-check": "vue-tsc --noEmit",
+    "test": "vitest --run",
+    "test:watch": "vitest",
     "clean": "pnpm dlx rimraf dist"
   },
   "peerDependencies": {
@@ -31,7 +33,8 @@
     "vue-i18n": "^11.1.12"
   },
   "dependencies": {
-    "@antcde/connect-ts": "0.4.33-rc.2"
+    "@antcde/connect-ts": "0.4.33-rc.4",
+    "rrule": "^2.8.1"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.6",
@@ -39,9 +42,11 @@
     "@vitejs/plugin-vue": "^6.0.9",
     "@vue/language-core": "^3.3.11",
     "@vue/tsconfig": "^0.9.1",
+    "happy-dom": "^20.14.5",
     "typescript": "~6.0.3",
     "vite": "^8.3.0",
     "vite-plugin-dts": "^5.1.1",
+    "vitest": "^5.0.1",
     "vue-tsc": "^3.3.11"
   }
 }