@jtakeit/kit 0.5.2 → 0.7.0

package/lib/schedule.mjs

@@ -0,0 +1,46 @@
+/**
+ * Whether an entry is out yet, and still out — the platform's scheduled
+ * publishing, read the way the platform reads it.
+ *
+ * An entry's file may carry `"show_at"` (hidden until then) and `"hide_at"`
+ * (hidden from then on), both RFC 3339 in UTC. A build the platform makes
+ * rewrites such an entry to `visible: false` in its checkout before the
+ * generator runs, so on the platform this changes nothing. On a laptop the
+ * files are read as they are, and every reader here that asks `visible` — the
+ * drafts in `_meta.json` (meta.mjs), the content the check reads (content.mjs,
+ * and so lint.mjs) — asks this instead, so a post scheduled for next week is a
+ * draft and not a listing's missing row.
+ *
+ * `visible: false` hides an entry whatever its dates say. A value that is not
+ * a time is no schedule: the platform refuses one where it is written, and a
+ * file edited by hand that says `"next week"` is shown rather than hidden for
+ * a reason nobody can see.
+ *
+ * The scaffold's entry loader asks the same question in
+ * `template/src/lib/schedule.ts` — a copy, not an import: a scaffold is built
+ * against the published kit, which may not have this file yet. The two are
+ * held to one answer by `test/schedule.test.mjs` at the repository's root.
+ */
+
+/**
+ * Whether the site lists the entry at `now` (milliseconds since the epoch).
+ * @param {{ visible?: boolean; show_at?: unknown; hide_at?: unknown } | null | undefined} document
+ * @param {number} [now]
+ * @returns {boolean}
+ */
+export function shownAt(document, now = Date.now()) {
+  if (document == null) return true;
+  if (document.visible === false) return false;
+  const show = instant(document.show_at);
+  if (show !== undefined && now < show) return false;
+  const hide = instant(document.hide_at);
+  if (hide !== undefined && now >= hide) return false;
+  return true;
+}
+
+/** A time written down, or `undefined` for none and for one that is not a time. */
+function instant(value) {
+  if (typeof value !== 'string' || value.trim() === '') return undefined;
+  const at = Date.parse(value);
+  return Number.isNaN(at) ? undefined : at;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jtakeit/kit",
-  "version": "0.5.2",
+  "version": "0.7.0",
   "description": "The framework-free half of a site on jtakeit: the booking form as an element and as markup, for Astro through @jtakeit/astro and for any other generator directly",
   "license": "MIT",
   "type": "module",
@@ -24,6 +24,10 @@
       "types": "./types/parts.d.ts",
       "default": "./lib/booking/parts.mjs"
     },
+    "./booking/hooks": {
+      "types": "./types/hooks.d.ts",
+      "default": "./lib/booking/hooks.mjs"
+    },
     "./lead": {
       "types": "./types/lead.d.ts",
       "default": "./lib/lead/render.mjs"

package/types/booking.d.ts

@@ -7,6 +7,7 @@ export interface Named {
   rates?: { day: string; from: number; until: number; costs: number }[];
   /** `'person'` for a price times the party — a class per place, shoes; the list says so and the running total multiplies. */
   per?: 'booking' | 'person';
+  /** The heading a service is listed under: the words — an option's label, a category's title — not the stored value. Services with none come after every heading. */
   group?: string;
   /** For a resource: the services they perform, by slug. The element greys the others out once they are chosen. */
   does?: string[];
@@ -34,5 +35,26 @@ export interface BookingFormProps {
 
 /** What the form sends to /api/book, as `data-sends` says it. */
 export const SENDS: readonly string[];
+/** What the booking form is made of, for a page that writes the markup itself (the scaffold's BookingForm.astro). */
+export interface BookingForm {
+  /** The form's words in the page's language; the platform's answer replaces the kind's. */
+  words: Record<string, string>;
+  /** The language tag prices and days are written in. */
+  lang: string;
+  /** A checklist, or one `<select>`. */
+  combine: boolean;
+  /** The checklist's runs: headings in order, the ones with none after them, add-ons last. `meta` is «45 min · CHF 95». */
+  runs: { group: string; items: (Named & { meta: string })[] }[];
+  /** For one `<select>`, as they came. */
+  services: Named[];
+  /** The choice of whom — empty for none; `does` is the slugs joined for `data-does`. */
+  resources: (Omit<Named, 'does'> & { does: string })[];
+  /** The day input's `min` and `max`. */
+  today: string;
+  last: string;
+  /** Every attribute of the `<form>` — `data-booking`, `data-api`, `data-sends`, `novalidate`… — to spread on it. */
+  attrs: Record<string, string>;
+}
+export function bookingForm(props: BookingFormProps): BookingForm;
 /** The booking form as HTML, wrapped in `<jtk-booking>`. */
 export function renderBookingForm(props: BookingFormProps): string;

package/types/content.d.ts

@@ -1,5 +1,5 @@
 /** The published content as one document, from the files in `jtk/` — what the build renders from. */
-export function collectContent(root: string, options?: { dir?: string }): Promise<{
+export function collectContent(root: string, options?: { dir?: string; now?: number }): Promise<{
   schema_version: number;
   content_rev: number;
   site: { slug: string; locale: string; media_base: string; business: Record<string, unknown> };

package/types/elements-booking.d.ts

@@ -7,3 +7,4 @@ export class JtkBooking extends HTMLElement {
   connectedCallback(): void;
 }
 export function defineBooking(name?: string): void;
+export const BOOKING_PROTOCOL: number;

package/types/hooks.d.ts

@@ -0,0 +1,12 @@
+export interface Hook {
+  hook: string;
+  says: string;
+}
+/** Every form has these, or it cannot book. */
+export const ALWAYS: readonly Hook[];
+/** Shown only when the platform's answer asks; preflight fails a form without one where the business asks. */
+export const ASKED: readonly (Hook & { when: string })[];
+/** Where the element writes what happened; left out, that line is not said. */
+export const SAID: readonly Hook[];
+export const HOOKS: readonly string[];
+export function lacking(form: ParentNode): string[];

package/types/index.d.ts

@@ -1,5 +1,7 @@
-export { renderBookingForm, SENDS } from './booking';
-export type { BookingFormProps, Named } from './booking';
+export { renderBookingForm, bookingForm, SENDS } from './booking';
+export type { BookingFormProps, BookingForm, Named } from './booking';
+export { ALWAYS, ASKED, SAID, HOOKS } from './hooks';
+export type { Hook } from './hooks';
 export { renderLeadForm, inputType } from './lead';
 export type { Ask, LeadCopy, LeadPaths, LeadFormProps } from './lead';
 export { wordsFor, LOCALES } from './words';

package/types/meta.d.ts

@@ -21,6 +21,6 @@ export function specimenAddresses(
   blocks: { type: string; views?: { key: string }[] }[],
   locales?: string[],
 ): string[];
-export function hiddenEntries(root?: string): Promise<string[]>;
+export function hiddenEntries(root?: string, now?: number): Promise<string[]>;
 export function buildMeta(what?: MetaInput): Promise<Meta>;
 export function writeMeta(dir: string, what?: MetaInput): Promise<Meta>;