@uniformdev/canvas-next 18.33.0 → 18.34.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ParsedUrlQuery } from 'querystring';
-export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-6ff72d91.js';
+export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-092c0912.js';
 import { NextApiHandler, NextApiRequest } from 'next';
 import { RootComponentInstance } from '@uniformdev/canvas';
 import '@uniformdev/canvas-react';

package/dist/index.esm.js

@@ -31,9 +31,22 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
   if (isUsingPreviewSecret && req.query.secret !== previewSecret) {
     return res.status(401).json({ message: "Invalid token" });
   }
-  res.setPreviewData({
-    isUniformContextualEditing: req.query[IN_CONTEXT_EDITOR_QUERY_STRING_PARAM] === "true"
-  });
+  const isUniformContextualEditing = req.query[IN_CONTEXT_EDITOR_QUERY_STRING_PARAM] === "true";
+  res.setPreviewData(
+    {
+      isUniformContextualEditing,
+      compositionId: id,
+      compositionSlug: slug,
+      compositionPath: path,
+      locale
+    },
+    {
+      // 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.
+      // This causes the second tab to still have the preview cookie, which causes unexpected behavior.
+      // This is more obvious in contextual editing mode because we skip the composition fetching and the user sees a blank page where they expected the published composition.
+      maxAge: isUniformContextualEditing ? 0 : void 0
+    }
+  );
   const cookies = res.getHeader("Set-Cookie");
   res.setHeader(
     "Set-Cookie",

package/dist/index.js

@@ -66,9 +66,22 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
   if (isUsingPreviewSecret && req.query.secret !== previewSecret) {
     return res.status(401).json({ message: "Invalid token" });
   }
-  res.setPreviewData({
-    isUniformContextualEditing: req.query[import_canvas.IN_CONTEXT_EDITOR_QUERY_STRING_PARAM] === "true"
-  });
+  const isUniformContextualEditing = req.query[import_canvas.IN_CONTEXT_EDITOR_QUERY_STRING_PARAM] === "true";
+  res.setPreviewData(
+    {
+      isUniformContextualEditing,
+      compositionId: id,
+      compositionSlug: slug,
+      compositionPath: path,
+      locale
+    },
+    {
+      // 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.
+      // This causes the second tab to still have the preview cookie, which causes unexpected behavior.
+      // This is more obvious in contextual editing mode because we skip the composition fetching and the user sees a blank page where they expected the published composition.
+      maxAge: isUniformContextualEditing ? 0 : void 0
+    }
+  );
   const cookies = res.getHeader("Set-Cookie");
   res.setHeader(
     "Set-Cookie",

package/dist/index.mjs

@@ -31,9 +31,22 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
   if (isUsingPreviewSecret && req.query.secret !== previewSecret) {
     return res.status(401).json({ message: "Invalid token" });
   }
-  res.setPreviewData({
-    isUniformContextualEditing: req.query[IN_CONTEXT_EDITOR_QUERY_STRING_PARAM] === "true"
-  });
+  const isUniformContextualEditing = req.query[IN_CONTEXT_EDITOR_QUERY_STRING_PARAM] === "true";
+  res.setPreviewData(
+    {
+      isUniformContextualEditing,
+      compositionId: id,
+      compositionSlug: slug,
+      compositionPath: path,
+      locale
+    },
+    {
+      // 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.
+      // This causes the second tab to still have the preview cookie, which causes unexpected behavior.
+      // This is more obvious in contextual editing mode because we skip the composition fetching and the user sees a blank page where they expected the published composition.
+      maxAge: isUniformContextualEditing ? 0 : void 0
+    }
+  );
   const cookies = res.getHeader("Set-Cookie");
   res.setHeader(
     "Set-Cookie",

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

@@ -6,6 +6,10 @@ import { ParsedUrlQuery } from 'querystring';
 type UniformCompositionNextPage<TProps = unknown> = NextPage<TProps & UniformCompositionProps>;
 type UniformPreviewData = PreviewData & {
     isUniformContextualEditing: boolean;
+    compositionId?: string;
+    compositionSlug?: string;
+    compositionPath?: string;
+    locale?: string;
 };
 type UniformGetStaticProps<P extends {
     [key: string]: any;

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-6ff72d91.js';
+import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-092c0912.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';

package/dist/project-map/index.js

@@ -33,7 +33,7 @@ module.exports = __toCommonJS(project_map_exports);
 var import_canvas = require("@uniformdev/canvas");
 var withUniformGetServerSideProps = (options) => {
   return async function wrappedGetServerSideProps(context) {
-    var _a;
+    var _a, _b;
     const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
     const canvasClient = (options == null ? void 0 : options.client) || new import_canvas.CanvasClient({
       apiKey: process.env.UNIFORM_API_KEY,
@@ -47,7 +47,9 @@ var withUniformGetServerSideProps = (options) => {
     if (options == null ? void 0 : options.modifyPath) {
       nodePath = options.modifyPath(nodePath, context);
     }
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...import_canvas.EMPTY_COMPOSITION, _id: (_b = previewData.compositionId) != null ? _b : import_canvas.EMPTY_COMPOSITION._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionByNodePath({
           ...options == null ? void 0 : options.requestOptions,
@@ -118,7 +120,7 @@ var resolveSlugFromParams = ({
 // src/project-map/withUniformGetStaticProps.ts
 var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
-    var _a, _b;
+    var _a, _b, _c;
     const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
     let pathString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
@@ -135,7 +137,9 @@ var withUniformGetStaticProps = (options) => {
     });
     const { preview, previewData } = context;
     let composition = void 0;
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...import_canvas3.EMPTY_COMPOSITION, _id: (_c = previewData.compositionId) != null ? _c : import_canvas3.EMPTY_COMPOSITION._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionByNodePath({
           ...options == null ? void 0 : options.requestOptions,

package/dist/project-map/index.mjs

@@ -6,11 +6,12 @@ import {
 import {
   CANVAS_DRAFT_STATE,
   CANVAS_PUBLISHED_STATE,
-  CanvasClient
+  CanvasClient,
+  EMPTY_COMPOSITION
 } from "@uniformdev/canvas";
 var withUniformGetServerSideProps = (options) => {
   return async function wrappedGetServerSideProps(context) {
-    var _a;
+    var _a, _b;
     const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
     const canvasClient = (options == null ? void 0 : options.client) || new CanvasClient({
       apiKey: process.env.UNIFORM_API_KEY,
@@ -24,7 +25,9 @@ var withUniformGetServerSideProps = (options) => {
     if (options == null ? void 0 : options.modifyPath) {
       nodePath = options.modifyPath(nodePath, context);
     }
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...EMPTY_COMPOSITION, _id: (_b = previewData.compositionId) != null ? _b : EMPTY_COMPOSITION._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionByNodePath({
           ...options == null ? void 0 : options.requestOptions,
@@ -85,11 +88,12 @@ var withUniformGetStaticPaths = (options) => {
 import {
   CANVAS_DRAFT_STATE as CANVAS_DRAFT_STATE3,
   CANVAS_PUBLISHED_STATE as CANVAS_PUBLISHED_STATE3,
-  CanvasClient as CanvasClient2
+  CanvasClient as CanvasClient2,
+  EMPTY_COMPOSITION as EMPTY_COMPOSITION2
 } from "@uniformdev/canvas";
 var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
-    var _a, _b;
+    var _a, _b, _c;
     const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
     let pathString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
@@ -106,7 +110,9 @@ var withUniformGetStaticProps = (options) => {
     });
     const { preview, previewData } = context;
     let composition = void 0;
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...EMPTY_COMPOSITION2, _id: (_c = previewData.compositionId) != null ? _c : EMPTY_COMPOSITION2._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionByNodePath({
           ...options == null ? void 0 : options.requestOptions,

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-6ff72d91.js';
+import { a as UniformPreviewData, c as UniformGetServerSideProps, b as UniformGetStaticProps } from '../models-092c0912.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';

package/dist/slug/index.js

@@ -33,6 +33,7 @@ module.exports = __toCommonJS(slug_exports);
 var import_canvas = require("@uniformdev/canvas");
 var withUniformGetServerSideProps = (options) => {
   return async function wrappedGetServerSideProps(context) {
+    var _a;
     const canvasClient = (options == null ? void 0 : options.client) || new import_canvas.CanvasClient({
       apiKey: process.env.UNIFORM_API_KEY,
       projectId: process.env.UNIFORM_PROJECT_ID,
@@ -45,7 +46,9 @@ var withUniformGetServerSideProps = (options) => {
     if (options == null ? void 0 : options.modifySlug) {
       slug = options.modifySlug(slug, context);
     }
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...import_canvas.EMPTY_COMPOSITION, _id: (_a = previewData.compositionId) != null ? _a : import_canvas.EMPTY_COMPOSITION._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionBySlug({
           ...options == null ? void 0 : options.requestOptions,
@@ -112,7 +115,7 @@ var resolveSlugFromParams = ({
 // src/slug/withUniformGetStaticProps.ts
 var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
-    var _a;
+    var _a, _b;
     let slugString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
       params: context == null ? void 0 : context.params
@@ -128,7 +131,9 @@ var withUniformGetStaticProps = (options) => {
     });
     const { preview, previewData } = context;
     let composition = void 0;
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...import_canvas3.EMPTY_COMPOSITION, _id: (_b = previewData.compositionId) != null ? _b : import_canvas3.EMPTY_COMPOSITION._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionBySlug({
           slug: slugString,

package/dist/slug/index.mjs

@@ -6,10 +6,12 @@ import {
 import {
   CANVAS_DRAFT_STATE,
   CANVAS_PUBLISHED_STATE,
-  CanvasClient
+  CanvasClient,
+  EMPTY_COMPOSITION
 } from "@uniformdev/canvas";
 var withUniformGetServerSideProps = (options) => {
   return async function wrappedGetServerSideProps(context) {
+    var _a;
     const canvasClient = (options == null ? void 0 : options.client) || new CanvasClient({
       apiKey: process.env.UNIFORM_API_KEY,
       projectId: process.env.UNIFORM_PROJECT_ID,
@@ -22,7 +24,9 @@ var withUniformGetServerSideProps = (options) => {
     if (options == null ? void 0 : options.modifySlug) {
       slug = options.modifySlug(slug, context);
     }
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...EMPTY_COMPOSITION, _id: (_a = previewData.compositionId) != null ? _a : EMPTY_COMPOSITION._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionBySlug({
           ...options == null ? void 0 : options.requestOptions,
@@ -81,11 +85,12 @@ var withUniformGetStaticPaths = (options) => {
 import {
   CANVAS_DRAFT_STATE as CANVAS_DRAFT_STATE3,
   CANVAS_PUBLISHED_STATE as CANVAS_PUBLISHED_STATE3,
-  CanvasClient as CanvasClient3
+  CanvasClient as CanvasClient3,
+  EMPTY_COMPOSITION as EMPTY_COMPOSITION2
 } from "@uniformdev/canvas";
 var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
-    var _a;
+    var _a, _b;
     let slugString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
       params: context == null ? void 0 : context.params
@@ -101,7 +106,9 @@ var withUniformGetStaticProps = (options) => {
     });
     const { preview, previewData } = context;
     let composition = void 0;
-    if (!(previewData == null ? void 0 : previewData.isUniformContextualEditing)) {
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...EMPTY_COMPOSITION2, _id: (_b = previewData.compositionId) != null ? _b : EMPTY_COMPOSITION2._id };
+    } else {
       try {
         const response = await canvasClient.getCompositionBySlug({
           slug: slugString,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next",
-  "version": "18.33.0",
+  "version": "18.34.0",
   "description": "Next.js SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -53,9 +53,9 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "18.33.0",
-    "@uniformdev/canvas-react": "18.33.0",
-    "@uniformdev/project-map": "18.33.0"
+    "@uniformdev/canvas": "18.34.0",
+    "@uniformdev/canvas-react": "18.34.0",
+    "@uniformdev/project-map": "18.34.0"
   },
   "peerDependencies": {
     "next": ">= 12.0.0",
@@ -74,5 +74,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2b6ca533e90fa133ead4ce435f4a3f19e30b21c1"
+  "gitHead": "563ab31aa4308102c988bea321028e73efe836d0"
 }