@dotcms/uve 0.0.1-beta.20 → 0.0.1-beta.22

package/index.cjs2.js

@@ -470,9 +470,10 @@ function registerUVEEvents() {
  * This is typically called after all UVE event handlers and DOM listeners
  * have been set up successfully.
  */
-function setClientIsReady() {
+function setClientIsReady(config) {
   sendMessageToUVE({
-    action: types.DotCMSUVEAction.CLIENT_READY
+    action: types.DotCMSUVEAction.CLIENT_READY,
+    payload: config
   });
 }
 /**
@@ -620,9 +621,9 @@ function initInlineEditing(type, data) {
  * destroyUVESubscriptions();
  * ```
  */
-function initUVE() {
+function initUVE(config = {}) {
   addClassToEmptyContentlets();
-  setClientIsReady();
+  setClientIsReady(config);
   const {
     subscriptions
   } = registerUVEEvents();

package/index.esm2.js

@@ -468,9 +468,10 @@ function registerUVEEvents() {
  * This is typically called after all UVE event handlers and DOM listeners
  * have been set up successfully.
  */
-function setClientIsReady() {
+function setClientIsReady(config) {
   sendMessageToUVE({
-    action: DotCMSUVEAction.CLIENT_READY
+    action: DotCMSUVEAction.CLIENT_READY,
+    payload: config
   });
 }
 /**
@@ -618,9 +619,9 @@ function initInlineEditing(type, data) {
  * destroyUVESubscriptions();
  * ```
  */
-function initUVE() {
+function initUVE(config = {}) {
   addClassToEmptyContentlets();
-  setClientIsReady();
+  setClientIsReady(config);
   const {
     subscriptions
   } = registerUVEEvents();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/uve",
-  "version": "0.0.1-beta.20",
+  "version": "0.0.1-beta.22",
   "description": "Official JavaScript library for interacting with Universal Visual Editor (UVE)",
   "repository": {
     "type": "git",

package/src/lib/editor/public.d.ts

@@ -1,5 +1,5 @@
 import { DotCMSReorderMenuConfig, DotCMSUVEMessage } from '../types/editor/internal';
-import { Contentlet } from '../types/editor/public';
+import { Contentlet, DotCMSUVEConfig } from '../types/editor/public';
 import { DotCMSInlineEditingPayload, DotCMSInlineEditingType } from '../types/events/public';
 /**
  * Post message to dotcms page editor
@@ -57,6 +57,6 @@ export declare function initInlineEditing(type: DotCMSInlineEditingType, data?:
  * destroyUVESubscriptions();
  * ```
  */
-export declare function initUVE(): {
+export declare function initUVE(config?: DotCMSUVEConfig): {
     destroyUVESubscriptions: () => void;
 };

package/src/lib/types/editor/public.d.ts

@@ -1,5 +1,6 @@
 import { ContentTypeMainFields, DotCMSContainerBound } from './internal';
 import { DEVELOPMENT_MODE, PRODUCTION_MODE } from '../../../internal';
+import { DotCMSBasicGraphQLPage, DotCMSPageAsset } from '../page/public';
 /**
  * Represents the state of the Universal Visual Editor (UVE)
  * @interface
@@ -179,7 +180,7 @@ export declare enum UVEEventType {
  * Type definitions for each event's payload
  */
 export type UVEEventPayloadMap = {
-    [UVEEventType.CONTENT_CHANGES]: unknown;
+    [UVEEventType.CONTENT_CHANGES]: DotCMSEditablePage;
     [UVEEventType.PAGE_RELOAD]: undefined;
     [UVEEventType.REQUEST_BOUNDS]: DotCMSContainerBound[];
     [UVEEventType.IFRAME_SCROLL]: 'up' | 'down';
@@ -223,3 +224,48 @@ export interface DotContentletAttributes {
     'data-dot-container': string;
     'data-dot-on-number-of-pages': string;
 }
+/**
+ * Represents a GraphQL error
+ * @interface DotCMSGraphQLError
+ */
+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>;
+    };
+}
+/**
+ * Payload for initializing the UVE
+ * @interface DotCMSEditablePage
+ */
+export type DotCMSEditablePage = DotCMSGraphQLPageResponse | DotCMSPageAsset;
+/**
+ * Configuration for the UVE
+ * @interface DotCMSUVEConfig
+ */
+export interface DotCMSUVEConfig {
+    graphql?: {
+        query: string;
+        variables: Record<string, unknown>;
+    };
+    params?: Record<string, unknown>;
+}

package/src/lib/types/page/public.d.ts

@@ -9,6 +9,7 @@ export interface DotCMSPageAsset {
     template: DotCMSTemplate;
     viewAs?: DotCMSViewAs;
     vanityUrl?: DotCMSVanityUrl;
+    params?: Record<string, unknown>;
 }
 export interface DotPageAssetLayoutRow {
     identifier: number;
@@ -418,4 +419,67 @@ interface DotCMSSiteField {
     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 {};

package/src/script/utils.d.ts

@@ -1,3 +1,4 @@
+import { DotCMSUVEConfig } from '../lib/types/editor/public';
 /**
  * Sets up scroll event handlers for the window to notify the editor about scroll events.
  * Adds listeners for both 'scroll' and 'scrollend' events, sending appropriate messages
@@ -43,7 +44,7 @@ export declare function registerUVEEvents(): {
  * This is typically called after all UVE event handlers and DOM listeners
  * have been set up successfully.
  */
-export declare function setClientIsReady(): void;
+export declare function setClientIsReady(config?: DotCMSUVEConfig): void;
 /**
  * Listen for block editor inline event.
  */