@griddo/api-types 1.1.3 → 1.3.0

package/dist/languages/index.d.ts

@@ -0,0 +1,23 @@
+export interface LanguageDomainInfo {
+    id: number;
+    url: string;
+    slug: string | null;
+}
+export interface LanguageListItem {
+    id: number;
+    locale: string;
+    language: string;
+    label: string;
+    isDefault: boolean;
+    path?: string | null;
+    domain?: LanguageDomainInfo | null;
+    home?: string | null;
+}
+export interface LanguageListResponse {
+    totalItems: number;
+    items: LanguageListItem[];
+}
+export interface LanguageSelectItem {
+    value: number;
+    label: string;
+}

package/dist/languages/index.js

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

package/dist/liveStatus/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Public types for the `live-status` module.
+ *
+ * `live_status` is a tiny lookup table that catalogues the publishing
+ * states (`offline`, `upload-pending`, `active`, `offline-pending`,
+ * `scheduled`). The values are seeded once at boot and exposed by the
+ * `GET /live-status` endpoint so admin UIs can render the catalogue.
+ */
+export interface LiveStatus {
+    id: number;
+    title: string | null;
+    status: string | null;
+}
+export type GetLiveStatusResponse = LiveStatus[];

package/dist/liveStatus/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Public types for the `live-status` module.
+ *
+ * `live_status` is a tiny lookup table that catalogues the publishing
+ * states (`offline`, `upload-pending`, `active`, `offline-pending`,
+ * `scheduled`). The values are seeded once at boot and exposed by the
+ * `GET /live-status` endpoint so admin UIs can render the catalogue.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/logs/LogActivityEvents.d.ts

@@ -474,6 +474,11 @@ export declare const LogActivityEvent: {
         readonly description: "Modificación de las configuraciones generales del site.";
         readonly scope: readonly ["SITE"];
     };
+    readonly REPUBLISH_SITE: {
+        readonly name: "Republish site";
+        readonly description: "Solicitud de re-renderizado (republicación) de todas las páginas publicables del site.";
+        readonly scope: readonly ["SITE"];
+    };
     readonly EDITED_ROBOT_TXT: {
         readonly name: "Edited robot.txt";
         readonly description: "Modificación del archivo robots.txt para guiar a los motores de búsqueda.";
@@ -664,4 +669,34 @@ export declare const LogActivityEvent: {
         readonly description: "Elimina un ID de analíticas para el seguimiento en Analytics.";
         readonly scope: readonly ["GLOBAL", "SITE"];
     };
+    readonly SET_PAGE_ACCESS: {
+        readonly name: "Set page access";
+        readonly description: "Primer cambio en los permisos de acceso de una página.";
+        readonly scope: readonly ["GLOBAL", "SITE"];
+    };
+    readonly SET_CONTENT_TYPE_PAGE_ACCESS: {
+        readonly name: "Set content type page access";
+        readonly description: "Primer cambio en los permisos de acceso de una página de tipo de contenido.";
+        readonly scope: readonly ["GLOBAL", "SITE"];
+    };
+    readonly SET_CONTENT_TYPE_SIMPLE_ACCESS: {
+        readonly name: "Set content type simple access";
+        readonly description: "Primer cambio en los permisos de acceso de un contenido simple.";
+        readonly scope: readonly ["GLOBAL", "SITE"];
+    };
+    readonly EDITED_PAGE_ACCESS: {
+        readonly name: "Edited page access";
+        readonly description: "Cualquier cambio en los permisos de acceso de una página.";
+        readonly scope: readonly ["GLOBAL", "SITE"];
+    };
+    readonly EDITED_CONTENT_TYPE_PAGE_ACCESS: {
+        readonly name: "Edited content type page access";
+        readonly description: "Cualquier cambio en los permisos de acceso de una página de tipo de contenido.";
+        readonly scope: readonly ["GLOBAL", "SITE"];
+    };
+    readonly EDITED_CONTENT_TYPE_SIMPLE_ACCESS: {
+        readonly name: "Edited content type simple access";
+        readonly description: "Cualquier cambio en los permisos de acceso de un contenido simple.";
+        readonly scope: readonly ["GLOBAL", "SITE"];
+    };
 };

package/dist/logs/LogActivityEvents.js

@@ -477,6 +477,11 @@ exports.LogActivityEvent = {
         description: `Modificación de las configuraciones generales del site.`,
         scope: ["SITE"],
     },
+    REPUBLISH_SITE: {
+        name: "Republish site",
+        description: `Solicitud de re-renderizado (republicación) de todas las páginas publicables del site.`,
+        scope: ["SITE"],
+    },
     EDITED_ROBOT_TXT: {
         name: "Edited robot.txt",
         description: `Modificación del archivo robots.txt para guiar a los motores de búsqueda.`,
@@ -667,4 +672,34 @@ exports.LogActivityEvent = {
         description: `Elimina un ID de analíticas para el seguimiento en Analytics.`,
         scope: ["GLOBAL", "SITE"],
     },
+    SET_PAGE_ACCESS: {
+        name: "Set page access",
+        description: `Primer cambio en los permisos de acceso de una página.`,
+        scope: ["GLOBAL", "SITE"],
+    },
+    SET_CONTENT_TYPE_PAGE_ACCESS: {
+        name: "Set content type page access",
+        description: `Primer cambio en los permisos de acceso de una página de tipo de contenido.`,
+        scope: ["GLOBAL", "SITE"],
+    },
+    SET_CONTENT_TYPE_SIMPLE_ACCESS: {
+        name: "Set content type simple access",
+        description: `Primer cambio en los permisos de acceso de un contenido simple.`,
+        scope: ["GLOBAL", "SITE"],
+    },
+    EDITED_PAGE_ACCESS: {
+        name: "Edited page access",
+        description: `Cualquier cambio en los permisos de acceso de una página.`,
+        scope: ["GLOBAL", "SITE"],
+    },
+    EDITED_CONTENT_TYPE_PAGE_ACCESS: {
+        name: "Edited content type page access",
+        description: `Cualquier cambio en los permisos de acceso de una página de tipo de contenido.`,
+        scope: ["GLOBAL", "SITE"],
+    },
+    EDITED_CONTENT_TYPE_SIMPLE_ACCESS: {
+        name: "Edited content type simple access",
+        description: `Cualquier cambio en los permisos de acceso de un contenido simple.`,
+        scope: ["GLOBAL", "SITE"],
+    },
 };

package/dist/menus/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Public types for `/menus` and `/menu_container` API responses.
+ *
+ * Mirrors the legacy contract emitted by `endpoints/menus.ts` so existing
+ * consumers can rely on the same shape after the DDD migration.
+ */
+export interface MenuSelectItem {
+    value: number;
+    label: string;
+}
+export interface MenuUrl {
+    href: string | null;
+    anchor: string | null;
+    subSlug: string | null;
+    linkTo: number | null;
+    newTab: boolean | null;
+    noFollow: boolean | null;
+    title: string | null;
+}
+export interface MenuElement {
+    id: number;
+    label: string | null;
+    url: MenuUrl | null;
+    component: string;
+    auxText: string | null;
+    image: unknown | null;
+    config: Record<string, unknown> | null;
+    special: boolean;
+    children: MenuElement[];
+    [key: string]: unknown;
+}
+export interface MenuContainer {
+    id: number;
+    site: number | null;
+    language: number | null;
+    name: string | null;
+    title: string;
+    component: string;
+    type: string | null;
+    layout: string | null;
+    elements: MenuElement[] | undefined;
+}
+export interface UpdateMenuContainerBody {
+    name: string;
+    component?: string;
+    type?: string | null;
+    layout?: string | null;
+    elements?: MenuElement[];
+    language: number | string | {
+        id: number;
+    };
+}

package/dist/menus/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Public types for `/menus` and `/menu_container` API responses.
+ *
+ * Mirrors the legacy contract emitted by `endpoints/menus.ts` so existing
+ * consumers can rely on the same shape after the DDD migration.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/navigation/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Public types for the `/navigations` API.
+ *
+ * Mirrors the contract emitted by `endpoints/navigation.ts` so existing
+ * consumers keep working after the DDD migration.
+ */
+export interface NavigationLanguageEntry {
+    navigationId: number;
+    languageId: number;
+    locale: string | null;
+    language: string | null;
+}
+export interface NavigationListResponse {
+    totalItems: number;
+    page: number;
+    items: NavigationPayload[];
+}
+export interface NavigationPayload {
+    id: number;
+    site: number | null;
+    language: number | null;
+    entity: string | null;
+    thumbnail: unknown | null;
+    isDefault: boolean;
+    deleted: boolean;
+    setAsDefault: boolean;
+    navigationLanguages?: NavigationLanguageEntry[];
+    [key: string]: unknown;
+}
+export interface PagesReplaceResponse {
+    availableNavigationsInSite: Array<{
+        id: number;
+        isDefault: boolean;
+    }>;
+    items: {
+        totalItems: number;
+        pagesInUse: Array<{
+            pageId: number;
+            pageTitle: string | null;
+            pathString: string | null;
+            navigationId: number;
+        }>;
+    };
+}

package/dist/navigation/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Public types for the `/navigations` API.
+ *
+ * Mirrors the contract emitted by `endpoints/navigation.ts` so existing
+ * consumers keep working after the DDD migration.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/pages/index.d.ts

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

package/dist/pages/index.js

@@ -16,3 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 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("./llms"), exports);
+__exportStar(require("./preview_share"), exports);

package/dist/pages/llms.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Public types for `GET /domains/:domainId/llms`.
+ *
+ * Returns the list of published pages of a domain, in the minimal shape
+ * consumed to build its `llms.txt` (id, title, absolute url, description).
+ */
+export interface LlmsReadyPage {
+    id: number;
+    title: string;
+    url: string;
+    description: string;
+}
+export type GetDomainLlmsResponse = LlmsReadyPage[];

package/dist/pages/llms.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Public types for `GET /domains/:domainId/llms`.
+ *
+ * Returns the list of published pages of a domain, in the minimal shape
+ * consumed to build its `llms.txt` (id, title, absolute url, description).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/pages/page_access_grants.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Forma mínima embebida en `GET /page/:id` (campo `accessGrants`).
+ * Solo IDs; los detalles los obtiene el FE desde `/access-grants` o `/candidates`.
+ */
+export interface PageAccessGrantsSummary {
+    users: number[];
+    roles: number[];
+}
+export interface PageAccessGrantUserResponse {
+    id: number;
+    email: string;
+    username: string;
+}
+export interface PageAccessGrantRoleResponse {
+    id: number;
+    name: string;
+}
+export interface GetPageAccessGrantsResponse {
+    users: PageAccessGrantUserResponse[];
+    roles: PageAccessGrantRoleResponse[];
+}
+export interface PageAccessGrantCandidateUser {
+    id: number;
+    name: string;
+    email: string;
+}
+export interface PageAccessGrantCandidateRole {
+    id: number;
+    name: string;
+}
+export interface GetPageAccessGrantsCandidatesResponse {
+    availableUsers: PageAccessGrantCandidateUser[];
+    grantedUsers: PageAccessGrantCandidateUser[];
+    availableRoles: PageAccessGrantCandidateRole[];
+    grantedRoles: PageAccessGrantCandidateRole[];
+}
+/**
+ * Body de `PUT /site/:site/pages/:page/access-grant`.
+ * Sobrescribe por completo la whitelist de la página.
+ * Solo puede llegar uno de los dos con contenido: `users` O `roles`, no ambos.
+ * Ambos vacíos limpia la whitelist.
+ */
+export interface ReplacePageAccessGrantsBody {
+    users: number[];
+    roles: number[];
+}

package/dist/pages/page_access_grants.js

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

package/dist/pages/preview_share.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Public types for the `/page/:id/share` endpoint family.
+ *
+ * `GET`, `POST` (create) and `PUT` (renew) all return the same shape: the
+ * current state of the page's preview share link.
+ */
+export interface PagePreviewShareResponseDTO {
+    entity: string;
+    daysValid: number;
+    startDate: string;
+    endDate: string;
+    visitCount: number;
+}

package/dist/pages/preview_share.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Public types for the `/page/:id/share` endpoint family.
+ *
+ * `GET`, `POST` (create) and `PUT` (renew) all return the same shape: the
+ * current state of the page's preview share link.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/payables/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Public types for the `/payables` endpoint family.
+ *
+ * `payables` is an internal accounting ledger: each AI / translation call
+ * appends a row recording the consumed units per concept (OPENAI_TOKENS,
+ * OPENAI_TOKENS_EMBED, DEEPL_CHARS, …). The reporting endpoint groups them
+ * by month and returns the rows plus a per-concept totals aggregate.
+ */
+export type PayableConcept = string;
+export interface PayableRecord {
+    id: number;
+    date: string;
+    concept: PayableConcept;
+    units: number;
+}
+export interface GetPayablesResponse {
+    total: Record<PayableConcept, number>;
+    detail: PayableRecord[];
+}

package/dist/payables/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Public types for the `/payables` endpoint family.
+ *
+ * `payables` is an internal accounting ledger: each AI / translation call
+ * appends a row recording the consumed units per concept (OPENAI_TOKENS,
+ * OPENAI_TOKENS_EMBED, DEEPL_CHARS, …). The reporting endpoint groups them
+ * by month and returns the rows plus a per-concept totals aggregate.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/redirects/index.d.ts

@@ -5,3 +5,36 @@ export interface RedirectDTO {
     slug: string;
     parentSlug: string | null;
 }
+export interface RedirectSiteInfo {
+    siteId: number | null;
+    siteName: string | null;
+    siteUrl: string;
+}
+export interface RedirectDestinationInfo {
+    pageId: number | null;
+    url: string | null;
+}
+export interface RedirectListItem {
+    id: number;
+    domain: string | null;
+    date: Date | string | null;
+    site: RedirectSiteInfo;
+    from: string;
+    to: RedirectDestinationInfo;
+}
+export interface RedirectListResponse {
+    totalItems: number;
+    page: number;
+    items: RedirectListItem[];
+}
+export interface RedirectBulkInput {
+    from?: string;
+    to?: string | number;
+    id?: number | string | null;
+}
+export interface RedirectBulkResult {
+    total: number;
+    error: Array<Record<string, unknown>>;
+    existing: Array<Record<string, unknown>>;
+    ok: Array<Record<string, unknown>>;
+}

package/dist/render/index.d.ts

@@ -0,0 +1 @@
+export * from "./status";

package/dist/render/index.js

@@ -0,0 +1,17 @@
+"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("./status"), exports);

package/dist/render/status.d.ts

@@ -0,0 +1,59 @@
+import type { PaginationRequest, PaginationResponse } from "src/common";
+/**
+ * Estados posibles de un `render_runs` (ciclo de render, legacy o K8s).
+ */
+export type RenderRunStatus = "pending" | "running" | "completed" | "failed";
+/**
+ * Estados posibles de un `render_run_sites` (site dentro de un run).
+ * `failed` se infiere por cascada cuando el run llega a terminal sin que el
+ * site haya reportado su `build/end` (reconcile-by-timeout, watch de K8s).
+ */
+export type RenderRunSiteStatus = "pending" | "completed" | "failed";
+/**
+ * DTO de un `render_runs` (sin sus sites — usado en el listado paginado).
+ */
+export interface RenderRunDTO {
+    readonly id: number;
+    readonly status: RenderRunStatus;
+    readonly jobName: string | null;
+    readonly requestedAt: Date;
+    readonly startedAt: Date | null;
+    readonly completedAt: Date | null;
+    readonly errorMessage: string | null;
+}
+/**
+ * DTO de un site dentro de un run (para el detalle).
+ */
+export interface RenderRunSiteDTO {
+    readonly id: number;
+    readonly siteId: number;
+    readonly status: RenderRunSiteStatus;
+    readonly startedAt: Date | null;
+    readonly completedAt: Date | null;
+}
+/**
+ * DTO de detalle de un run: el run + todos sus sites trackeados.
+ */
+export interface RenderRunDetailDTO extends RenderRunDTO {
+    readonly sites: RenderRunSiteDTO[];
+}
+/** Parámetros para `GET /renders/:id`. */
+export type GetRenderRunParamsDTO = {
+    id: number;
+};
+/** Respuesta de `GET /renders/:id`. */
+export type GetRenderRunResponseDTO = RenderRunDetailDTO;
+/** Respuesta de `GET /renders/active` — `null` si no hay run `running`. */
+export type GetActiveRenderRunResponseDTO = RenderRunDetailDTO | null;
+/** Filtro soportado por el listado paginado de runs. */
+export interface PaginationFilterRenderRunDTO {
+    status?: RenderRunStatus;
+}
+/**
+ * Parámetros de paginación para `GET /renders`. Sin `search` (no aplica a
+ * runs, que no tienen texto libre buscable).
+ */
+export type PaginationRenderRunDTO = Omit<PaginationRequest<PaginationFilterRenderRunDTO>, "search">;
+export type PaginationRenderRunParamsDTO = PaginationRenderRunDTO;
+/** Respuesta de `GET /renders`. */
+export type PaginationRenderRunResponseDTO = PaginationResponse<RenderRunDTO>;

package/dist/render/status.js

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

package/dist/roles/index.d.ts

@@ -0,0 +1,61 @@
+/** Public types for the Roles domain. */
+/** A site id context: a numeric site id, or the "global"/"all" sentinels. */
+export type RoleSiteId = number | "global" | "all";
+/**
+ * Basic role info as exposed by `GET /roles` and `CONFIG.rolesInfo`.
+ *
+ * `editable`/`visible` are kept as raw `0 | 1` numbers to match the legacy
+ * contract: the boolean transformer normalizes both dialects to 0/1, and
+ * downstream consumers rely on truthiness (`!item.editable`).
+ */
+export interface RoleInfo {
+    id: number;
+    name: string;
+    description: string | null;
+    editable: number | null;
+    visible: number | null;
+}
+/** A single permission entry inside a site role. */
+export interface SiteRolePermissionItem {
+    name: string;
+    key: string;
+}
+/** Permission breakdown for a role within a site. */
+export interface SiteRolePermissions {
+    totalPermissions: string;
+    sitePermissions: SiteRolePermissionItem[];
+    globalPermissions: SiteRolePermissionItem[];
+}
+/** A role as exposed by `GET /site/:site/roles`. */
+export interface SiteRole {
+    id: number;
+    name: string;
+    hex: string | undefined;
+    description: string | null;
+    permissions: SiteRolePermissions;
+    editable: boolean;
+    active: boolean;
+    /** Only present for non-global listings. */
+    users?: number[];
+}
+/** Roles a user holds, grouped by site, as exposed by `GET /user/:user/roles`. */
+export interface UserSiteRoles {
+    siteId: RoleSiteId;
+    roles: number[];
+}
+/** Input for activating/deactivating a role in a site or globally. */
+export interface ActivateRoleSiteParams {
+    active: boolean;
+    role: number | string;
+    site: number | string | "global";
+}
+/** Input for creating a role. */
+export interface CreateRoleParams {
+    name: string;
+    description: string;
+    visible?: boolean;
+    editable?: boolean;
+}
+/** Ordering accepted by `GET /site/:site/roles`. */
+export type SiteRolesOrderField = "name" | "users" | "permissions";
+export type SiteRolesOrderDir = "ASC" | "DESC";

package/dist/roles/index.js

@@ -0,0 +1,3 @@
+"use strict";
+/** Public types for the Roles domain. */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/schemas/index.d.ts

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

package/dist/schemas/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./select"), exports);
 __exportStar(require("./schemas"), exports);
+__exportStar(require("./version"), exports);

package/dist/schemas/schemas.d.ts

@@ -42,6 +42,8 @@ export interface SchemaRichTextConfig {
     paragraphStyles: SchemaStyleConfig[];
     tableStyles: SchemaStyleConfig[];
     tableCellStyles: SchemaStyleConfig[];
+    imageStyles: SchemaStyleConfig[];
+    imageResize: boolean;
     editorLangs: SchemaEditorLang[];
 }
 export interface SchemaStyleConfig {

package/dist/schemas/version.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Response shape for `GET /schemas/version`.
+ *
+ * The version is `null` when no schemas have been loaded yet (the API
+ * is still booting or `PUT /schemas` was never called).
+ */
+export interface SchemaVersionResponse {
+    version: string | null;
+}

package/dist/schemas/version.js

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