@griddo/api-types 1.1.3 → 1.3.0

package/dist/search/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Public types for the `/search` endpoint family.
+ *
+ * `GET /search` returns either an empty array (when the search query is
+ * empty/whitespace) or a `SearchResultPage` payload with one entry per
+ * matched page.
+ */
+export interface SearchResultItem {
+    site: string | null;
+    title: string | null;
+    url: string | null;
+    template: string | null;
+    image: string | null;
+    description: string | null;
+    priority: number;
+}
+export interface SearchResultPage {
+    items: SearchResultItem[];
+    page: number;
+    totalItems: number;
+}
+export type GetSearchResponse = SearchResultPage | SearchResultItem[];
+export interface PostSearchBody {
+    siteId: number | "global";
+    pageId: number;
+    languageId?: number | null;
+    url?: string | null;
+    image?: string | null;
+    title?: string | null;
+    description?: string | null;
+    content?: string | null;
+    template?: string | null;
+}

package/dist/search/index.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Public types for the `/search` endpoint family.
+ *
+ * `GET /search` returns either an empty array (when the search query is
+ * empty/whitespace) or a `SearchResultPage` payload with one entry per
+ * matched page.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/settings/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Public input/output types for the `/settings` endpoint.
+ *
+ * `GetGlobalSettingsResponse` is a key/value object whose value types vary
+ * per key (booleans for SEO flags, strings for welcome text, parsed JSON
+ * 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 GetGlobalSettingsResponse = Record<string, SettingValue> & {
+    cloudinaryName?: string | null;
+    apiVersion?: string;
+    schemasVersion: string;
+    schemasTimestamp: string;
+};
+export type SetGlobalSettingsRequest = Record<string, SettingValue>;

package/dist/settings/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Public input/output types for the `/settings` endpoint.
+ *
+ * `GetGlobalSettingsResponse` is a key/value object whose value types vary
+ * per key (booleans for SEO flags, strings for welcome text, parsed JSON
+ * for things like `allowedUsersToCRUD`). The exact list of keys is
+ * data-driven so the type is kept loose on purpose.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/site/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./languages";
 export * from "./site";
+export * from "./site_languages";

package/dist/site/index.js

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

package/dist/site/site.d.ts

@@ -22,6 +22,8 @@ interface BaseSiteDTO {
     hash?: string | null;
     rendering?: Date | null;
     isPublished?: number | null;
+    hidden?: number | null;
+    showSitemapInRobots?: number | null;
 }
 export type SiteDTO = BaseSiteDTO & {
     authorRelation?: SiteRelation;
@@ -32,7 +34,7 @@ export type SitePostParamsDTO = Pick<BaseSiteDTO, "name"> & {
     domain: number;
     path: string | null;
 };
-export type SitePutParamsDTO = Pick<BaseSiteDTO, "authorId" | "bigAvatar" | "deleted" | "favicon" | "hash" | "id" | "isPublished" | "name" | "published" | "navigationModules" | "siteMetaDataId" | "slug" | "smallAvatar" | "socials" | "thumbnail" | "timezone">;
+export type SitePutParamsDTO = Pick<BaseSiteDTO, "authorId" | "bigAvatar" | "deleted" | "favicon" | "hash" | "hidden" | "showSitemapInRobots" | "id" | "isPublished" | "name" | "published" | "navigationModules" | "siteMetaDataId" | "slug" | "smallAvatar" | "socials" | "thumbnail" | "timezone">;
 export type SitePostResponseDTO = SiteDTO;
 export type SitePutResponseDTO = SiteDTO;
 export type SiteSyncActionsDTO = {

package/dist/site/site_languages.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Public types for the `/site/:site/languages` endpoint family.
+ *
+ * `GET` returns the enriched list of languages configured for a site
+ * (including domain detail and a computed `home` URL). `POST`/`PUT` add or
+ * update a single site-language association.
+ *
+ * Not to be confused with `LanguageSiteDTO` (`site/languages.ts`), which is
+ * the raw `languages_site` row mapping used internally, or `LanguageListItem`
+ * / `LanguageListResponse` (`languages/index.ts`), which back the unrelated
+ * `/languages` endpoint.
+ */
+export interface SiteLanguageDomainDetail {
+    id: number;
+    url: string | null;
+    slug: string | null;
+}
+export interface SiteLanguageDetail {
+    id: number;
+    locale: string | null;
+    language: string | null;
+    label: string | null;
+    path: string | null;
+    isDefault: boolean;
+    domain: SiteLanguageDomainDetail | null;
+}
+export interface SiteLanguageDetailWithHome extends SiteLanguageDetail {
+    home: string | null;
+}
+export interface GetSiteLanguagesResult {
+    totalItems: number;
+    items: SiteLanguageDetailWithHome[];
+}
+export interface AddSiteLanguageRequest {
+    language: number | {
+        id: number;
+    };
+    domain: number | {
+        id: number;
+    };
+    path?: string;
+    isDefault?: boolean | number;
+}

package/dist/site/site_languages.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Public types for the `/site/:site/languages` endpoint family.
+ *
+ * `GET` returns the enriched list of languages configured for a site
+ * (including domain detail and a computed `home` URL). `POST`/`PUT` add or
+ * update a single site-language association.
+ *
+ * Not to be confused with `LanguageSiteDTO` (`site/languages.ts`), which is
+ * the raw `languages_site` row mapping used internally, or `LanguageListItem`
+ * / `LanguageListResponse` (`languages/index.ts`), which back the unrelated
+ * `/languages` endpoint.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/storage/index.d.ts

@@ -0,0 +1,4 @@
+export declare enum StorageUrlType {
+    IMAGES = "images",
+    FILES = "files"
+}

package/dist/storage/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageUrlType = void 0;
+var StorageUrlType;
+(function (StorageUrlType) {
+    StorageUrlType["IMAGES"] = "images";
+    StorageUrlType["FILES"] = "files";
+})(StorageUrlType || (exports.StorageUrlType = StorageUrlType = {}));

package/dist/structuredData/access_grants.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Forma mínima embebida en `GET /structured_data_content/:id` (campo `accessGrants`).
+ * Solo IDs; los detalles los obtiene el FE desde `/access-grants` o `/candidates`.
+ */
+export interface SimpleContentAccessGrantsSummary {
+    users: number[];
+    roles: number[];
+}
+export interface SimpleContentAccessGrantUserResponse {
+    id: number;
+    email: string;
+    username: string;
+}
+export interface SimpleContentAccessGrantRoleResponse {
+    id: number;
+    name: string;
+}
+export interface GetSimpleContentAccessGrantsResponse {
+    users: SimpleContentAccessGrantUserResponse[];
+    roles: SimpleContentAccessGrantRoleResponse[];
+}
+export interface SimpleContentAccessGrantCandidateUser {
+    id: number;
+    name: string;
+    email: string;
+}
+export interface SimpleContentAccessGrantCandidateRole {
+    id: number;
+    name: string;
+}
+export interface GetSimpleContentAccessGrantsCandidatesResponse {
+    availableUsers: SimpleContentAccessGrantCandidateUser[];
+    grantedUsers: SimpleContentAccessGrantCandidateUser[];
+    availableRoles: SimpleContentAccessGrantCandidateRole[];
+    grantedRoles: SimpleContentAccessGrantCandidateRole[];
+}

package/dist/structuredData/access_grants.js

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

package/dist/structuredData/categories.d.ts

@@ -0,0 +1,69 @@
+import type { DataLanguage } from "./content";
+import type { SuccessResponse } from "../common/success";
+/**
+ * Public types for category-group endpoints:
+ *
+ * - `POST /categories/group` (create) / `PUT /categories/group/:group` (update/move)
+ * - `GET /categories/group/:group`
+ * - `PUT /categories/order`
+ * - `DELETE /categories/:structuredData/site/:site/group/:group` (+ `/bulk`)
+ * - `DELETE /categories/delete/hard`
+ */
+/**
+ * A category group, as returned by `formatGroup`. Shared by the group CRUD
+ * (`POST`/`PUT`/`GET /categories/group...`) endpoints.
+ */
+export interface StructuredDataCategoryGroup {
+    id: number | null;
+    type: string;
+    structuredData: string | null;
+    parentGroup: number | null;
+    entity: string | null;
+    position: number | null;
+    selectable: boolean;
+    content: {
+        title: string | null;
+    };
+    dataLanguages: DataLanguage[];
+    language: number | null;
+    relatedSite: number | null;
+}
+/**
+ * Body for `POST /categories/group` (create) and `PUT /categories/group/:group`
+ * (rename / move).
+ */
+export interface UpsertCategoriesGroupBody {
+    title: string;
+    structuredData: string;
+    selectable?: boolean;
+    entity?: string | null;
+    language?: number;
+    /** Normalised server-side: "global" / empty / non-numeric input becomes `null`. */
+    relatedSite: number | null;
+}
+/** Body for `PUT /categories/order`. */
+export interface PutCategoriesOrderBody {
+    contentId: number;
+    type: string;
+    parentGroup: number;
+    position: number;
+    structuredData: string;
+    /** Normalised server-side: "global" / empty / non-numeric input becomes `null`. */
+    relatedSite: number | null;
+    language: number;
+}
+export type PutCategoriesOrderResponse = SuccessResponse;
+/** Body for `DELETE /categories/:structuredData/site/:site/group/bulk`. */
+export interface DeleteCategoriesGroupBulkBody {
+    groups: number[];
+}
+export type DeleteCategoriesGroupResponse = SuccessResponse;
+/** Body for `DELETE /categories/delete/hard` (developer-key gated). */
+export interface DeleteCategoriesHardBody {
+    developerKey?: string;
+    items: {
+        categories: Array<number | string>;
+        groups: Array<number | string>;
+    };
+}
+export type DeleteCategoriesHardResponse = SuccessResponse;

package/dist/structuredData/categories.js

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

package/dist/structuredData/content.d.ts

@@ -0,0 +1,164 @@
+import type { SimpleContentAccessGrantsSummary } from "./access_grants";
+/**
+ * Public types for the `structured_data_content` CRUD family:
+ *
+ * - `POST /structured_data_content` (create) / `PUT /structured_data_content/:id` (update)
+ * - `GET /structured_data_content/:id` (+ `/site/:site/...` variant)
+ * - `GET /structured_data_content/bulk/:ids` (+ `/site/:site/...` variant)
+ * - `GET /structured_data_contents/:structuredData` and its 4 route
+ *   variants (with/without `:site`, with/without `:structuredData`)
+ * - `GET /site/:site/structured_data_contents/:structuredData/checkgroup`
+ * - `DELETE /structured_data_content/:id` (+ `/bulk`)
+ * - `PUT /structured_data_content/:id/(draft|undraft)` (+ `/bulk`)
+ * - `PUT /structured_data_content/:id/restore` (+ `/bulk`)
+ * - `DELETE /structured_data_content/simple/hard/:structured_data_content` (+ `/bulk`)
+ * - `POST /structured_data_content/:structuredData/site/:site/export`
+ */
+/** One language version of a structured-data content row. */
+export interface DataLanguage {
+    id: number;
+    site: number | null;
+    page: number | null;
+    language: number;
+}
+/**
+ * A structured-data content item as returned by the single-item read path
+ * (`getStructuredDataContent` / `postStructuredDataContent` in the legacy
+ * orchestration, both funnel through the same `formatStructuredData`
+ * formatter). `relatedPage` starts out as a plain id and gets replaced with
+ * an enriched object (`{ pageId, url, urlCanonical, ... }`) once the URL
+ * remapping post-processing runs.
+ */
+export interface StructuredDataContentItem {
+    id: number;
+    structuredData: string | null;
+    type: "structuredData" | "category";
+    relatedSite: number | null;
+    relatedPage: number | Record<string, unknown> | null;
+    content: Record<string, unknown>;
+    entity: string | null;
+    draft: boolean;
+    published: Date | null;
+    modified: Date | null;
+    deleted: boolean;
+    pendingPublishing: boolean;
+    language: number | null;
+    originalLanguage: number | null;
+    canBeTranslated: boolean;
+    dataLanguages: DataLanguage[];
+    publicationScheduled: Date | null;
+    hasBeenPublished: boolean;
+    schemaVersion: string | null;
+    schemaVersionTimestamp: Date | null;
+    [key: string]: unknown;
+}
+/**
+ * A structured-data content item as returned by the *listing* path
+ * (`listStructuredDataContentOptimized`). Field set overlaps heavily with
+ * `StructuredDataContentItem` but comes from a different formatter
+ * (`formatRawRow` + batch enrichment), so it's kept as its own type.
+ */
+export interface StructuredDataContentListItem {
+    id: number;
+    structuredData: string | null;
+    title: string | null;
+    abstract: string | null;
+    entity: string | null;
+    content: Record<string, unknown>;
+    image: number | null;
+    draft: number | null;
+    published: Date | null;
+    modified: Date | null;
+    deleted: number | null;
+    relatedSite: number | null;
+    relatedPage: number | null;
+    language: number | null;
+    expirationDate: Date | null;
+    hasBeenPublished: boolean | null;
+    pendingPublishing: number | null;
+    publicationScheduled: Date | null;
+    dataLanguages: DataLanguage[];
+    totalLanguageVersions: number;
+    [key: string]: unknown;
+}
+export interface UpsertStructuredDataContentAccessGrantsBody {
+    users: number[];
+    roles: number[];
+}
+/**
+ * Body for `POST /structured_data_content` and `PUT /structured_data_content/:id`.
+ * The upsert payload accepts a large mode-specific surface (different content
+ * shapes per `structuredData` type) — only the keys the server reads are
+ * typed explicitly, the rest passes through untouched.
+ */
+export interface UpsertStructuredDataContentBody {
+    structuredData: string;
+    relatedSite?: number | string | null;
+    relatedPage?: number | string | null;
+    entity?: string | null;
+    content?: Record<string, unknown>;
+    draft?: boolean | number | string;
+    language?: number | string;
+    originalLanguage?: unknown;
+    canBeTranslated?: boolean | number | string;
+    publicationScheduled?: unknown;
+    accessGrants?: UpsertStructuredDataContentAccessGrantsBody;
+    [key: string]: unknown;
+}
+export type UpsertStructuredDataContentResponse = StructuredDataContentItem & {
+    accessGrants: SimpleContentAccessGrantsSummary;
+};
+export type GetStructuredDataContentResponse = StructuredDataContentItem & {
+    accessGrants: SimpleContentAccessGrantsSummary;
+};
+export interface GetStructuredDataContentBulkResponse {
+    page: number | string | undefined;
+    totalItems: number;
+    items: StructuredDataContentItem[];
+}
+export interface ListStructuredDataContentResponse {
+    totalItems: number;
+    schemasVersion: string | null;
+    schemasTimestamp: Date | null;
+    items: Array<StructuredDataContentListItem & {
+        accessGrants: SimpleContentAccessGrantsSummary;
+    }>;
+}
+/**
+ * One node of `GET .../checkgroup`. Categories are leaves; groups nest
+ * `children` recursively (mirrors `formatCheckgroupCategories`). When
+ * `groupingCategories` isn't active, items come back flat with just
+ * `{ value, name, title, code?, dataLanguages }`.
+ */
+export interface StructuredDataCheckGroupItem {
+    value: number;
+    name: number;
+    title: string | null;
+    code?: string;
+    type?: "category" | "group";
+    selectable?: boolean;
+    lang?: number | null;
+    dataLanguages?: DataLanguage[];
+    children?: StructuredDataCheckGroupItem[];
+}
+export type GetStructuredDataCheckGroupResponse = StructuredDataCheckGroupItem[];
+export interface SoftDeleteStructuredDataContentBulkBody {
+    ids: Array<number | string>;
+}
+export interface HardDeleteSimpleStructuredDataContentBody {
+    developerKey?: string;
+}
+export interface HardDeleteSimpleStructuredDataContentBulkBody {
+    developerKey?: string;
+    structuredDataIds: Array<number | string>;
+}
+export interface UpdateDraftStatusBulkBody {
+    ids: Array<number | string>;
+}
+export interface RestoreStructuredDataContentBulkBody {
+    ids: Array<number | string>;
+}
+export interface ExportStructuredDataContentBody {
+    ids: Array<number | string>;
+    format: string | string[];
+}

package/dist/structuredData/content.js

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

package/dist/structuredData/distributor.d.ts

@@ -0,0 +1,80 @@
+import type { DataLanguage } from "./content";
+/**
+ * Public types for the content-distribution endpoints:
+ *
+ * - `POST /site/:site/distributor`
+ * - `GET /site/:site/structured_data/filters/:structuredData`
+ */
+/** One resolved content item returned by the distributor. */
+export interface DistributorItem {
+    structuredData: string | null;
+    id: number;
+    language: number | null;
+    dataLanguages: DataLanguage[];
+    relatedSite: number | null;
+    relatedPage: number | Record<string, unknown> | null;
+    content: Record<string, unknown>;
+    modified: Date | null;
+    published: Date | null;
+}
+/**
+ * Body for `POST /site/:site/distributor`. Accepts a large mode-specific
+ * surface (auto/manual/navigation) — only the keys the server reads are
+ * typed explicitly, the rest passes through untouched.
+ */
+export interface PostDistributorContentBody {
+    site?: string | number;
+    language?: string | number;
+    mode?: "auto" | "manual" | "navigation" | string;
+    sources?: unknown[];
+    order?: unknown;
+    quantity?: unknown;
+    fixed?: unknown;
+    allLanguages?: unknown;
+    fullRelations?: unknown;
+    preferenceLanguage?: unknown;
+    referenceId?: unknown;
+    exclude?: unknown;
+    search?: unknown;
+    includePendingPublishing?: unknown;
+    page?: unknown;
+    responseObject?: unknown;
+    mapRelations?: unknown;
+    fields?: unknown;
+    groupingCategories?: unknown;
+    [key: string]: unknown;
+}
+/**
+ * `mode: "manual"` groups results by source (keyed object); `"auto"` /
+ * `"navigation"` return a flat array. `body.mapRelations === false` returns
+ * the unmapped raw rows instead (legacy "Public API" escape hatch) — kept
+ * loose (`unknown[]`) for that branch since the shape isn't `DistributorItem`.
+ */
+export type PostDistributorContentResponse = DistributorItem[] | Record<string, DistributorItem[]> | unknown[];
+export interface StructuredDataFilterItem {
+    id: number;
+    label: string;
+    language?: number;
+    published?: unknown;
+}
+/**
+ * A category-tree node, used instead of `StructuredDataFilterItem` once the
+ * filter result gets grouped (`groupingCategories=on`). Groups nest
+ * `children` recursively.
+ */
+export interface StructuredDataFilterCategoryNode {
+    id: number;
+    type: string;
+    label?: string;
+    selectable?: boolean;
+    language?: number | null;
+    published?: unknown;
+    children?: StructuredDataFilterCategoryNode[];
+    [key: string]: unknown;
+}
+export interface StructuredDataFilterGroup {
+    label: string;
+    items: Array<StructuredDataFilterItem | StructuredDataFilterCategoryNode>;
+}
+/** Response of `GET /site/:site/structured_data/filters/:structuredData`, keyed by structuredData id. */
+export type GetStructuredDataFiltersResponse = Record<string, StructuredDataFilterGroup>;

package/dist/structuredData/distributor.js

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

package/dist/structuredData/index.d.ts

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

package/dist/structuredData/index.js

@@ -0,0 +1,21 @@
+"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("./access_grants"), exports);
+__exportStar(require("./content"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./categories"), exports);
+__exportStar(require("./distributor"), exports);

package/dist/structuredData/types.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Public types for structured-data **type** metadata endpoints:
+ *
+ * - `GET /structured_data` (+ `/site/:site/structured_data`)
+ * - `GET /structured_data/titles/:id`
+ * - `GET /select/categories/:structuredData`
+ */
+/**
+ * A structured-data (or category) type definition, as declared in the
+ * instance's schema config. Intentionally loose — consumers in the editor
+ * read many ad-hoc fields from it.
+ */
+export interface StructuredDataTemplateSchema {
+    title?: string;
+    dataPacks?: string[];
+    type?: {
+        mode?: string;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+export type StructuredDataTypeListItem = StructuredDataTemplateSchema & {
+    id: string;
+};
+export interface StructuredDataTypeListResponse {
+    totalItems: number;
+    schemasVersion: string | null;
+    schemasTimestamp: string | null;
+    items: StructuredDataTypeListItem[];
+}
+export interface StructuredDataTitleItem {
+    id: string;
+    title: string | undefined;
+}
+export interface StructuredDataCategorySelectItem {
+    value: string;
+    label: string;
+}

package/dist/structuredData/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Public types for structured-data **type** metadata endpoints:
+ *
+ * - `GET /structured_data` (+ `/site/:site/structured_data`)
+ * - `GET /structured_data/titles/:id`
+ * - `GET /select/categories/:structuredData`
+ */
+Object.defineProperty(exports, "__esModule", { value: true });