@griddo/api-types 1.1.2 → 1.3.0

package/dist/feeds/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Public types for the `/feeds` endpoint family.
+ *
+ * `GET /feeds/:slug/data/:format?` returns the resolved content of a feed.
+ * When `format === "rss"` the `data` field is the serialized RSS/XML string;
+ * otherwise it is the list of cleaned content items.
+ */
+export interface FeedRelatedPage {
+    availableSites: {
+        id: number;
+        name: string;
+    }[];
+    editable: boolean;
+    manuallyImported: boolean;
+    origin: "GLOBAL" | "EDITOR";
+    originalPageId: number;
+    originalStructuredDataId: number;
+    pageId: number;
+    url: string;
+    urlCanonical: string;
+    relatedSite: number;
+    structuredData: string;
+}
+export interface FeedDataCleanedContent {
+    content: Record<string, any>;
+    dataLanguages: Record<string, number>[];
+    id: number;
+    language: number;
+    modified: string;
+    published: string;
+    relatedPage: FeedRelatedPage;
+    relatedSite: number;
+    structuredData: string;
+}
+export interface GetFeedDataResponse {
+    data: string | FeedDataCleanedContent[];
+    name: string;
+    expirationMinutes: number;
+    staleMinutes: number;
+}

package/dist/feeds/index.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Public types for the `/feeds` endpoint family.
+ *
+ * `GET /feeds/:slug/data/:format?` returns the resolved content of a feed.
+ * When `format === "rss"` the `data` field is the serialized RSS/XML string;
+ * otherwise it is the list of cleaned content items.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/files/index.d.ts

@@ -0,0 +1,60 @@
+export interface FilesApiPageUsage {
+    id: number;
+    title: string | null;
+    published: string | Date | null;
+    modified: string | Date | null;
+}
+export interface FilesApiSitePageUsage {
+    siteId: number;
+    siteName: string | null;
+    pages: FilesApiPageUsage[];
+}
+export interface FilesApiStructuredDataUsage {
+    id: number;
+    title: string | null;
+}
+export interface FilesApiContentInUse {
+    pages: FilesApiSitePageUsage[];
+    structuredData: FilesApiStructuredDataUsage[];
+}
+export interface FilesApiFolderInfo {
+    folderId: number;
+    folderName: string | null;
+}
+export interface FilesApiFile {
+    id: number;
+    site: number | null;
+    fileName: string | null;
+    url: string;
+    sizeBytes: number | null;
+    title: string | null;
+    alt: string | null;
+    uploadDate: string | Date | null;
+    fieldType: "file";
+    contentInUse: FilesApiContentInUse;
+    fileType: string | null;
+    tags: string[];
+    folder: FilesApiFolderInfo | null;
+}
+export interface FilesApiFolder {
+    id: number;
+    folderName: string | null;
+    parentId: number | null;
+    site: number | null;
+}
+export interface FilesApiFolderTreeNode {
+    id: number;
+    name: string | null;
+    children: FilesApiFolderTreeNode[];
+}
+export interface FilesApiSiteFolderList {
+    files: {
+        totalItems: number;
+        items: FilesApiFile[];
+    };
+    folders: FilesApiFolder[];
+}
+export interface FilesApiPostFolderResponse {
+    id: number;
+    updated: boolean;
+}

package/dist/files/index.js

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

package/dist/form-categories/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Public input/output types for the `/form/category/*` endpoints.
+ *
+ * A FormCategory is a small classification record attached to forms.
+ * Each row belongs either to the global scope (`relatedSiteId === null`)
+ * or to a specific site (numeric id).
+ */
+export interface FormCategoryContent {
+    title: string;
+    code: string;
+}
+export interface FormCategoryDTO {
+    id: number;
+    title: string;
+    relatedSiteId: number | null;
+    categoryType: string;
+    content: FormCategoryContent;
+    position: number;
+}
+export interface FormCategoryCheckGroupItem {
+    value: string;
+    name: number;
+    title: string;
+}
+export interface FormCategoryListResponse {
+    totalItems: number;
+    items: FormCategoryDTO[];
+}
+export interface CreateFormCategoryRequest {
+    categoryType: string;
+    content: FormCategoryContent;
+    position?: number;
+    relatedSite: number | null;
+}
+export interface UpdateFormCategoryRequest {
+    content: FormCategoryContent;
+}
+export interface UpdateFormCategoryOrderRequest {
+    id: number;
+    categoryType: string;
+    position: number;
+    relatedSite: number | null;
+}
+export interface DeleteFormCategoriesBulkRequest {
+    categoryIds: number[];
+}

package/dist/form-categories/index.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Public input/output types for the `/form/category/*` endpoints.
+ *
+ * A FormCategory is a small classification record attached to forms.
+ * Each row belongs either to the global scope (`relatedSiteId === null`)
+ * or to a specific site (numeric id).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/forms/index.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Public input/output types for the `/form` endpoints.
+ *
+ * A Form is a reusable structure (fields + template + categories)
+ * embedded in pages (`page.template`) and navigations
+ * (`navigation.content`). Each form belongs to a specific site
+ * (numeric id) or to the global scope (`site: null`).
+ */
+export type FormStateValue = "active" | "inactive";
+export interface FormTagList {
+    readonly tags: string[];
+}
+export interface FormDataLanguage {
+    id: number;
+    site: number | null;
+    language: number;
+}
+export type FormInUseMap = Record<"page" | "header" | "footer", number[]> | null;
+export interface FormResponse {
+    id: number;
+    title: string;
+    site: number | null;
+    language: number;
+    component: string;
+    entity: string;
+    tags: string[];
+    template: Record<string, unknown>;
+    message: string | null;
+    created: string | null;
+    modified: string | null;
+    state: FormStateValue;
+    thumbnail: string | null;
+    dataLanguages: FormDataLanguage[];
+    formInUse: FormInUseMap;
+    canBeTranslated: boolean;
+    originalLanguage: number | null;
+    deleted: boolean;
+}
+export interface FormListResponse {
+    totalItems: number;
+    active: number;
+    inactive: number;
+    items: FormResponse[];
+}
+export interface CreateFormRequest {
+    title: string;
+    site: number | null;
+    language: number;
+    tags?: string[];
+    template: Record<string, unknown>;
+    message?: string | null;
+    component: string;
+    entity?: string | null;
+    canBeTranslated?: boolean;
+    originalLanguage?: number | null;
+}
+export interface UpdateFormRequest {
+    title: string;
+    tags?: string[];
+    template: Record<string, unknown>;
+    message?: string | null;
+    canBeTranslated?: boolean;
+    originalLanguage?: number | null;
+    language: number;
+}
+export interface DuplicateFormRequest {
+    title?: string;
+}
+export interface BulkFormIdsRequest {
+    formIds: number[];
+}

package/dist/forms/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Public input/output types for the `/form` endpoints.
+ *
+ * A Form is a reusable structure (fields + template + categories)
+ * embedded in pages (`page.template`) and navigations
+ * (`navigation.content`). Each form belongs to a specific site
+ * (numeric id) or to the global scope (`site: null`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/images/index.d.ts

@@ -0,0 +1,235 @@
+/**
+ * Public types for the `/images`, `/image` and `/images/site/:site/folder`
+ * endpoint family.
+ */
+/**
+ * Image shape returned by `GET /images`, `GET /site/:site/images`,
+ * `GET /image/:id`, `POST /images` and `PUT /image/:id/replace`.
+ *
+ * Produced by `formatImageLegacy()` in the server (legacy-compatible field
+ * names: `folder`, not `folderId`).
+ */
+export interface ImageItem {
+    id: number;
+    name: string | null;
+    title: string | null;
+    description: string | null;
+    alt: string | null;
+    tags: unknown[] | null;
+    url: string | null;
+    thumb: string | null;
+    publicId: string | null;
+    damId: string | null;
+    published: string | null;
+    size: number | null;
+    width: number | null;
+    height: number | null;
+    orientation: string | null;
+    site: number | "global";
+    folder: number | null;
+}
+/** `GET /images`, `GET /site/:site/images`. */
+export interface GetImagesResponse {
+    totalItems: number;
+    items: ImageItem[];
+}
+export interface ImageRelatedPage {
+    id: number;
+    title: string | null;
+    siteId: number | null;
+    siteName: string | null;
+    published: string | null;
+    modified: string | null;
+}
+export interface ImageRelatedSimpleContent {
+    id: number;
+    title: string | null;
+    published: string | null;
+    modified: string | null;
+}
+export interface ImageRelatedSite {
+    id: number;
+    name: string | null;
+    published: string | null;
+    modified: string | null;
+}
+export interface ImageRelatedContent {
+    pages: ImageRelatedPage[];
+    structuredData: ImageRelatedSimpleContent[];
+    siteInfo: ImageRelatedSite[];
+}
+/**
+ * `GET /image/:id`.
+ *
+ * Extends {@link ImageItem} with the content referencing the image
+ * (`relatedContent`, included unless the caller opts out).
+ */
+export interface GetImageResponse extends ImageItem {
+    relatedContent?: ImageRelatedContent;
+}
+/**
+ * `POST /images` (multipart/form-data upload).
+ *
+ * Only the non-file text fields are represented here; the uploaded file
+ * itself is out-of-band (multipart part, not part of the JSON contract).
+ */
+export interface PostImagesBody {
+    site: number | "global" | null;
+    setAsGlobal: boolean;
+    active: boolean;
+    folder: number | null;
+}
+/** `POST /images` response. */
+export interface PostImagesResponse {
+    id: number;
+    name: string;
+    alt: string;
+    title: string;
+    description: string;
+    tags: unknown[];
+    width: number | null;
+    height: number | null;
+    size: number | null;
+    publicId: string | null;
+    published: string | null;
+    cloudinaryUrl: string | null;
+    damId: string | null;
+    damUrl: string | null;
+    url: string | null;
+    site: number | "global" | null;
+    folder: number | null;
+}
+/** `PUT /image/:id` request body. The image `id` itself travels in the URL. */
+export interface PutImageBody {
+    alt?: string;
+    title?: string;
+    description?: string;
+    tags?: unknown[];
+    site: number | "global" | null;
+}
+/**
+ * `PUT /image/:id/replace` request body (multipart/form-data upload).
+ *
+ * The image being replaced is identified by the `:id` URL param, not by a
+ * body field; only the non-file text fields are represented here.
+ */
+export interface PutImageReplaceBody {
+    site: number | "global" | null;
+    setAsGlobal: boolean;
+}
+/**
+ * Folder shape returned by the media-gallery folder-browsing endpoints.
+ * Shared by images (`type: "images"`) and, potentially, files
+ * (`type: "files"`) folders.
+ */
+export interface MediaFolder {
+    id: number;
+    folderName: string;
+    parentId: number | null;
+    site: number | null;
+}
+/** Minimal image entry attached to a {@link MediaFolderTree} node. */
+export interface MediaFolderTreeItem {
+    id: number;
+    name: string | null;
+    inUse: boolean;
+    folderId: number | null;
+}
+/** `GET /images/site/:site/folder/tree`. */
+export interface MediaFolderTree {
+    id: number;
+    name: string;
+    children: MediaFolderTree[];
+    items: MediaFolderTreeItem[];
+}
+export type GetImagesFolderTreeResponse = MediaFolderTree[];
+/**
+ * Image shape returned by the folder-browsing endpoints
+ * (`GET /images/site/:site/folder`, `GET /images/site/:site/folder/tree`
+ * via {@link MediaFolderTreeItem}).
+ *
+ * Distinct from {@link ImageItem}: produced by `ImageEntity.formatDTO()`,
+ * which uses `folderId` instead of `folder`. NOTE: `tags` is declared here
+ * as `string | null` matching the pre-existing local type, even though at
+ * runtime `ImageEntity.formatDTO()` actually assigns a parsed array
+ * (`unknown[]`) to it — a pre-existing inconsistency, preserved as-is.
+ */
+export interface FolderImageItem {
+    id: number;
+    alt: string | null;
+    description: string | null;
+    height: number | null;
+    name: string | null;
+    published: string | null;
+    site: number | null;
+    size: number | null;
+    tags: string | null;
+    title: string | null;
+    width: number | null;
+    folderId: number | null;
+    damId: string | null;
+    orientation: string | null;
+    publicId: string | null;
+    url: string | null;
+    thumb: string;
+}
+/**
+ * `GET /images/site/:site/folder` (single level, non-recursive).
+ *
+ * NOTE: this pagination shape uses `currentPage`, unlike
+ * {@link GetImagesResponse} which uses `page` — this is a real divergence
+ * between the two endpoints in the existing code, not a typo; preserved
+ * as-is rather than forced into consistency.
+ */
+export interface GetImagesInFolderResponse {
+    folders: MediaFolder[];
+    images: {
+        totalItems: number;
+        currentPage: number;
+        items: FolderImageItem[];
+    };
+}
+export interface ImageInUseStructuredDataInfo {
+    title: string;
+    id: string;
+}
+export interface ImageInUseContentEntry {
+    id: number;
+    title: string;
+    structuredData: ImageInUseStructuredDataInfo | null;
+    date: Date | null;
+}
+export interface ImageInUseSite {
+    id: number;
+    title: string;
+    pages: ImageInUseContentEntry[];
+    simpleContent: ImageInUseContentEntry[];
+}
+/** `GET /image/:id/inuse`. */
+export interface GetImageInUseResponse {
+    sites: ImageInUseSite[];
+    globalPages: ImageInUseContentEntry[];
+    simpleData: ImageInUseContentEntry[];
+}
+/**
+ * `DELETE /image/:id`, `DELETE /image/bulk`.
+ *
+ * Success responses use the default `HttpResponseHandler.ok` envelope
+ * (`{ code: 200, message: "ok" }`, no payload passed explicitly). Failures
+ * caused by an image still referenced by content return HTTP 400 with the
+ * list of conflicts in place of a plain string `message`.
+ */
+export interface DeleteImageConflict {
+    id: number;
+    error: string;
+}
+export interface DeleteImageSuccessResponse {
+    code: 200;
+    message: "ok";
+}
+export interface DeleteImageConflictResponse {
+    code: 400;
+    message: DeleteImageConflict[];
+}
+export type DeleteImageResponse = DeleteImageSuccessResponse | DeleteImageConflictResponse;
+export type BulkDeleteImagesResponse = DeleteImageResponse;

package/dist/images/index.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Public types for the `/images`, `/image` and `/images/site/:site/folder`
+ * endpoint family.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -6,4 +6,29 @@ 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 "./form-categories";
+export * from "./forms";
+export * from "./instances";
+export * from "./liveStatus";
+export * from "./payables";
+export * from "./translations";
+export * from "./roles";
+export * from "./files";
+export * from "./languages";
+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";

package/dist/index.js

@@ -22,4 +22,29 @@ __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("./form-categories"), exports);
+__exportStar(require("./forms"), exports);
+__exportStar(require("./instances"), exports);
+__exportStar(require("./liveStatus"), exports);
+__exportStar(require("./payables"), exports);
+__exportStar(require("./translations"), exports);
+__exportStar(require("./roles"), exports);
+__exportStar(require("./files"), exports);
+__exportStar(require("./languages"), 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);

package/dist/instances/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Public types for the `instances` heartbeat module.
+ *
+ * `instances` is an internal infrastructure table: each running API process
+ * registers its IP so that schema-change broadcasts know where to fan out.
+ * There are no HTTP endpoints; these types describe the values exchanged
+ * between usecases.
+ */
+export type InstanceIp = string;
+export type GetAllInstancesResponse = InstanceIp[];

package/dist/instances/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Public types for the `instances` heartbeat module.
+ *
+ * `instances` is an internal infrastructure table: each running API process
+ * registers its IP so that schema-change broadcasts know where to fan out.
+ * There are no HTTP endpoints; these types describe the values exchanged
+ * between usecases.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/integrations/index.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Public types for the site-level `/integration*` endpoint family.
+ *
+ * `GET /site/:site/integrations` returns a paginated list of the third-party
+ * integrations (analytics, chat widgets, tracking pixels, etc.) configured
+ * for a site. `GET /site/:site/integration/:id` returns a single one — both
+ * routes share the same controller/usecase, hence the response union.
+ *
+ * `POST /integration/site/:site/` (create) and `PUT /integration/:id/site/:site/`
+ * (update) share the same request body shape.
+ *
+ * Not to be confused with `PageIntegration` (`../pages/add-ons`), which is a
+ * different resource: an integration relation embedded in a page, not this
+ * site-level integration configuration.
+ */
+export interface FormattedIntegrationVariable {
+    id: number;
+    variableName: string;
+    variableKey: string;
+    defaultValue: string;
+    isMultilanguage: boolean;
+    value?: string | null;
+    multilanguage?: Array<{
+        id: number;
+        languageId: number;
+        value: string | null;
+    }>;
+}
+export interface FormattedIntegration {
+    id: number;
+    name: string;
+    type: string;
+    editable: boolean;
+    description: string | null;
+    site: number;
+    contentHead: string | null;
+    contentBody: string | null;
+    contentBodyPosition: string | null;
+    contentPresence: {
+        presenceType: string | null;
+        relatedPages: Array<{
+            id: number;
+            title: string | null;
+        }> | null;
+    };
+    active: boolean;
+    variables: FormattedIntegrationVariable[];
+    scriptOrder: number | null;
+    correlativeScriptOrder?: number;
+}
+export interface GetSiteIntegrationsListResponse {
+    totalItems: number;
+    page: number;
+    items: FormattedIntegration[];
+}
+/**
+ * `GET /site/:site/integrations` (list) and `GET /site/:site/integration/:id`
+ * (single, when `id` resolves) share this response type: a single formatted
+ * integration when an `id` is given, a paginated list otherwise.
+ */
+export type GetSiteIntegrationsResponse = FormattedIntegration | GetSiteIntegrationsListResponse;
+export interface PostIntegrationVariableBody {
+    id?: number;
+    variableName: string;
+    variableKey: string;
+    defaultValue: string;
+    multilanguage?: Array<{
+        id?: number;
+        languageId: number;
+        value: string | null;
+    }>;
+}
+/**
+ * Request body for `POST /integration/site/:site/` (create) and
+ * `PUT /integration/:id/site/:site/` (update).
+ */
+export interface PostIntegrationBody {
+    name: string;
+    description?: string | null;
+    contentHead?: string | null;
+    contentBody?: string | null;
+    contentBodyPosition?: string | null;
+    contentPresence: {
+        presenceType: string;
+        relatedPages?: Array<{
+            id: number;
+        }> | null;
+    };
+    active?: number | boolean;
+    variables?: PostIntegrationVariableBody[];
+    scriptOrder?: number | null;
+}

package/dist/integrations/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Public types for the site-level `/integration*` endpoint family.
+ *
+ * `GET /site/:site/integrations` returns a paginated list of the third-party
+ * integrations (analytics, chat widgets, tracking pixels, etc.) configured
+ * for a site. `GET /site/:site/integration/:id` returns a single one — both
+ * routes share the same controller/usecase, hence the response union.
+ *
+ * `POST /integration/site/:site/` (create) and `PUT /integration/:id/site/:site/`
+ * (update) share the same request body shape.
+ *
+ * Not to be confused with `PageIntegration` (`../pages/add-ons`), which is a
+ * different resource: an integration relation embedded in a page, not this
+ * site-level integration configuration.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });