cronli5 0.3.4 → 0.8.0

package/dist/cronli5.js

@@ -26,10 +26,10 @@ var fieldSpecs = {
   second: { cyclic: true, max: 59, min: 0, top: 59 },
   minute: { cyclic: true, max: 59, min: 0, top: 59 },
   hour: { cyclic: true, max: 23, min: 0, top: 23 },
-  date: { aliases: { "?": "*" }, cyclic: true, max: 31, min: 1, top: 31 },
+  date: { cyclic: true, max: 31, min: 1, top: 31 },
   month: { cyclic: true, max: 12, min: 1, numbers: monthNumbers, top: 12 },
   weekday: {
-    aliases: { "?": "*", L: "6" },
+    aliases: { L: "6" },
     cyclic: true,
     max: 7,
     min: 0,
@@ -326,6 +326,53 @@ function firstFire(segment, spec) {
   return start === "*" ? spec.min : toFieldNumber(start, spec.numbers);
 }
 
+// src/core/quartz.ts
+var quartzTokenMessage = "`?` is a Quartz token \u2014 pass { quartz: true } to enable Quartz semantics.";
+function applyQuartz(cronPattern, quartz) {
+  if (!quartz) {
+    rejectQuartzToken(cronPattern.date);
+    rejectQuartzToken(cronPattern.weekday);
+    return;
+  }
+  if ("" + cronPattern.date === "?") {
+    cronPattern.date = "*";
+  }
+  if ("" + cronPattern.weekday === "?") {
+    cronPattern.weekday = "*";
+    return;
+  }
+  cronPattern.weekday = reindexWeekday("" + cronPattern.weekday);
+}
+function rejectQuartzToken(value) {
+  if ("" + value === "?") {
+    throw new Error(quartzTokenMessage);
+  }
+}
+function reindexWeekday(value) {
+  if (value === "*") {
+    return value;
+  }
+  return value.split(",").map(reindexSegment).join(",");
+}
+function reindexSegment(segment) {
+  const operator = /(#\d+|L)$/.exec(segment);
+  const suffix = operator ? operator[0] : "";
+  const core = suffix ? segment.slice(0, -suffix.length) : segment;
+  const step = core.split("/");
+  const range = step[0].split("-").map(reindexNumber).join("-");
+  const head = step.length === 2 ? range + "/" + step[1] : range;
+  return head + suffix;
+}
+function reindexNumber(token) {
+  if (!isNonNegativeInteger(token)) {
+    return token;
+  }
+  if (token === "0") {
+    throw new Error('`cronli5` was passed an invalid Quartz day-of-week value "0"; Quartz numbers weekdays 1 (Sunday) through 7 (Saturday).');
+  }
+  return "" + (+token - 1);
+}
+
 // src/core/parse.ts
 function parseCronPattern(cronPattern, opts) {
   const isArray = cronPattern instanceof Array;
@@ -461,13 +508,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -859,6 +913,7 @@ function hourTimesPlan(hourField) {
 // src/core/index.ts
 function prepare(cronPattern, opts) {
   const pattern = parseCronPattern(cronPattern, opts);
+  applyQuartz(pattern, opts.quartz);
   applyQuartzAliases(pattern);
   validateCronPattern(pattern);
   return normalizeCronPattern(pattern);
@@ -987,6 +1042,7 @@ function normalizeOptions(options) {
   return {
     ampm: typeof options.ampm === "boolean" ? options.ampm : true,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style: resolveDialect(options.dialect),
@@ -1579,7 +1635,7 @@ var renderers = {
 function renderStride2(stride, opts) {
   const { interval, start, last, cycle, unit, anchor } = stride;
   const cadence = "every " + getNumber(interval, opts) + " " + unit + "s";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     // A clean wrap from a non-zero offset: name the start, no endpoint.
     offset: () => cadence + " from " + getNumber(start, opts) + " " + pluralize(start, unit) + " past the " + anchor,
@@ -1630,7 +1686,7 @@ function stepHours(segment, opts) {
 function hourStrideCadence(stride, opts) {
   const { start, interval, last } = stride;
   const cadence = "every " + getNumber(interval, opts) + " hours";
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " from " + getTime({ hour: start, minute: 0 }, opts),
     bounded: () => cadence + " from " + getTime({ hour: start, minute: 0 }, opts) + through(opts) + getTime({ hour: last, minute: 0 }, opts)
@@ -2289,7 +2345,14 @@ function interpretCronPattern(cronPattern, lang, opts) {
   const plan = lang.plan ? lang.plan(schedule, schedule.plan) : schedule.plan;
   return lang.describe({ ...schedule, plan }, opts);
 }
-var cronli5_default = cronli5;
+function sentence(cronPattern, options) {
+  return cronli5(cronPattern, { ...options, sentence: true });
+}
+function fragment(cronPattern, options) {
+  return cronli5(cronPattern, { ...options, sentence: false });
+}
+var callable = Object.assign(cronli5, { sentence, fragment });
+var cronli5_default = callable;
 export {
   cronli5_default as default
 };

package/dist/lang/de.cjs

@@ -77,13 +77,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -209,7 +216,7 @@ function renderStride2(stride) {
   const { interval, start, last, cycle, unit, anchor } = stride;
   const cadence = everyN(interval, unit);
   const tail = anchor ? " " + anchor : "";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     offset: () => cadence + " ab " + unit.singular + " " + start + tail,
     bounded: () => cadence + " von " + unit.singular + " " + start + " bis " + last + tail
@@ -667,7 +674,7 @@ function openOffsetCleanStride(schedule, segment) {
 function hourStrideCadence(stride) {
   const { start, interval, last } = stride;
   const cadence = everyN(interval, UNITS.hour);
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " ab " + start + " Uhr",
     bounded: () => cadence + " von " + start + " bis " + last + " Uhr"
@@ -883,6 +890,7 @@ function normalizeOptions(options) {
   return {
     ampm: typeof options.ampm === "boolean" ? options.ampm : false,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style,

package/dist/lang/de.js

@@ -51,13 +51,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -183,7 +190,7 @@ function renderStride2(stride) {
   const { interval, start, last, cycle, unit, anchor } = stride;
   const cadence = everyN(interval, unit);
   const tail = anchor ? " " + anchor : "";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     offset: () => cadence + " ab " + unit.singular + " " + start + tail,
     bounded: () => cadence + " von " + unit.singular + " " + start + " bis " + last + tail
@@ -641,7 +648,7 @@ function openOffsetCleanStride(schedule, segment) {
 function hourStrideCadence(stride) {
   const { start, interval, last } = stride;
   const cadence = everyN(interval, UNITS.hour);
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " ab " + start + " Uhr",
     bounded: () => cadence + " von " + start + " bis " + last + " Uhr"
@@ -857,6 +864,7 @@ function normalizeOptions(options) {
   return {
     ampm: typeof options.ampm === "boolean" ? options.ampm : false,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style,

package/dist/lang/en.cjs

@@ -59,13 +59,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -242,6 +249,7 @@ function normalizeOptions(options) {
   return {
     ampm: typeof options.ampm === "boolean" ? options.ampm : true,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style: resolveDialect(options.dialect),
@@ -834,7 +842,7 @@ var renderers = {
 function renderStride2(stride, opts) {
   const { interval, start, last, cycle, unit, anchor } = stride;
   const cadence = "every " + getNumber(interval, opts) + " " + unit + "s";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     // A clean wrap from a non-zero offset: name the start, no endpoint.
     offset: () => cadence + " from " + getNumber(start, opts) + " " + pluralize(start, unit) + " past the " + anchor,
@@ -885,7 +893,7 @@ function stepHours(segment, opts) {
 function hourStrideCadence(stride, opts) {
   const { start, interval, last } = stride;
   const cadence = "every " + getNumber(interval, opts) + " hours";
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " from " + getTime({ hour: start, minute: 0 }, opts),
     bounded: () => cadence + " from " + getTime({ hour: start, minute: 0 }, opts) + through(opts) + getTime({ hour: last, minute: 0 }, opts)

package/dist/lang/en.js

@@ -33,13 +33,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -216,6 +223,7 @@ function normalizeOptions(options) {
   return {
     ampm: typeof options.ampm === "boolean" ? options.ampm : true,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style: resolveDialect(options.dialect),
@@ -808,7 +816,7 @@ var renderers = {
 function renderStride2(stride, opts) {
   const { interval, start, last, cycle, unit, anchor } = stride;
   const cadence = "every " + getNumber(interval, opts) + " " + unit + "s";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     // A clean wrap from a non-zero offset: name the start, no endpoint.
     offset: () => cadence + " from " + getNumber(start, opts) + " " + pluralize(start, unit) + " past the " + anchor,
@@ -859,7 +867,7 @@ function stepHours(segment, opts) {
 function hourStrideCadence(stride, opts) {
   const { start, interval, last } = stride;
   const cadence = "every " + getNumber(interval, opts) + " hours";
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " from " + getTime({ hour: start, minute: 0 }, opts),
     bounded: () => cadence + " from " + getTime({ hour: start, minute: 0 }, opts) + through(opts) + getTime({ hour: last, minute: 0 }, opts)

package/dist/lang/es.cjs

@@ -101,13 +101,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -224,6 +231,7 @@ function normalizeOptions(options) {
     // 12-hour for Mexico/US); an explicit `{ampm}` option overrides it.
     ampm: typeof options.ampm === "boolean" ? options.ampm : style.ampm,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style,
@@ -815,7 +823,7 @@ function renderStride2(stride, opts) {
   const { interval, start, last, cycle, unit, anchor } = stride;
   const cadence = "cada " + numero(interval, opts) + " " + unit + "s";
   const tail = anchor ? " de cada " + anchor : "";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     offset: () => cadence + " a partir del " + unit + " " + start + tail,
     bounded: () => cadence + " del " + unit + " " + start + " al " + last + tail
@@ -860,7 +868,7 @@ function stepHours(segment, opts) {
 function hourStrideCadence(stride, opts) {
   const { start, interval, last } = stride;
   const cadence = "cada " + numero(interval, opts) + " horas";
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " a partir de " + timePhrase(start, 0, null, opts),
     bounded: () => cadence + " de " + timePhrase(start, 0, null, opts) + " a " + timePhrase(last, 0, null, opts)

package/dist/lang/es.js

@@ -75,13 +75,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -198,6 +205,7 @@ function normalizeOptions(options) {
     // 12-hour for Mexico/US); an explicit `{ampm}` option overrides it.
     ampm: typeof options.ampm === "boolean" ? options.ampm : style.ampm,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style,
@@ -789,7 +797,7 @@ function renderStride2(stride, opts) {
   const { interval, start, last, cycle, unit, anchor } = stride;
   const cadence = "cada " + numero(interval, opts) + " " + unit + "s";
   const tail = anchor ? " de cada " + anchor : "";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     offset: () => cadence + " a partir del " + unit + " " + start + tail,
     bounded: () => cadence + " del " + unit + " " + start + " al " + last + tail
@@ -834,7 +842,7 @@ function stepHours(segment, opts) {
 function hourStrideCadence(stride, opts) {
   const { start, interval, last } = stride;
   const cadence = "cada " + numero(interval, opts) + " horas";
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " a partir de " + timePhrase(start, 0, null, opts),
     bounded: () => cadence + " de " + timePhrase(start, 0, null, opts) + " a " + timePhrase(last, 0, null, opts)

package/dist/lang/fi.cjs

@@ -101,13 +101,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -301,6 +308,7 @@ function normalizeOptions(options) {
   return {
     ampm: false,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style: resolveDialect(options.dialect),
@@ -750,7 +758,7 @@ var renderers = {
 function renderStride2(stride, opts) {
   const { interval, start, last, cycle, unit } = stride;
   const cadence = genitive(interval, opts) + " " + unit.gen + " v\xE4lein";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     offset: () => cadence + " " + unit.anchor + " " + unit.ela + " " + start + " alkaen",
     bounded: () => cadence + " " + unit.ela + " " + start + " " + unit.ill + " " + last
@@ -795,7 +803,7 @@ function stepHours(segment, opts) {
 function hourStrideCadence(stride, opts) {
   const { start, interval, last } = stride;
   const cadence = genitive(interval, opts) + " tunnin v\xE4lein";
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " klo " + hourElatives[start] + " alkaen",
     bounded: () => cadence + " " + kloRange({ hour: start, minute: 0 }, { hour: last, minute: 0 }, opts)

package/dist/lang/fi.js

@@ -75,13 +75,20 @@ function singleValues(segments) {
 function offsetCleanStride(stride) {
   return stride.start < stride.interval && 24 % stride.interval === 0;
 }
+function lastTileOf(start, interval, cycle) {
+  return cycle - 1 - (cycle - 1 - start) % interval;
+}
 function renderStride(spec, parts) {
-  const { start, interval, cycle } = spec;
-  const tiles = cycle % interval === 0;
-  if (start === 0 && tiles) {
+  const { start, interval, last, cycle } = spec;
+  const open = cycle % interval === 0 && last === lastTileOf(
+    start,
+    interval,
+    cycle
+  );
+  if (start === 0 && open) {
     return parts.bare();
   }
-  if (start < interval && tiles) {
+  if (start < interval && open) {
     return parts.offset();
   }
   return parts.bounded();
@@ -275,6 +282,7 @@ function normalizeOptions(options) {
   return {
     ampm: false,
     lenient: !!options.lenient,
+    quartz: !!options.quartz,
     seconds: !!options.seconds,
     short: !!options.short,
     style: resolveDialect(options.dialect),
@@ -724,7 +732,7 @@ var renderers = {
 function renderStride2(stride, opts) {
   const { interval, start, last, cycle, unit } = stride;
   const cadence = genitive(interval, opts) + " " + unit.gen + " v\xE4lein";
-  return renderStride({ start, interval, cycle }, {
+  return renderStride({ start, interval, last, cycle }, {
     bare: () => cadence,
     offset: () => cadence + " " + unit.anchor + " " + unit.ela + " " + start + " alkaen",
     bounded: () => cadence + " " + unit.ela + " " + start + " " + unit.ill + " " + last
@@ -769,7 +777,7 @@ function stepHours(segment, opts) {
 function hourStrideCadence(stride, opts) {
   const { start, interval, last } = stride;
   const cadence = genitive(interval, opts) + " tunnin v\xE4lein";
-  return renderStride({ start, interval, cycle: 24 }, {
+  return renderStride({ start, interval, last, cycle: 24 }, {
     bare: () => cadence,
     offset: () => cadence + " klo " + hourElatives[start] + " alkaen",
     bounded: () => cadence + " " + kloRange({ hour: start, minute: 0 }, { hour: last, minute: 0 }, opts)