@griddo/api-types 1.1.3 → 1.3.0

package/dist/ai/answers.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Public types for `POST /ai/answers`.
+ *
+ * Generates a natural-language, AI-powered answer to a query, grounded on
+ * the most relevant indexed content found for it.
+ */
+export interface PostAiAnswersBody {
+    query: string;
+    lang: number;
+    site?: number | "global";
+    templates?: string[];
+    priorities?: Record<string, number>;
+    minSimilarity?: number;
+    format?: string | null;
+}
+export interface PostAiAnswersResponse {
+    status: "ok" | "noResponse";
+    response: string;
+    error: string;
+}

package/dist/ai/answers.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Public types for `POST /ai/answers`.
+ *
+ * Generates a natural-language, AI-powered answer to a query, grounded on
+ * the most relevant indexed content found for it.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ai/index.d.ts

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

package/dist/ai/index.js

@@ -0,0 +1,20 @@
+"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("./search"), exports);
+__exportStar(require("./answers"), exports);
+__exportStar(require("./pages"), exports);
+__exportStar(require("./summary"), exports);

package/dist/ai/pages.d.ts

@@ -0,0 +1,19 @@
+import type { AiSearchResultItem } from "./search";
+/**
+ * Public types for `POST /ai/pages/related`.
+ *
+ * Returns the pages most related to a given page (by its embedding),
+ * ranked by AI similarity. Reuses the same result shape as `/ai/search`.
+ */
+export interface PostAiPagesRelatedBody {
+    pageId?: number | null;
+    languageId: number;
+    site?: number | "global";
+    template?: string | string[] | null;
+    priorities?: Record<string, number>;
+    minSimilarity?: number;
+    quantity?: number;
+    useStructuredData?: boolean;
+    fields?: string[];
+}
+export type PostAiPagesRelatedResponse = AiSearchResultItem[];

package/dist/ai/pages.js

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

package/dist/ai/search.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Public types for the `/ai/search` endpoint family.
+ *
+ * `POST /ai/search` runs an AI-powered semantic search over indexed
+ * embeddings (pages and structured data) and returns a paginated,
+ * similarity-ranked list of results.
+ *
+ * `GET /ai/search/content-types` returns the distinct list of
+ * templates/structured-data schemas indexed for AI search, used to
+ * populate content-type filters in search UIs.
+ */
+export interface PostAiSearchBody {
+    query: string;
+    lang: number;
+    site?: number | "global";
+    templates?: string[];
+    priorities?: Record<string, number>;
+    minSimilarity?: number;
+    page?: number;
+    itemsPerPage?: number;
+    useStructuredData?: boolean;
+    fields?: string[];
+}
+/**
+ * A single AI search result, built from an indexed embedding and scored
+ * against the query.
+ *
+ * `content` is only present when the search requested it (`useContent`);
+ * `structuredData` is only present when it requested structured data
+ * (`useStructuredData`).
+ */
+export interface AiSearchResultItem {
+    searchId: number;
+    pageId: number;
+    title: string;
+    url: string | null;
+    image: string | null;
+    description: string | null;
+    template: string;
+    similarity: number;
+    content?: string;
+    structuredData?: Record<string, any> | string;
+}
+export interface PostAiSearchResponse {
+    page: number;
+    itemsPerPage: number;
+    totalItems: number;
+    items: AiSearchResultItem[];
+}
+export interface AiContentType {
+    id: string;
+    name: string;
+}
+export type GetAiSearchContentTypesResponse = AiContentType[];

package/dist/ai/search.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * Public types for the `/ai/search` endpoint family.
+ *
+ * `POST /ai/search` runs an AI-powered semantic search over indexed
+ * embeddings (pages and structured data) and returns a paginated,
+ * similarity-ranked list of results.
+ *
+ * `GET /ai/search/content-types` returns the distinct list of
+ * templates/structured-data schemas indexed for AI search, used to
+ * populate content-type filters in search UIs.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ai/summary.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Public types for `POST /ai/summary/page`.
+ *
+ * Generates an AI-powered summary (and keywords) for a page's content.
+ */
+export interface PostAiSummaryPageBody {
+    id: number;
+}
+export interface PostAiSummaryPageResponse {
+    summary: string;
+    keywords: string[];
+}

package/dist/ai/summary.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Public types for `POST /ai/summary/page`.
+ *
+ * Generates an AI-powered summary (and keywords) for a page's content.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/analytics/dimensions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Public types for analytics dimensions (`/metrics/dimensions`).
+ */
+export interface AnalyticsDimensionBody {
+    id?: number | null;
+    name: string;
+    values: string | null;
+}
+export type PostAnalyticsDimensionBody = AnalyticsDimensionBody;
+export type PutAnalyticsDimensionBody = Required<Pick<AnalyticsDimensionBody, "id" | "name">> & Pick<AnalyticsDimensionBody, "values">;
+export interface PostAnalyticsDimensionsBulkBody {
+    dimensions: AnalyticsDimensionBody[];
+}

package/dist/analytics/dimensions.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Public types for analytics dimensions (`/metrics/dimensions`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/analytics/groups.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Public types for analytics groups (`/metrics/groups`).
+ */
+export interface AnalyticsGroupBody {
+    id?: number | null;
+    name: string;
+    dimensions: string | null;
+    templates: string | null;
+}
+export type PostAnalyticsGroupBody = Pick<AnalyticsGroupBody, "name"> & Pick<Partial<AnalyticsGroupBody>, "dimensions" | "templates">;
+export type PutAnalyticsGroupBody = PostAnalyticsGroupBody;
+export interface PostAnalyticsGroupsBulkBody {
+    groups: AnalyticsGroupBody[];
+}
+export interface AnalyticsGroupBulkError {
+    group: AnalyticsGroupBody;
+    error: string;
+}
+/** Empty array means every group in the request was saved successfully. */
+export type PostAnalyticsGroupsBulkResponse = AnalyticsGroupBulkError[];

package/dist/analytics/groups.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Public types for analytics groups (`/metrics/groups`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/analytics/index.d.ts

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

package/dist/analytics/index.js

@@ -0,0 +1,19 @@
+"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("./script"), exports);
+__exportStar(require("./groups"), exports);
+__exportStar(require("./dimensions"), exports);

package/dist/analytics/script.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Public types for the site analytics script (`/site/:site/metrics/code`, `/site/:site/metrics`).
+ */
+export interface AnalyticsScriptResponse {
+    siteId?: number;
+    script_code: string | null;
+}
+/** Fallback shape returned by `GET /site/:site/metrics/code` when no script exists yet. */
+export interface EmptyAnalyticsScriptResponse {
+    script: "";
+}
+export type GetSiteAnalyticsScriptResponse = AnalyticsScriptResponse | EmptyAnalyticsScriptResponse;
+export interface PostSiteAnalyticsScriptBody {
+    scriptCode: string;
+}
+/** `POST`/`PUT /site/:site/metrics/code` echo back the submitted script code. */
+export type PostSiteAnalyticsScriptResponse = string;
+export interface AnalyticsDimensionSummary {
+    id: number;
+    name: string;
+    values: string;
+}
+export interface AnalyticsGroupSummary {
+    id: number;
+    name: string;
+    dimensions: string;
+    templates: string;
+}
+export interface GetSiteAnalyticsResponse {
+    scriptCode: string;
+    siteScriptCodeExists: boolean;
+    dimensions: AnalyticsDimensionSummary[];
+    groups: AnalyticsGroupSummary[];
+}

package/dist/analytics/script.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Public types for the site analytics script (`/site/:site/metrics/code`, `/site/:site/metrics`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/apiTokens/api_token.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Public types for the API token endpoints:
+ * - `POST /api-tokens`, `POST /users/:id/api-tokens`,
+ *   `POST /service-accounts/:id/api-tokens` (creation, all three share the
+ *   same request and response shape)
+ * - `GET /api-tokens`, `GET /users/:id/api-tokens` (listing)
+ * - `DELETE /api-tokens/:id`, `DELETE /users/:id/api-tokens/:tokenId`
+ *   (revocation; the controllers respond with an inline literal, not a
+ *   named DTO)
+ */
+export interface CreateApiTokenRequest {
+    name: string;
+    expiresAt?: string | null;
+}
+export interface ApiTokenResponseDTO {
+    id: number;
+    tokenPrefix: string;
+    name: string;
+    ownerId: number;
+    createdBy: number;
+    createdAt: string;
+    expiresAt: string | null;
+    lastUsedAt: string | null;
+    revokedAt: string | null;
+    revokeReason: string | null;
+    auditEnabled: boolean;
+}
+export interface ApiTokenWithPlainTokenResponseDTO extends ApiTokenResponseDTO {
+    token: string;
+}
+export interface RevokeApiTokenResponse {
+    revoked: true;
+}

package/dist/apiTokens/api_token.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Public types for the API token endpoints:
+ * - `POST /api-tokens`, `POST /users/:id/api-tokens`,
+ *   `POST /service-accounts/:id/api-tokens` (creation, all three share the
+ *   same request and response shape)
+ * - `GET /api-tokens`, `GET /users/:id/api-tokens` (listing)
+ * - `DELETE /api-tokens/:id`, `DELETE /users/:id/api-tokens/:tokenId`
+ *   (revocation; the controllers respond with an inline literal, not a
+ *   named DTO)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/apiTokens/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api_token";
+export * from "./service_account";

package/dist/apiTokens/index.js

@@ -0,0 +1,18 @@
+"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("./api_token"), exports);
+__exportStar(require("./service_account"), exports);

package/dist/apiTokens/service_account.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Public types for the service account endpoints:
+ * - `POST /service-accounts` (creation)
+ * - `GET /service-accounts` (listing)
+ * - `DELETE /service-accounts/:id` (deletion; the controller responds with
+ *   an inline literal, not a named DTO)
+ *
+ * Note: `GET /service-accounts/:id/api-tokens` does not exist as a route —
+ * only `POST /service-accounts/:id/api-tokens` (see `api_token.ts`).
+ */
+export type ServiceAccountSiteScope = number | "all" | "global";
+export interface ServiceAccountRoleAssignment {
+    siteId: ServiceAccountSiteScope;
+    roleIds: number[];
+}
+export interface CreateServiceAccountRequest {
+    name: string;
+    description?: string | null;
+    roleAssignments: ServiceAccountRoleAssignment[];
+}
+export interface ServiceAccountResponseDTO {
+    id: number;
+    name: string;
+    username: string;
+    description: string | null;
+    dateCreated: string | null;
+    enabled: number;
+    memberType: string;
+}
+export interface DeleteServiceAccountResponse {
+    deleted: true;
+}

package/dist/apiTokens/service_account.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Public types for the service account endpoints:
+ * - `POST /service-accounts` (creation)
+ * - `GET /service-accounts` (listing)
+ * - `DELETE /service-accounts/:id` (deletion; the controller responds with
+ *   an inline literal, not a named DTO)
+ *
+ * Note: `GET /service-accounts/:id/api-tokens` does not exist as a route —
+ * only `POST /service-accounts/:id/api-tokens` (see `api_token.ts`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/common/index.d.ts

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

package/dist/common/index.js

@@ -16,3 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./pagination"), exports);
 __exportStar(require("./export"), exports);
+__exportStar(require("./uuid"), exports);
+__exportStar(require("./success"), exports);

package/dist/common/success.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generic "no payload" success envelope. Several write endpoints across the
+ * API respond with just this literal when the operation succeeds and there
+ * is no natural resource to echo back (`HttpResponseHandler.ok` defaults to
+ * this shape when called without a `data` argument).
+ */
+export interface SuccessResponse {
+    code: 200;
+    message: "ok";
+}

package/dist/common/success.js

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

package/dist/common/uuid.d.ts

@@ -0,0 +1 @@
+export type UUID = string;

package/dist/common/uuid.js

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

package/dist/dataPack/index.d.ts

@@ -1 +1,2 @@
 export * from "./config";
+export * from "./types";

package/dist/dataPack/index.js

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

package/dist/dataPack/types.d.ts

@@ -0,0 +1,15 @@
+export type DataPackStatus = "activated" | "deactivated" | "all";
+export interface DataPackCategory {
+    id: string;
+    name: string;
+}
+export interface DataPackSiteActivation {
+    dataPackId: string;
+    config: string | null;
+}
+export interface DataPackDateRecord {
+    id: string;
+    created: string | null;
+    modified: string | null;
+    content: string | null;
+}

package/dist/dataPack/types.js

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

package/dist/domains/domains.d.ts

@@ -0,0 +1,33 @@
+export type DomainStatus = "pending" | "ready" | "error";
+interface BaseDomainDTO {
+    id?: number | null;
+    name?: string | null;
+    slug?: string | null;
+    url?: string | null;
+    assetsDomain?: string | null;
+    status?: DomainStatus | null;
+    errorMessage?: string | null;
+    enabled?: boolean | null;
+    createdAt?: Date | null;
+    updatedAt?: Date | null;
+    deletedAt?: Date | null;
+}
+export type DomainDTO = BaseDomainDTO;
+export type DomainPostParamsDTO = {
+    url: string;
+    slug?: string | null;
+};
+export type DomainPutParamsDTO = Pick<BaseDomainDTO, "slug" | "assetsDomain" | "url">;
+export interface DomainListItemDTO extends DomainDTO {
+    dryRun: boolean;
+}
+export type DomainPostResponseDTO = DomainDTO;
+export type DomainGetResponseDTO = DomainDTO;
+export type DomainListResponseDTO = DomainListItemDTO[];
+export type DomainDeleteResponseDTO = DomainDTO;
+export interface DomainSelectOptionDTO {
+    value: number;
+    label: string;
+}
+export type DomainSelectResponseDTO = DomainSelectOptionDTO[];
+export {};

package/dist/domains/domains.js

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

package/dist/domains/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Public types for the `/domains` endpoint family.
+ *
+ * `DomainDTO`, `DomainListItemDTO` and the rest of the K8s-aware contract
+ * (status/enabled lifecycle, robots.txt DTOs) live in `./domains` and
+ * `./robots`. That is the shape produced by the `Domain` (singular)
+ * hexagonal slice, which is the functionally-dominant implementation
+ * (CRD reconciliation, soft-delete, `spec.enabled`).
+ *
+ * The types below are additive and specific to the `Domains` (plural)
+ * hexagonal slice, which does not (yet) consume `packages/api-types` for
+ * its own request/response shapes. They are kept here so nothing from
+ * that slice is lost; see the merge report for the Domain/Domains
+ * duplication follow-up.
+ */
+export * from "./domains";
+export * from "./robots";
+export interface DomainSelectOption {
+    value: number;
+    label: string | null;
+}
+export interface DomainRobotsPayload {
+    id: number;
+    path: string | null;
+    fullUrl: string | null;
+    content: string | null;
+    computedContent: string;
+}
+export interface PostDomainPayload {
+    url: string;
+    slug?: string | null;
+    assetsDomain?: string | null;
+}
+export interface PostRobotsPayload {
+    content: string;
+}
+export interface PostRobotsBulkPayload {
+    robots: Array<{
+        id: number;
+        content: string;
+    }>;
+}

package/dist/domains/index.js

@@ -0,0 +1,33 @@
+"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 });
+/**
+ * Public types for the `/domains` endpoint family.
+ *
+ * `DomainDTO`, `DomainListItemDTO` and the rest of the K8s-aware contract
+ * (status/enabled lifecycle, robots.txt DTOs) live in `./domains` and
+ * `./robots`. That is the shape produced by the `Domain` (singular)
+ * hexagonal slice, which is the functionally-dominant implementation
+ * (CRD reconciliation, soft-delete, `spec.enabled`).
+ *
+ * The types below are additive and specific to the `Domains` (plural)
+ * hexagonal slice, which does not (yet) consume `packages/api-types` for
+ * its own request/response shapes. They are kept here so nothing from
+ * that slice is lost; see the merge report for the Domain/Domains
+ * duplication follow-up.
+ */
+__exportStar(require("./domains"), exports);
+__exportStar(require("./robots"), exports);

package/dist/domains/robots.d.ts

@@ -0,0 +1,24 @@
+export interface RobotsDTO {
+    id: number;
+    path: string | null;
+    fullUrl: string | null;
+    /** Raw `robots` field stored in the `domains` row. */
+    content: string | null;
+    /**
+     * Dynamic robots.txt computed by composing `content` with per-site rules
+     * (Disallow for `hidden=1` sites, Sitemap for `showSitemapInRobots=1`).
+     * Built in `GetRobotsUsesCase` via `buildDynamicRobotsContent`.
+     */
+    computedContent: string;
+}
+export type RobotsListResponseDTO = RobotsDTO[];
+export type RobotsPutParamsDTO = {
+    content: string | null;
+};
+export interface RobotsBulkItemDTO {
+    id: number;
+    content: string | null;
+}
+export type RobotsBulkPutParamsDTO = {
+    robots: RobotsBulkItemDTO[];
+};

package/dist/domains/robots.js

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