@dotcms/client 0.0.1-beta.24 → 0.0.1-beta.26

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-beta.24",
+  "version": "0.0.1-beta.26",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dotCMS/core.git#main"
   },
+  "devDependencies": {
+    "@dotcms/types": "next"
+  },
   "scripts": {
     "build": "nx run sdk-client:build:js; cd ../../../../dotCMS/src/main/webapp/html/js/editor-js; rm -rf src package.json *.esm.d.ts"
   },
@@ -29,12 +32,6 @@
       "types": "./next.esm.d.ts",
       "import": "./next.cjs.mjs",
       "default": "./next.cjs.js"
-    },
-    "./types": {
-      "module": "./types.esm.js",
-      "types": "./types.esm.d.ts",
-      "import": "./types.cjs.mjs",
-      "default": "./types.cjs.js"
     }
   },
   "typesVersions": {
@@ -44,9 +41,6 @@
       ],
       "next": [
         "./src/next.d.ts"
-      ],
-      "types": [
-        "./src/types.d.ts"
       ]
     }
   },

package/src/lib/client/page/page-api.d.ts

@@ -1,5 +1,5 @@
+import { DotCMSPageAsset, DotCMSGraphQLPageResponse } from '@dotcms/types';
 import { DotCMSClientConfig, RequestOptions } from '../client';
-import { DotCMSGraphQLPageResponse, DotCMSPageAsset } from '../models/types';
 /**
  * The parameters for the Page API.
  * @public
@@ -166,7 +166,7 @@ export declare class PageClient {
      *      });
      *```
      */
-    get(url: string, options?: PageRequestParams): Promise<DotCMSPageAsset>;
-    get(url: string, options?: GraphQLPageOptions): Promise<DotCMSGraphQLPageResponse>;
+    get<T extends DotCMSPageAsset | DotCMSGraphQLPageResponse = DotCMSPageAsset>(url: string, options?: PageRequestParams): Promise<T>;
+    get<T extends DotCMSPageAsset | DotCMSGraphQLPageResponse = DotCMSGraphQLPageResponse>(url: string, options?: GraphQLPageOptions): Promise<T>;
 }
 export {};

package/src/lib/utils/graphql/transforms.d.ts

@@ -1,14 +1,4 @@
-/**
- * Represents the response from a GraphQL query for a page.
- *
- * @interface GraphQLPageResponse
- * @property {Record<string, unknown>} page - The main page data.
- * @property {unknown} [key: string] - Additional properties that may be included in the response.
- */
-interface GraphQLPageResponse {
-    page: Record<string, unknown>;
-    [key: string]: unknown;
-}
+import { DotCMSGraphQLPageResponse } from '@dotcms/types';
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *
@@ -20,5 +10,4 @@ interface GraphQLPageResponse {
  * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
  * ```
  */
-export declare const graphqlToPageEntity: (graphQLPageResponse: GraphQLPageResponse) => any;
-export {};
+export declare const graphqlToPageEntity: (graphQLPageResponse: DotCMSGraphQLPageResponse) => any;

package/transforms.cjs.js

@@ -1064,6 +1064,7 @@ const ErrorMessages = {
     503: 'Service Unavailable. Try again later.'
 };
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *

package/transforms.esm.js

@@ -1062,6 +1062,7 @@ const ErrorMessages = {
     503: 'Service Unavailable. Try again later.'
 };
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *

package/src/lib/client/models/types.d.ts

@@ -1,576 +0,0 @@
-import { Contentlet } from '../content/shared/types';
-/**
- * Represents a DotCMS page asset with its associated data and configurations
- *
- * @template T - Type parameter for URL content mapping, defaults to unknown
- * @interface DotCMSPageAsset
- *
- * @example
- * // Using DotCMSPageAsset without urlContentMap type
- *
- * const basicPageAsset: DotCMSPageAsset = {
- *   canCreateTemplate: true,
- *   containers: {},
- *   layout: {...},
- *   page: {...},
- *   site: {...},
- *   template: {...},
- *   ...
- * };
- *
- * @example
- * // Using DotCMSPageAsset with urlContentMap type
- * interface SomeContentlet {
- *   urlContentMap: {
- *     slug: string;
- *     category: string;
- *   }
- * }
- *
- * const pageWithUrlMap: DotCMSPageAsset<{ urlContentMap: SomeContentlet }> = {
- *   containers: {},
- *   layout: {...},
- *   page: {...},
- *   site: {...},
- *   template: {...},
- *   // This is the contentlet SomeContentlet type
- *   urlContentMap: {
- *     slug: "/blog/post-1",
- *     category: "blog"
- *   }
- * };
- */
-export interface DotCMSPageAsset<T = unknown> {
-    /** Whether a template can be created for this page */
-    canCreateTemplate?: boolean;
-    /** Map of containers on the page indexed by container ID */
-    containers: {
-        [key: string]: DotCMSPageAssetContainer;
-    };
-    /** Layout configuration for the page */
-    layout: DotCMSLayout;
-    /** Page metadata and properties */
-    page: DotCMSPage;
-    /** Site information */
-    site: DotCMSSite;
-    /** Template configuration */
-    template: DotCMSTemplate;
-    /** View configuration */
-    viewAs?: DotCMSViewAs;
-    /** Vanity URL configuration if applicable */
-    vanityUrl?: DotCMSVanityUrl;
-    /** Content mapping for the page URL */
-    urlContentMap?: T extends {
-        urlContentMap: infer U;
-    } ? Contentlet<U> : Contentlet<T>;
-    /** The parameters used to fetch the page */
-    params?: Record<string, unknown>;
-}
-export interface DotPageAssetLayoutRow {
-    identifier: number;
-    value?: string;
-    id?: string;
-    columns: DotPageAssetLayoutColumn[];
-    styleClass?: string;
-}
-export interface DotCMSVanityUrl {
-    pattern: string;
-    vanityUrlId: string;
-    url: string;
-    siteId: string;
-    languageId: number;
-    forwardTo: string;
-    response: number;
-    order: number;
-    temporaryRedirect: boolean;
-    permanentRedirect: boolean;
-    forward: boolean;
-}
-export interface DotPageAssetLayoutColumn {
-    preview: boolean;
-    containers: DotCMSColumnContainer[];
-    widthPercent: number;
-    width: number;
-    leftOffset: number;
-    left: number;
-    styleClass?: string;
-}
-export interface DotCMSColumnContainer {
-    identifier: string;
-    uuid: string;
-    historyUUIDs: string[];
-}
-export interface DotCMSPageAssetContainer {
-    container: DotCMSContainer;
-    containerStructures: DotCMSContainerStructure[];
-    contentlets: {
-        [key: string]: DotCMSContentlet[];
-    };
-}
-export interface DotCMSContainer {
-    identifier: string;
-    uuid: string;
-    iDate: number;
-    type: string;
-    owner?: string;
-    inode: string;
-    source: string;
-    title: string;
-    friendlyName: string;
-    modDate: number;
-    modUser: string;
-    sortOrder: number;
-    showOnMenu: boolean;
-    code?: string;
-    maxContentlets: number;
-    useDiv: boolean;
-    sortContentletsBy?: string;
-    preLoop: string;
-    postLoop: string;
-    staticify: boolean;
-    luceneQuery?: string;
-    notes: string;
-    languageId?: number;
-    path?: string;
-    live: boolean;
-    locked: boolean;
-    working: boolean;
-    deleted: boolean;
-    name: string;
-    archived: boolean;
-    permissionId: string;
-    versionId: string;
-    versionType: string;
-    permissionType: string;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    acceptTypes: string;
-    contentlets: DotCMSContentlet[];
-    parentPermissionable: DotCMSSiteParentPermissionable;
-}
-export interface DotCMSContentlet {
-    archived: boolean;
-    baseType: string;
-    deleted?: boolean;
-    binary?: string;
-    binaryContentAsset?: string;
-    binaryVersion?: string;
-    contentType: string;
-    file?: string;
-    folder: string;
-    hasLiveVersion?: boolean;
-    hasTitleImage: boolean;
-    host: string;
-    hostName: string;
-    identifier: string;
-    inode: string;
-    image?: any;
-    languageId: number;
-    language?: string;
-    live: boolean;
-    locked: boolean;
-    mimeType?: string;
-    modDate: string;
-    modUser: string;
-    modUserName: string;
-    owner: string;
-    sortOrder: number;
-    stInode: string;
-    title: string;
-    titleImage: string;
-    text?: string;
-    url: string;
-    working: boolean;
-    body?: string;
-    contentTypeIcon?: string;
-    variant?: string;
-    __icon__?: string;
-    [key: string]: any;
-}
-export interface DotcmsNavigationItem {
-    code?: any;
-    folder: string;
-    children?: DotcmsNavigationItem[];
-    host: string;
-    languageId: number;
-    href: string;
-    title: string;
-    type: string;
-    hash: number;
-    target: string;
-    order: number;
-}
-interface DotCMSTemplate {
-    iDate: number;
-    type: string;
-    owner: string;
-    inode: string;
-    identifier: string;
-    source: string;
-    title: string;
-    friendlyName: string;
-    modDate: number;
-    modUser: string;
-    sortOrder: number;
-    showOnMenu: boolean;
-    image: string;
-    drawed: boolean;
-    drawedBody: string;
-    theme: string;
-    anonymous: boolean;
-    template: boolean;
-    name: string;
-    live: boolean;
-    archived: boolean;
-    locked: boolean;
-    working: boolean;
-    permissionId: string;
-    versionId: string;
-    versionType: string;
-    deleted: boolean;
-    permissionType: string;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    canEdit: boolean;
-}
-interface DotCMSPage {
-    template: string;
-    modDate: number;
-    metadata: string;
-    cachettl: string;
-    pageURI: string;
-    title: string;
-    type: string;
-    showOnMenu: string;
-    httpsRequired: boolean;
-    inode: string;
-    disabledWYSIWYG: any[];
-    seokeywords: string;
-    host: string;
-    lastReview: number;
-    working: boolean;
-    locked: boolean;
-    stInode: string;
-    friendlyName: string;
-    live: boolean;
-    owner: string;
-    identifier: string;
-    nullProperties: any[];
-    friendlyname: string;
-    pagemetadata: string;
-    languageId: number;
-    url: string;
-    seodescription: string;
-    modUserName: string;
-    folder: string;
-    deleted: boolean;
-    sortOrder: number;
-    modUser: string;
-    pageUrl: string;
-    workingInode: string;
-    shortyWorking: string;
-    canEdit: boolean;
-    canRead: boolean;
-    canLock: boolean;
-    lockedOn: number;
-    lockedBy: string;
-    lockedByName: string;
-    liveInode: string;
-    shortyLive: string;
-}
-interface DotCMSViewAs {
-    language: {
-        id: number;
-        languageCode: string;
-        countryCode: string;
-        language: string;
-        country: string;
-    };
-    mode: string;
-}
-interface DotCMSLayout {
-    pageWidth: string;
-    width: string;
-    layout: string;
-    title: string;
-    header: boolean;
-    footer: boolean;
-    body: DotPageAssetLayoutBody;
-    sidebar: DotPageAssetLayoutSidebar;
-}
-interface DotCMSContainerStructure {
-    id: string;
-    structureId: string;
-    containerInode: string;
-    containerId: string;
-    code: string;
-    contentTypeVar: string;
-}
-interface DotPageAssetLayoutSidebar {
-    preview: boolean;
-    containers: DotCMSContainer[];
-    location: string;
-    widthPercent: number;
-    width: string;
-}
-interface DotPageAssetLayoutBody {
-    rows: DotPageAssetLayoutRow[];
-}
-interface DotCMSSite {
-    lowIndexPriority: boolean;
-    name: string;
-    default: boolean;
-    aliases: string;
-    parent: boolean;
-    tagStorage: string;
-    systemHost: boolean;
-    inode: string;
-    versionType: string;
-    structureInode: string;
-    hostname: string;
-    hostThumbnail?: any;
-    owner: string;
-    permissionId: string;
-    permissionType: string;
-    type: string;
-    identifier: string;
-    modDate: number;
-    host: string;
-    live: boolean;
-    indexPolicy: string;
-    categoryId: string;
-    actionId?: any;
-    new: boolean;
-    archived: boolean;
-    locked: boolean;
-    disabledWysiwyg: any[];
-    modUser: string;
-    working: boolean;
-    titleImage: {
-        present: boolean;
-    };
-    folder: string;
-    htmlpage: boolean;
-    fileAsset: boolean;
-    vanityUrl: boolean;
-    keyValue: boolean;
-    structure?: DotCMSSiteStructure;
-    title: string;
-    languageId: number;
-    indexPolicyDependencies: string;
-    contentTypeId: string;
-    versionId: string;
-    lastReview: number;
-    nextReview?: any;
-    reviewInterval?: any;
-    sortOrder: number;
-    contentType: DotCMSSiteContentType;
-}
-interface DotCMSSiteContentType {
-    owner?: any;
-    parentPermissionable: DotCMSSiteParentPermissionable;
-    permissionId: string;
-    permissionType: string;
-}
-export interface DotCMSSiteParentPermissionable {
-    Inode: string;
-    Identifier: string;
-    permissionByIdentifier: boolean;
-    type: string;
-    owner?: any;
-    identifier: string;
-    permissionId: string;
-    parentPermissionable?: any;
-    permissionType: string;
-    inode: string;
-    childrenPermissionable?: any;
-    variantId?: string;
-}
-interface DotCMSSiteStructure {
-    iDate: number;
-    type: string;
-    owner?: any;
-    inode: string;
-    identifier: string;
-    name: string;
-    description: string;
-    defaultStructure: boolean;
-    reviewInterval?: any;
-    reviewerRole?: any;
-    pagedetail?: any;
-    structureType: number;
-    fixed: boolean;
-    system: boolean;
-    velocityVarName: string;
-    urlMapPattern?: any;
-    host: string;
-    folder: string;
-    publishDateVar?: any;
-    expireDateVar?: any;
-    modDate: number;
-    fields: DotCMSSiteField[];
-    widget: boolean;
-    detailPage?: any;
-    fieldsBySortOrder: DotCMSSiteField[];
-    form: boolean;
-    htmlpageAsset: boolean;
-    content: boolean;
-    fileAsset: boolean;
-    persona: boolean;
-    permissionId: string;
-    permissionType: string;
-    live: boolean;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    archived: boolean;
-    locked: boolean;
-    modUser: string;
-    working: boolean;
-    title: string;
-    versionId: string;
-    versionType: string;
-}
-interface DotCMSSiteField {
-    iDate: number;
-    type: string;
-    owner?: any;
-    inode: string;
-    identifier: string;
-    structureInode: string;
-    fieldName: string;
-    fieldType: string;
-    fieldRelationType?: any;
-    fieldContentlet: string;
-    required: boolean;
-    velocityVarName: string;
-    sortOrder: number;
-    values?: any;
-    regexCheck?: any;
-    hint?: any;
-    defaultValue?: any;
-    indexed: boolean;
-    listed: boolean;
-    fixed: boolean;
-    readOnly: boolean;
-    searchable: boolean;
-    unique: boolean;
-    modDate: number;
-    dataType: string;
-    live: boolean;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    archived: boolean;
-    locked: boolean;
-    modUser: string;
-    working: boolean;
-    permissionId: string;
-    parentPermissionable?: any;
-    permissionType: string;
-    title: string;
-    versionId: string;
-    versionType: string;
-}
-/**
- * Represents a basic page structure returned from GraphQL queries
- */
-export interface DotCMSBasicGraphQLPage {
-    publishDate: string;
-    type: string;
-    httpsRequired: boolean;
-    inode: string;
-    path: string;
-    identifier: string;
-    hasTitleImage: boolean;
-    sortOrder: number;
-    extension: string;
-    canRead: boolean;
-    pageURI: string;
-    canEdit: boolean;
-    archived: boolean;
-    friendlyName: string;
-    workingInode: string;
-    url: string;
-    hasLiveVersion: boolean;
-    deleted: boolean;
-    pageUrl: string;
-    shortyWorking: string;
-    mimeType: string;
-    locked: boolean;
-    stInode: string;
-    contentType: string;
-    creationDate: string;
-    liveInode: string;
-    name: string;
-    shortyLive: string;
-    modDate: string;
-    title: string;
-    baseType: string;
-    working: boolean;
-    canLock: boolean;
-    live: boolean;
-    isContentlet: boolean;
-    statusIcons: string;
-    conLanguage: {
-        id: number;
-        language: string;
-        languageCode: string;
-    };
-    template: {
-        drawed: boolean;
-    };
-    containers: {
-        path?: string;
-        identifier: string;
-        maxContentlets?: number;
-        containerStructures?: {
-            contentTypeVar: string;
-        }[];
-        containerContentlets?: {
-            uuid: string;
-            contentlets: DotCMSContentlet[];
-        }[];
-    };
-    layout: DotCMSLayout;
-    viewAs: DotCMSViewAs;
-}
-export interface DotCMSPageGraphQLContainer {
-    path: string;
-    identifier: string;
-    maxContentlets?: number;
-    containerStructures: DotCMSContainerStructure[];
-    containerContentlets: DotCMSPageContainerContentlets[];
-}
-export interface DotCMSPageContainerContentlets {
-    uuid: string;
-    contentlets: DotCMSContentlet[];
-}
-export interface DotCMSGraphQLError {
-    message: string;
-    locations: {
-        line: number;
-        column: number;
-    }[];
-    extensions: {
-        classification: string;
-    };
-}
-/**
- * Represents the complete response from a GraphQL page query
- *
- * @template TContent - The type of the content data
- * @template TNav - The type of the navigation data
- */
-export interface DotCMSGraphQLPageResponse<TContent = Record<string, any>> {
-    page: DotCMSBasicGraphQLPage;
-    content?: TContent;
-    errors?: DotCMSGraphQLError;
-    graphql: {
-        query: string;
-        variables: Record<string, unknown>;
-    };
-}
-export {};

package/src/types.d.ts

@@ -1,2 +0,0 @@
-export { DotCMSPageAsset, DotCMSGraphQLPageResponse } from './lib/client/models/types';
-export { Contentlet } from './lib/client/content/shared/types';

package/types.cjs.d.ts

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

package/types.cjs.default.js

@@ -1 +0,0 @@
-exports._default = require('./types.cjs.js').default;

package/types.cjs.js

@@ -1,2 +0,0 @@
-'use strict';
-

package/types.cjs.mjs

@@ -1,2 +0,0 @@
-export * from './types.cjs.js';
-export { _default as default } from './types.cjs.default.js';

package/types.esm.d.ts

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

package/types.esm.js

@@ -1 +0,0 @@
-