@reblu/site-contracts 1.1.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,79 @@
 # @reblu/site-contracts
 
+## 1.3.0
+
+### Minor Changes
+
+- baa36cf: Expose each taxonomy axis's selection mode on `ShopFacets` (REB-809).
+
+  `ShopFacets.taxonomies[].selectionMode` is a new required field: `'single' |
+'multiple'`, mirroring REB-801's per-axis `TaxonomySelectionMode`. It reflects
+  how many terms a PRODUCT may carry on that axis, not how many the SITE
+  storefront filter may select at once — `GET /api/site/shop/products`'s
+  `taxonomy[<key>]` param still accepts only one term slug per axis regardless
+  of this value (see `@reblu/site-blocks`'s `ShopFilters` docs).
+
+  Additive: a new required field on the existing `ShopFacets` shape, populated
+  for every axis. A SITE build that has not migrated its `ShopFacets` type yet
+  keeps working unchanged — the extra field is simply ignored at runtime.
+
+## 1.2.0
+
+### Minor Changes
+
+- 34b15c4: Expose the academy verification gate's field list on `AcademyCourseDetail` (REB-83).
+
+  `AcademyCourseDetail.validationFields` is a new field: an ordered array of
+  `AcademyValidationFieldPublic` (`{ key, label, required, maxLength? }`), the
+  tenant's OWN configured list of data points its access-validation gate asks
+  for (e.g. a colegiado number and a professional college), resolved server-side
+  from `AcademyConfig.validationFields` — or derived as a single legacy field
+  under the key `'validationField'` when the tenant has not configured a list
+  yet, so an already-integrated SITE keeps working unchanged. A SITE renders
+  its enrollment form from this array instead of a fixed field.
+
+  Additive: a new required field on the existing `AcademyCourseDetail` shape
+  (populated for every course, empty array when the gate does not apply) and a
+  new exported type. The existing `validationFieldLabel` field is unchanged and
+  still present for a SITE build that has not migrated to the new array yet.
+
+- 7ff47d7: Add the cookie-consent fields to `Analytics` (REB-642). _Entry added after
+  publishing (REB-787): these fields shipped in 1.2.0, but no changeset
+  targeted this package, so the generated notes above left them out._
+
+  `GET /api/site/analytics` now also returns what a SITE needs to run the
+  `@reblu/site-next/consent` banner. There is still one request, and the root
+  layout already makes it:
+  - `consentRequired: boolean`: `true` when the tenant has a valid GA4 or
+    Clarity id (computed from the already-validated `gaId`/`clarityId`, so an
+    id that fails validation never requires a banner). reCAPTCHA is excluded
+    on purpose because it is strictly necessary. `false` means no configured
+    vendor needs consent, so the SITE can skip the banner.
+    `<ConsentedAnalytics>` does not read this field.
+  - `cookiePolicyVersion: string | null`: a content hash of the tenant's cookie
+    policy. It is the same algorithm as `cookiePolicyVersion()` in
+    `@reblu/site-next/consent-server` on the same text, and a shared test
+    vector keeps the two identical. Pass it to
+    `<ConsentProvider policyVersion>`. When the tenant edits the policy in
+    nexus, the hash changes and visitors are asked again. `null` means no
+    policy is stored.
+  - `cookieBanner`: the banner copy the tenant edits in nexus:
+    `{ enabled, title, body, acceptLabel, rejectLabel, manageLabel, policyUrl }`.
+    A `null` text field means the SDK default applies. Map `body` to the
+    banner's `description` text and `policyUrl` to `policyHref`. The buttons
+    and categories are fixed and have no field here.
+  - `cookieInventory`: `{ vendor, category }[]`, where `category` is
+    `'necessary' | 'analytics' | 'marketing'`. It lists only the vendors this
+    SITE actually loads, and is meant for the cookie-policy table.
+
+  **Consumer note:** the four fields are required on the `Analytics` type.
+  Runtime responses always include them, but code that builds an `Analytics`
+  object by hand (for example test fixtures) must now set them. A neutral
+  fixture is `consentRequired: false`, `cookiePolicyVersion: null`,
+  `cookieBanner: { enabled: true, title: null, body: null, acceptLabel: null,
+rejectLabel: null, manageLabel: null, policyUrl: null }`,
+  `cookieInventory: []`.
+
 ## 1.1.0
 
 ### Minor Changes

package/dist/index.d.cts

@@ -5,7 +5,7 @@
  */
 export type AcademyCategoryPublic = {    id: string;    name: string;    slug: string;    sortOrder: number;}
 
-export type AcademyCourseDetail = {    id: string;    slug: string;    title: string;    shortDescription: string | null;    coverUrl: string | null;    priceCents: number;    accessMode: "IMMEDIATE" | "DRIP" | "COHORT";    category: {        id: string;        name: string;        slug: string;        sortOrder: number;    } | null;    description: string | null;    modules: {        id: string;        title: string;        description: string | null;        lessons: {            id: string;            slug: string;            title: string;            isFreePreview: boolean;            durationSeconds: number | null;            hasVideo: boolean;        }[];    }[];    instructors: {        id: string;        firstName: string | null;        lastName: string | null;        avatarUrl: string | null;    }[];    salesEnabled: boolean;    requiresValidation: boolean;    validationFieldLabel: string | null;}
+export type AcademyCourseDetail = {    id: string;    slug: string;    title: string;    shortDescription: string | null;    coverUrl: string | null;    priceCents: number;    accessMode: "IMMEDIATE" | "DRIP" | "COHORT";    category: {        id: string;        name: string;        slug: string;        sortOrder: number;    } | null;    description: string | null;    modules: {        id: string;        title: string;        description: string | null;        lessons: {            id: string;            slug: string;            title: string;            isFreePreview: boolean;            durationSeconds: number | null;            hasVideo: boolean;        }[];    }[];    instructors: {        id: string;        firstName: string | null;        lastName: string | null;        avatarUrl: string | null;    }[];    salesEnabled: boolean;    requiresValidation: boolean;    validationFieldLabel: string | null;    validationFields: {        key: string;        label: string;        required: boolean;        maxLength?: number | undefined;    }[];}
 
 export type AcademyCourseSort = "price_asc" | "price_desc" | "newest"
 
@@ -17,7 +17,9 @@ export type AcademyLessonPublic = {    id: string;    slug: string;    title: st
 
 export type AcademyModulePublic = {    id: string;    title: string;    description: string | null;    lessons: {        id: string;        slug: string;        title: string;        isFreePreview: boolean;        durationSeconds: number | null;        hasVideo: boolean;    }[];}
 
-export type Analytics = {    gaId: string | null;    clarityId: string | null;    recaptchaSiteKey: string | null;    contactFormMode: "NOT_CONFIGURED" | "DISABLED" | "DB_ONLY" | "WEBHOOK" | "RESEND";    metaPixelId: string | null;    metaVerificationContent: string | null;    googleVerificationContent: string | null;}
+export type AcademyValidationFieldPublic = {    key: string;    label: string;    required: boolean;    maxLength?: number | undefined;}
+
+export type Analytics = {    gaId: string | null;    clarityId: string | null;    recaptchaSiteKey: string | null;    contactFormMode: "NOT_CONFIGURED" | "DISABLED" | "DB_ONLY" | "WEBHOOK" | "RESEND";    metaPixelId: string | null;    metaVerificationContent: string | null;    googleVerificationContent: string | null;    consentRequired: boolean;    cookiePolicyVersion: string | null;    cookieBanner: {        enabled: boolean;        title: string | null;        body: string | null;        acceptLabel: string | null;        rejectLabel: string | null;        manageLabel: string | null;        policyUrl: string | null;    };    cookieInventory: {        vendor: string;        category: "necessary" | "analytics" | "marketing";    }[];}
 
 export type BlogAuthor = {    firstName: string | null;    lastName: string | null;    avatarUrl: string | null;}
 
@@ -143,7 +145,7 @@ export type ShopDiscountApplication = {    valid: boolean;    discount: number;
 
 export type ShopEmailCheck = {    exists: boolean;}
 
-export type ShopFacets = {    taxonomies: {        key: string;        label: string;        showAsBadge: boolean;        terms: {            slug: string;            name: string;            count: number;        }[];    }[];    attributes: {        key: string;        label: string;        valueType: "boolean" | "text" | "select" | "multiselect";        options: {            value: string;            label: string;            count: number;        }[];    }[];    price: {        min: number;        max: number;    };    onSale: {        count: number;    };}
+export type ShopFacets = {    taxonomies: {        key: string;        label: string;        showAsBadge: boolean;        selectionMode: "single" | "multiple";        terms: {            slug: string;            name: string;            count: number;        }[];    }[];    attributes: {        key: string;        label: string;        valueType: "boolean" | "text" | "select" | "multiselect";        options: {            value: string;            label: string;            count: number;        }[];    }[];    price: {        min: number;        max: number;    };    onSale: {        count: number;    };}
 
 export type ShopInventoryRef = {    stockQuantity: number;    reservedQuantity: number;    lowStockThreshold: number | null;}
 
@@ -169,6 +171,8 @@ export type ShopSort = "price_asc" | "price_desc" | "newest" | "on_sale"
 
 export type ShopTaxRateRef = {    rate: number;    type: "IVA" | "IGIC" | "RETENTION" | "OTHER";    isExempt: boolean;}
 
+export type ShopTaxonomySelectionMode = "single" | "multiple"
+
 export type ShopTaxonomyTermRef = {    taxonomyKey: string;    taxonomyLabel: string;    showAsBadge: boolean;    slug: string;    name: string;    imageUrl: string | null;}
 
 export type ShopValidateCartInput = {    items: {        productId: string;        quantity: number;        variantId?: string | null | undefined;    }[];}

package/dist/index.d.ts

@@ -5,7 +5,7 @@
  */
 export type AcademyCategoryPublic = {    id: string;    name: string;    slug: string;    sortOrder: number;}
 
-export type AcademyCourseDetail = {    id: string;    slug: string;    title: string;    shortDescription: string | null;    coverUrl: string | null;    priceCents: number;    accessMode: "IMMEDIATE" | "DRIP" | "COHORT";    category: {        id: string;        name: string;        slug: string;        sortOrder: number;    } | null;    description: string | null;    modules: {        id: string;        title: string;        description: string | null;        lessons: {            id: string;            slug: string;            title: string;            isFreePreview: boolean;            durationSeconds: number | null;            hasVideo: boolean;        }[];    }[];    instructors: {        id: string;        firstName: string | null;        lastName: string | null;        avatarUrl: string | null;    }[];    salesEnabled: boolean;    requiresValidation: boolean;    validationFieldLabel: string | null;}
+export type AcademyCourseDetail = {    id: string;    slug: string;    title: string;    shortDescription: string | null;    coverUrl: string | null;    priceCents: number;    accessMode: "IMMEDIATE" | "DRIP" | "COHORT";    category: {        id: string;        name: string;        slug: string;        sortOrder: number;    } | null;    description: string | null;    modules: {        id: string;        title: string;        description: string | null;        lessons: {            id: string;            slug: string;            title: string;            isFreePreview: boolean;            durationSeconds: number | null;            hasVideo: boolean;        }[];    }[];    instructors: {        id: string;        firstName: string | null;        lastName: string | null;        avatarUrl: string | null;    }[];    salesEnabled: boolean;    requiresValidation: boolean;    validationFieldLabel: string | null;    validationFields: {        key: string;        label: string;        required: boolean;        maxLength?: number | undefined;    }[];}
 
 export type AcademyCourseSort = "price_asc" | "price_desc" | "newest"
 
@@ -17,7 +17,9 @@ export type AcademyLessonPublic = {    id: string;    slug: string;    title: st
 
 export type AcademyModulePublic = {    id: string;    title: string;    description: string | null;    lessons: {        id: string;        slug: string;        title: string;        isFreePreview: boolean;        durationSeconds: number | null;        hasVideo: boolean;    }[];}
 
-export type Analytics = {    gaId: string | null;    clarityId: string | null;    recaptchaSiteKey: string | null;    contactFormMode: "NOT_CONFIGURED" | "DISABLED" | "DB_ONLY" | "WEBHOOK" | "RESEND";    metaPixelId: string | null;    metaVerificationContent: string | null;    googleVerificationContent: string | null;}
+export type AcademyValidationFieldPublic = {    key: string;    label: string;    required: boolean;    maxLength?: number | undefined;}
+
+export type Analytics = {    gaId: string | null;    clarityId: string | null;    recaptchaSiteKey: string | null;    contactFormMode: "NOT_CONFIGURED" | "DISABLED" | "DB_ONLY" | "WEBHOOK" | "RESEND";    metaPixelId: string | null;    metaVerificationContent: string | null;    googleVerificationContent: string | null;    consentRequired: boolean;    cookiePolicyVersion: string | null;    cookieBanner: {        enabled: boolean;        title: string | null;        body: string | null;        acceptLabel: string | null;        rejectLabel: string | null;        manageLabel: string | null;        policyUrl: string | null;    };    cookieInventory: {        vendor: string;        category: "necessary" | "analytics" | "marketing";    }[];}
 
 export type BlogAuthor = {    firstName: string | null;    lastName: string | null;    avatarUrl: string | null;}
 
@@ -143,7 +145,7 @@ export type ShopDiscountApplication = {    valid: boolean;    discount: number;
 
 export type ShopEmailCheck = {    exists: boolean;}
 
-export type ShopFacets = {    taxonomies: {        key: string;        label: string;        showAsBadge: boolean;        terms: {            slug: string;            name: string;            count: number;        }[];    }[];    attributes: {        key: string;        label: string;        valueType: "boolean" | "text" | "select" | "multiselect";        options: {            value: string;            label: string;            count: number;        }[];    }[];    price: {        min: number;        max: number;    };    onSale: {        count: number;    };}
+export type ShopFacets = {    taxonomies: {        key: string;        label: string;        showAsBadge: boolean;        selectionMode: "single" | "multiple";        terms: {            slug: string;            name: string;            count: number;        }[];    }[];    attributes: {        key: string;        label: string;        valueType: "boolean" | "text" | "select" | "multiselect";        options: {            value: string;            label: string;            count: number;        }[];    }[];    price: {        min: number;        max: number;    };    onSale: {        count: number;    };}
 
 export type ShopInventoryRef = {    stockQuantity: number;    reservedQuantity: number;    lowStockThreshold: number | null;}
 
@@ -169,6 +171,8 @@ export type ShopSort = "price_asc" | "price_desc" | "newest" | "on_sale"
 
 export type ShopTaxRateRef = {    rate: number;    type: "IVA" | "IGIC" | "RETENTION" | "OTHER";    isExempt: boolean;}
 
+export type ShopTaxonomySelectionMode = "single" | "multiple"
+
 export type ShopTaxonomyTermRef = {    taxonomyKey: string;    taxonomyLabel: string;    showAsBadge: boolean;    slug: string;    name: string;    imageUrl: string | null;}
 
 export type ShopValidateCartInput = {    items: {        productId: string;        quantity: number;        variantId?: string | null | undefined;    }[];}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reblu/site-contracts",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "private": false,
   "description": "Public, dependency-free TypeScript types for the Reblu SITE API (types only — no Zod, no Prisma at runtime).",
   "license": "Apache-2.0",