@griddo/api-types 1.1.1 → 1.1.3

package/dist/logs/activity.d.ts

@@ -1,5 +1,5 @@
-import type { PaginationRequest } from 'src/common';
-import type { ExportFormat } from 'src/common/export';
+import type { PaginationRequest } from "src/common";
+import type { ExportFormat } from "src/common/export";
 export declare const LogActivityEventEnum: Record<string, string>;
 export declare enum ContentType {
     TEMPLATE = "template",// page
@@ -32,8 +32,8 @@ export interface LogActivityRelation {
     internal_key?: string | null;
 }
 export type LogActivityUserDTO = LogActivityRelation & {
-    ip?: BaseLogActivityDTO['ip'];
-    country?: BaseLogActivityDTO['country'];
+    ip?: BaseLogActivityDTO["ip"];
+    country?: BaseLogActivityDTO["country"];
     action?: LogActivityEventEnumInterface;
     company?: string | null;
     image?: string | null;
@@ -46,7 +46,7 @@ export interface LogActivityFilterDTO {
         from?: Date;
         until?: Date;
     } | undefined;
-    sites?: (number | 'global')[];
+    sites?: (number | "global")[];
     contentTypes?: string[];
     eventTypes?: number[];
     users?: number[];
@@ -66,22 +66,22 @@ export interface BaseLogActivityDTO {
     contentTypeLanguageId?: number | null;
 }
 export type LogContentTypeDTO = {
-    id: BaseLogActivityDTO['contentTypeId'];
-    title: BaseLogActivityDTO['contentTypeTitle'];
+    id: BaseLogActivityDTO["contentTypeId"];
+    title: BaseLogActivityDTO["contentTypeTitle"];
     content: {
         id: string;
         title: string;
     };
-    type: BaseLogActivityDTO['contentType'];
-    languageId: BaseLogActivityDTO['contentTypeLanguageId'];
+    type: BaseLogActivityDTO["contentType"];
+    languageId: BaseLogActivityDTO["contentTypeLanguageId"];
 };
 export type LogContentDTO = {
-    id: BaseLogActivityDTO['contentTypeId'];
-    title: BaseLogActivityDTO['contentTypeTitle'];
-    type: BaseLogActivityDTO['contentTypePublic'];
-    language: BaseLogActivityDTO['contentTypeLanguageId'];
+    id: BaseLogActivityDTO["contentTypeId"];
+    title: BaseLogActivityDTO["contentTypeTitle"];
+    type: BaseLogActivityDTO["contentTypePublic"];
+    language: BaseLogActivityDTO["contentTypeLanguageId"];
 };
-export type LogActivityDTO = Omit<BaseLogActivityDTO, 'contentType' | 'contentTypeId' | 'contentTypePublic' | 'contentTypeTitle' | 'userId' | 'siteId' | 'ip' | 'country'> & {
+export type LogActivityDTO = Omit<BaseLogActivityDTO, "contentType" | "contentTypeId" | "contentTypePublic" | "contentTypeTitle" | "userId" | "siteId" | "ip" | "country"> & {
     user: LogActivityUserDTO;
     site: LogActivityRelation | null;
     eventType: LogActivityRelation | null;
@@ -92,11 +92,11 @@ export type LogActivityDTO = Omit<BaseLogActivityDTO, 'contentType' | 'contentTy
     contentType: LogContentTypeDTO | null;
     content: LogContentDTO | null;
 };
-export type LogActivityGroupedUserDTO<TLogActivity = LogActivityDTO[]> = Omit<BaseLogActivityDTO, 'createdAt' | 'contentType' | 'contentTypeId' | 'contentTypePublic' | 'contentTypeTitle' | 'userId' | 'siteId' | 'ip' | 'country' | 'eventTypeId'> & {
+export type LogActivityGroupedUserDTO<TLogActivity = LogActivityDTO[]> = Omit<BaseLogActivityDTO, "createdAt" | "contentType" | "contentTypeId" | "contentTypePublic" | "contentTypeTitle" | "userId" | "siteId" | "ip" | "country" | "eventTypeId"> & {
     date: string;
     user: LogActivityUserGrouped<TLogActivity>[];
 };
-export type LogActivityGroupedDayDTO = Omit<BaseLogActivityDTO, 'createdAt' | 'contentType' | 'contentTypeId' | 'contentTypePublic' | 'contentTypeTitle' | 'userId' | 'siteId' | 'ip' | 'country' | 'eventTypeId'> & {
+export type LogActivityGroupedDayDTO = Omit<BaseLogActivityDTO, "createdAt" | "contentType" | "contentTypeId" | "contentTypePublic" | "contentTypeTitle" | "userId" | "siteId" | "ip" | "country" | "eventTypeId"> & {
     date: string;
     totalItems: number;
     items: LogActivityDTO[];
@@ -110,11 +110,11 @@ export interface LogActivityExportRequest {
     startTime?: string | null;
     maxEvents?: number | null;
 }
-export type LogActivityPaginationRequest = Omit<PaginationRequest, 'filters'> & {
+export type LogActivityPaginationRequest = Omit<PaginationRequest, "filters"> & {
     page?: number;
     itemsPerPage?: number;
     date?: string;
-    sites?: (number | 'global')[];
+    sites?: (number | "global")[];
     contentTypes?: string[];
     eventTypes?: number[];
     users?: number[];

package/dist/logs/index.d.ts

@@ -1 +1 @@
-export * from './activity';
+export * from "./activity";

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

@@ -1,5 +1,5 @@
-import type { ContentBodyPosition, ContentPresence } from 'src/add-ons';
-export type PageIntegrationType = 'addon' | 'analytics' | 'datalayer';
+import type { ContentBodyPosition, ContentPresence } from "src/add-ons";
+export type PageIntegrationType = "addon" | "analytics" | "datalayer";
 export interface PageIntegration {
     id: number;
     name: string;

package/dist/pages/clear_corrupted_pages.d.ts

@@ -1,7 +1,10 @@
 export interface CleanCorruptedPagesResponse {
     deletedPages: number;
     deletedStructuredData: number;
+    duplicatePagesDelete: number;
+    unpublishingSitePages: number;
     liveStatusStructuredDataUpdate: number;
     unpublishedStructuredDataUpdate: number;
     orphanStructureDataDelete: number;
+    globalPagesWithMismatchedLiveStatus: number;
 }

package/dist/pages/index.d.ts

@@ -1 +1,2 @@
-export * from './add-ons';
+export * from "./clear_corrupted_pages";
+export * from "./add-ons";

package/dist/pages/index.js

@@ -14,4 +14,5 @@ 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);

package/dist/queue/index.d.ts

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

package/dist/queue/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/queue/status.d.ts

@@ -0,0 +1,63 @@
+import type { PaginationRequest, PaginationResponse } from "src/common";
+/**
+ * Represents the possible states of a job in the queue.
+ */
+export declare enum JobStatusStateEnum {
+    PENDING = "pending",
+    PROCESSING = "processing",
+    COMPLETED = "completed",
+    FAILED = "failed"
+}
+export type JobStatusState = (typeof JobStatusStateEnum)[keyof typeof JobStatusStateEnum];
+/**
+ * Data Transfer Object (DTO) representing the full status of a job.
+ */
+export interface JobStatusDTO {
+    readonly id: number;
+    readonly dedupId: string;
+    readonly jobName: string;
+    readonly state: JobStatusState;
+    readonly attempts: number;
+    readonly output?: unknown | null;
+    readonly lastError?: string | null;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+}
+/**
+ * DTO for the parameters required to fetch a job by its ID.
+ */
+export type GetJobStatusParamsDTO = Pick<JobStatusDTO, "id">;
+/**
+ * DTO for the response body when fetching a job by its ID.
+ */
+export type GetJobStatusResponseDTO = JobStatusDTO;
+/**
+ * DTO for the parameters required to fetch the latest job by its deduplication ID.
+ */
+export type GetLatestJobStatusParamsDTO = Pick<JobStatusDTO, "dedupId">;
+/**
+ * DTO for the response body when fetching the latest job by its deduplication ID.
+ */
+export type GetLatestJobStatusResponseDTO = JobStatusDTO;
+/**
+ * Defines the filter criteria that can be applied when querying for job statuses.
+ */
+export interface PaginationFilterJobStatusDTO {
+    state?: JobStatusState;
+}
+/**
+ * Represents the parameters for a paginated request for job statuses.
+ * It extends the base `PaginationRequest` with specific filters and excludes the generic `search` field.
+ */
+export type PaginationJobStatusDTO = Omit<PaginationRequest<PaginationFilterJobStatusDTO>, "search"> & {
+    status?: JobStatusState;
+};
+/**
+ * Type alias for the query parameters expected in the paginate endpoint request.
+ */
+export type PaginationJobStatusParamsDTO = PaginationJobStatusDTO;
+/**
+ * Represents the structure of the response for a paginated list of jobs.
+ * It contains an array of job data and pagination metadata.
+ */
+export type PaginationJobStatusResponseDTO = PaginationResponse<JobStatusDTO>;

package/dist/queue/status.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobStatusStateEnum = void 0;
+/**
+ * Represents the possible states of a job in the queue.
+ */
+var JobStatusStateEnum;
+(function (JobStatusStateEnum) {
+    JobStatusStateEnum["PENDING"] = "pending";
+    JobStatusStateEnum["PROCESSING"] = "processing";
+    JobStatusStateEnum["COMPLETED"] = "completed";
+    JobStatusStateEnum["FAILED"] = "failed";
+})(JobStatusStateEnum || (exports.JobStatusStateEnum = JobStatusStateEnum = {}));

package/dist/schemas/index.d.ts

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

package/dist/schemas/schemas.d.ts

@@ -110,8 +110,8 @@ export interface SchemaComponentDefault {
     [key: string]: any;
 }
 export interface SchemaThumbnails {
-    '1x': string;
-    '2x': string;
+    "1x": string;
+    "2x": string;
 }
 export interface SchemaModule extends SchemaComponent {
     category: string;

package/dist/site/index.d.ts

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

package/dist/site/index.js

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

package/dist/site/languages.d.ts

@@ -1,8 +1,8 @@
 export interface LanguageSiteDTO {
     id?: number | null;
     languageId: number;
-    siteId: number;
+    siteId: number | null;
     path?: string | null;
     defaultField?: 0 | 1;
-    domainId: number;
+    domainId: number | null;
 }

package/dist/site/site.d.ts

@@ -0,0 +1,48 @@
+export interface SiteRelation {
+    id?: number | null;
+    name?: string | null;
+}
+interface BaseSiteDTO {
+    name: string;
+    authorId?: number | null;
+    id?: number | null;
+    slug?: string | null;
+    theme?: string | null;
+    thumbnail?: string | null;
+    timezone?: string | null;
+    favicon?: string | null;
+    smallAvatar?: string | null;
+    bigAvatar?: string | null;
+    navigationModules?: string | null;
+    siteMetaDataId?: number | null;
+    published?: Date | null;
+    modified?: Date | null;
+    deleted?: number | null;
+    socials?: string | null;
+    hash?: string | null;
+    rendering?: Date | null;
+    isPublished?: number | null;
+}
+export type SiteDTO = BaseSiteDTO & {
+    authorRelation?: SiteRelation;
+    distributorPagesRelation?: SiteRelation[];
+};
+export type SitePostParamsDTO = Pick<BaseSiteDTO, "name"> & {
+    defaultLanguage: number;
+    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 SitePostResponseDTO = SiteDTO;
+export type SitePutResponseDTO = SiteDTO;
+export type SiteSyncActionsDTO = {
+    republishSitesIds: number[];
+    dispatchRelatedPageUpdates: {
+        id: number;
+        siteId: number;
+        languageId: number;
+        structuredDataId?: string | null;
+    }[];
+};
+export type SiteSyncActionsResponseDTO = SiteSyncActionsDTO;
+export {};

package/dist/site/site.js

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

package/package.json

@@ -1,22 +1,22 @@
 {
-    "name": "@griddo/api-types",
-    "version": "1.1.1",
-    "description": "Tipos públicos de la API de Griddo",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "files": [
-        "dist"
-    ],
-    "publishConfig": {
-        "access": "public"
-    },
-    "scripts": {
-        "build": "tsc -p tsconfig.json",
-        "clean": "rm -rf dist",
-        "prepare": "npm run build"
-    },
-    "license": "MIT",
-    "devDependencies": {
-        "@types/minimatch": "^6.0.0"
-    }
+	"name": "@griddo/api-types",
+	"version": "1.1.3",
+	"description": "Tipos públicos de la API de Griddo",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "tsc -p tsconfig.json",
+		"clean": "rm -rf dist",
+		"prepare": "npm run build"
+	},
+	"license": "MIT",
+	"devDependencies": {
+		"@types/minimatch": "^6.0.0"
+	}
 }