@agence-zef/sdk 0.13.2 → 0.14.0

package/dist/business.d.ts

@@ -0,0 +1,3 @@
+import type { ApiBusiness } from "./types.js";
+/** Nœud schema.org de l'établissement (`@id` = `<origine>/#organization`). */
+export declare function businessJsonLd(business: ApiBusiness, origin: string): Record<string, unknown>;

package/dist/business.js

@@ -0,0 +1,35 @@
+/*
+ * Données structurées de l'établissement (cahier des charges § 5.13) : l'objet schema.org tiré de
+ * `site.business`, partagé par `<Seo>` (`@agence-zef/astro`) et l'aperçu du CMS (C-38).
+ */
+const absolute = (origin, url) => /^https?:\/\//.test(url) ? url : `${origin}${url.startsWith("/") ? "" : "/"}${url}`;
+/** Nœud schema.org de l'établissement (`@id` = `<origine>/#organization`). */
+export function businessJsonLd(business, origin) {
+    const logo = business.logo ? absolute(origin, business.logo.url) : undefined;
+    const node = {
+        "@type": business.type,
+        "@id": `${origin}/#organization`,
+        name: business.name,
+        url: `${origin}/`,
+        logo,
+        image: logo,
+        description: business.description ?? undefined,
+        telephone: business.telephone ?? undefined,
+        email: business.email ?? undefined,
+        vatID: business.vatId ?? undefined,
+        identifier: business.siret
+            ? { "@type": "PropertyValue", propertyID: "SIRET", value: business.siret }
+            : undefined,
+        address: business.address ? { "@type": "PostalAddress", ...business.address } : undefined,
+        geo: business.geo ? { "@type": "GeoCoordinates", ...business.geo } : undefined,
+        openingHoursSpecification: business.openingHours.length
+            ? business.openingHours.map((h) => ({ "@type": "OpeningHoursSpecification", ...h }))
+            : undefined,
+        sameAs: business.sameAs.length ? business.sameAs : undefined,
+        ...business.extra,
+    };
+    for (const key of Object.keys(node))
+        if (node[key] === undefined)
+            delete node[key];
+    return node;
+}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import type { ConfigCollections, CustomValuesOf, Registry, ZefConfig } from "@agence-zef/schema";
 import type { ApiAccess, ApiAccount, ApiAccountSession, ApiAccountUpdate, ApiCart, ApiCheckout, ApiCheckoutInput, ApiGiftCardInput, ApiItem, ApiLayout, ApiLink, ApiList, ApiOrder, ApiPage, ApiPageEntry, ApiPlayback, ApiPreviewDocument, ApiRedirect, ApiRegisterInput, ApiSection, ApiServicePoint, ApiShippingOption, ApiSite, ApiSubscription, ApiSyncResult } from "./types.js";
+export { businessJsonLd } from "./business.js";
 export type * from "./types.js";
 /** Erreur renvoyée par l'API (clé invalide, schéma refusé…). */
 export declare class ZefApiError extends Error {
@@ -65,6 +66,15 @@ export declare function createClient<C extends ZefConfig = ZefConfig>(options: C
     }) => Promise<ApiSection>;
     /** Vérifie la clé et enregistre le lien du dépôt (`zef link`). */
     link: () => Promise<ApiLink>;
+    /**
+     * Relève une visite sur une adresse inconnue du site (C-38 › Pages introuvables) : appelé par
+     * le serveur du site quand il répond 404. Le CMS écarte les robots et les adresses techniques.
+     */
+    reportNotFound: (input: {
+        path: string;
+        referrer?: string | null;
+        userAgent?: string | null;
+    }) => Promise<void>;
     /**
      * Module Comptes : comptes des personnes du site. `session` est le jeton gardé dans le cookie
      * du site ; `ip` l'adresse du visiteur (limites de débit, anti-robot).

package/dist/index.js

@@ -1,3 +1,4 @@
+export { businessJsonLd } from "./business.js";
 /** Erreur renvoyée par l'API (clé invalide, schéma refusé…). */
 export class ZefApiError extends Error {
     status;
@@ -95,6 +96,13 @@ export function createClient(options) {
         },
         /** Vérifie la clé et enregistre le lien du dépôt (`zef link`). */
         link: async () => required(await request("/link", { method: "POST" }), "Lien"),
+        /**
+         * Relève une visite sur une adresse inconnue du site (C-38 › Pages introuvables) : appelé par
+         * le serveur du site quand il répond 404. Le CMS écarte les robots et les adresses techniques.
+         */
+        reportNotFound: async (input) => {
+            await request("/not-found", { method: "POST", body: input });
+        },
         /**
          * Module Comptes : comptes des personnes du site. `session` est le jeton gardé dans le cookie
          * du site ; `ip` l'adresse du visiteur (limites de débit, anti-robot).

package/dist/types.d.ts

@@ -29,6 +29,59 @@ export type ApiSite = {
     ga4: null;
     /** Réglages publics du module Comptes (U-03), `null` s'il n'est pas activé. */
     accounts: ApiAccountsSettings | null;
+    /**
+     * Établissement déclaré dans Référencement › Données structurées (C-38), `null` tant que
+     * rien n'est déclaré : `<Seo>` en tire les données structurées, le footer peut l'afficher.
+     */
+    business?: ApiBusiness | null;
+    /** Code personnalisé (C-38) : blocs actifs, déjà préparés pour le bandeau cookies. */
+    customCode?: ApiCodeBlock[];
+};
+/** Bloc de code personnalisé servi au site. */
+export type ApiCodeBlock = {
+    placement: "head_start" | "head_end" | "body_end";
+    /**
+     * HTML à écrire tel quel. Bloc d'une catégorie de cookies facultative : ses scripts sont en
+     * `type="text/plain"` avec `data-category`, lancés par le bandeau après l'accord.
+     */
+    html: string;
+    /** Adresses des pages qui reçoivent le bloc (toutes les langues), `null` = tout le site. */
+    paths: string[] | null;
+};
+/** Établissement du site, prêt pour schema.org. */
+export type ApiBusiness = {
+    /** Type schema.org (`LiquorStore`, `Restaurant`, `Organization`…). */
+    type: string;
+    name: string;
+    logo: Media | null;
+    description: string | null;
+    siret: string | null;
+    vatId: string | null;
+    telephone: string | null;
+    email: string | null;
+    address: {
+        streetAddress: string;
+        postalCode: string;
+        addressLocality: string;
+        /** Code pays (`FR`). */
+        addressCountry: string;
+    } | null;
+    geo: {
+        latitude: number;
+        longitude: number;
+    } | null;
+    /** `OpeningHoursSpecification` ; une fermeture exceptionnelle va de 00:00 à 00:00. */
+    openingHours: {
+        dayOfWeek: string[];
+        opens: string;
+        closes: string;
+        validFrom?: string;
+        validThrough?: string;
+    }[];
+    /** Profils en ligne : fiche Google, réseaux sociaux, annuaires. */
+    sameAs: string[];
+    /** Propriétés propres au type (`priceRange`, `servesCuisine`, `hasMenu`…). */
+    extra: Record<string, string | string[]>;
 };
 /** Ce que le site doit savoir pour ses formulaires de compte. */
 export type ApiAccountsSettings = {
@@ -66,6 +119,11 @@ export type ApiSeo = {
     canonical: string | null;
     /** Image de partage (1200 × 630 conseillé), sinon `null` : celle du gabarit du site. */
     image: Media | null;
+    /**
+     * JSON-LD en plus de la page (onglet SEO de l'éditeur), déjà validé : `<Seo>` l'ajoute au graphe.
+     * Absent quand il n'y en a pas.
+     */
+    jsonLd?: Record<string, unknown>[];
 };
 export type ApiPage = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agence-zef/sdk",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "description": "Client typé de l'API d'un CMS ZEF (client.agence-zef.fr/api/v1).",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@agence-zef/schema": "0.17.1"
+    "@agence-zef/schema": "0.18.0"
   },
   "homepage": "https://agence-zef.fr",
   "scripts": {