@griddo/api-types 1.1.2 → 1.3.0

package/dist/translations/index.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Public types for the `/translations` endpoint family.
+ */
+export interface GlossaryRecord {
+    sourceLanguage: string;
+    targetLanguage: string;
+    content: string;
+    deepLGlossaryId: string;
+}
+export type ListGlossariesResponse = GlossaryRecord[];
+export interface AddGlossaryRequest {
+    sourceLanguage: string;
+    targetLanguage: string;
+    content: string;
+}
+/**
+ * Minimal content-metadata fields the translation logic reads/writes on
+ * pages and forms. `metaKeywords` is the only one of these stored as an
+ * array in practice; the rest are plain strings (or absent).
+ */
+export interface TranslatableContentMetadata {
+    title?: string | null;
+    metaTitle?: string | null;
+    metaDescription?: string | null;
+    metaKeywords?: string | string[] | null;
+}
+/**
+ * A page/form's `template` tree (its module structure). The concrete shape
+ * is entirely schema/component-driven (see `componentsTextFields` /
+ * `templatesTextFields` in `ScanSchemasService`), so beyond `templateType`
+ * it is intentionally left as `unknown` — the translation logic walks it
+ * generically without assuming a fixed structure.
+ */
+export interface TranslatableTemplate {
+    templateType: string;
+    [key: string]: unknown;
+}
+/**
+ * `POST /translations/page/:targetLanguage` — translates a page's text
+ * fields (title/meta/slug/module content) from `originalLanguage` (read off
+ * the body) to the `targetLanguage` route param. The endpoint accepts a full
+ * page object; only the fields the translation logic actually touches are
+ * typed here (see `TranslatePageUseCase.execute`).
+ */
+export interface PostTranslatePageBody extends TranslatableContentMetadata {
+    slug?: string;
+    template: TranslatableTemplate;
+    originalLanguage?: string | number;
+    [key: string]: unknown;
+}
+export interface PostTranslatePageResponse extends TranslatableContentMetadata {
+    slug?: string;
+    template: TranslatableTemplate;
+    /** Set by the use case to the resolved target language. */
+    language: {
+        id: string | number;
+        locale?: string;
+    };
+    [key: string]: unknown;
+}
+/**
+ * `POST /translations/structured_data_content/:targetLanguage` — translates
+ * a structured-data entry's text fields. `content`'s concrete shape is
+ * schema-driven per `structuredDataType` (see
+ * `scanStructuredDataForText`/`scanStructuredContentForText` in
+ * `ScanSchemasService.ts`, which walk it generically without a fixed
+ * structure), so it is kept as `Record<string, unknown>` — see
+ * `TranslateStructuredDataUseCase.execute`.
+ */
+export interface PostTranslateStructuredDataBody {
+    structuredData: string;
+    content: Record<string, unknown>;
+    originalLanguage?: string | number;
+    [key: string]: unknown;
+}
+export interface PostTranslateStructuredDataResponse {
+    structuredData: string;
+    content: Record<string, unknown>;
+    /** Set by the use case to the resolved target language. */
+    language: string | number;
+    [key: string]: unknown;
+}
+/**
+ * `POST /translations/form/:targetLanguage` — translates a form's text
+ * fields (title/meta/field labels), same field-level criteria as
+ * `PostTranslatePageBody` (see `TranslateFormUseCase.execute`).
+ */
+export interface PostTranslateFormBody extends TranslatableContentMetadata {
+    template: TranslatableTemplate;
+    originalLanguage?: string | number;
+    [key: string]: unknown;
+}
+export interface PostTranslateFormResponse extends TranslatableContentMetadata {
+    template: TranslatableTemplate;
+    /** Set by the use case to the resolved target language. */
+    language: string | number;
+    [key: string]: unknown;
+}
+/**
+ * `POST /translations/page/:pageId/retranslate` — no request body (params
+ * only). PLACEHOLDER, requires revision: the use case persists through the
+ * legacy `postPage` bridge (`models/pages/index.ts`), which ultimately
+ * returns the full formatted page (`getPage`, the same shape as
+ * `GET /pages/:id`) — a response not yet typed anywhere in this package.
+ * Tracing that shape precisely was out of scope for the translations
+ * domain; revisit once the Pages domain's read response gets a public type.
+ */
+export type PostRetranslatePageResponse = Record<string, unknown>;

package/dist/translations/index.js

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

package/dist/user/index.d.ts

@@ -0,0 +1,74 @@
+export * from "./page_permissions";
+export * from "./single_login";
+export * from "./sso_login";
+export interface UserSiteRoleEntryInput {
+    siteId: number | "global" | "all" | string;
+    roles: number[];
+}
+export interface UsersApiFormattedUser {
+    id: number;
+    username: string;
+    name: string;
+    email: string;
+    isSuperAdmin: boolean;
+    image: unknown | null;
+    company: string | null;
+    description: string | null;
+    dateCreated: string | null;
+    failed: number | null;
+    timezone: string | null;
+    enabled: boolean;
+    status: "active" | "invited";
+    roles: Array<{
+        siteId: number | "all" | "global";
+        roles: number[];
+    }>;
+    sites: "all" | Array<string | number>;
+    position: string | null;
+    profileCreated: boolean;
+}
+export interface UsersApiCreateUserInput {
+    name: string;
+    email: string;
+    password?: string;
+    fullCreate?: boolean;
+    bot?: boolean;
+    roles?: UserSiteRoleEntryInput[];
+    isSuperAdmin?: boolean;
+}
+export interface UsersApiUpdateUserInput {
+    name: string;
+    username: string;
+    image?: number | string | null;
+    email?: string | null;
+    company?: string;
+    description?: string;
+    timezone?: string;
+    roles?: UserSiteRoleEntryInput[];
+    isSuperAdmin?: boolean;
+    position?: string | null;
+    profileCreated?: boolean;
+    bot?: boolean;
+}
+export interface UsersApiPasswordChangeInput {
+    currentPassword: string;
+    password: string;
+    retypedPassword: string;
+}
+export interface UsersApiInitialPasswordInput {
+    token: string;
+    password: string;
+    retypedPassword: string;
+}
+export interface UsersApiNewPasswordInput {
+    token: string;
+    password: string;
+    retypedPassword: string;
+}
+export interface UsersApiSiteRestrictInput {
+    users: Array<number | string>;
+}
+export interface UsersApiHardDeleteBulkInput {
+    developerKey: string;
+    users: Array<number | string>;
+}

package/dist/user/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("./page_permissions"), exports);
+__exportStar(require("./single_login"), exports);
+__exportStar(require("./sso_login"), exports);

package/dist/user/page_permissions.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Entrada del array `pagePermissions` que viaja tanto:
+ *  - En el body de POST /user y PUT /user/:id (asignación de páginas restringidas).
+ *  - En la response de GET /user/:id y GET /users (qué páginas tiene asignadas).
+ *
+ * Cada entrada agrupa pages por site. siteId puede ser "global" o número.
+ */
+export interface UserPagePermissionEntry {
+    siteId: "global" | number;
+    pageIds: number[];
+}
+/**
+ * Entrada del array `roles` en el body de POST /user y PUT /user/:id.
+ * El user puede tener varios roles por site; todos aplican a las pages
+ * indicadas en `pagePermissions` para ese site (producto cartesiano).
+ *
+ * `"all"` representa permisos cross-site.
+ */
+export interface UserRoleAssignment {
+    siteId: "global" | "all" | number;
+    roles: number[];
+}

package/dist/user/page_permissions.js

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

package/dist/user/single_login.d.ts

@@ -0,0 +1,17 @@
+import type { UUID } from "src";
+export type LoginRequest = Readonly<{
+    email: string;
+    password: string;
+    username?: string;
+    petitionId?: UUID | null;
+}>;
+export type LoginParams = Readonly<{
+    email: string;
+    password: string;
+    jwtKey: string;
+}>;
+export type LoginResponse = Readonly<{
+    message: string;
+    token: string;
+    id: number;
+}>;

package/dist/user/single_login.js

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

package/dist/user/sso_login.d.ts

@@ -0,0 +1,12 @@
+import type { UUID } from "src";
+export interface SSOClientParamsDTO {
+    clientId: string;
+    clientSecret: string;
+    issuerUrl: string;
+    redirectUris: string[];
+}
+export interface SSOLoginParams {
+    ssoClientParamsDTO: SSOClientParamsDTO;
+    jwtKey: string;
+    petitionId?: UUID | null;
+}

package/dist/user/sso_login.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@griddo/api-types",
-	"version": "1.1.2",
+	"version": "1.3.0",
 	"description": "Tipos públicos de la API de Griddo",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -17,6 +17,8 @@
 	},
 	"license": "MIT",
 	"devDependencies": {
-		"@types/minimatch": "^6.0.0"
+		"@types/minimatch": "^6.0.0",
+		"@types/node": "^22.13.13",
+		"typescript": "^5.7.2"
 	}
 }