@dotcms/client 0.0.1-beta.2 → 0.0.1-beta.4

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

@@ -0,0 +1,84 @@
+import { Content } from './content/content-api';
+import { NavigationClient } from './navigation/navigation-api';
+import { PageClient } from './page/page-api';
+/**
+ * Options for configuring fetch requests, excluding body and method properties.
+ */
+export type RequestOptions = Omit<RequestInit, 'body' | 'method'>;
+/**
+ * Configuration options for the DotCMS client.
+ */
+export interface DotCMSClientConfig {
+    /**
+     * The URL of the dotCMS instance.
+     * Ensure to include the protocol (http or https).
+     * @example `https://demo.dotcms.com`
+     */
+    dotcmsUrl: string;
+    /**
+     * The authentication token for requests.
+     * Obtainable from the dotCMS UI.
+     */
+    authToken: string;
+    /**
+     * The id of the site you want to interact with. Defaults to the default site if not provided.
+     */
+    siteId?: string;
+    /**
+     * Additional options for the fetch request.
+     * @example `{ headers: { 'Content-Type': 'application/json' } }`
+     */
+    requestOptions?: RequestOptions;
+}
+/**
+ * Client for interacting with the DotCMS REST API.
+ * Provides access to content, page, and navigation functionality.
+ */
+declare class DotCMSClient {
+    private config;
+    private requestOptions;
+    /**
+     * Client for content-related operations.
+     */
+    content: Content;
+    /**
+     * Client for page-related operations.
+     */
+    page: PageClient;
+    /**
+     * Client for navigation-related operations.
+     */
+    nav: NavigationClient;
+    /**
+     * Creates a new DotCMS client instance.
+     *
+     * @param config - Configuration options for the client
+     * @throws Warning if dotcmsUrl is invalid or authToken is missing
+     */
+    constructor(config?: DotCMSClientConfig);
+    /**
+     * Creates request options with authentication headers.
+     *
+     * @param config - The client configuration
+     * @returns Request options with authorization headers
+     */
+    private createAuthenticatedRequestOptions;
+}
+/**
+ * Creates and returns a new DotCMS client instance.
+ *
+ * @param config - Configuration options for the client
+ * @returns A configured DotCMS client instance
+ * @example
+ * ```typescript
+ * const client = dotCMSCreateClient({
+ *   dotcmsUrl: 'https://demo.dotcms.com',
+ *   authToken: 'your-auth-token'
+ * });
+ *
+ * // Use the client to fetch content
+ * const pages = await client.page.get('/about-us');
+ * ```
+ */
+export declare const createDotCMSClient: (clientConfig: DotCMSClientConfig) => DotCMSClient;
+export {};

package/src/lib/client/content/builders/collection/collection.d.ts

@@ -1,4 +1,4 @@
-import { ClientOptions } from '../../../sdk-js-client';
+import { ClientOptions } from '../../../../deprecated/sdk-js-client';
 import { GetCollectionResponse, BuildQuery, SortBy, GetCollectionError, OnFullfilled, OnRejected } from '../../shared/types';
 /**
  * Creates a Builder to filter and fetch content from the content API for a specific content type.

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

@@ -1,5 +1,5 @@
 import { CollectionBuilder } from './builders/collection/collection';
-import { ClientOptions } from '../sdk-js-client';
+import { ClientOptions } from '../../deprecated/sdk-js-client';
 /**
  * Creates a builder to filter and fetch a collection of content items.
  * @param contentType - The content type to retrieve.

package/src/lib/client/content/shared/types.d.ts

@@ -1,5 +1,5 @@
-import { Equals } from '../../../query-builder/lucene-syntax';
-import { QueryBuilder } from '../../../query-builder/sdk-query-builder';
+import { Equals } from '../builders/query/lucene-syntax';
+import { QueryBuilder } from '../builders/query/query';
 /**
  * Model to sort by fields.
  */

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

@@ -1,13 +1,516 @@
+export interface DotCMSPageAsset {
+    canCreateTemplate?: boolean;
+    containers: {
+        [key: string]: DotCMSPageAssetContainer;
+    };
+    layout: DotCMSLayout;
+    page: DotCMSPage;
+    site: DotCMSSite;
+    template: DotCMSTemplate;
+    viewAs?: DotCMSViewAs;
+    vanityUrl?: DotCMSVanityUrl;
+}
+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 listener for DotcmsClientListener.
+ * 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
  *
- * @typedef {Object} DotcmsClientListener
- * @property {string} action - The action that triggers the event.
- * @property {string} event - The name of the event.
- * @property {function(...args: any[]): void} callback - The callback function to handle the event.
+ * @template TContent - The type of the content data
+ * @template TNav - The type of the navigation data
  */
-export type DotcmsClientListener = {
-    action: string;
-    event: string;
-    callback: (...args: any[]) => void;
-};
+export interface DotCMSGraphQLPageResponse<TContent = Record<string, any>> {
+    page: DotCMSBasicGraphQLPage;
+    content?: TContent;
+    errors?: DotCMSGraphQLError;
+}
+export {};

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

@@ -0,0 +1,31 @@
+import { DotCMSClientConfig, RequestOptions } from '../client';
+interface NavRequestParams {
+    /**
+     * The depth of the folder tree to return.
+     * @example
+     * `1` returns only the element specified in the path.
+     * `2` returns the element specified in the path, and if that element is a folder, returns all direct children of that folder.
+     * `3` returns all children and grandchildren of the element specified in the path.
+     */
+    depth?: number;
+    /**
+     * The language ID of content to return.
+     * @example
+     * `1` (or unspecified) returns content in the default language of the site.
+     */
+    languageId?: number;
+}
+export declare class NavigationClient {
+    private requestOptions;
+    private BASE_URL;
+    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
+    /**
+     * Retrieves information about the dotCMS file and folder tree.
+     * @param {NavigationApiOptions} options - The options for the Navigation API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
+     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
+     * @throws {Error} - Throws an error if the options are not valid.
+     */
+    get(path: string, params?: NavRequestParams): Promise<unknown>;
+    private mapToBackendParams;
+}
+export {};