@prenta/core 8.9.2 → 8.11.0

package/dist/chrome/schema.d.ts

@@ -0,0 +1,231 @@
+/**
+ * Code-first site chrome (DATA_CONTRACTS §2). A site declares what editors may
+ * change in its header and footer with `defineRegion` and the `field.*`
+ * builders, imported from `@prenta/core/config`:
+ *
+ *   export const header = defineRegion('header', {
+ *     component: './src/components/site/Header.astro',
+ *     variants: { default: 'Logo left, menu right', minimal: 'Logo + CTA' },
+ *     fields: { menu: field.menu({ default: 'main' }), cta: field.link({ optional: true }) },
+ *   })
+ *
+ * Markup stays in the site's components. `prenta push chrome` sends the
+ * serialized schema to the CMS on deploy, and the saved values are typed per
+ * region: `RegionFieldValues<typeof header>` for what the CMS stores,
+ * `ChromeFieldsOf<typeof header>` for what `getChrome` returns.
+ *
+ * This module has no runtime dependencies, so a site can import it anywhere.
+ */
+import type { ResolvedLogo } from '../appearance/types.js';
+import type { PublicNavItem } from '../site.js';
+/** The regions a site can define. The announcement bar is CMS-owned. */
+export declare const CHROME_REGIONS: readonly ["header", "footer"];
+export type ChromeRegionName = (typeof CHROME_REGIONS)[number];
+/** Options every field takes. */
+export interface FieldCommon {
+    label?: string;
+    help?: string;
+    /** The key this field had before. Its saved value moves over on the next schema read. */
+    renamedFrom?: string;
+}
+/** Read-only. The value comes from Settings > Brand. */
+export interface BrandFieldDef extends FieldCommon {
+    type: 'brand';
+    key: 'logo' | 'name';
+}
+/** A menu, by its slug. `list` picks up to `max` menus (footer columns). */
+export interface MenuFieldDef extends FieldCommon {
+    type: 'menu';
+    optional?: boolean;
+    list?: boolean;
+    max?: number;
+    default?: string;
+}
+export interface LinkFieldDef extends FieldCommon {
+    type: 'link';
+    optional?: boolean;
+}
+export interface TextFieldDef extends FieldCommon {
+    type: 'text';
+    optional?: boolean;
+    format?: 'tel' | 'email';
+    /** Placeholders the CMS fills in, such as `{year}`. */
+    tokens?: readonly string[];
+    max?: number;
+}
+export interface TextareaFieldDef extends FieldCommon {
+    type: 'textarea';
+    max?: number;
+}
+export interface SelectFieldDef<O extends string = string> extends FieldCommon {
+    type: 'select';
+    options: readonly O[];
+    default?: O;
+}
+export interface BooleanFieldDef extends FieldCommon {
+    type: 'boolean';
+    default?: boolean;
+}
+/** A list of `{ platform, url }` links. */
+export interface SocialFieldDef extends FieldCommon {
+    type: 'social';
+}
+export type FieldDef = BrandFieldDef | MenuFieldDef | LinkFieldDef | TextFieldDef | TextareaFieldDef | SelectFieldDef | BooleanFieldDef | SocialFieldDef;
+export type FieldType = FieldDef['type'];
+export interface RegionDefinition<N extends ChromeRegionName = ChromeRegionName, V extends string = string, F extends Record<string, FieldDef> = Record<string, FieldDef>> {
+    region: N;
+    /** Path of the component that renders the region, shown in the CMS. */
+    component: string;
+    /** Variant id → label. The first one is the site default until an editor picks another. */
+    variants: Record<V, string>;
+    fields: F;
+}
+type Options<T extends FieldDef> = Omit<T, 'type'>;
+/** A builder called without options. */
+type NoOptions = Record<never, never>;
+/**
+ * Field builders. Each keeps its options as literal types, so
+ * `field.link({ optional: true })` stores `{ on, label, url }` and
+ * `field.select(['dark', 'light'])` stores `'dark' | 'light'`.
+ */
+export declare const field: {
+    brand<const K extends BrandFieldDef["key"]>(key: K, options?: FieldCommon): {
+        type: "brand";
+        key: K;
+    };
+    menu<const O extends Options<MenuFieldDef> = NoOptions>(options?: O): {
+        type: "menu";
+    } & O;
+    link<const O extends Options<LinkFieldDef> = NoOptions>(options?: O): {
+        type: "link";
+    } & O;
+    text<const O extends Options<TextFieldDef> = NoOptions>(options?: O): {
+        type: "text";
+    } & O;
+    textarea<const O extends Options<TextareaFieldDef> = NoOptions>(options?: O): {
+        type: "textarea";
+    } & O;
+    select<const T extends string, const O extends Omit<Options<SelectFieldDef<T>>, "options" | "default"> & {
+        default?: NoInfer<T>;
+    } = NoOptions>(options: readonly T[], extra?: O): {
+        type: "select";
+        options: T[];
+    } & O;
+    boolean<const O extends Options<BooleanFieldDef> = NoOptions>(options?: O): {
+        type: "boolean";
+    } & O;
+    social<const O extends Options<SocialFieldDef> = NoOptions>(options?: O): {
+        type: "social";
+    } & O;
+};
+/**
+ * Declare an editable region. The returned object is plain data plus a hidden
+ * marker, so `prenta push chrome` can find every region a config exports.
+ */
+export declare function defineRegion<const N extends ChromeRegionName, const V extends string, const F extends Record<string, FieldDef>>(name: N, definition: {
+    component: string;
+    variants: Record<V, string>;
+    fields: F;
+}): RegionDefinition<N, V, F>;
+/** Whether a value came from `defineRegion`. */
+export declare function isRegionDefinition(value: unknown): value is RegionDefinition;
+/** The plain JSON `prenta push chrome` sends for one region (`PUT /chrome/schema`). */
+export declare function serializeRegion(definition: RegionDefinition): {
+    region: ChromeRegionName;
+    component: string;
+    variants: Record<string, string>;
+    fields: Record<string, FieldDef>;
+};
+export interface ChromeLinkValue {
+    label: string;
+    url: string;
+}
+export interface ChromeSocialLink {
+    platform: string;
+    url: string;
+}
+/** How an optional field is stored: a switch next to its value. */
+export type Toggle<T> = {
+    on: boolean;
+} & T;
+/** What the CMS stores for one field. Brand fields store nothing. */
+export type StoredFieldValue<F extends FieldDef> = F extends {
+    type: 'menu';
+    list: true;
+} ? string[] : F extends {
+    type: 'menu';
+    optional: true;
+} ? Toggle<{
+    value: string;
+}> : F extends {
+    type: 'menu';
+} ? string : F extends {
+    type: 'link';
+    optional: true;
+} ? Toggle<ChromeLinkValue> : F extends {
+    type: 'link';
+} ? ChromeLinkValue : F extends {
+    type: 'text';
+    optional: true;
+} ? Toggle<{
+    value: string;
+}> : F extends {
+    type: 'text' | 'textarea';
+} ? string : F extends {
+    type: 'select';
+    options: readonly (infer O extends string)[];
+} ? O : F extends {
+    type: 'boolean';
+} ? boolean : F extends {
+    type: 'social';
+} ? ChromeSocialLink[] : never;
+type FieldsOf<R extends RegionDefinition> = R['fields'];
+/** `RegionValues.fields` for one region: every editable field, each optional. */
+export type RegionFieldValues<R extends RegionDefinition> = {
+    [K in keyof FieldsOf<R> as FieldsOf<R>[K] extends {
+        type: 'brand';
+    } ? never : K]?: StoredFieldValue<FieldsOf<R>[K]>;
+};
+/** A menu as the site receives it. `id` is the menu's slug. */
+export interface ChromeMenu {
+    id: string;
+    name: string;
+    items: PublicNavItem[];
+}
+/** What `getChrome` returns for one field. */
+export type PublicFieldValue<F extends FieldDef> = F extends {
+    type: 'brand';
+    key: 'logo';
+} ? ResolvedLogo | null : F extends {
+    type: 'brand';
+} ? string : F extends {
+    type: 'menu';
+    list: true;
+} ? ChromeMenu[] : F extends {
+    type: 'menu';
+} ? ChromeMenu | null : F extends {
+    type: 'link';
+} ? ChromeLinkValue | null : F extends {
+    type: 'text';
+    optional: true;
+} ? string | null : F extends {
+    type: 'text' | 'textarea';
+} ? string : F extends {
+    type: 'select';
+    options: readonly (infer O extends string)[];
+} ? O : F extends {
+    type: 'boolean';
+} ? boolean : F extends {
+    type: 'social';
+} ? ChromeSocialLink[] : never;
+/** The `fields` a site receives for one region. */
+export type ChromeFieldsOf<R extends RegionDefinition> = {
+    [K in keyof FieldsOf<R>]: PublicFieldValue<FieldsOf<R>[K]>;
+};
+/** A region as `getChrome` returns it. */
+export interface ResolvedRegion<R extends RegionDefinition = RegionDefinition> {
+    variant: Extract<keyof R['variants'], string>;
+    fields: ChromeFieldsOf<R>;
+}
+export {};
+//# sourceMappingURL=schema.d.ts.map

package/dist/chrome/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/chrome/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE/C,wEAAwE;AACxE,eAAO,MAAM,cAAc,+BAAgC,CAAA;AAC3D,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE9D,iCAAiC;AACjC,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,yFAAyF;IACzF,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,wDAAwD;AACxD,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,IAAI,EAAE,OAAO,CAAA;IACb,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACrB;AACD,4EAA4E;AAC5E,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AACD,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AACD,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,KAAK,GAAG,OAAO,CAAA;IACxB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AACD,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,IAAI,EAAE,UAAU,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AACD,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,WAAW;IAC5E,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,EAAE,SAAS,CAAC,EAAE,CAAA;IACrB,OAAO,CAAC,EAAE,CAAC,CAAA;CACZ;AACD,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AACD,2CAA2C;AAC3C,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,IAAI,EAAE,QAAQ,CAAA;CACf;AAED,MAAM,MAAM,QAAQ,GAChB,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,cAAc,CAAA;AAElB,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;AAExC,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,EAC7C,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;IAE7D,MAAM,EAAE,CAAC,CAAA;IACT,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAA;IACjB,2FAA2F;IAC3F,QAAQ,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;IAC3B,MAAM,EAAE,CAAC,CAAA;CACV;AAED,KAAK,OAAO,CAAC,CAAC,SAAS,QAAQ,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;AAClD,wCAAwC;AACxC,KAAK,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAWrC;;;;GAIG;AACH,eAAO,MAAM,KAAK;gBACJ,CAAC,SAAS,aAAa,CAAC,KAAK,CAAC,OACnC,CAAC,YACI,WAAW,GACpB;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,GAAG,EAAE,CAAC,CAAA;KAAE;eAGjB,CAAC,SAAS,OAAO,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,CAAC;eAG/E,CAAC,SAAS,OAAO,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,CAAC;eAG/E,CAAC,SAAS,OAAO,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,CAAC;mBAG3E,CAAC,SAAS,OAAO,CAAC,gBAAgB,CAAC,wBACtC,CAAC,GACV;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,CAAC;iBAInB,CAAC,SAAS,MAAM,QAChB,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC,GAAG;QACxE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;KACrB,uBACQ,SAAS,CAAC,EAAE,UAAU,CAAC,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,CAAC,EAAE,CAAA;KAAE,GAAG,CAAC;kBAM3D,CAAC,SAAS,OAAO,CAAC,eAAe,CAAC,wBACpC,CAAC,GACV;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC;iBAGb,CAAC,SAAS,OAAO,CAAC,cAAc,CAAC,wBAAwB,CAAC,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,CAAC;CAGjG,CAAA;AAID;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,KAAK,CAAC,CAAC,SAAS,gBAAgB,EAChC,KAAK,CAAC,CAAC,SAAS,MAAM,EACtB,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EAExC,IAAI,EAAE,CAAC,EACP,UAAU,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAE,GACxE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAS3B;AAED,gDAAgD;AAChD,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,gBAAgB,CAM5E;AAED,uFAAuF;AACvF,wBAAgB,eAAe,CAAC,UAAU,EAAE,gBAAgB,GAAG;IAC7D,MAAM,EAAE,gBAAgB,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;CACjC,CASA;AAID,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;CACZ;AACD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AACD,mEAAmE;AACnE,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;IAAE,EAAE,EAAE,OAAO,CAAA;CAAE,GAAG,CAAC,CAAA;AAE3C,qEAAqE;AACrE,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,QAAQ,IAAI,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,GACrF,MAAM,EAAE,GACR,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,GACxC,MAAM,CAAC;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GACzB,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GACxB,MAAM,GACN,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,GACxC,MAAM,CAAC,eAAe,CAAC,GACvB,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GACxB,eAAe,GACf,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,GACxC,MAAM,CAAC;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GACzB,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;CAAE,GACrC,MAAM,GACN,CAAC,SAAS;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,EAAE,CAAA;CAAE,GACxE,CAAC,GACD,CAAC,SAAS;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAC3B,OAAO,GACP,CAAC,SAAS;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAC1B,gBAAgB,EAAE,GAClB,KAAK,CAAA;AAE3B,KAAK,QAAQ,CAAC,CAAC,SAAS,gBAAgB,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;AAEvD,iFAAiF;AACjF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,gBAAgB,IAAI;KACzD,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAC/D,KAAK,GACL,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1C,CAAA;AAED,+DAA+D;AAC/D,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,aAAa,EAAE,CAAA;CACvB;AAED,8CAA8C;AAC9C,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,QAAQ,IAAI,CAAC,SAAS;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACvF,YAAY,GAAG,IAAI,GACnB,CAAC,SAAS;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACzB,MAAM,GACN,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,GACpC,UAAU,EAAE,GACZ,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GACxB,UAAU,GAAG,IAAI,GACjB,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GACxB,eAAe,GAAG,IAAI,GACtB,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,GACxC,MAAM,GAAG,IAAI,GACb,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;CAAE,GACrC,MAAM,GACN,CAAC,SAAS;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,EAAE,CAAA;CAAE,GACxE,CAAC,GACD,CAAC,SAAS;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAC3B,OAAO,GACP,CAAC,SAAS;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAC1B,gBAAgB,EAAE,GAClB,KAAK,CAAA;AAE3B,mDAAmD;AACnD,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,gBAAgB,IAAI;KACtD,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3D,CAAA;AAED,0CAA0C;AAC1C,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAC3E,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAA;IAC7C,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAA;CAC1B"}

package/dist/chrome/schema.js

@@ -0,0 +1,73 @@
+/** The regions a site can define. The announcement bar is CMS-owned. */
+export const CHROME_REGIONS = ['header', 'footer'];
+/** Copy only the options that were set, so the serialized schema stays small and stable. */
+function defined(type, options) {
+    const out = { type };
+    for (const [key, value] of Object.entries(options ?? {})) {
+        if (value !== undefined)
+            out[key] = Array.isArray(value) ? [...value] : value;
+    }
+    return out;
+}
+/**
+ * Field builders. Each keeps its options as literal types, so
+ * `field.link({ optional: true })` stores `{ on, label, url }` and
+ * `field.select(['dark', 'light'])` stores `'dark' | 'light'`.
+ */
+export const field = {
+    brand(key, options) {
+        return { ...defined('brand', options), key };
+    },
+    menu(options) {
+        return defined('menu', options);
+    },
+    link(options) {
+        return defined('link', options);
+    },
+    text(options) {
+        return defined('text', options);
+    },
+    textarea(options) {
+        return defined('textarea', options);
+    },
+    select(options, extra) {
+        return { ...defined('select', extra), options: [...options] };
+    },
+    boolean(options) {
+        return defined('boolean', options);
+    },
+    social(options) {
+        return defined('social', options);
+    },
+};
+const REGION_BRAND = Symbol.for('prenta.chrome.region');
+/**
+ * Declare an editable region. The returned object is plain data plus a hidden
+ * marker, so `prenta push chrome` can find every region a config exports.
+ */
+export function defineRegion(name, definition) {
+    const region = {
+        region: name,
+        component: definition.component,
+        variants: { ...definition.variants },
+        fields: { ...definition.fields },
+    };
+    Object.defineProperty(region, REGION_BRAND, { value: true });
+    return region;
+}
+/** Whether a value came from `defineRegion`. */
+export function isRegionDefinition(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        value[REGION_BRAND] === true);
+}
+/** The plain JSON `prenta push chrome` sends for one region (`PUT /chrome/schema`). */
+export function serializeRegion(definition) {
+    return JSON.parse(JSON.stringify({
+        region: definition.region,
+        component: definition.component,
+        variants: definition.variants,
+        fields: definition.fields,
+    }));
+}
+//# sourceMappingURL=schema.js.map

package/dist/chrome/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/chrome/schema.ts"],"names":[],"mappings":"AAqBA,wEAAwE;AACxE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAA;AAmF3D,4FAA4F;AAC5F,SAAS,OAAO,CAAmB,IAAY,EAAE,OAAsB;IACrE,MAAM,GAAG,GAA4B,EAAE,IAAI,EAAE,CAAA;IAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;QACzD,IAAI,KAAK,KAAK,SAAS;YAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IAC/E,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,KAAK,CACH,GAAM,EACN,OAAqB;QAErB,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,GAAG,EAA+B,CAAA;IAC3E,CAAC;IACD,IAAI,CAAoD,OAAW;QACjE,OAAO,OAAO,CAAC,MAAM,EAAE,OAAO,CAAyB,CAAA;IACzD,CAAC;IACD,IAAI,CAAoD,OAAW;QACjE,OAAO,OAAO,CAAC,MAAM,EAAE,OAAO,CAAyB,CAAA;IACzD,CAAC;IACD,IAAI,CAAoD,OAAW;QACjE,OAAO,OAAO,CAAC,MAAM,EAAE,OAAO,CAAyB,CAAA;IACzD,CAAC;IACD,QAAQ,CACN,OAAW;QAEX,OAAO,OAAO,CAAC,UAAU,EAAE,OAAO,CAA6B,CAAA;IACjE,CAAC;IACD,MAAM,CAKJ,OAAqB,EAAE,KAAS;QAChC,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EAGtD,CAAA;IACP,CAAC;IACD,OAAO,CACL,OAAW;QAEX,OAAO,OAAO,CAAC,SAAS,EAAE,OAAO,CAA4B,CAAA;IAC/D,CAAC;IACD,MAAM,CAAsD,OAAW;QACrE,OAAO,OAAO,CAAC,QAAQ,EAAE,OAAO,CAA2B,CAAA;IAC7D,CAAC;CACF,CAAA;AAED,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;AAEvD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAK1B,IAAO,EACP,UAAyE;IAEzE,MAAM,MAAM,GAA8B;QACxC,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,QAAQ,EAAE,EAAE,GAAG,UAAU,CAAC,QAAQ,EAAE;QACpC,MAAM,EAAE,EAAE,GAAG,UAAU,CAAC,MAAM,EAAE;KACjC,CAAA;IACD,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5D,OAAO,MAAM,CAAA;AACf,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACb,KAAiC,CAAC,YAAY,CAAC,KAAK,IAAI,CAC1D,CAAA;AACH,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,eAAe,CAAC,UAA4B;IAM1D,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,CAAC,SAAS,CAAC;QACb,MAAM,EAAE,UAAU,CAAC,MAAM;QACzB,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,MAAM,EAAE,UAAU,CAAC,MAAM;KAC1B,CAAC,CACmC,CAAA;AACzC,CAAC"}

package/dist/chrome/service.d.ts

@@ -0,0 +1,76 @@
+import type { Announcement, ChromeOrphan, ChromeSchemaReadResult, ChromeSyncStatus, RegionSchema } from './contract.js';
+import type { SchemaReadInput } from './parse.js';
+import { type ChromeRegionName } from './schema.js';
+import { type ChromeRow, type ChromeStore } from './store.js';
+export type ChromeFailure = {
+    ok: false;
+    status: 400 | 404 | 409 | 412;
+    error: string;
+};
+/**
+ * ETag for `GET /chrome/:region`, over what the editor sees: the schema, the
+ * values and the live orphans. A cron purge of expired orphans doesn't change it.
+ */
+export declare function regionEtag(row: ChromeRow, now: Date): string;
+/** ETag for `GET /chrome/announcement`, over its content only, so a schedule tick doesn't change it. */
+export declare function announcementEtag(announcement: Announcement): string;
+/** `If-Match` as sent, or null for no precondition. A `*` always matches. */
+export declare function readIfMatch(request: Request): string | null;
+export interface ChromeSchemaView {
+    regions: RegionSchema[];
+    sync: ChromeSyncStatus;
+}
+export declare function getChromeSchema(store: ChromeStore): Promise<ChromeSchemaView>;
+/**
+ * Store a pushed schema and fit each region's values to it. A region the push
+ * leaves out loses its schema (the site falls back to layout variants) and its
+ * values become orphans, which come back if the region does within 30 days.
+ */
+export declare function readChromeSchema(store: ChromeStore, input: SchemaReadInput, options: {
+    userId: string | null;
+    now: Date;
+}): Promise<ChromeSchemaReadResult | ChromeFailure>;
+export interface RegionView {
+    row: ChromeRow;
+    schema: RegionSchema;
+    variant: string;
+    orphans: ChromeOrphan[];
+}
+export declare function getRegion(store: ChromeStore, region: ChromeRegionName, now: Date): Promise<RegionView | ChromeFailure>;
+/** `PUT /chrome/:region`: replace the variant and field values. Orphans are kept. */
+export declare function saveRegion(store: ChromeStore, region: ChromeRegionName, body: unknown, options: {
+    userId: string;
+    ifMatch: string | null;
+    now: Date;
+}): Promise<RegionView | ChromeFailure>;
+/** `DELETE /chrome/:region/orphans/:key`, the orphan notice's "Remove now". */
+export declare function removeOrphan(store: ChromeStore, region: ChromeRegionName, key: string, options: {
+    userId: string;
+    now: Date;
+}): Promise<RegionView | ChromeFailure>;
+/** Cleanup cron: drop orphans older than 30 days. A row that changes meanwhile waits for the next run. */
+export declare function purgeExpiredOrphans(store: ChromeStore, now: Date): Promise<number>;
+export interface AnnouncementView {
+    announcement: Announcement;
+    row: ChromeRow | null;
+}
+export declare function getAnnouncement(store: ChromeStore): Promise<AnnouncementView>;
+/** `PUT /chrome/announcement`. A boundary already past counts as fired, since the save revalidates. */
+export declare function saveAnnouncement(store: ChromeStore, body: unknown, options: {
+    userId: string;
+    ifMatch: string | null;
+    now: Date;
+}): Promise<AnnouncementView | ChromeFailure>;
+/**
+ * Publish cron: revalidate the site when a scheduled announcement starts or
+ * ends. The webhook goes first and the boundary is marked after, so a crash
+ * in between fires it again on the next tick rather than never. Overlapping
+ * ticks can both fire; a second `chrome.updated` is harmless.
+ */
+export declare function processAnnouncementSchedule(store: ChromeStore, options: {
+    now: Date;
+    revalidate: (region: string) => Promise<void>;
+}): Promise<{
+    fired: Array<'start' | 'end'>;
+}>;
+//# sourceMappingURL=service.d.ts.map

package/dist/chrome/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/chrome/service.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,YAAY,EAEb,MAAM,eAAe,CAAA;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AACjD,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAA;AACnE,OAAO,EAAoB,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAA;AAc/E,MAAM,MAAM,aAAa,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAoBvF;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,GAAG,MAAM,CAO5D;AAED,wGAAwG;AACxG,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED,6EAA6E;AAC7E,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAG3D;AAkCD,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,IAAI,EAAE,gBAAgB,CAAA;CACvB;AAED,wBAAsB,eAAe,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAoBnF;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,WAAW,EAClB,KAAK,EAAE,eAAe,EACtB,OAAO,EAAE;IAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,IAAI,CAAA;CAAE,GAC5C,OAAO,CAAC,sBAAsB,GAAG,aAAa,CAAC,CA2DjD;AAID,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,SAAS,CAAA;IACd,MAAM,EAAE,YAAY,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,YAAY,EAAE,CAAA;CACxB;AAmBD,wBAAsB,SAAS,CAC7B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,gBAAgB,EACxB,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,CAGrC;AAED,qFAAqF;AACrF,wBAAsB,UAAU,CAC9B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,OAAO,EACb,OAAO,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,IAAI,CAAA;CAAE,GAC7D,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,CA0BrC;AAED,+EAA+E;AAC/E,wBAAsB,YAAY,CAChC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,gBAAgB,EACxB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,IAAI,CAAA;CAAE,GACrC,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,CAmBrC;AAED,0GAA0G;AAC1G,wBAAsB,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAUxF;AAID,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,YAAY,CAAA;IAC1B,GAAG,EAAE,SAAS,GAAG,IAAI,CAAA;CACtB;AAED,wBAAsB,eAAe,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGnF;AAED,uGAAuG;AACvG,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,OAAO,EACb,OAAO,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,IAAI,CAAA;CAAE,GAC7D,OAAO,CAAC,gBAAgB,GAAG,aAAa,CAAC,CAmB3C;AAED;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAC/C,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE;IAAE,GAAG,EAAE,IAAI,CAAC;IAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,GACpE,OAAO,CAAC;IAAE,KAAK,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,CAAA;CAAE,CAAC,CAkB5C"}