Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
bridge.on",id:"bridgeon",level:3},{value:"bridge.notification",id:"bridgenotification",level:3},{value:"bridge.call",id:"bridgecall",level:3}];function p(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["This package is a bridge designed to pass ",(0,o.jsx)(n.a,{href:"https://www.jsonrpc.org/specification",children:"JSON-RPC 2.0"})," messages between a web application and a native web view."]}),"\n",(0,o.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,o.jsx)(n.p,{children:"To install:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:"npm install @podium/bridge\n"})}),"\n",(0,o.jsx)(n.p,{children:"Import the bridge in your client-side bundle:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n'})}),"\n",(0,o.jsxs)(n.p,{children:["You should probably send messages via ",(0,o.jsx)(n.a,{href:"/docs/api/browser",children:"@podium/browser"}),". That said, the bridge is available on ",(0,o.jsx)(n.code,{children:"window['@podium'].bridge"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-js",children:'/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\n// You can listen for incoming messages, which can either be RpcRequest or RpcResponse\nbridge.on("global/authentication", (message) => {\n const request =\n /** @type {import("@podium/bridge").RpcRequest<{ token?: string }>} */ (\n message\n );\n\n if (typeof request.token === "string") {\n // logged in\n } else {\n // logged out\n }\n});\n\n// You can trigger notifications (one-way messages)\nbridge.notification({\n method: "global/authentication",\n params: { token: null },\n});\n\n// And you can call methods and await the response\n/** @type {import("@podium/bridge").RpcResponse<{ c: string }>} */\nconst response = await bridge.call({\n method: "document/native-feature",\n params: { a: "foo", b: "bar" },\n});\n'})}),"\n",(0,o.jsx)(n.h2,{id:"api",children:"API"}),"\n",(0,o.jsx)(n.h3,{id:"bridgeon",children:(0,o.jsx)(n.code,{children:"bridge.on"})}),"\n",(0,o.jsx)(n.p,{children:"Add a listener for incoming messages for a given method name."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n\n/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\nbridge.on("global/authentication", (message) => {\n const request =\n /** @type {import("@podium/bridge").RpcRequest<{ token?: string }>} */ (\n message\n );\n\n if (typeof request.token === "string") {\n // logged in\n } else {\n // logged out\n }\n});\n'})}),"\n",(0,o.jsx)(n.h3,{id:"bridgenotification",children:(0,o.jsx)(n.code,{children:"bridge.notification"})}),"\n",(0,o.jsxs)(n.p,{children:["Send a ",(0,o.jsx)(n.a,{href:"https://www.jsonrpc.org/specification#notification",children:"notification"})," (one-way message)."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n\n/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\nbridge.notification({\n method: "global/authentication",\n params: { token: null },\n});\n'})}),"\n",(0,o.jsx)(n.h3,{id:"bridgecall",children:(0,o.jsx)(n.code,{children:"bridge.call"})}),"\n",(0,o.jsxs)(n.p,{children:["Send a ",(0,o.jsx)(n.a,{href:"https://www.jsonrpc.org/specification#request_object",children:"request"})," and await a ",(0,o.jsx)(n.a,{href:"https://www.jsonrpc.org/specification#response_object",children:"response"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n\n/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\n/** @type {import("@podium/bridge").RpcResponse<{ c: string }>} */\nconst response = await bridge.call({\n method: "document/native-feature",\n params: { a: "foo", b: "bar" },\n});\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var o=i(6540);const s={},t=o.createContext(s);function r(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/07ee3fee.9cbe4c3a.js b/assets/js/07ee3fee.9cbe4c3a.js
new file mode 100644
index 0000000..b06ce36
--- /dev/null
+++ b/assets/js/07ee3fee.9cbe4c3a.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[6183],{2063:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"api/bridge","title":"@podium/bridge","description":"This package is a bridge designed to pass JSON-RPC 2.0 messages between a web application and a native web view.","source":"@site/docs/api/bridge.md","sourceDirName":"api","slug":"/api/bridge","permalink":"/docs/api/bridge","draft":false,"unlisted":false,"editUrl":"https://github.com/podium-lib/podium-lib.github.io/tree/source/docs/docs/api/bridge.md","tags":[],"version":"current","frontMatter":{"title":"@podium/bridge"},"sidebar":"sidebar","previous":{"title":"Assets","permalink":"/docs/api/assets"},"next":{"title":"@podium/browser","permalink":"/docs/api/browser"}}');var s=i(4848),t=i(8453);const r={title:"@podium/bridge"},d=void 0,a={},c=[{value:"Usage",id:"usage",level:2},{value:"API",id:"api",level:2},{value:"bridge.on",id:"bridgeon",level:3},{value:"bridge.notification",id:"bridgenotification",level:3},{value:"bridge.call",id:"bridgecall",level:3}];function p(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["This package is a bridge designed to pass ",(0,s.jsx)(n.a,{href:"https://www.jsonrpc.org/specification",children:"JSON-RPC 2.0"})," messages between a web application and a native web view."]}),"\n",(0,s.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(n.p,{children:"To install:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"npm install @podium/bridge\n"})}),"\n",(0,s.jsx)(n.p,{children:"Import the bridge in your client-side bundle:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n'})}),"\n",(0,s.jsxs)(n.p,{children:["You should probably send messages via ",(0,s.jsx)(n.a,{href:"/docs/api/browser",children:"@podium/browser"}),". That said, the bridge is available on ",(0,s.jsx)(n.code,{children:"window['@podium'].bridge"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\n// You can listen for incoming messages, which can either be RpcRequest or RpcResponse\nbridge.on("global/authentication", (message) => {\n const request =\n /** @type {import("@podium/bridge").RpcRequest<{ token?: string }>} */ (\n message\n );\n\n if (typeof request.token === "string") {\n // logged in\n } else {\n // logged out\n }\n});\n\n// You can trigger notifications (one-way messages)\nbridge.notification({\n method: "global/authentication",\n params: { token: null },\n});\n\n// And you can call methods and await the response\n/** @type {import("@podium/bridge").RpcResponse<{ c: string }>} */\nconst response = await bridge.call({\n method: "document/native-feature",\n params: { a: "foo", b: "bar" },\n});\n'})}),"\n",(0,s.jsx)(n.h2,{id:"api",children:"API"}),"\n",(0,s.jsx)(n.h3,{id:"bridgeon",children:(0,s.jsx)(n.code,{children:"bridge.on"})}),"\n",(0,s.jsx)(n.p,{children:"Add a listener for incoming messages for a given method name."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n\n/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\nbridge.on("global/authentication", (message) => {\n const request =\n /** @type {import("@podium/bridge").RpcRequest<{ token?: string }>} */ (\n message\n );\n\n if (typeof request.token === "string") {\n // logged in\n } else {\n // logged out\n }\n});\n'})}),"\n",(0,s.jsx)(n.h3,{id:"bridgenotification",children:(0,s.jsx)(n.code,{children:"bridge.notification"})}),"\n",(0,s.jsxs)(n.p,{children:["Send a ",(0,s.jsx)(n.a,{href:"https://www.jsonrpc.org/specification#notification",children:"notification"})," (one-way message)."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n\n/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\nbridge.notification({\n method: "global/authentication",\n params: { token: null },\n});\n'})}),"\n",(0,s.jsx)(n.h3,{id:"bridgecall",children:(0,s.jsx)(n.code,{children:"bridge.call"})}),"\n",(0,s.jsxs)(n.p,{children:["Send a ",(0,s.jsx)(n.a,{href:"https://www.jsonrpc.org/specification#request_object",children:"request"})," and await a ",(0,s.jsx)(n.a,{href:"https://www.jsonrpc.org/specification#response_object",children:"response"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'import "@podium/bridge";\n\n/** @type {import("@podium/bridge").PodiumBridge} */\nconst bridge = window["@podium"].bridge;\n\n/** @type {import("@podium/bridge").RpcResponse<{ c: string }>} */\nconst response = await bridge.call({\n method: "document/native-feature",\n params: { a: "foo", b: "bar" },\n});\n'})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var o=i(6540);const s={},t=o.createContext(s);function r(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/0a966f68.4d61aadd.js b/assets/js/0a966f68.4d61aadd.js
new file mode 100644
index 0000000..b9d21e0
--- /dev/null
+++ b/assets/js/0a966f68.4d61aadd.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[7289],{4076:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>l,metadata:()=>n,toc:()=>r});const n=JSON.parse('{"id":"guides/assets","title":"Client-side assets","description":"A podlet will likely depend on some CSS and maybe client-side JavaScript to work properly. When a layout composes podlets it has to include each podlet\'s assets in the final document. This poses some novel challenges.","source":"@site/docs/guides/assets.md","sourceDirName":"guides","slug":"/guides/assets","permalink":"/docs/guides/assets","draft":false,"unlisted":false,"editUrl":"https://github.com/podium-lib/podium-lib.github.io/tree/source/docs/docs/guides/assets.md","tags":[],"version":"current","frontMatter":{"id":"assets","title":"Client-side assets"},"sidebar":"sidebar","previous":{"title":"Hello, Podium","permalink":"/docs/introduction/hello-podium"},"next":{"title":"Podium context","permalink":"/docs/guides/context"}}');var i=t(4848),o=t(8453);const l={id:"assets",title:"Client-side assets"},a=void 0,d={},r=[{value:"Hosting assets",id:"hosting-assets",level:2},{value:"Podlet serves assets",id:"podlet-serves-assets",level:3},{value:"Use a CDN",id:"use-a-cdn",level:3},{value:"Deduplicating shared dependencies",id:"deduplicating-shared-dependencies",level:2},{value:"Isolation",id:"isolation",level:2},{value:"Unique selectors",id:"unique-selectors",level:3},{value:"Declarative shadow DOM",id:"declarative-shadow-dom",level:3},{value:"podlet.css() can't be used with shadow DOM",id:"podletcss-cant-be-used-with-shadow-dom",level:4},{value:"Islands architecture",id:"islands-architecture",level:3}];function c(e){const s={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.p,{children:"A podlet will likely depend on some CSS and maybe client-side JavaScript to work properly. When a layout composes podlets it has to include each podlet's assets in the final document. This poses some novel challenges."}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Where to host the client-side assets?"}),"\n",(0,i.jsx)(s.li,{children:"How to handle duplication of shared libraries such as React?"}),"\n",(0,i.jsx)(s.li,{children:"How to isolate styling or behavior between podlets and layout?"}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"hosting-assets",children:"Hosting assets"}),"\n",(0,i.jsx)(s.p,{children:"There are two main options for hosting assets:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"The podlet can serve its own assets"}),"\n",(0,i.jsx)(s.li,{children:"Use a separate asset server or CDN"}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"podlet-serves-assets",children:"Podlet serves assets"}),"\n",(0,i.jsx)(s.p,{children:"Note: this will only work if your podlets are publicly available."}),"\n",(0,i.jsx)(s.p,{children:"This approach involves each podlet serving its assets so that the layout can then include these files in its HTML template."}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Step 1."})}),"\n",(0,i.jsx)(s.p,{children:"In your podlet, use the podlet asset helper functions to define inline client code."}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-js",children:"podlet.js({ value: `http://my-podlet.com/assets/scripts.js` });\npodlet.css({ value: `http://my-podlet.com/assets/styles.js` });\n"})}),"\n",(0,i.jsx)(s.p,{children:"Each of these functions can be called multiple times to add additional assets. For each call, you may also set a type."}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-js",children:'podlet.js({ value: `http://my-podlet.com/assets/scripts1.js`, type: "esm" });\npodlet.js({\n value: `http://my-podlet.com/assets/scripts2.js`,\n type: "default",\n});\n'})}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Step 2."})}),"\n",(0,i.jsxs)(s.p,{children:["Serve the assets from express.\nAssuming the podlets client side assets have been placed in a directory called ",(0,i.jsx)(s.code,{children:"assets"}),":"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-js",children:'app.use("/assets", express.static("assets"));\n'})}),"\n",(0,i.jsxs)(s.p,{children:["See the ",(0,i.jsx)(s.a,{href:"https://expressjs.com/en/starter/static-files.html",children:"Express documentation"})," for more information on ",(0,i.jsx)(s.code,{children:"static"}),"."]}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Step 3."})}),"\n",(0,i.jsxs)(s.p,{children:["Set ",(0,i.jsx)(s.code,{children:"incoming.podlets"})," and use ",(0,i.jsx)(s.code,{children:"podiumSend"})," in your layout's request handler. This way the ",(0,i.jsx)(s.a,{href:"/docs/api/document",children:"document template"})," can include the CSS and JS assets served by the podlet."]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-js",children:"app.get(layout.pathname(), (req, res) => {\n const incoming = res.locals.podium;\n const response = await myPodlet.fetch(incoming);\n\n incoming.podlets = [response];\n res.podiumSend(`podlet.css() can't be used with shadow DOM",id:"podletcss-cant-be-used-with-shadow-dom",level:4},{value:"Islands architecture",id:"islands-architecture",level:3}];function c(e){const s={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.p,{children:"A podlet will likely depend on some CSS and maybe client-side JavaScript to work properly. When a layout composes podlets it has to include each podlet's assets in the final document. This poses some novel challenges."}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Where to host the client-side assets?"}),"\n",(0,n.jsx)(s.li,{children:"How to handle duplication of shared libraries such as React?"}),"\n",(0,n.jsx)(s.li,{children:"How to isolate styling or behavior between podlets and layout?"}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"hosting-assets",children:"Hosting assets"}),"\n",(0,n.jsx)(s.p,{children:"There are two main options for hosting assets:"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"The podlet can serve its own assets"}),"\n",(0,n.jsx)(s.li,{children:"Use a separate asset server or CDN"}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"podlet-serves-assets",children:"Podlet serves assets"}),"\n",(0,n.jsx)(s.p,{children:"Note: this will only work if your podlets are publicly available."}),"\n",(0,n.jsx)(s.p,{children:"This approach involves each podlet serving its assets so that the layout can then include these files in its HTML template."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Step 1."})}),"\n",(0,n.jsx)(s.p,{children:"In your podlet, use the podlet asset helper functions to define inline client code."}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-js",children:"podlet.js({ value: `http://my-podlet.com/assets/scripts.js` });\npodlet.css({ value: `http://my-podlet.com/assets/styles.js` });\n"})}),"\n",(0,n.jsx)(s.p,{children:"Each of these functions can be called multiple times to add additional assets. For each call, you may also set a type."}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-js",children:'podlet.js({ value: `http://my-podlet.com/assets/scripts1.js`, type: "esm" });\npodlet.js({\n value: `http://my-podlet.com/assets/scripts2.js`,\n type: "default",\n});\n'})}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Step 2."})}),"\n",(0,n.jsxs)(s.p,{children:["Serve the assets from express.\nAssuming the podlets client side assets have been placed in a directory called ",(0,n.jsx)(s.code,{children:"assets"}),":"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-js",children:'app.use("/assets", express.static("assets"));\n'})}),"\n",(0,n.jsxs)(s.p,{children:["See the ",(0,n.jsx)(s.a,{href:"https://expressjs.com/en/starter/static-files.html",children:"Express documentation"})," for more information on ",(0,n.jsx)(s.code,{children:"static"}),"."]}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Step 3."})}),"\n",(0,n.jsxs)(s.p,{children:["Set ",(0,n.jsx)(s.code,{children:"incoming.podlets"})," and use ",(0,n.jsx)(s.code,{children:"podiumSend"})," in your layout's request handler. This way the ",(0,n.jsx)(s.a,{href:"/docs/api/document",children:"document template"})," can include the CSS and JS assets served by the podlet."]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-js",children:"app.get(layout.pathname(), (req, res) => {\n const incoming = res.locals.podium;\n const response = await myPodlet.fetch(incoming);\n\n incoming.podlets = [response];\n res.podiumSend(`excludeBy and includeBy",id:"excludeby-and-includeby",level:5},{value:".client.refreshManifests()",id:"clientrefreshmanifests",level:3},{value:".client.state",id:"clientstate",level:3},{value:".client Events",id:"client-events",level:3},{value:"state",id:"state",level:4},{value:".context",id:"context-1",level:3},{value:".context.register(name, parser)",id:"contextregistername-parser",level:3},{value:"name (required)",id:"name-required",level:4},{value:"parser (required)",id:"parser-required",level:4},{value:".metrics",id:"metrics",level:3},{value:"Podlet Resource",id:"podlet-resource",level:2},{value:".fetch(HttpIncoming, options)",id:"fetchhttpincoming-options",level:3},{value:"HttpIncoming (required)",id:"httpincoming-required-2",level:4},{value:"options (optional)",id:"options-optional",level:4},{value:"return value",id:"return-value",level:4},{value:".stream(HttpIncoming, options)",id:"streamhttpincoming-options",level:3},{value:"HttpIncoming (required)",id:"httpincoming-required-3",level:4},{value:"options (optional)",id:"options-optional-1",level:4},{value:"Event: beforeStream",id:"event-beforestream",level:4},{value:".refresh()",id:"refresh",level:3},{value:".name",id:"name-1",level:3},{value:".uri",id:"uri",level:3},{value:"Podlet Response",id:"podlet-response",level:2},{value:"res.podiumSend(fragment)",id:"respodiumsendfragment",level:2}];function p(e){const n={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"In Podium a layout server is mainly responsible for fetching HTML fragments\n(podlets) and stitching these fragments together into an HTML page (a layout)."}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"@podium/layout"})," module is used for composing HTML pages (layouts) out of\npage fragments (podlets)."]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"@podium/layout"})," module provide three core features:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"A client used to fetch content from podlets"}),"\n",(0,s.jsx)(n.li,{children:"A context used to set request bound information on requests from a layout to its podlets when fetching content from them"}),"\n",(0,s.jsx)(n.li,{children:"A proxy that makes it possible to publicly expose podlet data endpoints (or any backend services) via the layout"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"This module is to be used in conjunction with a Node.js HTTP server. For this,\nExpress js, Hapi and Fastify are all supported. It's also possible to write your\nserver using other HTTP frameworks or even just using the core Node.js HTTP\nlibraries."}),"\n",(0,s.jsxs)(n.p,{children:["Connect compatible middleware based frameworks (such as ",(0,s.jsx)(n.a,{href:"https://expressjs.com/",title:"Express",children:"Express"}),") are\nconsidered first class in Podium and as such the layout module provides a\n",(0,s.jsx)(n.code,{children:".middleware()"})," method for convenience."]}),"\n",(0,s.jsxs)(n.p,{children:["For writing layout servers with other HTTP frameworks, see ",(0,s.jsx)(n.a,{href:"/docs/api/http-framework-compatibility",children:"HTTP Framework Compatibility"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,s.jsxs)(a.A,{groupId:"server-frameworks",children:[(0,s.jsx)(i.A,{value:"express",label:"Express",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"$ npm install @podium/layout\n"})})}),(0,s.jsx)(i.A,{value:"hapi",label:"Hapi",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"$ npm install @podium/layout\n$ npm install @podium/hapi-layout\n"})})}),(0,s.jsx)(i.A,{value:"fastify",label:"Fastify",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"$ npm install @podium/layout\n$ npm install @podium/fastify-layout\n"})})})]}),"\n",(0,s.jsx)(n.h2,{id:"getting-started",children:"Getting started"}),"\n",(0,s.jsx)(n.p,{children:"Building a simple layout server including two podlets:"}),"\n",(0,s.jsxs)(a.A,{groupId:"server-frameworks",children:[(0,s.jsx)(i.A,{value:"express",label:"Express",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'import express from "express";\nimport Layout from "@podium/layout";\n\nconst layout = new Layout({\n name: "myLayout",\n pathname: "/",\n});\n\nconst podletA = layout.client.register({\n name: "myPodletA",\n uri: "http://localhost:7100/manifest.json",\n});\n\nconst podletB = layout.client.register({\n name: "myPodletB",\n uri: "http://localhost:7200/manifest.json",\n});\n\nconst app = express();\napp.use(layout.middleware());\n\napp.get(layout.pathname(), async (req, res, next) => {\n const incoming = res.locals.podium;\n\n const [a, b] = await Promise.all([\n podletA.fetch(incoming),\n podletB.fetch(incoming),\n ]);\n\n res.podiumSend(`\n