@payloadcms/live-preview-vue 3.73.0-canary.4 → 3.73.0-internal.6ea481d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +34 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -2
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,36 @@
|
|
|
1
|
+
import type { CollectionPopulationRequestHandler } from '@payloadcms/live-preview';
|
|
1
2
|
import type { Ref } from 'vue';
|
|
2
3
|
/**
|
|
3
4
|
* This is a Vue composable to implement {@link https://payloadcms.com/docs/live-preview/overview Payload Live Preview}.
|
|
4
5
|
*
|
|
6
|
+
* @example
|
|
7
|
+
* ```ts
|
|
8
|
+
* // Basic usage
|
|
9
|
+
* const { data, isLoading } = useLivePreview({
|
|
10
|
+
* initialData: pageData,
|
|
11
|
+
* serverURL: 'https://your-payload-server.com',
|
|
12
|
+
* depth: 2,
|
|
13
|
+
* })
|
|
14
|
+
* ```
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* // Custom request handler (e.g., routing through middleware)
|
|
19
|
+
* const customHandler = async ({ endpoint, data }) => {
|
|
20
|
+
* return fetch(`https://api.example.com/preview/${endpoint}`, {
|
|
21
|
+
* method: 'POST',
|
|
22
|
+
* body: JSON.stringify(data),
|
|
23
|
+
* credentials: 'include',
|
|
24
|
+
* })
|
|
25
|
+
* }
|
|
26
|
+
*
|
|
27
|
+
* const { data, isLoading } = useLivePreview({
|
|
28
|
+
* initialData: pageData,
|
|
29
|
+
* serverURL: 'https://your-payload-server.com',
|
|
30
|
+
* requestHandler: customHandler,
|
|
31
|
+
* })
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
5
34
|
* @link https://payloadcms.com/docs/live-preview/frontend
|
|
6
35
|
*/
|
|
7
36
|
export declare const useLivePreview: <T extends Record<string, any>>(props: {
|
|
@@ -12,6 +41,11 @@ export declare const useLivePreview: <T extends Record<string, any>>(props: {
|
|
|
12
41
|
* you can pass in the initial page data from the server.
|
|
13
42
|
*/
|
|
14
43
|
initialData: T;
|
|
44
|
+
/**
|
|
45
|
+
* Custom handler to intercept and modify data fetching.
|
|
46
|
+
* Useful for routing requests through middleware or applying transformations.
|
|
47
|
+
*/
|
|
48
|
+
requestHandler?: CollectionPopulationRequestHandler;
|
|
15
49
|
serverURL: string;
|
|
16
50
|
}) => {
|
|
17
51
|
data: Ref<T>;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAK9B
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAA;AAClF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAK9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAAS;IACnE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,WAAW,EAAE,CAAC,CAAA;IACd;;;OAGG;IACH,cAAc,CAAC,EAAE,kCAAkC,CAAA;IACnD,SAAS,EAAE,MAAM,CAAA;CAClB,KAAG;IACF,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAA;IACZ;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CAyCxB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -11,7 +11,7 @@ Object.defineProperty(exports, "useLivePreview", {
|
|
|
11
11
|
const _livepreview = require("@payloadcms/live-preview");
|
|
12
12
|
const _vue = require("vue");
|
|
13
13
|
const useLivePreview = (props)=>{
|
|
14
|
-
const { apiRoute, depth, initialData, serverURL } = props;
|
|
14
|
+
const { apiRoute, depth, initialData, requestHandler, serverURL } = props;
|
|
15
15
|
const data = (0, _vue.ref)(initialData);
|
|
16
16
|
const isLoading = (0, _vue.ref)(true);
|
|
17
17
|
const hasSentReadyMessage = (0, _vue.ref)(false);
|
|
@@ -26,6 +26,7 @@ const useLivePreview = (props)=>{
|
|
|
26
26
|
callback: onChange,
|
|
27
27
|
depth,
|
|
28
28
|
initialData,
|
|
29
|
+
requestHandler,
|
|
29
30
|
serverURL
|
|
30
31
|
});
|
|
31
32
|
if (!hasSentReadyMessage.value) {
|
|
@@ -44,4 +45,4 @@ const useLivePreview = (props)=>{
|
|
|
44
45
|
};
|
|
45
46
|
};
|
|
46
47
|
|
|
47
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
48
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgdHlwZSB7IENvbGxlY3Rpb25Qb3B1bGF0aW9uUmVxdWVzdEhhbmRsZXIgfSBmcm9tICdAcGF5bG9hZGNtcy9saXZlLXByZXZpZXcnXG5pbXBvcnQgdHlwZSB7IFJlZiB9IGZyb20gJ3Z1ZSdcblxuaW1wb3J0IHsgcmVhZHksIHN1YnNjcmliZSwgdW5zdWJzY3JpYmUgfSBmcm9tICdAcGF5bG9hZGNtcy9saXZlLXByZXZpZXcnXG5pbXBvcnQgeyBvbk1vdW50ZWQsIG9uVW5tb3VudGVkLCByZWYgfSBmcm9tICd2dWUnXG5cbi8qKlxuICogVGhpcyBpcyBhIFZ1ZSBjb21wb3NhYmxlIHRvIGltcGxlbWVudCB7QGxpbmsgaHR0cHM6Ly9wYXlsb2FkY21zLmNvbS9kb2NzL2xpdmUtcHJldmlldy9vdmVydmlldyBQYXlsb2FkIExpdmUgUHJldmlld30uXG4gKlxuICogQGV4YW1wbGVcbiAqIGBgYHRzXG4gKiAvLyBCYXNpYyB1c2FnZVxuICogY29uc3QgeyBkYXRhLCBpc0xvYWRpbmcgfSA9IHVzZUxpdmVQcmV2aWV3KHtcbiAqICAgaW5pdGlhbERhdGE6IHBhZ2VEYXRhLFxuICogICBzZXJ2ZXJVUkw6ICdodHRwczovL3lvdXItcGF5bG9hZC1zZXJ2ZXIuY29tJyxcbiAqICAgZGVwdGg6IDIsXG4gKiB9KVxuICogYGBgXG4gKlxuICogQGV4YW1wbGVcbiAqIGBgYHRzXG4gKiAvLyBDdXN0b20gcmVxdWVzdCBoYW5kbGVyIChlLmcuLCByb3V0aW5nIHRocm91Z2ggbWlkZGxld2FyZSlcbiAqIGNvbnN0IGN1c3RvbUhhbmRsZXIgPSBhc3luYyAoeyBlbmRwb2ludCwgZGF0YSB9KSA9PiB7XG4gKiAgIHJldHVybiBmZXRjaChgaHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vcHJldmlldy8ke2VuZHBvaW50fWAsIHtcbiAqICAgICBtZXRob2Q6ICdQT1NUJyxcbiAqICAgICBib2R5OiBKU09OLnN0cmluZ2lmeShkYXRhKSxcbiAqICAgICBjcmVkZW50aWFsczogJ2luY2x1ZGUnLFxuICogICB9KVxuICogfVxuICpcbiAqIGNvbnN0IHsgZGF0YSwgaXNMb2FkaW5nIH0gPSB1c2VMaXZlUHJldmlldyh7XG4gKiAgIGluaXRpYWxEYXRhOiBwYWdlRGF0YSxcbiAqICAgc2VydmVyVVJMOiAnaHR0cHM6Ly95b3VyLXBheWxvYWQtc2VydmVyLmNvbScsXG4gKiAgIHJlcXVlc3RIYW5kbGVyOiBjdXN0b21IYW5kbGVyLFxuICogfSlcbiAqIGBgYFxuICpcbiAqIEBsaW5rIGh0dHBzOi8vcGF5bG9hZGNtcy5jb20vZG9jcy9saXZlLXByZXZpZXcvZnJvbnRlbmRcbiAqL1xuZXhwb3J0IGNvbnN0IHVzZUxpdmVQcmV2aWV3ID0gPFQgZXh0ZW5kcyBSZWNvcmQ8c3RyaW5nLCBhbnk+Pihwcm9wczoge1xuICBhcGlSb3V0ZT86IHN0cmluZ1xuICBkZXB0aD86IG51bWJlclxuICAvKipcbiAgICogVG8gcHJldmVudCB0aGUgZmxpY2tlciBvZiBtaXNzaW5nIGRhdGEgb24gaW5pdGlhbCBsb2FkLFxuICAgKiB5b3UgY2FuIHBhc3MgaW4gdGhlIGluaXRpYWwgcGFnZSBkYXRhIGZyb20gdGhlIHNlcnZlci5cbiAgICovXG4gIGluaXRpYWxEYXRhOiBUXG4gIC8qKlxuICAgKiBDdXN0b20gaGFuZGxlciB0byBpbnRlcmNlcHQgYW5kIG1vZGlmeSBkYXRhIGZldGNoaW5nLlxuICAgKiBVc2VmdWwgZm9yIHJvdXRpbmcgcmVxdWVzdHMgdGhyb3VnaCBtaWRkbGV3YXJlIG9yIGFwcGx5aW5nIHRyYW5zZm9ybWF0aW9ucy5cbiAgICovXG4gIHJlcXVlc3RIYW5kbGVyPzogQ29sbGVjdGlvblBvcHVsYXRpb25SZXF1ZXN0SGFuZGxlclxuICBzZXJ2ZXJVUkw6IHN0cmluZ1xufSk6IHtcbiAgZGF0YTogUmVmPFQ+XG4gIC8qKlxuICAgKiBUbyBwcmV2ZW50IHRoZSBmbGlja2VyIG9mIHN0YWxlIGRhdGEgd2hpbGUgdGhlIHBvc3QgbWVzc2FnZSBpcyBiZWluZyBzZW50LFxuICAgKiB5b3UgY2FuIGNvbmRpdGlvbmFsbHkgcmVuZGVyIGxvYWRpbmcgVUkgYmFzZWQgb24gdGhlIGBpc0xvYWRpbmdgIHN0YXRlLlxuICAgKi9cbiAgaXNMb2FkaW5nOiBSZWY8Ym9vbGVhbj5cbn0gPT4ge1xuICBjb25zdCB7IGFwaVJvdXRlLCBkZXB0aCwgaW5pdGlhbERhdGEsIHJlcXVlc3RIYW5kbGVyLCBzZXJ2ZXJVUkwgfSA9IHByb3BzXG4gIGNvbnN0IGRhdGEgPSByZWYoaW5pdGlhbERhdGEpIGFzIFJlZjxUPlxuICBjb25zdCBpc0xvYWRpbmcgPSByZWYodHJ1ZSlcbiAgY29uc3QgaGFzU2VudFJlYWR5TWVzc2FnZSA9IHJlZihmYWxzZSlcblxuICBjb25zdCBvbkNoYW5nZSA9IChtZXJnZWREYXRhOiBUKSA9PiB7XG4gICAgZGF0YS52YWx1ZSA9IG1lcmdlZERhdGFcbiAgICBpc0xvYWRpbmcudmFsdWUgPSBmYWxzZVxuICB9XG5cbiAgbGV0IHN1YnNjcmlwdGlvbjogKGV2ZW50OiBNZXNzYWdlRXZlbnQpID0+IFByb21pc2U8dm9pZD4gfCB2b2lkXG5cbiAgb25Nb3VudGVkKCgpID0+IHtcbiAgICBzdWJzY3JpcHRpb24gPSBzdWJzY3JpYmUoe1xuICAgICAgYXBpUm91dGUsXG4gICAgICBjYWxsYmFjazogb25DaGFuZ2UsXG4gICAgICBkZXB0aCxcbiAgICAgIGluaXRpYWxEYXRhLFxuICAgICAgcmVxdWVzdEhhbmRsZXIsXG4gICAgICBzZXJ2ZXJVUkwsXG4gICAgfSlcblxuICAgIGlmICghaGFzU2VudFJlYWR5TWVzc2FnZS52YWx1ZSkge1xuICAgICAgaGFzU2VudFJlYWR5TWVzc2FnZS52YWx1ZSA9IHRydWVcblxuICAgICAgcmVhZHkoe1xuICAgICAgICBzZXJ2ZXJVUkwsXG4gICAgICB9KVxuICAgIH1cbiAgfSlcblxuICBvblVubW91bnRlZCgoKSA9PiB7XG4gICAgdW5zdWJzY3JpYmUoc3Vic2NyaXB0aW9uKVxuICB9KVxuXG4gIHJldHVybiB7XG4gICAgZGF0YSxcbiAgICBpc0xvYWRpbmcsXG4gIH1cbn1cbiJdLCJuYW1lcyI6WyJ1c2VMaXZlUHJldmlldyIsInByb3BzIiwiYXBpUm91dGUiLCJkZXB0aCIsImluaXRpYWxEYXRhIiwicmVxdWVzdEhhbmRsZXIiLCJzZXJ2ZXJVUkwiLCJkYXRhIiwicmVmIiwiaXNMb2FkaW5nIiwiaGFzU2VudFJlYWR5TWVzc2FnZSIsIm9uQ2hhbmdlIiwibWVyZ2VkRGF0YSIsInZhbHVlIiwic3Vic2NyaXB0aW9uIiwib25Nb3VudGVkIiwic3Vic2NyaWJlIiwiY2FsbGJhY2siLCJyZWFkeSIsIm9uVW5tb3VudGVkIiwidW5zdWJzY3JpYmUiXSwibWFwcGluZ3MiOiI7Ozs7K0JBdUNhQTs7O2VBQUFBOzs7NkJBcENpQztxQkFDRjtBQW1DckMsTUFBTUEsaUJBQWlCLENBQWdDQztJQXNCNUQsTUFBTSxFQUFFQyxRQUFRLEVBQUVDLEtBQUssRUFBRUMsV0FBVyxFQUFFQyxjQUFjLEVBQUVDLFNBQVMsRUFBRSxHQUFHTDtJQUNwRSxNQUFNTSxPQUFPQyxJQUFBQSxRQUFHLEVBQUNKO0lBQ2pCLE1BQU1LLFlBQVlELElBQUFBLFFBQUcsRUFBQztJQUN0QixNQUFNRSxzQkFBc0JGLElBQUFBLFFBQUcsRUFBQztJQUVoQyxNQUFNRyxXQUFXLENBQUNDO1FBQ2hCTCxLQUFLTSxLQUFLLEdBQUdEO1FBQ2JILFVBQVVJLEtBQUssR0FBRztJQUNwQjtJQUVBLElBQUlDO0lBRUpDLElBQUFBLGNBQVMsRUFBQztRQUNSRCxlQUFlRSxJQUFBQSxzQkFBUyxFQUFDO1lBQ3ZCZDtZQUNBZSxVQUFVTjtZQUNWUjtZQUNBQztZQUNBQztZQUNBQztRQUNGO1FBRUEsSUFBSSxDQUFDSSxvQkFBb0JHLEtBQUssRUFBRTtZQUM5Qkgsb0JBQW9CRyxLQUFLLEdBQUc7WUFFNUJLLElBQUFBLGtCQUFLLEVBQUM7Z0JBQ0paO1lBQ0Y7UUFDRjtJQUNGO0lBRUFhLElBQUFBLGdCQUFXLEVBQUM7UUFDVkMsSUFBQUEsd0JBQVcsRUFBQ047SUFDZDtJQUVBLE9BQU87UUFDTFA7UUFDQUU7SUFDRjtBQUNGIn0=
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/live-preview-vue",
|
|
3
|
-
"version": "3.73.0-
|
|
3
|
+
"version": "3.73.0-internal.6ea481d",
|
|
4
4
|
"description": "The official Vue SDK for Payload Live Preview",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -32,11 +32,11 @@
|
|
|
32
32
|
"dist"
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@payloadcms/live-preview": "3.73.0-
|
|
35
|
+
"@payloadcms/live-preview": "3.73.0-internal.6ea481d"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"vue": "^3.0.0",
|
|
39
|
-
"payload": "3.73.0-
|
|
39
|
+
"payload": "3.73.0-internal.6ea481d",
|
|
40
40
|
"@payloadcms/eslint-config": "3.28.0"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|