@commercetools-demo/puck-renderer 0.1.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.
@@ -0,0 +1,59 @@
1
+ import React, { ReactElement } from 'react';
2
+ import { PuckData, PuckConfig } from '@commercetools-demo/puck-types';
3
+
4
+ interface PuckDataRendererProps {
5
+ /** The Puck Data to render (from the API or SSR props). */
6
+ data: PuckData;
7
+ /**
8
+ * The Puck Config that defines available components and their render functions.
9
+ * Must match the config used in the editor to ensure consistent output.
10
+ */
11
+ config: PuckConfig;
12
+ className?: string;
13
+ style?: React.CSSProperties;
14
+ }
15
+ /**
16
+ * SSR-friendly renderer — no data fetching, renders whatever Data you pass in.
17
+ * Wrap with PuckApiProvider only if you use it alongside API hooks.
18
+ */
19
+ declare const PuckDataRenderer: React.FC<PuckDataRendererProps>;
20
+
21
+ interface PuckRendererProps {
22
+ /**
23
+ * Whether to render a page or a content item. Defaults to 'page'.
24
+ * - 'page': use pageKey or slug to fetch
25
+ * - 'content': use contentKey or query (contentType) to fetch
26
+ */
27
+ type?: 'page' | 'content';
28
+ /**
29
+ * Service base URL. Can be omitted if a PuckApiProvider is already in the tree.
30
+ */
31
+ baseURL?: string;
32
+ /** CommerceTools project key. Can be omitted if provider is in tree. */
33
+ projectKey?: string;
34
+ /** Business unit key. Can be omitted if provider is in tree. */
35
+ businessUnitKey?: string;
36
+ /** [type=page] Fetch by page key. */
37
+ pageKey?: string;
38
+ /** [type=page] OR fetch by slug (URL path). */
39
+ slug?: string;
40
+ /** [type=content] Fetch by content key. */
41
+ contentKey?: string;
42
+ /** [type=content] OR fetch by contentType query string. */
43
+ query?: string;
44
+ /** 'published' (default) or 'preview' (draft || published). */
45
+ mode?: 'published' | 'preview';
46
+ /**
47
+ * Puck config — must match the config used in the editor.
48
+ */
49
+ config: PuckConfig;
50
+ /** Custom loading indicator. */
51
+ loadingComponent?: ReactElement;
52
+ /** Custom error display. */
53
+ errorComponent?: ReactElement;
54
+ className?: string;
55
+ style?: React.CSSProperties;
56
+ }
57
+ declare const PuckRenderer: React.FC<PuckRendererProps>;
58
+
59
+ export { PuckDataRenderer, type PuckDataRendererProps, PuckRenderer, type PuckRendererProps };
@@ -0,0 +1,59 @@
1
+ import React, { ReactElement } from 'react';
2
+ import { PuckData, PuckConfig } from '@commercetools-demo/puck-types';
3
+
4
+ interface PuckDataRendererProps {
5
+ /** The Puck Data to render (from the API or SSR props). */
6
+ data: PuckData;
7
+ /**
8
+ * The Puck Config that defines available components and their render functions.
9
+ * Must match the config used in the editor to ensure consistent output.
10
+ */
11
+ config: PuckConfig;
12
+ className?: string;
13
+ style?: React.CSSProperties;
14
+ }
15
+ /**
16
+ * SSR-friendly renderer — no data fetching, renders whatever Data you pass in.
17
+ * Wrap with PuckApiProvider only if you use it alongside API hooks.
18
+ */
19
+ declare const PuckDataRenderer: React.FC<PuckDataRendererProps>;
20
+
21
+ interface PuckRendererProps {
22
+ /**
23
+ * Whether to render a page or a content item. Defaults to 'page'.
24
+ * - 'page': use pageKey or slug to fetch
25
+ * - 'content': use contentKey or query (contentType) to fetch
26
+ */
27
+ type?: 'page' | 'content';
28
+ /**
29
+ * Service base URL. Can be omitted if a PuckApiProvider is already in the tree.
30
+ */
31
+ baseURL?: string;
32
+ /** CommerceTools project key. Can be omitted if provider is in tree. */
33
+ projectKey?: string;
34
+ /** Business unit key. Can be omitted if provider is in tree. */
35
+ businessUnitKey?: string;
36
+ /** [type=page] Fetch by page key. */
37
+ pageKey?: string;
38
+ /** [type=page] OR fetch by slug (URL path). */
39
+ slug?: string;
40
+ /** [type=content] Fetch by content key. */
41
+ contentKey?: string;
42
+ /** [type=content] OR fetch by contentType query string. */
43
+ query?: string;
44
+ /** 'published' (default) or 'preview' (draft || published). */
45
+ mode?: 'published' | 'preview';
46
+ /**
47
+ * Puck config — must match the config used in the editor.
48
+ */
49
+ config: PuckConfig;
50
+ /** Custom loading indicator. */
51
+ loadingComponent?: ReactElement;
52
+ /** Custom error display. */
53
+ errorComponent?: ReactElement;
54
+ className?: string;
55
+ style?: React.CSSProperties;
56
+ }
57
+ declare const PuckRenderer: React.FC<PuckRendererProps>;
58
+
59
+ export { PuckDataRenderer, type PuckDataRendererProps, PuckRenderer, type PuckRendererProps };
package/dist/index.js ADDED
@@ -0,0 +1,191 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+
20
+ // src/index.ts
21
+ var index_exports = {};
22
+ __export(index_exports, {
23
+ PuckDataRenderer: () => PuckDataRenderer,
24
+ PuckRenderer: () => PuckRenderer
25
+ });
26
+ module.exports = __toCommonJS(index_exports);
27
+
28
+ // src/PuckDataRenderer.tsx
29
+ var import_puck = require("@measured/puck");
30
+ var import_jsx_runtime = require("react/jsx-runtime");
31
+ var PuckDataRenderer = ({
32
+ data,
33
+ config,
34
+ className,
35
+ style
36
+ }) => {
37
+ return /* @__PURE__ */ (0, import_jsx_runtime.jsx)("div", { className, style, children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_puck.Render, { config, data }) });
38
+ };
39
+
40
+ // src/PuckRenderer.tsx
41
+ var import_react = require("react");
42
+ var import_puck_api = require("@commercetools-demo/puck-api");
43
+ var import_puck_api2 = require("@commercetools-demo/puck-api");
44
+ var import_jsx_runtime2 = require("react/jsx-runtime");
45
+ var PuckRendererInner = ({
46
+ type,
47
+ pageKey,
48
+ slug,
49
+ contentKey,
50
+ query,
51
+ mode,
52
+ config,
53
+ loadingComponent,
54
+ errorComponent,
55
+ className,
56
+ style
57
+ }) => {
58
+ const { baseURL, projectKey, businessUnitKey } = (0, import_puck_api.usePuckApiContext)();
59
+ const [data, setData] = (0, import_react.useState)(null);
60
+ const [loading, setLoading] = (0, import_react.useState)(true);
61
+ const [error, setError] = (0, import_react.useState)(null);
62
+ (0, import_react.useEffect)(() => {
63
+ let cancelled = false;
64
+ const fetchData = async () => {
65
+ setLoading(true);
66
+ setError(null);
67
+ try {
68
+ if (type === "content") {
69
+ let puckData = null;
70
+ if (contentKey) {
71
+ const value = mode === "published" ? await (0, import_puck_api2.getPublishedPuckContentApi)(baseURL, projectKey, businessUnitKey, contentKey) : await (0, import_puck_api2.getPreviewPuckContentApi)(baseURL, projectKey, businessUnitKey, contentKey);
72
+ puckData = value.data;
73
+ } else if (query) {
74
+ const value = await (0, import_puck_api2.queryPuckContentApi)(baseURL, projectKey, businessUnitKey, query, mode);
75
+ puckData = value?.data ?? null;
76
+ }
77
+ if (!cancelled) {
78
+ if (puckData) {
79
+ setData(puckData);
80
+ } else {
81
+ setError("Content not found");
82
+ }
83
+ }
84
+ } else {
85
+ let pageValue = null;
86
+ if (pageKey) {
87
+ pageValue = mode === "published" ? await (0, import_puck_api2.getPublishedPuckPageApi)(baseURL, projectKey, businessUnitKey, pageKey) : await (0, import_puck_api2.getPreviewPuckPageApi)(baseURL, projectKey, businessUnitKey, pageKey);
88
+ } else if (slug) {
89
+ pageValue = await (0, import_puck_api2.queryPuckPageApi)(baseURL, projectKey, businessUnitKey, slug, mode);
90
+ }
91
+ if (!cancelled) {
92
+ if (pageValue) {
93
+ setData(pageValue.puckData);
94
+ } else {
95
+ setError("Page not found");
96
+ }
97
+ }
98
+ }
99
+ } catch (err) {
100
+ if (!cancelled) setError(err.message);
101
+ } finally {
102
+ if (!cancelled) setLoading(false);
103
+ }
104
+ };
105
+ void fetchData();
106
+ return () => {
107
+ cancelled = true;
108
+ };
109
+ }, [baseURL, projectKey, businessUnitKey, type, pageKey, slug, contentKey, query, mode]);
110
+ if (loading) {
111
+ return loadingComponent ?? /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
112
+ "div",
113
+ {
114
+ style: {
115
+ display: "flex",
116
+ alignItems: "center",
117
+ justifyContent: "center",
118
+ padding: "64px",
119
+ color: "#6b7280"
120
+ },
121
+ children: "Loading\u2026"
122
+ }
123
+ );
124
+ }
125
+ if (error || !data) {
126
+ return errorComponent ?? /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
127
+ "div",
128
+ {
129
+ style: {
130
+ padding: "32px",
131
+ color: "#dc2626",
132
+ background: "#fef2f2",
133
+ borderRadius: "8px"
134
+ },
135
+ children: error ?? "Failed to load"
136
+ }
137
+ );
138
+ }
139
+ return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(PuckDataRenderer, { data, config, className, style });
140
+ };
141
+ var PuckRenderer = ({
142
+ type = "page",
143
+ baseURL,
144
+ projectKey,
145
+ businessUnitKey,
146
+ pageKey,
147
+ slug,
148
+ contentKey,
149
+ query,
150
+ mode = "published",
151
+ config,
152
+ loadingComponent,
153
+ errorComponent,
154
+ className,
155
+ style
156
+ }) => {
157
+ const inner = /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
158
+ PuckRendererInner,
159
+ {
160
+ type,
161
+ pageKey,
162
+ slug,
163
+ contentKey,
164
+ query,
165
+ mode,
166
+ config,
167
+ loadingComponent,
168
+ errorComponent,
169
+ className,
170
+ style
171
+ }
172
+ );
173
+ if (baseURL && projectKey && businessUnitKey) {
174
+ return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
175
+ import_puck_api.PuckApiProvider,
176
+ {
177
+ baseURL,
178
+ projectKey,
179
+ businessUnitKey,
180
+ children: inner
181
+ }
182
+ );
183
+ }
184
+ return inner;
185
+ };
186
+ // Annotate the CommonJS export names for ESM import in node:
187
+ 0 && (module.exports = {
188
+ PuckDataRenderer,
189
+ PuckRenderer
190
+ });
191
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/PuckDataRenderer.tsx","../src/PuckRenderer.tsx"],"sourcesContent":["export { PuckDataRenderer } from './PuckDataRenderer';\nexport type { PuckDataRendererProps } from './PuckDataRenderer';\n\nexport { PuckRenderer } from './PuckRenderer';\nexport type { PuckRendererProps } from './PuckRenderer';\n","import React from 'react';\nimport { Render } from '@measured/puck';\nimport type { Config, Data } from '@measured/puck';\nimport type { PuckData, PuckConfig } from '@commercetools-demo/puck-types';\n\nexport interface PuckDataRendererProps {\n /** The Puck Data to render (from the API or SSR props). */\n data: PuckData;\n /**\n * The Puck Config that defines available components and their render functions.\n * Must match the config used in the editor to ensure consistent output.\n */\n config: PuckConfig;\n className?: string;\n style?: React.CSSProperties;\n}\n\n/**\n * SSR-friendly renderer — no data fetching, renders whatever Data you pass in.\n * Wrap with PuckApiProvider only if you use it alongside API hooks.\n */\nexport const PuckDataRenderer: React.FC<PuckDataRendererProps> = ({\n data,\n config,\n className,\n style,\n}) => {\n return (\n <div className={className} style={style}>\n <Render config={config as Config} data={data as Data} />\n </div>\n );\n};\n","import React, { useEffect, useState, type ReactElement } from 'react';\nimport { PuckApiProvider, usePuckApiContext } from '@commercetools-demo/puck-api';\nimport {\n getPublishedPuckPageApi,\n getPreviewPuckPageApi,\n queryPuckPageApi,\n getPublishedPuckContentApi,\n getPreviewPuckContentApi,\n queryPuckContentApi,\n} from '@commercetools-demo/puck-api';\nimport type { PuckConfig, PuckData } from '@commercetools-demo/puck-types';\nimport { PuckDataRenderer } from './PuckDataRenderer';\n\n// ---------------------------------------------------------------------------\n// Inner component (needs PuckApiContext)\n// ---------------------------------------------------------------------------\n\ninterface PuckRendererInnerProps {\n type: 'page' | 'content';\n pageKey?: string;\n slug?: string;\n contentKey?: string;\n query?: string;\n mode: 'published' | 'preview';\n config: PuckConfig;\n loadingComponent?: ReactElement;\n errorComponent?: ReactElement;\n className?: string;\n style?: React.CSSProperties;\n}\n\nconst PuckRendererInner: React.FC<PuckRendererInnerProps> = ({\n type,\n pageKey,\n slug,\n contentKey,\n query,\n mode,\n config,\n loadingComponent,\n errorComponent,\n className,\n style,\n}) => {\n const { baseURL, projectKey, businessUnitKey } = usePuckApiContext();\n\n const [data, setData] = useState<PuckData | null>(null);\n const [loading, setLoading] = useState(true);\n const [error, setError] = useState<string | null>(null);\n\n useEffect(() => {\n let cancelled = false;\n\n const fetchData = async () => {\n setLoading(true);\n setError(null);\n\n try {\n if (type === 'content') {\n let puckData: PuckData | null = null;\n\n if (contentKey) {\n const value =\n mode === 'published'\n ? await getPublishedPuckContentApi(baseURL, projectKey, businessUnitKey, contentKey)\n : await getPreviewPuckContentApi(baseURL, projectKey, businessUnitKey, contentKey);\n puckData = value.data;\n } else if (query) {\n const value = await queryPuckContentApi(baseURL, projectKey, businessUnitKey, query, mode);\n puckData = value?.data ?? null;\n }\n\n if (!cancelled) {\n if (puckData) {\n setData(puckData);\n } else {\n setError('Content not found');\n }\n }\n } else {\n // type === 'page'\n let pageValue = null;\n\n if (pageKey) {\n pageValue =\n mode === 'published'\n ? await getPublishedPuckPageApi(baseURL, projectKey, businessUnitKey, pageKey)\n : await getPreviewPuckPageApi(baseURL, projectKey, businessUnitKey, pageKey);\n } else if (slug) {\n pageValue = await queryPuckPageApi(baseURL, projectKey, businessUnitKey, slug, mode);\n }\n\n if (!cancelled) {\n if (pageValue) {\n setData(pageValue.puckData);\n } else {\n setError('Page not found');\n }\n }\n }\n } catch (err) {\n if (!cancelled) setError((err as Error).message);\n } finally {\n if (!cancelled) setLoading(false);\n }\n };\n\n void fetchData();\n return () => {\n cancelled = true;\n };\n }, [baseURL, projectKey, businessUnitKey, type, pageKey, slug, contentKey, query, mode]);\n\n if (loading) {\n return (\n loadingComponent ?? (\n <div\n style={{\n display: 'flex',\n alignItems: 'center',\n justifyContent: 'center',\n padding: '64px',\n color: '#6b7280',\n }}\n >\n Loading…\n </div>\n )\n );\n }\n\n if (error || !data) {\n return (\n errorComponent ?? (\n <div\n style={{\n padding: '32px',\n color: '#dc2626',\n background: '#fef2f2',\n borderRadius: '8px',\n }}\n >\n {error ?? 'Failed to load'}\n </div>\n )\n );\n }\n\n return <PuckDataRenderer data={data} config={config} className={className} style={style} />;\n};\n\n// ---------------------------------------------------------------------------\n// Public component\n// ---------------------------------------------------------------------------\n\nexport interface PuckRendererProps {\n /**\n * Whether to render a page or a content item. Defaults to 'page'.\n * - 'page': use pageKey or slug to fetch\n * - 'content': use contentKey or query (contentType) to fetch\n */\n type?: 'page' | 'content';\n\n /**\n * Service base URL. Can be omitted if a PuckApiProvider is already in the tree.\n */\n baseURL?: string;\n /** CommerceTools project key. Can be omitted if provider is in tree. */\n projectKey?: string;\n /** Business unit key. Can be omitted if provider is in tree. */\n businessUnitKey?: string;\n\n /** [type=page] Fetch by page key. */\n pageKey?: string;\n /** [type=page] OR fetch by slug (URL path). */\n slug?: string;\n\n /** [type=content] Fetch by content key. */\n contentKey?: string;\n /** [type=content] OR fetch by contentType query string. */\n query?: string;\n\n /** 'published' (default) or 'preview' (draft || published). */\n mode?: 'published' | 'preview';\n\n /**\n * Puck config — must match the config used in the editor.\n */\n config: PuckConfig;\n\n /** Custom loading indicator. */\n loadingComponent?: ReactElement;\n /** Custom error display. */\n errorComponent?: ReactElement;\n\n className?: string;\n style?: React.CSSProperties;\n}\n\nexport const PuckRenderer: React.FC<PuckRendererProps> = ({\n type = 'page',\n baseURL,\n projectKey,\n businessUnitKey,\n pageKey,\n slug,\n contentKey,\n query,\n mode = 'published',\n config,\n loadingComponent,\n errorComponent,\n className,\n style,\n}) => {\n const inner = (\n <PuckRendererInner\n type={type}\n pageKey={pageKey}\n slug={slug}\n contentKey={contentKey}\n query={query}\n mode={mode}\n config={config}\n loadingComponent={loadingComponent}\n errorComponent={errorComponent}\n className={className}\n style={style}\n />\n );\n\n if (baseURL && projectKey && businessUnitKey) {\n return (\n <PuckApiProvider\n baseURL={baseURL}\n projectKey={projectKey}\n businessUnitKey={businessUnitKey}\n >\n {inner}\n </PuckApiProvider>\n );\n }\n\n return inner;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,kBAAuB;AA4BjB;AARC,IAAM,mBAAoD,CAAC;AAAA,EAChE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAAM;AACJ,SACE,4CAAC,SAAI,WAAsB,OACzB,sDAAC,sBAAO,QAA0B,MAAoB,GACxD;AAEJ;;;AChCA,mBAA8D;AAC9D,sBAAmD;AACnD,IAAAA,mBAOO;AA2GC,IAAAC,sBAAA;AArFR,IAAM,oBAAsD,CAAC;AAAA,EAC3D;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAAM;AACJ,QAAM,EAAE,SAAS,YAAY,gBAAgB,QAAI,mCAAkB;AAEnE,QAAM,CAAC,MAAM,OAAO,QAAI,uBAA0B,IAAI;AACtD,QAAM,CAAC,SAAS,UAAU,QAAI,uBAAS,IAAI;AAC3C,QAAM,CAAC,OAAO,QAAQ,QAAI,uBAAwB,IAAI;AAEtD,8BAAU,MAAM;AACd,QAAI,YAAY;AAEhB,UAAM,YAAY,YAAY;AAC5B,iBAAW,IAAI;AACf,eAAS,IAAI;AAEb,UAAI;AACF,YAAI,SAAS,WAAW;AACtB,cAAI,WAA4B;AAEhC,cAAI,YAAY;AACd,kBAAM,QACJ,SAAS,cACL,UAAM,6CAA2B,SAAS,YAAY,iBAAiB,UAAU,IACjF,UAAM,2CAAyB,SAAS,YAAY,iBAAiB,UAAU;AACrF,uBAAW,MAAM;AAAA,UACnB,WAAW,OAAO;AAChB,kBAAM,QAAQ,UAAM,sCAAoB,SAAS,YAAY,iBAAiB,OAAO,IAAI;AACzF,uBAAW,OAAO,QAAQ;AAAA,UAC5B;AAEA,cAAI,CAAC,WAAW;AACd,gBAAI,UAAU;AACZ,sBAAQ,QAAQ;AAAA,YAClB,OAAO;AACL,uBAAS,mBAAmB;AAAA,YAC9B;AAAA,UACF;AAAA,QACF,OAAO;AAEL,cAAI,YAAY;AAEhB,cAAI,SAAS;AACX,wBACE,SAAS,cACL,UAAM,0CAAwB,SAAS,YAAY,iBAAiB,OAAO,IAC3E,UAAM,wCAAsB,SAAS,YAAY,iBAAiB,OAAO;AAAA,UACjF,WAAW,MAAM;AACf,wBAAY,UAAM,mCAAiB,SAAS,YAAY,iBAAiB,MAAM,IAAI;AAAA,UACrF;AAEA,cAAI,CAAC,WAAW;AACd,gBAAI,WAAW;AACb,sBAAQ,UAAU,QAAQ;AAAA,YAC5B,OAAO;AACL,uBAAS,gBAAgB;AAAA,YAC3B;AAAA,UACF;AAAA,QACF;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,CAAC,UAAW,UAAU,IAAc,OAAO;AAAA,MACjD,UAAE;AACA,YAAI,CAAC,UAAW,YAAW,KAAK;AAAA,MAClC;AAAA,IACF;AAEA,SAAK,UAAU;AACf,WAAO,MAAM;AACX,kBAAY;AAAA,IACd;AAAA,EACF,GAAG,CAAC,SAAS,YAAY,iBAAiB,MAAM,SAAS,MAAM,YAAY,OAAO,IAAI,CAAC;AAEvF,MAAI,SAAS;AACX,WACE,oBACE;AAAA,MAAC;AAAA;AAAA,QACC,OAAO;AAAA,UACL,SAAS;AAAA,UACT,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,SAAS;AAAA,UACT,OAAO;AAAA,QACT;AAAA,QACD;AAAA;AAAA,IAED;AAAA,EAGN;AAEA,MAAI,SAAS,CAAC,MAAM;AAClB,WACE,kBACE;AAAA,MAAC;AAAA;AAAA,QACC,OAAO;AAAA,UACL,SAAS;AAAA,UACT,OAAO;AAAA,UACP,YAAY;AAAA,UACZ,cAAc;AAAA,QAChB;AAAA,QAEC,mBAAS;AAAA;AAAA,IACZ;AAAA,EAGN;AAEA,SAAO,6CAAC,oBAAiB,MAAY,QAAgB,WAAsB,OAAc;AAC3F;AAkDO,IAAM,eAA4C,CAAC;AAAA,EACxD,OAAO;AAAA,EACP;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,OAAO;AAAA,EACP;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAAM;AACJ,QAAM,QACJ;AAAA,IAAC;AAAA;AAAA,MACC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,EACF;AAGF,MAAI,WAAW,cAAc,iBAAiB;AAC5C,WACE;AAAA,MAAC;AAAA;AAAA,QACC;AAAA,QACA;AAAA,QACA;AAAA,QAEC;AAAA;AAAA,IACH;AAAA,EAEJ;AAEA,SAAO;AACT;","names":["import_puck_api","import_jsx_runtime"]}
package/dist/index.mjs ADDED
@@ -0,0 +1,170 @@
1
+ // src/PuckDataRenderer.tsx
2
+ import { Render } from "@measured/puck";
3
+ import { jsx } from "react/jsx-runtime";
4
+ var PuckDataRenderer = ({
5
+ data,
6
+ config,
7
+ className,
8
+ style
9
+ }) => {
10
+ return /* @__PURE__ */ jsx("div", { className, style, children: /* @__PURE__ */ jsx(Render, { config, data }) });
11
+ };
12
+
13
+ // src/PuckRenderer.tsx
14
+ import { useEffect, useState } from "react";
15
+ import { PuckApiProvider, usePuckApiContext } from "@commercetools-demo/puck-api";
16
+ import {
17
+ getPublishedPuckPageApi,
18
+ getPreviewPuckPageApi,
19
+ queryPuckPageApi,
20
+ getPublishedPuckContentApi,
21
+ getPreviewPuckContentApi,
22
+ queryPuckContentApi
23
+ } from "@commercetools-demo/puck-api";
24
+ import { jsx as jsx2 } from "react/jsx-runtime";
25
+ var PuckRendererInner = ({
26
+ type,
27
+ pageKey,
28
+ slug,
29
+ contentKey,
30
+ query,
31
+ mode,
32
+ config,
33
+ loadingComponent,
34
+ errorComponent,
35
+ className,
36
+ style
37
+ }) => {
38
+ const { baseURL, projectKey, businessUnitKey } = usePuckApiContext();
39
+ const [data, setData] = useState(null);
40
+ const [loading, setLoading] = useState(true);
41
+ const [error, setError] = useState(null);
42
+ useEffect(() => {
43
+ let cancelled = false;
44
+ const fetchData = async () => {
45
+ setLoading(true);
46
+ setError(null);
47
+ try {
48
+ if (type === "content") {
49
+ let puckData = null;
50
+ if (contentKey) {
51
+ const value = mode === "published" ? await getPublishedPuckContentApi(baseURL, projectKey, businessUnitKey, contentKey) : await getPreviewPuckContentApi(baseURL, projectKey, businessUnitKey, contentKey);
52
+ puckData = value.data;
53
+ } else if (query) {
54
+ const value = await queryPuckContentApi(baseURL, projectKey, businessUnitKey, query, mode);
55
+ puckData = value?.data ?? null;
56
+ }
57
+ if (!cancelled) {
58
+ if (puckData) {
59
+ setData(puckData);
60
+ } else {
61
+ setError("Content not found");
62
+ }
63
+ }
64
+ } else {
65
+ let pageValue = null;
66
+ if (pageKey) {
67
+ pageValue = mode === "published" ? await getPublishedPuckPageApi(baseURL, projectKey, businessUnitKey, pageKey) : await getPreviewPuckPageApi(baseURL, projectKey, businessUnitKey, pageKey);
68
+ } else if (slug) {
69
+ pageValue = await queryPuckPageApi(baseURL, projectKey, businessUnitKey, slug, mode);
70
+ }
71
+ if (!cancelled) {
72
+ if (pageValue) {
73
+ setData(pageValue.puckData);
74
+ } else {
75
+ setError("Page not found");
76
+ }
77
+ }
78
+ }
79
+ } catch (err) {
80
+ if (!cancelled) setError(err.message);
81
+ } finally {
82
+ if (!cancelled) setLoading(false);
83
+ }
84
+ };
85
+ void fetchData();
86
+ return () => {
87
+ cancelled = true;
88
+ };
89
+ }, [baseURL, projectKey, businessUnitKey, type, pageKey, slug, contentKey, query, mode]);
90
+ if (loading) {
91
+ return loadingComponent ?? /* @__PURE__ */ jsx2(
92
+ "div",
93
+ {
94
+ style: {
95
+ display: "flex",
96
+ alignItems: "center",
97
+ justifyContent: "center",
98
+ padding: "64px",
99
+ color: "#6b7280"
100
+ },
101
+ children: "Loading\u2026"
102
+ }
103
+ );
104
+ }
105
+ if (error || !data) {
106
+ return errorComponent ?? /* @__PURE__ */ jsx2(
107
+ "div",
108
+ {
109
+ style: {
110
+ padding: "32px",
111
+ color: "#dc2626",
112
+ background: "#fef2f2",
113
+ borderRadius: "8px"
114
+ },
115
+ children: error ?? "Failed to load"
116
+ }
117
+ );
118
+ }
119
+ return /* @__PURE__ */ jsx2(PuckDataRenderer, { data, config, className, style });
120
+ };
121
+ var PuckRenderer = ({
122
+ type = "page",
123
+ baseURL,
124
+ projectKey,
125
+ businessUnitKey,
126
+ pageKey,
127
+ slug,
128
+ contentKey,
129
+ query,
130
+ mode = "published",
131
+ config,
132
+ loadingComponent,
133
+ errorComponent,
134
+ className,
135
+ style
136
+ }) => {
137
+ const inner = /* @__PURE__ */ jsx2(
138
+ PuckRendererInner,
139
+ {
140
+ type,
141
+ pageKey,
142
+ slug,
143
+ contentKey,
144
+ query,
145
+ mode,
146
+ config,
147
+ loadingComponent,
148
+ errorComponent,
149
+ className,
150
+ style
151
+ }
152
+ );
153
+ if (baseURL && projectKey && businessUnitKey) {
154
+ return /* @__PURE__ */ jsx2(
155
+ PuckApiProvider,
156
+ {
157
+ baseURL,
158
+ projectKey,
159
+ businessUnitKey,
160
+ children: inner
161
+ }
162
+ );
163
+ }
164
+ return inner;
165
+ };
166
+ export {
167
+ PuckDataRenderer,
168
+ PuckRenderer
169
+ };
170
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/PuckDataRenderer.tsx","../src/PuckRenderer.tsx"],"sourcesContent":["import React from 'react';\nimport { Render } from '@measured/puck';\nimport type { Config, Data } from '@measured/puck';\nimport type { PuckData, PuckConfig } from '@commercetools-demo/puck-types';\n\nexport interface PuckDataRendererProps {\n /** The Puck Data to render (from the API or SSR props). */\n data: PuckData;\n /**\n * The Puck Config that defines available components and their render functions.\n * Must match the config used in the editor to ensure consistent output.\n */\n config: PuckConfig;\n className?: string;\n style?: React.CSSProperties;\n}\n\n/**\n * SSR-friendly renderer — no data fetching, renders whatever Data you pass in.\n * Wrap with PuckApiProvider only if you use it alongside API hooks.\n */\nexport const PuckDataRenderer: React.FC<PuckDataRendererProps> = ({\n data,\n config,\n className,\n style,\n}) => {\n return (\n <div className={className} style={style}>\n <Render config={config as Config} data={data as Data} />\n </div>\n );\n};\n","import React, { useEffect, useState, type ReactElement } from 'react';\nimport { PuckApiProvider, usePuckApiContext } from '@commercetools-demo/puck-api';\nimport {\n getPublishedPuckPageApi,\n getPreviewPuckPageApi,\n queryPuckPageApi,\n getPublishedPuckContentApi,\n getPreviewPuckContentApi,\n queryPuckContentApi,\n} from '@commercetools-demo/puck-api';\nimport type { PuckConfig, PuckData } from '@commercetools-demo/puck-types';\nimport { PuckDataRenderer } from './PuckDataRenderer';\n\n// ---------------------------------------------------------------------------\n// Inner component (needs PuckApiContext)\n// ---------------------------------------------------------------------------\n\ninterface PuckRendererInnerProps {\n type: 'page' | 'content';\n pageKey?: string;\n slug?: string;\n contentKey?: string;\n query?: string;\n mode: 'published' | 'preview';\n config: PuckConfig;\n loadingComponent?: ReactElement;\n errorComponent?: ReactElement;\n className?: string;\n style?: React.CSSProperties;\n}\n\nconst PuckRendererInner: React.FC<PuckRendererInnerProps> = ({\n type,\n pageKey,\n slug,\n contentKey,\n query,\n mode,\n config,\n loadingComponent,\n errorComponent,\n className,\n style,\n}) => {\n const { baseURL, projectKey, businessUnitKey } = usePuckApiContext();\n\n const [data, setData] = useState<PuckData | null>(null);\n const [loading, setLoading] = useState(true);\n const [error, setError] = useState<string | null>(null);\n\n useEffect(() => {\n let cancelled = false;\n\n const fetchData = async () => {\n setLoading(true);\n setError(null);\n\n try {\n if (type === 'content') {\n let puckData: PuckData | null = null;\n\n if (contentKey) {\n const value =\n mode === 'published'\n ? await getPublishedPuckContentApi(baseURL, projectKey, businessUnitKey, contentKey)\n : await getPreviewPuckContentApi(baseURL, projectKey, businessUnitKey, contentKey);\n puckData = value.data;\n } else if (query) {\n const value = await queryPuckContentApi(baseURL, projectKey, businessUnitKey, query, mode);\n puckData = value?.data ?? null;\n }\n\n if (!cancelled) {\n if (puckData) {\n setData(puckData);\n } else {\n setError('Content not found');\n }\n }\n } else {\n // type === 'page'\n let pageValue = null;\n\n if (pageKey) {\n pageValue =\n mode === 'published'\n ? await getPublishedPuckPageApi(baseURL, projectKey, businessUnitKey, pageKey)\n : await getPreviewPuckPageApi(baseURL, projectKey, businessUnitKey, pageKey);\n } else if (slug) {\n pageValue = await queryPuckPageApi(baseURL, projectKey, businessUnitKey, slug, mode);\n }\n\n if (!cancelled) {\n if (pageValue) {\n setData(pageValue.puckData);\n } else {\n setError('Page not found');\n }\n }\n }\n } catch (err) {\n if (!cancelled) setError((err as Error).message);\n } finally {\n if (!cancelled) setLoading(false);\n }\n };\n\n void fetchData();\n return () => {\n cancelled = true;\n };\n }, [baseURL, projectKey, businessUnitKey, type, pageKey, slug, contentKey, query, mode]);\n\n if (loading) {\n return (\n loadingComponent ?? (\n <div\n style={{\n display: 'flex',\n alignItems: 'center',\n justifyContent: 'center',\n padding: '64px',\n color: '#6b7280',\n }}\n >\n Loading…\n </div>\n )\n );\n }\n\n if (error || !data) {\n return (\n errorComponent ?? (\n <div\n style={{\n padding: '32px',\n color: '#dc2626',\n background: '#fef2f2',\n borderRadius: '8px',\n }}\n >\n {error ?? 'Failed to load'}\n </div>\n )\n );\n }\n\n return <PuckDataRenderer data={data} config={config} className={className} style={style} />;\n};\n\n// ---------------------------------------------------------------------------\n// Public component\n// ---------------------------------------------------------------------------\n\nexport interface PuckRendererProps {\n /**\n * Whether to render a page or a content item. Defaults to 'page'.\n * - 'page': use pageKey or slug to fetch\n * - 'content': use contentKey or query (contentType) to fetch\n */\n type?: 'page' | 'content';\n\n /**\n * Service base URL. Can be omitted if a PuckApiProvider is already in the tree.\n */\n baseURL?: string;\n /** CommerceTools project key. Can be omitted if provider is in tree. */\n projectKey?: string;\n /** Business unit key. Can be omitted if provider is in tree. */\n businessUnitKey?: string;\n\n /** [type=page] Fetch by page key. */\n pageKey?: string;\n /** [type=page] OR fetch by slug (URL path). */\n slug?: string;\n\n /** [type=content] Fetch by content key. */\n contentKey?: string;\n /** [type=content] OR fetch by contentType query string. */\n query?: string;\n\n /** 'published' (default) or 'preview' (draft || published). */\n mode?: 'published' | 'preview';\n\n /**\n * Puck config — must match the config used in the editor.\n */\n config: PuckConfig;\n\n /** Custom loading indicator. */\n loadingComponent?: ReactElement;\n /** Custom error display. */\n errorComponent?: ReactElement;\n\n className?: string;\n style?: React.CSSProperties;\n}\n\nexport const PuckRenderer: React.FC<PuckRendererProps> = ({\n type = 'page',\n baseURL,\n projectKey,\n businessUnitKey,\n pageKey,\n slug,\n contentKey,\n query,\n mode = 'published',\n config,\n loadingComponent,\n errorComponent,\n className,\n style,\n}) => {\n const inner = (\n <PuckRendererInner\n type={type}\n pageKey={pageKey}\n slug={slug}\n contentKey={contentKey}\n query={query}\n mode={mode}\n config={config}\n loadingComponent={loadingComponent}\n errorComponent={errorComponent}\n className={className}\n style={style}\n />\n );\n\n if (baseURL && projectKey && businessUnitKey) {\n return (\n <PuckApiProvider\n baseURL={baseURL}\n projectKey={projectKey}\n businessUnitKey={businessUnitKey}\n >\n {inner}\n </PuckApiProvider>\n );\n }\n\n return inner;\n};\n"],"mappings":";AACA,SAAS,cAAc;AA4BjB;AARC,IAAM,mBAAoD,CAAC;AAAA,EAChE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAAM;AACJ,SACE,oBAAC,SAAI,WAAsB,OACzB,8BAAC,UAAO,QAA0B,MAAoB,GACxD;AAEJ;;;AChCA,SAAgB,WAAW,gBAAmC;AAC9D,SAAS,iBAAiB,yBAAyB;AACnD;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AA2GC,gBAAAA,YAAA;AArFR,IAAM,oBAAsD,CAAC;AAAA,EAC3D;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAAM;AACJ,QAAM,EAAE,SAAS,YAAY,gBAAgB,IAAI,kBAAkB;AAEnE,QAAM,CAAC,MAAM,OAAO,IAAI,SAA0B,IAAI;AACtD,QAAM,CAAC,SAAS,UAAU,IAAI,SAAS,IAAI;AAC3C,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAwB,IAAI;AAEtD,YAAU,MAAM;AACd,QAAI,YAAY;AAEhB,UAAM,YAAY,YAAY;AAC5B,iBAAW,IAAI;AACf,eAAS,IAAI;AAEb,UAAI;AACF,YAAI,SAAS,WAAW;AACtB,cAAI,WAA4B;AAEhC,cAAI,YAAY;AACd,kBAAM,QACJ,SAAS,cACL,MAAM,2BAA2B,SAAS,YAAY,iBAAiB,UAAU,IACjF,MAAM,yBAAyB,SAAS,YAAY,iBAAiB,UAAU;AACrF,uBAAW,MAAM;AAAA,UACnB,WAAW,OAAO;AAChB,kBAAM,QAAQ,MAAM,oBAAoB,SAAS,YAAY,iBAAiB,OAAO,IAAI;AACzF,uBAAW,OAAO,QAAQ;AAAA,UAC5B;AAEA,cAAI,CAAC,WAAW;AACd,gBAAI,UAAU;AACZ,sBAAQ,QAAQ;AAAA,YAClB,OAAO;AACL,uBAAS,mBAAmB;AAAA,YAC9B;AAAA,UACF;AAAA,QACF,OAAO;AAEL,cAAI,YAAY;AAEhB,cAAI,SAAS;AACX,wBACE,SAAS,cACL,MAAM,wBAAwB,SAAS,YAAY,iBAAiB,OAAO,IAC3E,MAAM,sBAAsB,SAAS,YAAY,iBAAiB,OAAO;AAAA,UACjF,WAAW,MAAM;AACf,wBAAY,MAAM,iBAAiB,SAAS,YAAY,iBAAiB,MAAM,IAAI;AAAA,UACrF;AAEA,cAAI,CAAC,WAAW;AACd,gBAAI,WAAW;AACb,sBAAQ,UAAU,QAAQ;AAAA,YAC5B,OAAO;AACL,uBAAS,gBAAgB;AAAA,YAC3B;AAAA,UACF;AAAA,QACF;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,CAAC,UAAW,UAAU,IAAc,OAAO;AAAA,MACjD,UAAE;AACA,YAAI,CAAC,UAAW,YAAW,KAAK;AAAA,MAClC;AAAA,IACF;AAEA,SAAK,UAAU;AACf,WAAO,MAAM;AACX,kBAAY;AAAA,IACd;AAAA,EACF,GAAG,CAAC,SAAS,YAAY,iBAAiB,MAAM,SAAS,MAAM,YAAY,OAAO,IAAI,CAAC;AAEvF,MAAI,SAAS;AACX,WACE,oBACE,gBAAAA;AAAA,MAAC;AAAA;AAAA,QACC,OAAO;AAAA,UACL,SAAS;AAAA,UACT,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,SAAS;AAAA,UACT,OAAO;AAAA,QACT;AAAA,QACD;AAAA;AAAA,IAED;AAAA,EAGN;AAEA,MAAI,SAAS,CAAC,MAAM;AAClB,WACE,kBACE,gBAAAA;AAAA,MAAC;AAAA;AAAA,QACC,OAAO;AAAA,UACL,SAAS;AAAA,UACT,OAAO;AAAA,UACP,YAAY;AAAA,UACZ,cAAc;AAAA,QAChB;AAAA,QAEC,mBAAS;AAAA;AAAA,IACZ;AAAA,EAGN;AAEA,SAAO,gBAAAA,KAAC,oBAAiB,MAAY,QAAgB,WAAsB,OAAc;AAC3F;AAkDO,IAAM,eAA4C,CAAC;AAAA,EACxD,OAAO;AAAA,EACP;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,OAAO;AAAA,EACP;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAAM;AACJ,QAAM,QACJ,gBAAAA;AAAA,IAAC;AAAA;AAAA,MACC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,EACF;AAGF,MAAI,WAAW,cAAc,iBAAiB;AAC5C,WACE,gBAAAA;AAAA,MAAC;AAAA;AAAA,QACC;AAAA,QACA;AAAA,QACA;AAAA,QAEC;AAAA;AAAA,IACH;AAAA,EAEJ;AAEA,SAAO;AACT;","names":["jsx"]}
package/package.json ADDED
@@ -0,0 +1,42 @@
1
+ {
2
+ "name": "@commercetools-demo/puck-renderer",
3
+ "version": "0.1.0",
4
+ "description": "Lightweight Puck page renderer for storefronts",
5
+ "main": "dist/index.js",
6
+ "module": "dist/index.mjs",
7
+ "types": "dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.mjs",
12
+ "require": "./dist/index.js"
13
+ }
14
+ },
15
+ "files": [
16
+ "dist",
17
+ "package.json"
18
+ ],
19
+ "publishConfig": {
20
+ "access": "public"
21
+ },
22
+ "scripts": {
23
+ "build": "tsup",
24
+ "build:watch": "tsup --watch",
25
+ "typecheck": "tsc --noEmit"
26
+ },
27
+ "dependencies": {
28
+ "@commercetools-demo/puck-api": "^0.1.0",
29
+ "@commercetools-demo/puck-types": "^0.1.0",
30
+ "@measured/puck": "^0.18.2"
31
+ },
32
+ "peerDependencies": {
33
+ "react": ">=19.0.0",
34
+ "react-dom": ">=19.0.0"
35
+ },
36
+ "devDependencies": {
37
+ "@types/react": "^18",
38
+ "@types/react-dom": "^18",
39
+ "tsup": "^8.3.0",
40
+ "typescript": "^5.7.2"
41
+ }
42
+ }