@griddo/api-types 1.3.2 → 1.4.0

package/dist/add-ons/index.d.ts

@@ -1,5 +1,5 @@
 export interface ContentPresence {
     presenceType: "page-specific" | "page-custom" | "page-manual" | "all";
-    relatedPages: Array<number> | null;
+    relatedPages: number[] | null;
 }
 export type ContentBodyPosition = "start" | "end";

package/dist/ai/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./search";
 export * from "./answers";
 export * from "./pages";
+export * from "./search";
 export * from "./summary";

package/dist/ai/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./search"), exports);
 __exportStar(require("./answers"), exports);
 __exportStar(require("./pages"), exports);
+__exportStar(require("./search"), exports);
 __exportStar(require("./summary"), exports);

package/dist/ai/search.d.ts

@@ -20,6 +20,13 @@ export interface PostAiSearchBody {
     itemsPerPage?: number;
     useStructuredData?: boolean;
     fields?: string[];
+    /**
+     * Structured-data filters applied before scoring: `{ field: value | values }`.
+     * AND across fields, OR across the values of one field. Matching ignores case
+     * and accents and accepts partial matches; results missing the field are
+     * excluded.
+     */
+    filters?: Record<string, string | string[]>;
 }
 /**
  * A single AI search result, built from an indexed embedding and scored
@@ -37,6 +44,16 @@ export interface AiSearchResultItem {
     image: string | null;
     description: string | null;
     template: string;
+    /**
+     * Relevance of the result to the query, always in [0, 1]:
+     * `0.8 * cosine + 0.2 * lexical coverage` (share of the query's words found
+     * as whole words in `title` + `description`).
+     *
+     * The cut-off (`minSimilarity`, or the automatic one when omitted) is applied
+     * to this value. `priorities` never changes it: they only reorder the results
+     * that pass the cut-off (by `similarity + priorities[template]`), so a result
+     * may appear ahead of another with a higher `similarity`.
+     */
     similarity: number;
     content?: string;
     structuredData?: Record<string, any> | string;

package/dist/analytics/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./script";
-export * from "./groups";
 export * from "./dimensions";
+export * from "./groups";
+export * from "./script";

package/dist/analytics/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./script"), exports);
-__exportStar(require("./groups"), exports);
 __exportStar(require("./dimensions"), exports);
+__exportStar(require("./groups"), exports);
+__exportStar(require("./script"), exports);

package/dist/common/clientName.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Public values for the `x-client-name` request header, which identifies the
+ * calling client. Read by the auth middlewares (`isAuth`, `apiTokenAuth`); a
+ * missing header is treated as `UNDEFINED`. Governs, among others, the QA render
+ * scope (`QA` clients only see/render QA content).
+ */
+export declare enum CLIENT_NAME {
+    SDK = "SDK",
+    AX = "AX",
+    QA = "QA",
+    CX = "CX",
+    APP = "APP",
+    LAMBDA = "LAMBDA",
+    PUBLIC_API = "PUBLIC_API",
+    UNDEFINED = "UNDEFINED"
+}

package/dist/common/clientName.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLIENT_NAME = void 0;
+/**
+ * Public values for the `x-client-name` request header, which identifies the
+ * calling client. Read by the auth middlewares (`isAuth`, `apiTokenAuth`); a
+ * missing header is treated as `UNDEFINED`. Governs, among others, the QA render
+ * scope (`QA` clients only see/render QA content).
+ */
+var CLIENT_NAME;
+(function (CLIENT_NAME) {
+    CLIENT_NAME["SDK"] = "SDK";
+    CLIENT_NAME["AX"] = "AX";
+    CLIENT_NAME["QA"] = "QA";
+    CLIENT_NAME["CX"] = "CX";
+    CLIENT_NAME["APP"] = "APP";
+    CLIENT_NAME["LAMBDA"] = "LAMBDA";
+    CLIENT_NAME["PUBLIC_API"] = "PUBLIC_API";
+    CLIENT_NAME["UNDEFINED"] = "UNDEFINED";
+})(CLIENT_NAME || (exports.CLIENT_NAME = CLIENT_NAME = {}));

package/dist/common/export.d.ts

@@ -1,7 +1,7 @@
 export type ExportFormat = "json" | "xml" | "csv" | "xlsx";
 export type ExportedFile = {
     type: "single";
-    content: string;
+    content: string | Buffer;
     contentType: string;
     fileName: string;
 } | {

package/dist/common/index.d.ts

@@ -1,4 +1,5 @@
-export * from "./pagination";
+export * from "./clientName";
 export * from "./export";
-export * from "./uuid";
+export * from "./pagination";
 export * from "./success";
+export * from "./uuid";

package/dist/common/index.js

@@ -14,7 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./pagination"), exports);
+__exportStar(require("./clientName"), exports);
 __exportStar(require("./export"), exports);
-__exportStar(require("./uuid"), exports);
+__exportStar(require("./pagination"), exports);
 __exportStar(require("./success"), exports);
+__exportStar(require("./uuid"), exports);

package/dist/common/pagination.d.ts

@@ -2,7 +2,7 @@ export declare enum PaginationOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export type PaginationRequest<TFilter extends unknown = {}> = {
+export type PaginationRequest<TFilter = {}> = {
     page: number;
     itemsPerPage: number;
     order?: PaginationOrder | `${PaginationOrder}`;

package/dist/index.d.ts

@@ -1,34 +1,35 @@
+export * from "./add-ons";
+export * from "./ai";
+export * from "./analytics";
+export * from "./apiTokens";
 export * from "./common";
-export * from "./logs";
-export * from "./schemas";
 export * from "./dataPack";
-export * from "./site";
-export * from "./redirects";
-export * from "./add-ons";
-export * from "./pages";
-export * from "./structuredData";
-export * from "./user";
-export * from "./queue";
 export * from "./domains";
-export * from "./storage";
-export * from "./render";
-export * from "./settings";
+export * from "./domains";
+export * from "./feeds";
+export * from "./files";
 export * from "./form-categories";
 export * from "./forms";
+export * from "./images";
 export * from "./instances";
+export * from "./integrations";
+export * from "./languages";
 export * from "./liveStatus";
+export * from "./logs";
+export * from "./menus";
+export * from "./navigation";
+export * from "./pages";
 export * from "./payables";
-export * from "./translations";
+export * from "./publicApi";
+export * from "./queue";
+export * from "./redirects";
+export * from "./render";
 export * from "./roles";
-export * from "./files";
-export * from "./languages";
+export * from "./schemas";
 export * from "./search";
-export * from "./domains";
-export * from "./menus";
-export * from "./navigation";
-export * from "./feeds";
-export * from "./ai";
-export * from "./apiTokens";
-export * from "./images";
-export * from "./integrations";
-export * from "./analytics";
+export * from "./settings";
+export * from "./site";
+export * from "./storage";
+export * from "./structuredData";
+export * from "./translations";
+export * from "./user";

package/dist/index.js

@@ -14,37 +14,38 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./add-ons"), exports);
+__exportStar(require("./ai"), exports);
+__exportStar(require("./analytics"), exports);
+__exportStar(require("./apiTokens"), exports);
 __exportStar(require("./common"), exports);
-__exportStar(require("./logs"), exports);
-__exportStar(require("./schemas"), exports);
 __exportStar(require("./dataPack"), exports);
-__exportStar(require("./site"), exports);
-__exportStar(require("./redirects"), exports);
-__exportStar(require("./add-ons"), exports);
-__exportStar(require("./pages"), exports);
-__exportStar(require("./structuredData"), exports);
-__exportStar(require("./user"), exports);
-__exportStar(require("./queue"), exports);
 __exportStar(require("./domains"), exports);
-__exportStar(require("./storage"), exports);
-__exportStar(require("./render"), exports);
-__exportStar(require("./settings"), exports);
+__exportStar(require("./domains"), exports);
+__exportStar(require("./feeds"), exports);
+__exportStar(require("./files"), exports);
 __exportStar(require("./form-categories"), exports);
 __exportStar(require("./forms"), exports);
+__exportStar(require("./images"), exports);
 __exportStar(require("./instances"), exports);
+__exportStar(require("./integrations"), exports);
+__exportStar(require("./languages"), exports);
 __exportStar(require("./liveStatus"), exports);
+__exportStar(require("./logs"), exports);
+__exportStar(require("./menus"), exports);
+__exportStar(require("./navigation"), exports);
+__exportStar(require("./pages"), exports);
 __exportStar(require("./payables"), exports);
-__exportStar(require("./translations"), exports);
+__exportStar(require("./publicApi"), exports);
+__exportStar(require("./queue"), exports);
+__exportStar(require("./redirects"), exports);
+__exportStar(require("./render"), exports);
 __exportStar(require("./roles"), exports);
-__exportStar(require("./files"), exports);
-__exportStar(require("./languages"), exports);
+__exportStar(require("./schemas"), exports);
 __exportStar(require("./search"), exports);
-__exportStar(require("./domains"), exports);
-__exportStar(require("./menus"), exports);
-__exportStar(require("./navigation"), exports);
-__exportStar(require("./feeds"), exports);
-__exportStar(require("./ai"), exports);
-__exportStar(require("./apiTokens"), exports);
-__exportStar(require("./images"), exports);
-__exportStar(require("./integrations"), exports);
-__exportStar(require("./analytics"), exports);
+__exportStar(require("./settings"), exports);
+__exportStar(require("./site"), exports);
+__exportStar(require("./storage"), exports);
+__exportStar(require("./structuredData"), exports);
+__exportStar(require("./translations"), exports);
+__exportStar(require("./user"), exports);

package/dist/pages/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./clear_corrupted_pages";
 export * from "./add-ons";
-export * from "./page_access_grants";
+export * from "./clear_corrupted_pages";
 export * from "./llms";
+export * from "./page_access_grants";
 export * from "./preview_share";

package/dist/pages/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./clear_corrupted_pages"), exports);
 __exportStar(require("./add-ons"), exports);
-__exportStar(require("./page_access_grants"), exports);
+__exportStar(require("./clear_corrupted_pages"), exports);
 __exportStar(require("./llms"), exports);
+__exportStar(require("./page_access_grants"), exports);
 __exportStar(require("./preview_share"), exports);

package/dist/publicApi/ai.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Public types for `POST /public/ai/search`, `POST /public/ai/answers` and `GET /public/ai/pages/related/*`.
+ *
+ * Same wire contract as `POST /ai/search`, `POST /ai/answers` and `POST /ai/pages/related` (`../ai`): aliased, not duplicated.
+ * The related-pages request has no body (its parameters travel as `key/value` path segments), so only the response is aliased.
+ */
+export type { PostAiAnswersBody as PostPublicAiAnswersBody, PostAiAnswersResponse as PostPublicAiAnswersResponse, } from "../ai/answers";
+export type { PostAiPagesRelatedResponse as GetPublicAiPagesRelatedResponse } from "../ai/pages";
+export type { PostAiSearchBody as PostPublicAiSearchBody, PostAiSearchResponse as PostPublicAiSearchResponse, } from "../ai/search";

package/dist/publicApi/ai.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/alert.d.ts

@@ -0,0 +1,24 @@
+import type { SuccessResponse } from "../common/success";
+/**
+ * Public types for `POST /public/alert`.
+ *
+ * Same wire contract as `POST /alert` of the Public API: it stores an alert log and, for level `E` (or a truthy
+ * `instantNotification`), publishes it to SNS. Errors are a 400 `{ code, message }`.
+ */
+/** Body of `POST /public/alert`. */
+export interface PostPublicAlertBody {
+    /** `I`, `W` or `E` (case-insensitive). Required. */
+    level: string;
+    /** Required. At most 45 characters in the database. */
+    area: string;
+    /** Required unless `fullData` is present. */
+    description?: string;
+    /** Required unless `description` is present. Only an object is stored in the log (a string travels to SNS only). */
+    fullData?: string | Record<string, unknown>;
+    /**
+     * Publish to SNS even when the level is not `E`. Defaults to `level === "E"` only when absent: any truthy value
+     * (even the string `"false"`) publishes. It is not stored in the log.
+     */
+    instantNotification?: boolean;
+}
+export type PostPublicAlertResponse = SuccessResponse;

package/dist/publicApi/alert.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/calendar.d.ts

@@ -0,0 +1,29 @@
+import type { SuccessResponse } from "../common/success";
+/**
+ * Public types for the `/public/calendar/*` endpoints.
+ *
+ * Same wire contract as `/calendar/*` of the Public API. A failure is a 400 `{ code, message }`; a Google response
+ * without the queried calendar is a 504 `{ code: 504, message }` (the Public API left the request hanging).
+ */
+/** Body of `POST /public/calendar/reservation`. All fields are validated in this order: mail, date, hour, name. */
+export interface PostCalendarReservationBody {
+    /** `YYYY-MM-DD` (format only: `2026-13-45` passes the check and then fails creating the event). */
+    date: string;
+    /** `HH:MM:SS`. */
+    hour: string;
+    /** Event title and subject of the confirmation mail (optional). */
+    summary?: string;
+    /** Event description (`"undefined"` if missing). */
+    description?: string;
+    /** Letters, digits and `_-/`, spaces allowed, fewer than 50 characters. */
+    requestorName: string;
+    requestorMail: string;
+}
+/** Response of `POST /public/calendar/reservation`: `{ code: 200, message: "ok" }`. */
+export type PostCalendarReservationResponse = SuccessResponse;
+/**
+ * Response of `GET /public/calendar/freeslots/*`: the free hour slots (`"09:00 - 10:00"` … `"17:00 - 18:00"`) of every
+ * day that has at least one busy event, keyed by `YYYY-MM-DD`. When the Google query fails the Public API answers
+ * `{ code: 200, message: "ok" }` instead (the error is swallowed).
+ */
+export type GetCalendarFreeSlotsResponse = Record<string, string[]>;

package/dist/publicApi/calendar.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/crm.d.ts

@@ -0,0 +1,74 @@
+import type { SuccessResponse } from "../common/success";
+/**
+ * Public types for the `/public/crm/*` endpoints.
+ *
+ * Same wire contract as `/crm/*` of the Public API. A failure is a 400 `{ code, message }`.
+ */
+/** Response of `GET /public/crm/cognito/token`. */
+export interface GetCognitoTokenResponse {
+    /** Value of the first `CognitoIdentityServiceProvider*.accessToken` cookie. */
+    cognitoToken: string;
+}
+/**
+ * Response of `GET /public/crm/melissa/:phone`: `{ code: 200, message: "ok" }` when the phone is accepted. A phone
+ * Melissa flags as bad (`PE__`) is a 400 `{ code: 400, message: "MELISSA_FAIL" }`.
+ */
+export type GetCrmMelissaResponse = SuccessResponse;
+/** Body of `POST /public/crm/nbk`: the form fields, forwarded to Nubika as they come. Query: `?melissa=<phone>` validates the phone first. */
+export type PostCrmNbkBody = Record<string, unknown>;
+/**
+ * Response of `POST /public/crm/nbk` when the CRM accepts the form: whatever Nubika answered (`success` truthy) plus
+ * `disclaimer` (the CRM's, or `Response generated by the external CRM.`).
+ */
+export interface PostCrmNbkResponse {
+    success: unknown;
+    message?: string;
+    logs?: unknown;
+    requestParams?: unknown;
+    disclaimer: string;
+    [key: string]: unknown;
+}
+/**
+ * `message` of the 400 `{ code, message }` of `POST /public/crm/nbk` when it is an object: the CRM rejected the form
+ * (`response` is its `message`) or Melissa flagged the phone (`{ response: "MELISSA_FAIL" }`, no other field). Other
+ * failures (incomplete configuration, connection failed) have a plain-text `message`.
+ */
+export interface PostCrmNbkRejection {
+    response?: string;
+    logs?: unknown;
+    requestParams?: unknown;
+    disclaimer?: string;
+}
+/**
+ * Response of `GET|POST /public/crm/dynamics/:path` and `PATCH /public/crm/dynamics/:path/:id`.
+ * `data` is the CRM's JSON for a GET; for a POST/PATCH it is the CRM's `statusText` (`"Created"`, `"No Content"`…) or,
+ * with a 200, `{ size: 0, timeout: 0 }` (what the Public API serialised from the node-fetch `Response`).
+ */
+export interface DynamicsPetitionResponse {
+    success: true;
+    data: unknown;
+    disclaimer: string;
+}
+/** Response of `POST /public/crm/dynamics/relation/:dataName/:dataId/:relationName/:relatedName/:relatedId`. */
+export interface DynamicsRelationResponse {
+    success: true;
+    /** The CRM's `statusText`. */
+    message: string;
+    disclaimer: string;
+}
+/**
+ * `message` of the 400 `{ code, message }` of every `/public/crm/dynamics/*` route: `{ success: false, message }`
+ * with a literal such as `Path <p> is not allowed for method <M>.`, `XML required for get.`, `Body required for post.`,
+ * `CRM Authentication failed.`, `CRM auth failed (code <c>): <m>` or `CRM connection failed (code <status>): <statusText>`.
+ */
+export interface DynamicsRejection {
+    success: false;
+    message?: string;
+}
+/**
+ * Body of `POST /public/crm/gsheets/:sheetIndex`: one row, as a flat object. Each key is a header of the sheet (the
+ * missing ones are appended to the header row, in order); an empty body is a 400 `Missing data`.
+ */
+export type PostCrmGsheetsBody = Record<string, unknown>;
+/** Response of `POST /public/crm/gsheets/:sheetIndex`: `{ code: 200, message: "ok" }` once the row is appended. */
+export type PostCrmGsheetsResponse = SuccessResponse;

package/dist/publicApi/crm.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/feed.d.ts

@@ -0,0 +1,9 @@
+import type { FeedDataCleanedContent } from "../feeds";
+/**
+ * Public types for `GET /public/feed/:feed{/:format}`.
+ *
+ * With `format !== "rss"` (the default `json` and any other value) the body is only the `data` array of
+ * `GET /feeds/:slug/data/:format` (`GetFeedDataResponse` in `../feeds`), without `name`, `expirationMinutes` or
+ * `staleMinutes`. With `format === "rss"` the response is an `application/xml` document (a string), not JSON.
+ */
+export type GetPublicFeedResponse = FeedDataCleanedContent[];

package/dist/publicApi/feed.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/files.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Public types for `POST /public/files`.
+ *
+ * Same wire contract as `POST /files` of the Public API: it uploads a file received as a base64 dataURL to the
+ * configured bucket (not the DAM) under a uuid name and returns its public URL. A failure is a 400 `{ code, message }`.
+ */
+/** Body of `POST /public/files`. */
+export interface PostPublicFilesBody {
+    /** `data:<type>;base64,<content>`. The object key is `[folder/]<uuid>.<subtype>`. */
+    content: string;
+}
+/** Response of `POST /public/files`. */
+export interface PostPublicFilesResponse {
+    /** `<filesS3URL without a trailing slash>/<key>`. */
+    url: string;
+}

package/dist/publicApi/files.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Public types for `POST /public/files`.
+ *
+ * Same wire contract as `POST /files` of the Public API: it uploads a file received as a base64 dataURL to the
+ * configured bucket (not the DAM) under a uuid name and returns its public URL. A failure is a 400 `{ code, message }`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/filters.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Public types for `GET /public/filters/:structuredData/site/:site/lang/:lang/...`.
+ *
+ * Same wire contract as `GET /site/:site/structured_data/filters/:structuredData`
+ * (`../structuredData/distributor`): one group of filter values per filter field. Aliased, not duplicated.
+ */
+export type { GetStructuredDataFiltersResponse as GetPublicFiltersResponse } from "../structuredData/distributor";

package/dist/publicApi/filters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/form.d.ts

@@ -0,0 +1,28 @@
+import type { SuccessResponse } from "../common/success";
+/**
+ * Public types for `POST /public/form`.
+ *
+ * Same wire contract as `POST /form` of the Public API: it saves the form log, validates the recipient and sends the
+ * form by mail (`key: value` body, Griddo logo inline, dataURL attachments). A failure is a 400 `{ code, message }`
+ * and also raises an `E`/`FORM` alert.
+ */
+/** One attachment of the form: `content` may be a `data:<type>;base64,<content>` URL or plain base64. */
+export interface PublicFormAttachment {
+    filename?: string;
+    contentType?: string;
+    content: string;
+}
+/**
+ * Body of `POST /public/form`. Besides `to`, `subject` and `attachments`, any other key is a form field and
+ * ends up in the mail body as `key: value` (values are stringified and inserted unescaped).
+ */
+export interface PostPublicFormBody {
+    /** Single recipient; required and valid, or the request is a 400. */
+    to: string;
+    /** Defaults to `No subject` only when absent. */
+    subject?: string;
+    /** Ignored if it is not an array. */
+    attachments?: PublicFormAttachment[];
+    [field: string]: unknown;
+}
+export type PostPublicFormResponse = SuccessResponse;

package/dist/publicApi/form.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/geoip.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Public types for `GET /public/geoip/country`.
+ *
+ * Country and IP of the visitor, resolved from the CDN headers (CloudFront, CloudFlare, Akamai) and
+ * `x-forwarded-for`. Same contract as `GET /geoip/country` of the Public API.
+ */
+export interface GetPublicGeoipCountryResponse {
+    /** Country as sent by the CDN (not validated or normalized), or `"XX"` when no header carries one. */
+    country: string;
+    /** First `x-forwarded-for` entry, or the socket address. Omitted from the JSON if neither exists. */
+    ip?: string;
+}

package/dist/publicApi/geoip.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/gpx.d.ts

@@ -0,0 +1,60 @@
+import type { PostAiSearchResponse } from "../ai/search";
+import type { SuccessResponse } from "../common/success";
+/**
+ * Public types for `POST /public/gpx/collect`, `GET /public/gpx/profile/areas/:areas/id/:id` and
+ * `POST /public/gpx/pages`.
+ *
+ * Same wire contract as `POST /gpx/collect`, `GET /gpx/profile/:areas/:id` and `POST /gpx/pages` of the private API,
+ * except that every error is a 400 `{ code, message }` (the Public API ignored the private status in this family) and
+ * the visitor's country is derived only from the headers the Public API forwarded.
+ */
+/** One interest of the visitor, as sent by `POST /public/gpx/collect`. */
+export interface PublicGpxInterest {
+    area: string;
+    interest: {
+        id?: string;
+        label: string;
+    };
+    /** Positive. */
+    weight: number;
+}
+/** Body of `POST /public/gpx/collect`. `countryISO`, if sent, is discarded: the country comes from the headers. */
+export interface PostPublicGpxCollectBody {
+    /** Visitor UUID. */
+    id: string;
+    navigator: {
+        language: string;
+        userAgent: string;
+    };
+    interests: PublicGpxInterest[];
+}
+export type PostPublicGpxCollectResponse = SuccessResponse;
+/** Interests of the profile, grouped by the requested areas (areas without interests are omitted). */
+export type GetPublicGpxProfileResponse = Record<string, {
+    interest: {
+        id?: string;
+        label: string;
+    };
+    weight: number;
+    updated_at?: string;
+}[]>;
+/** Body of `POST /public/gpx/pages`. */
+export interface PostPublicGpxPagesBody {
+    /** Visitor UUID; without it (or without a profile) only `prompt` / `pageId` drive the search. */
+    id?: string;
+    /** At least one template. */
+    templates: string[];
+    /** Positive integer language id. */
+    language: number;
+    useStructuredData: boolean;
+    /** Positive integer: number of items to return. */
+    limit: number;
+    /** Non-empty area (trimmed) whose profile interests feed the query. */
+    area: string;
+    pageId?: number;
+    sites?: number[];
+    prompt?: string;
+    fields?: string[];
+}
+/** Same page of results as `POST /ai/search` (always the first page, `limit` items). */
+export type PostPublicGpxPagesResponse = PostAiSearchResponse;

package/dist/publicApi/gpx.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./ai";
+export * from "./alert";
+export * from "./calendar";
+export * from "./crm";
+export * from "./feed";
+export * from "./files";
+export * from "./filters";
+export * from "./form";
+export * from "./geoip";
+export * from "./gpx";
+export * from "./list";
+export * from "./page";
+export * from "./search";
+export * from "./socials";

package/dist/publicApi/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ai"), exports);
+__exportStar(require("./alert"), exports);
+__exportStar(require("./calendar"), exports);
+__exportStar(require("./crm"), exports);
+__exportStar(require("./feed"), exports);
+__exportStar(require("./files"), exports);
+__exportStar(require("./filters"), exports);
+__exportStar(require("./form"), exports);
+__exportStar(require("./geoip"), exports);
+__exportStar(require("./gpx"), exports);
+__exportStar(require("./list"), exports);
+__exportStar(require("./page"), exports);
+__exportStar(require("./search"), exports);
+__exportStar(require("./socials"), exports);

package/dist/publicApi/list.d.ts

@@ -0,0 +1,50 @@
+import type { DataLanguage, GetStructuredDataContentBulkResponse } from "../structuredData/content";
+import type { PostDistributorContentResponse } from "../structuredData/distributor";
+/**
+ * Public types for `GET /public/list/fixed/:fixed/site/:site/lang/:lang/...`.
+ *
+ * Same envelope as `GET /site/:site/structured_data_content/bulk/:ids` (`{ page, totalItems, items }`) but each item is
+ * the flattened public shape `{ id, url, urlCanonical, ...content, relatedPage? }` (optionally projected with `get`),
+ * so `items` is a list of free-form records. `totalItems` is the private total, not discounted by hidden drafts.
+ */
+export type GetPublicListFixedResponse = Omit<GetStructuredDataContentBulkResponse, "items"> & {
+    items: Record<string, unknown>[];
+};
+/**
+ * Public types for `GET /public/list/navigations/reference/:id/site/:site/lang/:lang/...`.
+ *
+ * Returns the body of `POST /site/:site/distributor` in `navigation` mode without reshaping it.
+ */
+export type GetPublicListNavigationsResponse = PostDistributorContentResponse;
+/**
+ * Public types for `GET /public/list/:type/site/:site/lang/:lang/...` (v1).
+ *
+ * `{ page, totalItems, items }` where each item is the flattened shape `{ id, ...content, url }` (no `urlCanonical`,
+ * optionally projected with `get`). Inherited behaviour: the distributor ignores the legacy `source` key the public API
+ * sends, so in practice this endpoint answers `400` (or `200 { totalItems: null, items: [] }` with a valid `maxItems`).
+ */
+export type GetPublicListResponse = {
+    page: number;
+    totalItems: number;
+    items: Record<string, unknown>[];
+};
+/**
+ * Public types for `GET /public/list/v2/:type/site/:site/lang/:lang/...` (v2).
+ *
+ * `{ page, totalItems, items }` where `page` is `Number(page)` of the URL (`null` if it was not numeric) and each item is
+ * `{ id, ...content, dataLanguages, url, urlCanonical }` (optionally projected with `get`). `dataLanguages` only lists the
+ * publishable language versions. With `groupingCategories=on` each item also carries `type` and `children`.
+ */
+export type GetPublicListV2Response = {
+    page: number | null;
+    totalItems: number;
+    items: PublicListV2Item[];
+};
+export type PublicListV2Item = Record<string, unknown> & {
+    id?: number;
+    dataLanguages?: DataLanguage[];
+    url?: string;
+    urlCanonical?: string;
+    type?: string;
+    children?: PublicListV2Item[];
+};

package/dist/publicApi/list.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/page.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Public types for `GET /public/page/:id/preview/:entity`.
+ *
+ * The body is the shared page as returned by `GET /page/:id/preview` (the draft if there is one), plus the fields the
+ * endpoint composes, which win over any field of the same name in the page. Only the fields the composition reads
+ * are typed; the rest of the page passes through untouched.
+ */
+export interface GetPublicPagePreviewResponse {
+    id: number;
+    entity: string;
+    site?: number | null;
+    canonicalSite?: number | null;
+    language: number;
+    header?: number | null;
+    footer?: number | null;
+    /** `cloudinaryName` of `GET /settings` (absent when the instance has none). */
+    cloudinaryName?: string | null;
+    /** Always the fixed development domain `https://images.dev.griddo.io` (inherited behaviour, not configurable). */
+    damDomain: string;
+    siteInfo: {
+        siteId: number;
+        name: string;
+        theme: string | null;
+        /** `items` of `GET /site/:site/languages`. */
+        siteLanguages: unknown[];
+        socials?: unknown;
+    };
+    /** Header navigation of the page (its own, or the site default); `null` when it does not exist. */
+    headerContent: Record<string, unknown> | null;
+    /** Footer navigation of the page (its own, or the site default); `null` when it does not exist. */
+    footerContent: Record<string, unknown> | null;
+    /** The rest of the page passes through intact. */
+    [key: string]: unknown;
+}

package/dist/publicApi/page.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/search.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Public types for `GET /public/search`.
+ *
+ * Same wire contract as `GET /search` (`../search`): `[]` when `searchquery` is missing or blank, otherwise a
+ * paginated `{ items, page, totalItems }`. Aliased, not duplicated.
+ */
+export type { GetSearchResponse as GetPublicSearchResponse } from "../search";

package/dist/publicApi/search.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/publicApi/socials.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Public types for the `/public/youtube/*` and `/public/rrss/*` endpoints.
+ *
+ * Same wire contract as the Public API. A network failure, a timeout or a body that is not JSON is a 400
+ * `{ code, message }` with `Cache-Control: no-store`.
+ */
+import type { SuccessResponse } from "../common/success";
+/**
+ * Response of `GET /public/youtube/playlist/:playlist/:quantity`: the JSON of YouTube's `playlistItems` as it comes.
+ * The HTTP status of Google is **not** checked: an error JSON (`{ error: { code: 403, … } }`) is returned as a 200.
+ */
+export type GetYoutubePlaylistResponse = Record<string, unknown> | unknown[] | null;
+/**
+ * Body of `POST /public/rrss/socials/:socials` (`:socials` is `twitter`, `instagram` or `youtube`). `numPosts` must be a
+ * JSON number (a string or `0` is a 400); Twitter accepts 5 to 100. Query: `?order=<field>-<ASC|DESC>` (`date` is the
+ * date field; only the exact `ASC` sorts ascending).
+ */
+export interface PostSocialsFeedBody {
+    numPosts: number;
+    /** A key of the account map of the network (`iebusiness`, `ieuniversity`…); ignored by Instagram. */
+    accountName: string;
+}
+/**
+ * Response of `POST /public/rrss/socials/:socials`: the feed items of the network, each with `from` (a date) and a
+ * `label` (`tw`, `yt` or `ig`). A Twitter tweet carries the fields of the first user of the response (its `id` replaces
+ * the tweet's, which stays in `tweetID`) and never a `media` field. Instagram always ends in a 400 through this
+ * endpoint (inherited bug B4: the account looked up is `numPosts`).
+ */
+export type PostSocialsFeedResponse = Array<Record<string, unknown> & {
+    from: string | null;
+    label: "tw" | "yt" | "ig";
+}>;
+/**
+ * Response of `GET /public/rrss/socials/instagram/auth/redirect?code=<code>`: the long-lived token is exchanged and
+ * stored encrypted, and the body is the default success envelope (`{ code: 200, message: "ok" }`) with the success
+ * cache. Any failure (Instagram, network, timeout, the token store, missing configuration) is a 400 `{ code, message }`
+ * with `Cache-Control: no-store`.
+ *
+ * `GET /public/rrss/socials/instagram/auth/join` has no payload: it is a 302 to Instagram's authorization page, with
+ * `redirect_uri=https://<Host>/rrss/socials/instagram/auth/redirect` (no `/public` prefix, not encoded). The four stubs
+ * `privacy`, `delete_user_data`, `cancel` and `delete` answer 200 with `Content-Type: application/json` and the literal
+ * body `ok` (not valid JSON). Every route is `GET` only; any other method is a 404.
+ */
+export type GetInstagramAuthRedirectResponse = SuccessResponse;

package/dist/publicApi/socials.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Public types for the `/public/youtube/*` and `/public/rrss/*` endpoints.
+ *
+ * Same wire contract as the Public API. A network failure, a timeout or a body that is not JSON is a 400
+ * `{ code, message }` with `Cache-Control: no-store`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/redirects/index.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Código de estado con el que se responde a una redirección: `"301"`
+ * (permanente) o `"302"` (temporal).
+ *
+ * Es un string y no un number a propósito: el consumidor final es una
+ * cabecera HTTP, y es la forma en la que el admin lo envía y lo pinta. En las
+ * respuestas del listado el campo viene siempre informado.
+ */
+export type RedirectType = "301" | "302";
 export interface RedirectDTO {
     pageId: number;
     siteId: number;
@@ -21,6 +30,7 @@ export interface RedirectListItem {
     site: RedirectSiteInfo;
     from: string;
     to: RedirectDestinationInfo;
+    type: RedirectType;
 }
 export interface RedirectListResponse {
     totalItems: number;
@@ -30,11 +40,12 @@ export interface RedirectListResponse {
 export interface RedirectBulkInput {
     from?: string;
     to?: string | number;
+    type?: RedirectType;
     id?: number | string | null;
 }
 export interface RedirectBulkResult {
     total: number;
-    error: Array<Record<string, unknown>>;
-    existing: Array<Record<string, unknown>>;
-    ok: Array<Record<string, unknown>>;
+    error: Record<string, unknown>[];
+    existing: Record<string, unknown>[];
+    ok: Record<string, unknown>[];
 }

package/dist/schemas/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./select";
 export * from "./schemas";
+export * from "./select";
 export * from "./version";

package/dist/schemas/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./select"), exports);
 __exportStar(require("./schemas"), exports);
+__exportStar(require("./select"), exports);
 __exportStar(require("./version"), exports);

package/dist/schemas/template.d.ts

@@ -20,4 +20,4 @@ declare enum TemplateSpecialTypeEnum {
     NOT_FOUND = "404",
     SITEMAP = "sitemap"
 }
-export { TemplateTypeKeyEnum, TemplateModeTypeEnum, TemplateBasicTypeEnum, TemplateSpecialTypeEnum, };
+export { TemplateBasicTypeEnum, TemplateModeTypeEnum, TemplateSpecialTypeEnum, TemplateTypeKeyEnum, };

package/dist/schemas/template.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateSpecialTypeEnum = exports.TemplateBasicTypeEnum = exports.TemplateModeTypeEnum = exports.TemplateTypeKeyEnum = void 0;
+exports.TemplateTypeKeyEnum = exports.TemplateSpecialTypeEnum = exports.TemplateModeTypeEnum = exports.TemplateBasicTypeEnum = void 0;
 var TemplateTypeKeyEnum;
 (function (TemplateTypeKeyEnum) {
     TemplateTypeKeyEnum["LABEL"] = "label";

package/dist/settings/index.d.ts

@@ -6,7 +6,7 @@
  * for things like `allowedUsersToCRUD`). The exact list of keys is
  * data-driven so the type is kept loose on purpose.
  */
-export type SettingValue = string | number | boolean | Record<string, unknown> | Array<unknown> | null;
+export type SettingValue = string | number | boolean | Record<string, unknown> | unknown[] | null;
 export type GetGlobalSettingsResponse = Record<string, SettingValue> & {
     cloudinaryName?: string | null;
     apiVersion?: string;

package/dist/structuredData/categories.d.ts

@@ -1,5 +1,5 @@
-import type { DataLanguage } from "./content";
 import type { SuccessResponse } from "../common/success";
+import type { DataLanguage } from "./content";
 /**
  * Public types for category-group endpoints:
  *

package/dist/structuredData/content.d.ts

@@ -98,7 +98,7 @@ export interface UpsertStructuredDataContentBody {
     entity?: string | null;
     content?: Record<string, unknown>;
     draft?: boolean | number | string;
-    language?: number | string;
+    language?: number | string | null;
     originalLanguage?: unknown;
     canBeTranslated?: boolean | number | string;
     publicationScheduled?: unknown;

package/dist/structuredData/distributor.d.ts

@@ -23,8 +23,8 @@ export interface DistributorItem {
  * typed explicitly, the rest passes through untouched.
  */
 export interface PostDistributorContentBody {
-    site?: string | number;
-    language?: string | number;
+    site?: string | number | null;
+    language?: string | number | null;
     mode?: "auto" | "manual" | "navigation" | string;
     sources?: unknown[];
     order?: unknown;

package/dist/structuredData/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./access_grants";
-export * from "./content";
-export * from "./types";
 export * from "./categories";
+export * from "./content";
 export * from "./distributor";
+export * from "./types";

package/dist/structuredData/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./access_grants"), exports);
-__exportStar(require("./content"), exports);
-__exportStar(require("./types"), exports);
 __exportStar(require("./categories"), exports);
+__exportStar(require("./content"), exports);
 __exportStar(require("./distributor"), exports);
+__exportStar(require("./types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@griddo/api-types",
-	"version": "1.3.2",
+	"version": "1.4.0",
 	"description": "Tipos públicos de la API de Griddo",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",