@dotcms/vue 1.5.5

package/lib/contexts/dotcms-page.context.d.ts

@@ -0,0 +1,61 @@
+import { Component, ComputedRef, InjectionKey } from 'vue';
+import { DotCMSPageAsset, DotCMSPageRendererMode } from '@dotcms/types';
+/**
+ * The value carried by the dotCMS page context.
+ *
+ * This is the Vue analog of the React SDK's `DotCMSPageContext`. It is provided
+ * once by {@link DotCMSLayoutBody} and consumed by the internal layout tree
+ * (Container, Contentlet) as well as the dev-mode composable.
+ *
+ * @internal
+ */
+export interface DotCMSPageContextValue {
+    /** The dotCMS page asset containing the layout and containers. */
+    pageAsset: DotCMSPageAsset;
+    /** The renderer mode: `production` or `development`. */
+    mode: DotCMSPageRendererMode;
+    /**
+     * Map of content-type variable name to the Vue component that renders it.
+     * The special `CustomNoComponent` key is used as the fallback for unmatched
+     * content types.
+     */
+    userComponents: Record<string, Component>;
+    /**
+     * Whether editor metadata (`data-dot-*`, placeholders, fallbacks) should be
+     * emitted. Resolved once at the layout root and shared with the whole tree
+     * so it isn't recomputed per contentlet.
+     */
+    isDevMode: boolean;
+    /**
+     * Whether dotCMS Analytics is active. Resolved once at the layout root (a
+     * single `dotcms:analytics:ready` listener) and shared with the tree.
+     */
+    isAnalyticsActive: boolean;
+}
+/**
+ * Injection key for the dotCMS page context.
+ *
+ * The value is a `ComputedRef` so that live UVE updates to the page (a new page
+ * asset arriving via `uve-set-page-data`) propagate to every consumer that reads
+ * `ctx.value` — the whole layout tree re-renders reactively.
+ *
+ * @internal
+ */
+export declare const DOTCMS_PAGE_CONTEXT: InjectionKey<ComputedRef<DotCMSPageContextValue>>;
+/**
+ * Provides the dotCMS page context to descendant components.
+ *
+ * @internal
+ * @param value a computed producing the current context value
+ */
+export declare function provideDotCMSPageContext(value: ComputedRef<DotCMSPageContextValue>): void;
+/**
+ * Injects the dotCMS page context as a reactive `ComputedRef`.
+ *
+ * Falls back to an empty context when used outside of a {@link DotCMSLayoutBody},
+ * mirroring the default value the React context is created with.
+ *
+ * @internal
+ * @returns the current page context value as a computed ref
+ */
+export declare function useDotCMSPageContext(): ComputedRef<DotCMSPageContextValue>;

package/lib/utils/toPlain.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Recursively unwrap Vue reactivity (refs / reactive proxies) into a plain,
+ * structured-clone-safe object.
+ *
+ * The UVE bridge sends data to the editor via `postMessage`, which uses the
+ * structured clone algorithm — and that throws a `DataCloneError` on Vue
+ * reactive Proxies. Values passed to UVE actions (`initUVE`, `editContentlet`,
+ * `enableBlockEditorInline`, …) commonly come through reactive props or
+ * `reactive()`, so unwrap them first. Plain values pass through untouched;
+ * cycles are guarded and non-plain objects (e.g. `Date`) are preserved as-is.
+ */
+export declare function toPlain<T>(value: T): T;

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@dotcms/vue",
+    "version": "1.5.5",
+    "peerDependencies": {
+        "vue": ">=3.4"
+    },
+    "dependencies": {
+        "@dotcms/uve": "latest",
+        "@dotcms/client": "latest",
+        "@tinymce/tinymce-vue": "^6.1.0"
+    },
+    "devDependencies": {
+        "@dotcms/types": "latest"
+    },
+    "description": "Official Vue components library to render a dotCMS page.",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/dotCMS/core.git#main"
+    },
+    "keywords": [
+        "dotCMS",
+        "CMS",
+        "Content Management",
+        "API Client",
+        "REST API",
+        "Vue",
+        "Vue 3",
+        "Components"
+    ],
+    "type": "module",
+    "main": "./index.js",
+    "module": "./index.js",
+    "types": "./index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "types": "./index.d.ts",
+            "import": "./index.js"
+        }
+    },
+    "author": "dotcms <dev@dotcms.com>",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/dotCMS/core/issues"
+    },
+    "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/vue/README.md"
+}