@prismicio/next 0.1.4 → 0.1.6-alpha.0

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.
Files changed (66) hide show
  1. package/dist/PrismicNextImage.cjs +59 -0
  2. package/dist/PrismicNextImage.cjs.map +1 -0
  3. package/dist/PrismicNextImage.d.ts +48 -0
  4. package/dist/PrismicNextImage.js +38 -0
  5. package/dist/PrismicNextImage.js.map +1 -0
  6. package/dist/PrismicPreview.cjs +81 -0
  7. package/dist/PrismicPreview.cjs.map +1 -0
  8. package/dist/PrismicPreview.d.ts +42 -0
  9. package/dist/{PrismicPreview.mjs → PrismicPreview.js} +18 -43
  10. package/dist/PrismicPreview.js.map +1 -0
  11. package/dist/enableAutoPreviews.cjs +17 -0
  12. package/dist/enableAutoPreviews.cjs.map +1 -0
  13. package/dist/enableAutoPreviews.d.ts +38 -0
  14. package/dist/{enableAutoPreviews.mjs → enableAutoPreviews.js} +4 -2
  15. package/dist/enableAutoPreviews.js.map +1 -0
  16. package/dist/exitPreview.cjs +8 -0
  17. package/dist/exitPreview.cjs.map +1 -0
  18. package/dist/exitPreview.d.ts +34 -0
  19. package/dist/{exitPreview.mjs → exitPreview.js} +4 -2
  20. package/dist/exitPreview.js.map +1 -0
  21. package/dist/index.cjs +15 -0
  22. package/dist/index.cjs.map +1 -0
  23. package/dist/index.d.ts +13 -273
  24. package/dist/index.js +15 -0
  25. package/dist/index.js.map +1 -0
  26. package/dist/lib/__PRODUCTION__.cjs +5 -0
  27. package/dist/lib/__PRODUCTION__.cjs.map +1 -0
  28. package/dist/lib/__PRODUCTION__.d.ts +7 -0
  29. package/dist/lib/__PRODUCTION__.js +5 -0
  30. package/dist/lib/__PRODUCTION__.js.map +1 -0
  31. package/dist/lib/devMsg.cjs +8 -0
  32. package/dist/lib/devMsg.cjs.map +1 -0
  33. package/dist/lib/devMsg.d.ts +16 -0
  34. package/dist/lib/devMsg.js +8 -0
  35. package/dist/lib/devMsg.js.map +1 -0
  36. package/dist/lib/getPreviewCookieRepositoryName.cjs +7 -0
  37. package/dist/lib/getPreviewCookieRepositoryName.cjs.map +1 -0
  38. package/dist/lib/getPreviewCookieRepositoryName.d.ts +9 -0
  39. package/dist/lib/{getPreviewCookieRepositoryName.mjs → getPreviewCookieRepositoryName.js} +4 -2
  40. package/dist/lib/getPreviewCookieRepositoryName.js.map +1 -0
  41. package/dist/lib/getPrismicPreviewCookie.cjs +40 -0
  42. package/dist/lib/getPrismicPreviewCookie.cjs.map +1 -0
  43. package/dist/lib/getPrismicPreviewCookie.d.ts +9 -0
  44. package/dist/lib/{getPrismicPreviewCookie.mjs → getPrismicPreviewCookie.js} +5 -4
  45. package/dist/lib/getPrismicPreviewCookie.js.map +1 -0
  46. package/dist/package.cjs +5 -0
  47. package/dist/package.cjs.map +1 -0
  48. package/dist/package.js +5 -0
  49. package/dist/package.js.map +1 -0
  50. package/dist/redirectToPreviewURL.cjs +22 -0
  51. package/dist/redirectToPreviewURL.cjs.map +1 -0
  52. package/dist/redirectToPreviewURL.d.ts +59 -0
  53. package/dist/{redirectToPreviewURL.mjs → redirectToPreviewURL.js} +4 -2
  54. package/dist/redirectToPreviewURL.js.map +1 -0
  55. package/dist/setPreviewData.cjs +30 -0
  56. package/dist/setPreviewData.cjs.map +1 -0
  57. package/dist/setPreviewData.d.ts +29 -0
  58. package/dist/{setPreviewData.mjs → setPreviewData.js} +5 -4
  59. package/dist/setPreviewData.js.map +1 -0
  60. package/dist/types.d.ts +21 -0
  61. package/package.json +13 -8
  62. package/dist/PrismicNextImage.mjs +0 -60
  63. package/dist/index.mjs +0 -6
  64. package/dist/lib/__PRODUCTION__.mjs +0 -3
  65. package/dist/lib/devMsg.mjs +0 -7
  66. package/dist/package.mjs +0 -3
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
3
+ const prismic = require("@prismicio/client");
4
+ function _interopNamespace(e) {
5
+ if (e && e.__esModule)
6
+ return e;
7
+ const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
8
+ if (e) {
9
+ for (const k in e) {
10
+ if (k !== "default") {
11
+ const d = Object.getOwnPropertyDescriptor(e, k);
12
+ Object.defineProperty(n, k, d.get ? d : {
13
+ enumerable: true,
14
+ get: () => e[k]
15
+ });
16
+ }
17
+ }
18
+ }
19
+ n.default = e;
20
+ return Object.freeze(n);
21
+ }
22
+ const prismic__namespace = /* @__PURE__ */ _interopNamespace(prismic);
23
+ function setPreviewData({ req, res }) {
24
+ const ref = req.query.token || req.cookies[prismic__namespace.cookie.preview];
25
+ if (ref) {
26
+ res.setPreviewData({ ref });
27
+ }
28
+ }
29
+ exports.setPreviewData = setPreviewData;
30
+ //# sourceMappingURL=setPreviewData.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"setPreviewData.cjs","sources":["../src/setPreviewData.ts"],"sourcesContent":["import { NextApiResponse, NextApiRequest } from \"next\";\nimport * as prismic from \"@prismicio/client\";\n\n/**\n * Configuration for `setPreviewData`.\n */\nexport type SetPreviewDataConfig = {\n\t/**\n\t * The `req` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\treq: {\n\t\tquery: NextApiRequest[\"query\"];\n\t\tcookies: NextApiRequest[\"cookies\"];\n\t};\n\n\t/**\n\t * The `res` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\tres: {\n\t\tsetPreviewData: NextApiResponse[\"setPreviewData\"];\n\t};\n};\n\n/**\n * Set Prismic preview data for Next.js's Preview Mode.\n */\nexport function setPreviewData({ req, res }: SetPreviewDataConfig): void {\n\tconst ref = req.query.token || req.cookies[prismic.cookie.preview];\n\n\tif (ref) {\n\t\tres.setPreviewData({ ref });\n\t}\n}\n"],"names":["prismic"],"mappings":";;;;;;;;;;;;;;;;;;;;;;SAgCgB,eAAe,EAAE,KAAK,OAA2B;AAChE,QAAM,MAAM,IAAI,MAAM,SAAS,IAAI,QAAQA,mBAAQ,OAAO;AAE1D,MAAI,KAAK;AACJ,QAAA,eAAe,EAAE,IAAA,CAAK;AAAA,EAC1B;AACF;;"}
@@ -0,0 +1,29 @@
1
+ import { NextApiResponse, NextApiRequest } from "next";
2
+ /**
3
+ * Configuration for `setPreviewData`.
4
+ */
5
+ export declare type SetPreviewDataConfig = {
6
+ /**
7
+ * The `req` object from a Next.js API route. This is given as a parameter to
8
+ * the API route.
9
+ *
10
+ * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
11
+ */
12
+ req: {
13
+ query: NextApiRequest["query"];
14
+ cookies: NextApiRequest["cookies"];
15
+ };
16
+ /**
17
+ * The `res` object from a Next.js API route. This is given as a parameter to
18
+ * the API route.
19
+ *
20
+ * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
21
+ */
22
+ res: {
23
+ setPreviewData: NextApiResponse["setPreviewData"];
24
+ };
25
+ };
26
+ /**
27
+ * Set Prismic preview data for Next.js's Preview Mode.
28
+ */
29
+ export declare function setPreviewData({ req, res }: SetPreviewDataConfig): void;
@@ -1,10 +1,11 @@
1
- import * as prismic from '@prismicio/client';
2
-
1
+ import * as prismic from "@prismicio/client";
3
2
  function setPreviewData({ req, res }) {
4
3
  const ref = req.query.token || req.cookies[prismic.cookie.preview];
5
4
  if (ref) {
6
5
  res.setPreviewData({ ref });
7
6
  }
8
7
  }
9
-
10
- export { setPreviewData };
8
+ export {
9
+ setPreviewData
10
+ };
11
+ //# sourceMappingURL=setPreviewData.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"setPreviewData.js","sources":["../src/setPreviewData.ts"],"sourcesContent":["import { NextApiResponse, NextApiRequest } from \"next\";\nimport * as prismic from \"@prismicio/client\";\n\n/**\n * Configuration for `setPreviewData`.\n */\nexport type SetPreviewDataConfig = {\n\t/**\n\t * The `req` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\treq: {\n\t\tquery: NextApiRequest[\"query\"];\n\t\tcookies: NextApiRequest[\"cookies\"];\n\t};\n\n\t/**\n\t * The `res` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\tres: {\n\t\tsetPreviewData: NextApiResponse[\"setPreviewData\"];\n\t};\n};\n\n/**\n * Set Prismic preview data for Next.js's Preview Mode.\n */\nexport function setPreviewData({ req, res }: SetPreviewDataConfig): void {\n\tconst ref = req.query.token || req.cookies[prismic.cookie.preview];\n\n\tif (ref) {\n\t\tres.setPreviewData({ ref });\n\t}\n}\n"],"names":[],"mappings":";SAgCgB,eAAe,EAAE,KAAK,OAA2B;AAChE,QAAM,MAAM,IAAI,MAAM,SAAS,IAAI,QAAQ,QAAQ,OAAO;AAE1D,MAAI,KAAK;AACJ,QAAA,eAAe,EAAE,IAAA,CAAK;AAAA,EAC1B;AACF;"}
@@ -0,0 +1,21 @@
1
+ import type { PreviewData, NextApiRequest } from "next";
2
+ import type { ClientConfig } from "@prismicio/client";
3
+ /**
4
+ * Configuration for creating a Prismic client with automatic preview support in
5
+ * Next.js apps.
6
+ */
7
+ export declare type CreateClientConfig = {
8
+ /**
9
+ * Preview data coming from Next.js context object. This context object comes
10
+ * from `getStaticProps` or `getServerSideProps`.
11
+ *
12
+ * Pass `previewData` when using outside a Next.js API endpoint.
13
+ */
14
+ previewData?: PreviewData;
15
+ /**
16
+ * A Next.js API endpoint request object.
17
+ *
18
+ * Pass a `req` object when using in a Next.js API endpoint.
19
+ */
20
+ req?: NextApiRequest;
21
+ } & ClientConfig;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prismicio/next",
3
- "version": "0.1.4",
3
+ "version": "0.1.6-alpha.0",
4
4
  "description": "Helpers to integrate Prismic into Next.js apps",
5
5
  "keywords": [
6
6
  "typescript",
@@ -16,18 +16,23 @@
16
16
  "license": "Apache-2.0",
17
17
  "author": "Prismic <contact@prismic.io> (https://prismic.io)",
18
18
  "sideEffects": false,
19
- "type": "module",
20
19
  "exports": {
21
- ".": "./dist/index.mjs"
20
+ ".": {
21
+ "require": "./dist/index.cjs",
22
+ "import": "./dist/index.js"
23
+ },
24
+ "./package.json": "./package.json"
22
25
  },
26
+ "main": "./dist/index.cjs",
27
+ "module": "./dist/index.js",
23
28
  "types": "dist/index.d.ts",
24
29
  "files": [
25
30
  "dist",
26
31
  "src"
27
32
  ],
28
33
  "scripts": {
29
- "build": "unbuild",
30
- "dev": "chokidar src --initial --command unbuild",
34
+ "build": "vite build",
35
+ "dev": "vite build --watch",
31
36
  "format": "prettier --write .",
32
37
  "lint": "eslint --ext .js,.ts .",
33
38
  "prepare": "npm run build",
@@ -41,10 +46,11 @@
41
46
  "unit:watch": "vitest watch"
42
47
  },
43
48
  "dependencies": {
44
- "@prismicio/client": "^6.7.1",
49
+ "@prismicio/client": "^6.0.0",
45
50
  "@prismicio/helpers": "^2.3.3",
46
51
  "@prismicio/react": "^2.5.0",
47
52
  "@prismicio/types": "^0.2.3",
53
+ "@rollup/plugin-typescript": "^8.5.0",
48
54
  "eslint-plugin-react": "^7.31.7",
49
55
  "eslint-plugin-react-hooks": "^4.6.0",
50
56
  "imgix-url-builder": "^0.0.3"
@@ -56,7 +62,6 @@
56
62
  "@typescript-eslint/eslint-plugin": "^5.36.2",
57
63
  "@typescript-eslint/parser": "^5.36.2",
58
64
  "@vitest/coverage-c8": "^0.23.1",
59
- "chokidar-cli": "^3.0.0",
60
65
  "eslint": "^8.23.0",
61
66
  "eslint-config-prettier": "^8.5.0",
62
67
  "eslint-plugin-prettier": "^4.2.1",
@@ -71,7 +76,7 @@
71
76
  "size-limit": "^8.1.0",
72
77
  "standard-version": "^9.5.0",
73
78
  "typescript": "^4.8.3",
74
- "unbuild": "^0.8.10",
79
+ "vite": "^3.1.1",
75
80
  "vitest": "^0.23.1"
76
81
  },
77
82
  "peerDependencies": {
@@ -1,60 +0,0 @@
1
- import { jsx } from 'react/jsx-runtime';
2
- import Image from 'next/image';
3
- import { buildURL } from 'imgix-url-builder';
4
- import * as prismicH from '@prismicio/helpers';
5
- import { __PRODUCTION__ } from './lib/__PRODUCTION__.mjs';
6
- import { devMsg } from './lib/devMsg.mjs';
7
-
8
- const imgixLoader = (args) => {
9
- const url = new URL(args.src);
10
- const params = {
11
- fit: url.searchParams.get("fit") || "max",
12
- w: args.width,
13
- h: void 0
14
- };
15
- if (args.quality) {
16
- params.q = args.quality;
17
- }
18
- return buildURL(args.src, params);
19
- };
20
- const PrismicNextImage = ({
21
- field,
22
- imgixParams = {},
23
- alt,
24
- fallbackAlt,
25
- layout,
26
- ...restProps
27
- }) => {
28
- if (!__PRODUCTION__) {
29
- if (typeof alt === "string" && alt !== "") {
30
- console.warn(
31
- `[PrismicNextImage] The "alt" prop can only be used to declare an image as decorative by passing an empty string (alt="") but was provided a non-empty string. You can resolve this warning by removing the "alt" prop or changing it to alt="". For more details, see ${devMsg(
32
- "alt-must-be-an-empty-string"
33
- )}`
34
- );
35
- }
36
- if (typeof fallbackAlt === "string" && fallbackAlt !== "") {
37
- console.warn(
38
- `[PrismicNextImage] The "fallbackAlt" prop can only be used to declare an image as decorative by passing an empty string (fallbackAlt="") but was provided a non-empty string. You can resolve this warning by removing the "fallbackAlt" prop or changing it to fallbackAlt="". For more details, see ${devMsg(
39
- "alt-must-be-an-empty-string"
40
- )}`
41
- );
42
- }
43
- }
44
- if (prismicH.isFilled.imageThumbnail(field)) {
45
- const src = buildURL(field.url, imgixParams);
46
- return /* @__PURE__ */ jsx(Image, {
47
- src,
48
- width: layout === "fill" ? void 0 : field.dimensions.width,
49
- height: layout === "fill" ? void 0 : field.dimensions.height,
50
- alt: alt ?? (field.alt || fallbackAlt),
51
- loader: imgixLoader,
52
- layout,
53
- ...restProps
54
- });
55
- } else {
56
- return null;
57
- }
58
- };
59
-
60
- export { PrismicNextImage };
package/dist/index.mjs DELETED
@@ -1,6 +0,0 @@
1
- export { setPreviewData } from './setPreviewData.mjs';
2
- export { exitPreview } from './exitPreview.mjs';
3
- export { PrismicPreview } from './PrismicPreview.mjs';
4
- export { enableAutoPreviews } from './enableAutoPreviews.mjs';
5
- export { redirectToPreviewURL } from './redirectToPreviewURL.mjs';
6
- export { PrismicNextImage } from './PrismicNextImage.mjs';
@@ -1,3 +0,0 @@
1
- const __PRODUCTION__ = process.env.NODE_ENV === "production";
2
-
3
- export { __PRODUCTION__ };
@@ -1,7 +0,0 @@
1
- import { version } from '../package.mjs';
2
-
3
- const devMsg = (slug) => {
4
- return `https://prismic.dev/msg/next/v${version}/${slug}`;
5
- };
6
-
7
- export { devMsg };
package/dist/package.mjs DELETED
@@ -1,3 +0,0 @@
1
- const version = "0.1.4";
2
-
3
- export { version };