@pmeweb/content 1.0.0 → 1.1.0

package/README.md

@@ -8,7 +8,7 @@ collections in `src/content.schema.json`; this package is what reads that declar
 | `@pmeweb/content/types` | `CollectionDecl`, `Field`, `ScheduleDecl`, `ContentSchema` | sites, portal |
 | `@pmeweb/content/zodFrom` | declaration -> Astro zod schema (needs `astro`) | sites |
 | `@pmeweb/content/fields` | `isDate`, `isDateTime`, `isTime`, `isDayDate`, `TIME_RE` | portal tier 1, `zodFrom` |
-| `@pmeweb/content/schedule` | `scheduleState`, `visibleOnSite`, `scheduleErrors`, `jourQuebec`, `quebecDay` | sites, portal |
+| `@pmeweb/content/schedule` | `scheduleState`, `visibleOnSite`, `portalPreview`, `scheduleErrors`, `jourQuebec`, `quebecDay` | sites, portal |
 
 ## Dated kinds
 
@@ -28,6 +28,15 @@ collections in `src/content.schema.json`; this package is what reads that declar
   latest value in the array. Always read as a Quebec day: the entry stays through that whole day
   and comes off at the next day's rebuild. A site that declares a schedule needs a daily rebuild.
 
+## The portal preview
+
+The builder sets `PMEWEB_PORTAL_PREVIEW=1` on the portal's preview builds, and
+`PMEWEB_PORTAL_PREVIEW_PAST=1` too when the client ticked « Afficher les entrées passées ». A site
+reads both once, `const APERCU = portalPreview(process.env)`, and filters with
+`visibleOnSite(scheduleState(data, decl.<collection>, now), APERCU)`: live entries always,
+scheduled ones in the preview, removed ones only in a preview that asked for them. Only the exact
+string `'1'` counts, and the past flag means nothing without the preview flag.
+
 ## Versioning
 
 Sites and the portal pin an EXACT version. What `scheduleState` returns and what the field checks

package/dist/schedule.d.ts

@@ -47,7 +47,22 @@ export declare function scheduleErrors(c: SchedulableLike): string[];
  */
 export declare function scheduleState(data: Record<string, unknown>, c: SchedulableLike, now: Date): ScheduleState;
 /**
- * What a site builds. The portal's PRIVATE preview (`PMEWEB_PORTAL_PREVIEW === '1'`) shows a
- * scheduled entry early so the client can check it; it never brings back a removed one.
+ * What kind of build this is, read from the two variables the portal's builder sets.
+ *
+ * `active` is the portal's PRIVATE preview (`PMEWEB_PORTAL_PREVIEW`): it shows a scheduled entry
+ * early so the client can check it. `showPast` is « Afficher les entrées passées » in the portal
+ * (`PMEWEB_PORTAL_PREVIEW_PAST`), which brings back entries already off the site so the client
+ * can see the one they are correcting.
+ *
+ * ONLY THE EXACT STRING `'1'` COUNTS, and `showPast` MEANS NOTHING WITHOUT `active`. The
+ * dangerous failure is a past or future entry on the LIVE site, so every other value -- absent,
+ * empty, `true` -- reads as « not a preview », and no environment can turn on the past without
+ * the preview signal the builder sets for its own builds only.
  */
-export declare function visibleOnSite(state: ScheduleState, portalPreview: boolean): boolean;
+export interface PortalPreview {
+    active: boolean;
+    showPast: boolean;
+}
+export declare function portalPreview(env: Record<string, string | undefined>): PortalPreview;
+/** What a site builds: live always; scheduled in the preview; removed only when asked for. */
+export declare function visibleOnSite(state: ScheduleState, preview: PortalPreview): boolean;

package/dist/schedule.js

@@ -174,10 +174,15 @@ export function scheduleState(data, c, now) {
     const d = removeDay(data, c);
     return d !== null && quebecDayOf(now.getTime()) > d ? 'removed' : 'live';
 }
-/**
- * What a site builds. The portal's PRIVATE preview (`PMEWEB_PORTAL_PREVIEW === '1'`) shows a
- * scheduled entry early so the client can check it; it never brings back a removed one.
- */
-export function visibleOnSite(state, portalPreview) {
-    return state === 'live' || (state === 'scheduled' && portalPreview);
+export function portalPreview(env) {
+    const active = env.PMEWEB_PORTAL_PREVIEW === '1';
+    return { active, showPast: active && env.PMEWEB_PORTAL_PREVIEW_PAST === '1' };
+}
+/** What a site builds: live always; scheduled in the preview; removed only when asked for. */
+export function visibleOnSite(state, preview) {
+    if (state === 'live')
+        return true;
+    if (!preview.active)
+        return false;
+    return state === 'scheduled' || preview.showPast;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pmeweb/content",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "PmeWeb content contract: content.schema.json types, zodFrom, field checks, scheduling. Read by every site's build and by the client portal.",
   "type": "module",
   "license": "MIT",