@uniformdev/canvas-next 19.38.3-alpha.70 → 19.38.3-alpha.78

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { RichTextRendererComponent, RenderRichTextComponentResolver, UniformRichText as UniformRichText$1, UniformRichTextNode as UniformRichTextNode$1 } from '@uniformdev/canvas-react';
 import { ParsedUrlQuery } from 'querystring';
-export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-092c0912.js';
+export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-f9fd03c4.js';
 import { NextApiHandler, NextApiRequest } from 'next';
 import { RootComponentInstance } from '@uniformdev/canvas';
 
@@ -31,6 +31,10 @@ type CreatePreviewHandlerGetOptions = {
      * defaults to a function that returns the `path` if truthy, otherwise returns `slug`.
      */
     resolveFullPath?: ResolveFullPath;
+    /**
+     * The path to the playground page, to live preview components and patterns
+     */
+    playgroundPath?: string;
 };
 type CreatePreviewHandlerGet = (options?: CreatePreviewHandlerGetOptions) => NextApiHandler;
 declare const createPreviewHandlerGet: CreatePreviewHandlerGet;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { RichTextRendererComponent, RenderRichTextComponentResolver, UniformRichText as UniformRichText$1, UniformRichTextNode as UniformRichTextNode$1 } from '@uniformdev/canvas-react';
 import { ParsedUrlQuery } from 'querystring';
-export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-092c0912.js';
+export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-f9fd03c4.js';
 import { NextApiHandler, NextApiRequest } from 'next';
 import { RootComponentInstance } from '@uniformdev/canvas';
 
@@ -31,6 +31,10 @@ type CreatePreviewHandlerGetOptions = {
      * defaults to a function that returns the `path` if truthy, otherwise returns `slug`.
      */
     resolveFullPath?: ResolveFullPath;
+    /**
+     * The path to the playground page, to live preview components and patterns
+     */
+    playgroundPath?: string;
 };
 type CreatePreviewHandlerGet = (options?: CreatePreviewHandlerGetOptions) => NextApiHandler;
 declare const createPreviewHandlerGet: CreatePreviewHandlerGet;

package/dist/index.esm.js

@@ -49,7 +49,10 @@ var UniformRichTextNode = ({
 };
 
 // src/preview/previewHandlerGet.ts
-import { IN_CONTEXT_EDITOR_QUERY_STRING_PARAM } from "@uniformdev/canvas";
+import {
+  IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
+  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM
+} from "@uniformdev/canvas";
 var BASE_URL_EXAMPLE = "https://exmaple.com";
 var getQueryParam = (req, paramName) => {
   const value = req.query[paramName];
@@ -58,16 +61,33 @@ var getQueryParam = (req, paramName) => {
   }
   return Array.isArray(value) ? value[0] : value;
 };
-var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefault } = {}) => async (req, res) => {
+var queryParamsToPreserve = [
+  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
+  IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM
+];
+var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefault, playgroundPath } = {}) => async (req, res) => {
+  const isConfigCheck = getQueryParam(req, "is_config_check") === "true";
+  if (isConfigCheck) {
+    return res.json({
+      hasPlayground: Boolean(playgroundPath),
+      isUsingCustomFullPathResolver: resolveFullPath !== resolveFullPathDefault
+    });
+  }
   if (req.headers["sec-fetch-mode"] === "no-cors") {
     return res.status(204).end();
   }
-  const queryParamsToPreserve = [IN_CONTEXT_EDITOR_QUERY_STRING_PARAM];
+  const isPlayground = req.query[IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM] === "true";
+  let pathToRedirectTo;
+  if (isPlayground && playgroundPath) {
+    pathToRedirectTo = playgroundPath;
+  }
   const id = getQueryParam(req, "id");
   const slug = getQueryParam(req, "slug");
   const path = getQueryParam(req, "path");
   const locale = getQueryParam(req, "locale");
-  const pathToRedirectTo = resolveFullPath({ id, slug, path, locale });
+  if (typeof pathToRedirectTo === "undefined") {
+    pathToRedirectTo = resolveFullPath({ id, slug, path, locale });
+  }
   validateLocalRedirectUrl(pathToRedirectTo);
   if (!pathToRedirectTo) {
     return res.status(400).json({ message: "Could not resolve the full path of the preview page" });
@@ -89,7 +109,8 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
       compositionId: id,
       compositionSlug: slug,
       compositionPath: path,
-      locale
+      locale,
+      isPlayground
     },
     {
       // By default the preview cookies stays as long as the tab is open. And in contextual editing mode, people tend to open Canvas editor (one tab) and another tab to see published changes.
@@ -153,17 +174,17 @@ var createPreviewHandlerPost = ({ secret, enhance } = {}) => async (req, res) =>
 };
 
 // src/preview/previewHandler.ts
-var createPreviewHandler = ({ secret, enhance, resolveFullPath } = {}) => async (req, res) => {
+var createPreviewHandler = ({ secret, enhance, resolveFullPath, playgroundPath } = {}) => async (req, res) => {
   var _a;
   const method = (_a = req.method) == null ? void 0 : _a.toLocaleLowerCase();
+  res.setHeader("Access-Control-Allow-Origin", "*");
+  res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
+  res.setHeader("Access-Control-Allow-Methods", "GET, HEAD");
   if (method === "get") {
-    return createPreviewHandlerGet({ secret, resolveFullPath })(req, res);
+    return createPreviewHandlerGet({ secret, resolveFullPath, playgroundPath })(req, res);
   } else if (method === "post") {
     return createPreviewHandlerPost({ secret, enhance })(req, res);
   } else if (method === "options") {
-    res.setHeader("Access-Control-Allow-Origin", "*");
-    res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
-    res.setHeader("Access-Control-Allow-Methods", "GET");
     return res.status(204).end();
   }
   return res.status(501).json({ message: `Method "${method}" not implemented` });

package/dist/index.js

@@ -104,16 +104,33 @@ var getQueryParam = (req, paramName) => {
   }
   return Array.isArray(value) ? value[0] : value;
 };
-var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefault } = {}) => async (req, res) => {
+var queryParamsToPreserve = [
+  import_canvas.IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
+  import_canvas.IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM
+];
+var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefault, playgroundPath } = {}) => async (req, res) => {
+  const isConfigCheck = getQueryParam(req, "is_config_check") === "true";
+  if (isConfigCheck) {
+    return res.json({
+      hasPlayground: Boolean(playgroundPath),
+      isUsingCustomFullPathResolver: resolveFullPath !== resolveFullPathDefault
+    });
+  }
   if (req.headers["sec-fetch-mode"] === "no-cors") {
     return res.status(204).end();
   }
-  const queryParamsToPreserve = [import_canvas.IN_CONTEXT_EDITOR_QUERY_STRING_PARAM];
+  const isPlayground = req.query[import_canvas.IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM] === "true";
+  let pathToRedirectTo;
+  if (isPlayground && playgroundPath) {
+    pathToRedirectTo = playgroundPath;
+  }
   const id = getQueryParam(req, "id");
   const slug = getQueryParam(req, "slug");
   const path = getQueryParam(req, "path");
   const locale = getQueryParam(req, "locale");
-  const pathToRedirectTo = resolveFullPath({ id, slug, path, locale });
+  if (typeof pathToRedirectTo === "undefined") {
+    pathToRedirectTo = resolveFullPath({ id, slug, path, locale });
+  }
   validateLocalRedirectUrl(pathToRedirectTo);
   if (!pathToRedirectTo) {
     return res.status(400).json({ message: "Could not resolve the full path of the preview page" });
@@ -135,7 +152,8 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
       compositionId: id,
       compositionSlug: slug,
       compositionPath: path,
-      locale
+      locale,
+      isPlayground
     },
     {
       // By default the preview cookies stays as long as the tab is open. And in contextual editing mode, people tend to open Canvas editor (one tab) and another tab to see published changes.
@@ -199,17 +217,17 @@ var createPreviewHandlerPost = ({ secret, enhance } = {}) => async (req, res) =>
 };
 
 // src/preview/previewHandler.ts
-var createPreviewHandler = ({ secret, enhance, resolveFullPath } = {}) => async (req, res) => {
+var createPreviewHandler = ({ secret, enhance, resolveFullPath, playgroundPath } = {}) => async (req, res) => {
   var _a;
   const method = (_a = req.method) == null ? void 0 : _a.toLocaleLowerCase();
+  res.setHeader("Access-Control-Allow-Origin", "*");
+  res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
+  res.setHeader("Access-Control-Allow-Methods", "GET, HEAD");
   if (method === "get") {
-    return createPreviewHandlerGet({ secret, resolveFullPath })(req, res);
+    return createPreviewHandlerGet({ secret, resolveFullPath, playgroundPath })(req, res);
   } else if (method === "post") {
     return createPreviewHandlerPost({ secret, enhance })(req, res);
   } else if (method === "options") {
-    res.setHeader("Access-Control-Allow-Origin", "*");
-    res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
-    res.setHeader("Access-Control-Allow-Methods", "GET");
     return res.status(204).end();
   }
   return res.status(501).json({ message: `Method "${method}" not implemented` });

package/dist/index.mjs

@@ -49,7 +49,10 @@ var UniformRichTextNode = ({
 };
 
 // src/preview/previewHandlerGet.ts
-import { IN_CONTEXT_EDITOR_QUERY_STRING_PARAM } from "@uniformdev/canvas";
+import {
+  IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
+  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM
+} from "@uniformdev/canvas";
 var BASE_URL_EXAMPLE = "https://exmaple.com";
 var getQueryParam = (req, paramName) => {
   const value = req.query[paramName];
@@ -58,16 +61,33 @@ var getQueryParam = (req, paramName) => {
   }
   return Array.isArray(value) ? value[0] : value;
 };
-var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefault } = {}) => async (req, res) => {
+var queryParamsToPreserve = [
+  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
+  IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM
+];
+var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefault, playgroundPath } = {}) => async (req, res) => {
+  const isConfigCheck = getQueryParam(req, "is_config_check") === "true";
+  if (isConfigCheck) {
+    return res.json({
+      hasPlayground: Boolean(playgroundPath),
+      isUsingCustomFullPathResolver: resolveFullPath !== resolveFullPathDefault
+    });
+  }
   if (req.headers["sec-fetch-mode"] === "no-cors") {
     return res.status(204).end();
   }
-  const queryParamsToPreserve = [IN_CONTEXT_EDITOR_QUERY_STRING_PARAM];
+  const isPlayground = req.query[IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM] === "true";
+  let pathToRedirectTo;
+  if (isPlayground && playgroundPath) {
+    pathToRedirectTo = playgroundPath;
+  }
   const id = getQueryParam(req, "id");
   const slug = getQueryParam(req, "slug");
   const path = getQueryParam(req, "path");
   const locale = getQueryParam(req, "locale");
-  const pathToRedirectTo = resolveFullPath({ id, slug, path, locale });
+  if (typeof pathToRedirectTo === "undefined") {
+    pathToRedirectTo = resolveFullPath({ id, slug, path, locale });
+  }
   validateLocalRedirectUrl(pathToRedirectTo);
   if (!pathToRedirectTo) {
     return res.status(400).json({ message: "Could not resolve the full path of the preview page" });
@@ -89,7 +109,8 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
       compositionId: id,
       compositionSlug: slug,
       compositionPath: path,
-      locale
+      locale,
+      isPlayground
     },
     {
       // By default the preview cookies stays as long as the tab is open. And in contextual editing mode, people tend to open Canvas editor (one tab) and another tab to see published changes.
@@ -153,17 +174,17 @@ var createPreviewHandlerPost = ({ secret, enhance } = {}) => async (req, res) =>
 };
 
 // src/preview/previewHandler.ts
-var createPreviewHandler = ({ secret, enhance, resolveFullPath } = {}) => async (req, res) => {
+var createPreviewHandler = ({ secret, enhance, resolveFullPath, playgroundPath } = {}) => async (req, res) => {
   var _a;
   const method = (_a = req.method) == null ? void 0 : _a.toLocaleLowerCase();
+  res.setHeader("Access-Control-Allow-Origin", "*");
+  res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
+  res.setHeader("Access-Control-Allow-Methods", "GET, HEAD");
   if (method === "get") {
-    return createPreviewHandlerGet({ secret, resolveFullPath })(req, res);
+    return createPreviewHandlerGet({ secret, resolveFullPath, playgroundPath })(req, res);
   } else if (method === "post") {
     return createPreviewHandlerPost({ secret, enhance })(req, res);
   } else if (method === "options") {
-    res.setHeader("Access-Control-Allow-Origin", "*");
-    res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
-    res.setHeader("Access-Control-Allow-Methods", "GET");
     return res.status(204).end();
   }
   return res.status(501).json({ message: `Method "${method}" not implemented` });

package/dist/{models-092c0912.d.ts → models-f9fd03c4.d.ts}

@@ -10,6 +10,7 @@ type UniformPreviewData = PreviewData & {
     compositionSlug?: string;
     compositionPath?: string;
     locale?: string;
+    isPlayground?: boolean;
 };
 type UniformGetStaticProps<P extends {
     [key: string]: any;

package/dist/project-map/index.d.mts

@@ -1,6 +1,6 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, PreviewData, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
-import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-092c0912.js';
+import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-f9fd03c4.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';

package/dist/project-map/index.d.ts

@@ -1,6 +1,6 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, PreviewData, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
-import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-092c0912.js';
+import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-f9fd03c4.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';

package/dist/route/index.d.mts

@@ -1,6 +1,6 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, GetServerSidePropsResult, GetServerSideProps, GetStaticPropsContext, GetStaticPropsResult, GetStaticProps } from 'next';
-import { a as UniformPreviewData } from '../models-092c0912.js';
+import { a as UniformPreviewData } from '../models-f9fd03c4.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 export { w as withUniformGetStaticPaths } from '../withUniformGetStaticPaths-77db0164.js';

package/dist/route/index.d.ts

@@ -1,6 +1,6 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, GetServerSidePropsResult, GetServerSideProps, GetStaticPropsContext, GetStaticPropsResult, GetStaticProps } from 'next';
-import { a as UniformPreviewData } from '../models-092c0912.js';
+import { a as UniformPreviewData } from '../models-f9fd03c4.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 export { w as withUniformGetStaticPaths } from '../withUniformGetStaticPaths-77db0164.js';

package/dist/slug/index.d.mts

@@ -1,6 +1,6 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
-import { a as UniformPreviewData, c as UniformGetServerSideProps, b as UniformGetStaticProps } from '../models-092c0912.js';
+import { a as UniformPreviewData, c as UniformGetServerSideProps, b as UniformGetStaticProps } from '../models-f9fd03c4.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';

package/dist/slug/index.d.ts

@@ -1,6 +1,6 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
-import { a as UniformPreviewData, c as UniformGetServerSideProps, b as UniformGetStaticProps } from '../models-092c0912.js';
+import { a as UniformPreviewData, c as UniformGetServerSideProps, b as UniformGetStaticProps } from '../models-f9fd03c4.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next",
-  "version": "19.38.3-alpha.70+55e5a8fe1",
+  "version": "19.38.3-alpha.78+5c9892bf1",
   "description": "Next.js SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -63,11 +63,11 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.38.3-alpha.70+55e5a8fe1",
-    "@uniformdev/canvas-react": "19.38.3-alpha.70+55e5a8fe1",
-    "@uniformdev/project-map": "19.38.3-alpha.70+55e5a8fe1",
-    "@uniformdev/redirect": "19.38.3-alpha.70+55e5a8fe1",
-    "@uniformdev/richtext": "19.38.3-alpha.70+55e5a8fe1",
+    "@uniformdev/canvas": "19.38.3-alpha.78+5c9892bf1",
+    "@uniformdev/canvas-react": "19.38.3-alpha.78+5c9892bf1",
+    "@uniformdev/project-map": "19.38.3-alpha.78+5c9892bf1",
+    "@uniformdev/redirect": "19.38.3-alpha.78+5c9892bf1",
+    "@uniformdev/richtext": "19.38.3-alpha.78+5c9892bf1",
     "colorette": "2.0.20"
   },
   "peerDependencies": {
@@ -76,7 +76,7 @@
     "react-dom": ">=16"
   },
   "devDependencies": {
-    "@types/react": "18.2.18",
+    "@types/react": "18.2.20",
     "next": "13.4.12",
     "react": "18.2.0",
     "react-dom": "18.2.0"
@@ -87,5 +87,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "55e5a8fe1d80971a93ea31d3a50cec72e71be70a"
+  "gitHead": "5c9892bf101584d351d06b65e1658a1237594cfb"
 }