@griddo/api-types 1.0.31 → 1.1.1

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

@@ -0,0 +1,5 @@
+export interface ContentPresence {
+    presenceType: 'page-specific' | 'page-custom' | 'page-manual' | 'all';
+    relatedPages: Array<number> | null;
+}
+export type ContentBodyPosition = 'start' | 'end';

package/dist/add-ons/index.js

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

package/dist/dataPack/config.d.ts

@@ -0,0 +1,29 @@
+import type { PageIntegration } from 'src/pages';
+export type Integration = Pick<PageIntegration, 'name' | 'description' | 'site' | 'contentHead' | 'contentBody' | 'contentBodyPosition' | 'contentPresence' | 'active' | 'type'>;
+export interface DataPackSiteConfigDataDTO {
+    defaultParent?: null | number;
+    modifiableOnPage?: boolean;
+    indexDefault?: boolean;
+    defaultTemplate?: null;
+    defaultHeader?: null | number;
+    defaultFooter?: null | number;
+    import?: Record<string, unknown>[];
+    templates?: {
+        [templateName: string]: {
+            integrations: Integration[];
+        };
+    };
+}
+export interface DataPackSiteDTO {
+    id?: number | null;
+    siteId: number;
+    dataPackId: string;
+    config?: DataPackSiteConfigDataDTO | null;
+    deleted: boolean | 1 | 0;
+}
+export type DataPackSiteUpdateParamsDTO = Omit<DataPackSiteDTO, 'deleted' | 'id'>;
+export interface DataPackConfigConfigParams {
+    id: string;
+    site: string;
+}
+export type DataPackConfigRequest = DataPackSiteConfigDataDTO;

package/dist/dataPack/config.js

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

package/dist/dataPack/index.d.ts

@@ -0,0 +1 @@
+export * from './config';

package/dist/dataPack/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("./config"), exports);

package/dist/index.d.ts

@@ -1,2 +1,8 @@
 export * from './common';
 export * from './logs';
+export * from './schemas';
+export * from './dataPack';
+export * from './site';
+export * from './redirects';
+export * from './add-ons';
+export * from './pages';

package/dist/index.js

@@ -16,3 +16,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./common"), exports);
 __exportStar(require("./logs"), exports);
+__exportStar(require("./schemas"), exports);
+__exportStar(require("./dataPack"), exports);
+__exportStar(require("./site"), exports);
+__exportStar(require("./redirects"), exports);
+__exportStar(require("./add-ons"), exports);
+__exportStar(require("./pages"), exports);

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

@@ -0,0 +1,14 @@
+import type { ContentBodyPosition, ContentPresence } from 'src/add-ons';
+export type PageIntegrationType = 'addon' | 'analytics' | 'datalayer';
+export interface PageIntegration {
+    id: number;
+    name: string;
+    description: string;
+    site: number;
+    contentHead: string | null;
+    contentBody: string | null;
+    contentBodyPosition: ContentBodyPosition;
+    contentPresence: ContentPresence;
+    active: boolean;
+    type: PageIntegrationType;
+}

package/dist/pages/add-ons.js

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

package/dist/pages/clear_corrupted_pages.d.ts

@@ -0,0 +1,7 @@
+export interface CleanCorruptedPagesResponse {
+    deletedPages: number;
+    deletedStructuredData: number;
+    liveStatusStructuredDataUpdate: number;
+    unpublishedStructuredDataUpdate: number;
+    orphanStructureDataDelete: number;
+}

package/dist/pages/clear_corrupted_pages.js

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

package/dist/pages/index.d.ts

@@ -0,0 +1 @@
+export * from './add-ons';

package/dist/pages/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("./add-ons"), exports);

package/dist/redirects/index.d.ts

@@ -0,0 +1,7 @@
+export interface RedirectDTO {
+    pageId: number;
+    siteId: number;
+    languageId: number;
+    slug: string;
+    parentSlug: string | null;
+}

package/dist/redirects/index.js

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

package/dist/schemas/index.d.ts

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

package/dist/schemas/index.js

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

package/dist/schemas/schemas.d.ts

@@ -0,0 +1,209 @@
+export interface SchemaConfig {
+    menus: SchemaMenu[];
+    themes: SchemaTheme[];
+    subthemes: string[];
+    languages: Record<string, SchemaLanguage>;
+    menuItems: SchemaMenuItems;
+    moduleCategories: SchemaCategory[];
+    richTextConfig: SchemaRichTextConfig;
+}
+export interface SchemaMenu {
+    key: string;
+    display: string;
+}
+export interface SchemaTheme {
+    default?: boolean;
+    label: string;
+    value: string;
+    elements?: {
+        include: {
+            datapacks: string[];
+            modules: string[];
+        };
+    };
+}
+export interface SchemaLanguage {
+    name: string;
+    label: string;
+}
+export interface SchemaMenuItems {
+    link: SchemaMenuItemConfig;
+    group: SchemaMenuItemConfig;
+}
+export interface SchemaMenuItemConfig {
+    fields: SchemaField[];
+}
+export interface SchemaCategory {
+    label: string;
+    value: string;
+    featured?: boolean;
+}
+export interface SchemaRichTextConfig {
+    paragraphStyles: SchemaStyleConfig[];
+    tableStyles: SchemaStyleConfig[];
+    tableCellStyles: SchemaStyleConfig[];
+    editorLangs: SchemaEditorLang[];
+}
+export interface SchemaStyleConfig {
+    label: string;
+    className: string;
+}
+export interface SchemaEditorLang {
+    name: string;
+    iso: string;
+    featured?: boolean;
+}
+export interface SchemaField {
+    title?: string;
+    type: string;
+    key: string;
+    placeholder?: string;
+    options?: SchemaOption[];
+    auxText?: string;
+    helptext?: string;
+    background?: boolean;
+    default?: SchemaHeadingDefault;
+    advanced?: boolean;
+    hideable?: boolean;
+    isMockup?: boolean;
+    mandatory?: boolean;
+    humanReadable?: boolean;
+    full?: boolean;
+    whiteList?: string[];
+    contentType?: string;
+    maxItems?: number;
+    prefix?: string;
+    columns?: number;
+    filled?: boolean;
+    categories?: string[];
+    fields?: SchemaField[];
+    overwrite?: boolean;
+}
+export interface SchemaOption {
+    value: string;
+    label?: string;
+    name?: string;
+    title?: string;
+    img?: string;
+    theme?: string;
+    options?: SchemaOption[];
+}
+export interface SchemaHeadingDefault {
+    content: string;
+    tag: string;
+}
+export interface SchemaComponent {
+    schemaType: string;
+    component: string;
+    displayName: string;
+    configTabs?: SchemaConfigTab[];
+    default: SchemaComponentDefault;
+    thumbnails: SchemaThumbnails;
+    category?: string;
+}
+export interface SchemaConfigTab {
+    title: string;
+    fields: SchemaField[];
+}
+export interface SchemaComponentDefault {
+    component: string;
+    [key: string]: any;
+}
+export interface SchemaThumbnails {
+    '1x': string;
+    '2x': string;
+}
+export interface SchemaModule extends SchemaComponent {
+    category: string;
+}
+export interface SchemaTemplate {
+    schemaType: string;
+    displayName: string;
+    component: string;
+    type: SchemaTemplateType;
+    dimensions: any[];
+    content: SchemaField[];
+    default: SchemaTemplateDefault;
+    thumbnails: SchemaThumbnails;
+}
+export interface SchemaTemplateType {
+    label: string;
+    value: string;
+}
+export interface SchemaTemplateDefault {
+    type: string;
+    templateType: string;
+    [key: string]: any;
+}
+export interface SchemaUI {
+    components: Record<string, SchemaComponent>;
+    modules: Record<string, SchemaModule>;
+    templates: Record<string, SchemaTemplate>;
+}
+export interface SchemaContentTypes {
+    dataPacks: Record<string, SchemaDataPack>;
+    dataPacksCategories: Record<string, SchemaDataPackCategory>;
+    structuredData: Record<string, SchemaStructuredData>;
+}
+export interface SchemaDataPack {
+    title: string;
+    category: string;
+    description: string;
+    image: string;
+}
+export interface SchemaDataPackCategory {
+    title: string;
+}
+export interface SchemaStructuredData {
+    dataPacks: string[];
+    title: string;
+    local: boolean;
+    translate: boolean;
+    taxonomy: boolean;
+    fromPage: boolean;
+}
+export interface SchemaForms {
+    templates: Record<string, SchemaFormTemplate>;
+    fields: Record<string, SchemaFormField>;
+    categories: SchemaCategory[];
+    templateCategories: SchemaCategory[];
+}
+export interface SchemaFormTemplate {
+    schemaType: string;
+    displayName: string;
+    component: string;
+    category?: string;
+    content: SchemaField[];
+    config: SchemaField[];
+    default: SchemaFormTemplateDefault;
+    thumbnails: SchemaThumbnails;
+}
+export interface SchemaFormTemplateDefault {
+    type: string;
+    templateType: string;
+    [key: string]: any;
+}
+export interface SchemaFormField {
+    schemaType: string;
+    component: string;
+    displayName: string;
+    configTabs: SchemaConfigTab[];
+    default: SchemaComponentDefault;
+}
+export interface SchemaLanguageDefinition {
+    id: number;
+    locale: string;
+    language: string;
+    label: string;
+    isDefault: boolean;
+}
+export interface SchemaRootConfig {
+    config: SchemaConfig;
+    ui: SchemaUI;
+    contentTypes: SchemaContentTypes;
+    forms: SchemaForms;
+    languagesDefinition: Record<string, SchemaLanguage>;
+    version: string;
+    languages: SchemaLanguageDefinition[];
+    defaultLanguage: SchemaLanguageDefinition;
+}

package/dist/schemas/schemas.js

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

package/dist/schemas/template.d.ts

@@ -0,0 +1,23 @@
+declare enum TemplateTypeKeyEnum {
+    LABEL = "label",
+    VALUE = "value",
+    MODE = "mode",
+    SPECIAL = "special"
+}
+declare enum TemplateModeTypeEnum {
+    DETAIL = "detail",
+    LIST = "list",
+    PAGINATED_DATA = "paginated-data",
+    VIRTUAL_LIST = "virtual-list"
+}
+declare enum TemplateBasicTypeEnum {
+    STATIC = "static",
+    LIST = "list",
+    PAGINATED_DATA = "paginated-data",
+    VIRTUAL_LIST = "virtual-list"
+}
+declare enum TemplateSpecialTypeEnum {
+    NOT_FOUND = "404",
+    SITEMAP = "sitemap"
+}
+export { TemplateTypeKeyEnum, TemplateModeTypeEnum, TemplateBasicTypeEnum, TemplateSpecialTypeEnum, };

package/dist/schemas/template.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateSpecialTypeEnum = exports.TemplateBasicTypeEnum = exports.TemplateModeTypeEnum = exports.TemplateTypeKeyEnum = void 0;
+var TemplateTypeKeyEnum;
+(function (TemplateTypeKeyEnum) {
+    TemplateTypeKeyEnum["LABEL"] = "label";
+    TemplateTypeKeyEnum["VALUE"] = "value";
+    TemplateTypeKeyEnum["MODE"] = "mode";
+    TemplateTypeKeyEnum["SPECIAL"] = "special";
+})(TemplateTypeKeyEnum || (exports.TemplateTypeKeyEnum = TemplateTypeKeyEnum = {}));
+var TemplateModeTypeEnum;
+(function (TemplateModeTypeEnum) {
+    TemplateModeTypeEnum["DETAIL"] = "detail";
+    TemplateModeTypeEnum["LIST"] = "list";
+    TemplateModeTypeEnum["PAGINATED_DATA"] = "paginated-data";
+    TemplateModeTypeEnum["VIRTUAL_LIST"] = "virtual-list";
+})(TemplateModeTypeEnum || (exports.TemplateModeTypeEnum = TemplateModeTypeEnum = {}));
+var TemplateBasicTypeEnum;
+(function (TemplateBasicTypeEnum) {
+    TemplateBasicTypeEnum["STATIC"] = "static";
+    TemplateBasicTypeEnum["LIST"] = "list";
+    TemplateBasicTypeEnum["PAGINATED_DATA"] = "paginated-data";
+    TemplateBasicTypeEnum["VIRTUAL_LIST"] = "virtual-list";
+})(TemplateBasicTypeEnum || (exports.TemplateBasicTypeEnum = TemplateBasicTypeEnum = {}));
+var TemplateSpecialTypeEnum;
+(function (TemplateSpecialTypeEnum) {
+    TemplateSpecialTypeEnum["NOT_FOUND"] = "404";
+    TemplateSpecialTypeEnum["SITEMAP"] = "sitemap";
+})(TemplateSpecialTypeEnum || (exports.TemplateSpecialTypeEnum = TemplateSpecialTypeEnum = {}));

package/dist/site/index.d.ts

@@ -0,0 +1 @@
+export * from './languages';

package/dist/site/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("./languages"), exports);

package/dist/site/languages.d.ts

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

package/dist/site/languages.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.0.31",
+    "version": "1.1.1",
     "description": "Tipos públicos de la API de Griddo",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",