@alignable/bifrost 0.0.8 → 0.0.10

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 (89) hide show
  1. package/dist/index.d.ts +2 -2
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/lib/getGlobalObject.d.ts +5 -0
  4. package/dist/lib/getGlobalObject.d.ts.map +1 -0
  5. package/dist/lib/getGlobalObject.js +7 -0
  6. package/dist/lib/turbolinks/adapter.d.ts +17 -0
  7. package/dist/lib/turbolinks/adapter.d.ts.map +1 -0
  8. package/dist/lib/turbolinks/adapter.js +1 -0
  9. package/dist/lib/turbolinks/browser_adapter.d.ts +28 -0
  10. package/dist/lib/turbolinks/browser_adapter.d.ts.map +1 -0
  11. package/dist/lib/turbolinks/browser_adapter.js +71 -0
  12. package/dist/lib/turbolinks/controller.d.ts +101 -0
  13. package/dist/lib/turbolinks/controller.d.ts.map +1 -0
  14. package/dist/lib/turbolinks/controller.js +290 -0
  15. package/dist/lib/turbolinks/head_details.d.ts +23 -0
  16. package/dist/lib/turbolinks/head_details.d.ts.map +1 -0
  17. package/dist/lib/turbolinks/head_details.js +92 -0
  18. package/dist/lib/turbolinks/history.d.ts +22 -0
  19. package/dist/lib/turbolinks/history.d.ts.map +1 -0
  20. package/dist/lib/turbolinks/history.js +60 -0
  21. package/dist/lib/turbolinks/index.d.ts +14 -0
  22. package/dist/lib/turbolinks/index.d.ts.map +1 -0
  23. package/dist/lib/turbolinks/index.js +55 -0
  24. package/dist/lib/turbolinks/location.d.ts +23 -0
  25. package/dist/lib/turbolinks/location.d.ts.map +1 -0
  26. package/dist/lib/turbolinks/location.js +75 -0
  27. package/dist/lib/turbolinks/namespace.d.ts +12 -0
  28. package/dist/lib/turbolinks/namespace.d.ts.map +1 -0
  29. package/dist/lib/turbolinks/namespace.js +20 -0
  30. package/dist/lib/turbolinks/passthrough_renderer.d.ts +32 -0
  31. package/dist/lib/turbolinks/passthrough_renderer.d.ts.map +1 -0
  32. package/dist/lib/turbolinks/passthrough_renderer.js +128 -0
  33. package/dist/lib/turbolinks/progress_bar.d.ts +24 -0
  34. package/dist/lib/turbolinks/progress_bar.d.ts.map +1 -0
  35. package/dist/lib/turbolinks/progress_bar.js +99 -0
  36. package/dist/lib/turbolinks/renderer.d.ts +14 -0
  37. package/dist/lib/turbolinks/renderer.d.ts.map +1 -0
  38. package/dist/lib/turbolinks/renderer.js +28 -0
  39. package/dist/lib/turbolinks/scroll_manager.d.ts +16 -0
  40. package/dist/lib/turbolinks/scroll_manager.d.ts.map +1 -0
  41. package/dist/lib/turbolinks/scroll_manager.js +32 -0
  42. package/dist/lib/turbolinks/snapshot.d.ts +25 -0
  43. package/dist/lib/turbolinks/snapshot.d.ts.map +1 -0
  44. package/dist/lib/turbolinks/snapshot.js +77 -0
  45. package/dist/lib/turbolinks/snapshot_cache.d.ts +18 -0
  46. package/dist/lib/turbolinks/snapshot_cache.d.ts.map +1 -0
  47. package/dist/lib/turbolinks/snapshot_cache.js +42 -0
  48. package/dist/lib/turbolinks/snapshot_renderer copy.d.ts +45 -0
  49. package/dist/lib/turbolinks/snapshot_renderer copy.d.ts.map +1 -0
  50. package/dist/lib/turbolinks/snapshot_renderer copy.js +179 -0
  51. package/dist/lib/turbolinks/snapshot_renderer.d.ts +43 -0
  52. package/dist/lib/turbolinks/snapshot_renderer.d.ts.map +1 -0
  53. package/dist/lib/turbolinks/snapshot_renderer.js +139 -0
  54. package/dist/lib/turbolinks/types.d.ts +7 -0
  55. package/dist/lib/turbolinks/types.d.ts.map +1 -0
  56. package/dist/lib/turbolinks/types.js +3 -0
  57. package/dist/lib/turbolinks/util.d.ts +14 -0
  58. package/dist/lib/turbolinks/util.d.ts.map +1 -0
  59. package/dist/lib/turbolinks/util.js +85 -0
  60. package/dist/lib/turbolinks/view.d.ts +21 -0
  61. package/dist/lib/turbolinks/view.d.ts.map +1 -0
  62. package/dist/lib/turbolinks/view.js +42 -0
  63. package/dist/lib/turbolinks/visit.d.ts +73 -0
  64. package/dist/lib/turbolinks/visit.d.ts.map +1 -0
  65. package/dist/lib/turbolinks/visit.js +227 -0
  66. package/dist/proxy/pages/+config.d.ts +4 -4
  67. package/dist/proxy/pages/+config.js +4 -4
  68. package/dist/proxy/pages/onPageTransitionStart.d.ts +3 -0
  69. package/dist/proxy/pages/onPageTransitionStart.d.ts.map +1 -0
  70. package/dist/proxy/pages/onPageTransitionStart.js +9 -0
  71. package/dist/proxy/pages/restorationVisit/+config.d.ts +2 -2
  72. package/dist/proxy/pages/restorationVisit/+config.js +2 -2
  73. package/dist/renderer/+config.d.ts +9 -3
  74. package/dist/renderer/+config.d.ts.map +1 -1
  75. package/dist/renderer/+config.js +6 -4
  76. package/dist/renderer/onRenderClient.d.ts.map +1 -1
  77. package/dist/renderer/onRenderClient.js +7 -1
  78. package/dist/renderer/onRenderHtml.d.ts.map +1 -1
  79. package/dist/renderer/onRenderHtml.js +9 -1
  80. package/dist/renderer/usePageContext.d.ts +1 -0
  81. package/dist/renderer/usePageContext.d.ts.map +1 -1
  82. package/dist/renderer/usePageContext.js +9 -1
  83. package/dist/renderer/utils/formatMetaObject.d.ts +4 -0
  84. package/dist/renderer/utils/formatMetaObject.d.ts.map +1 -0
  85. package/dist/renderer/utils/formatMetaObject.js +3 -0
  86. package/dist/renderer/utils/getGlobalObject.d.ts +5 -0
  87. package/dist/renderer/utils/getGlobalObject.d.ts.map +1 -0
  88. package/dist/renderer/utils/getGlobalObject.js +8 -0
  89. package/package.json +3 -3
@@ -0,0 +1,9 @@
1
+ import { Visit, getAdapter } from "../../lib/turbolinks";
2
+ export default function onPageTransitionStart(pageContext) {
3
+ const v = new Visit();
4
+ window.Turbolinks.controller.restorationIdentifier = v.restorationIdentifier;
5
+ window.Turbolinks.controller.currentVisit = v;
6
+ console.log(v.identifier);
7
+ getAdapter()?.visitStarted(v);
8
+ getAdapter()?.visitRequestStarted(v);
9
+ }
@@ -1,6 +1,6 @@
1
1
  declare const _default: {
2
- routePath: string;
3
- PagePath: string;
2
+ route: string;
3
+ Page: string;
4
4
  meta: {
5
5
  onBeforeRender: {
6
6
  env: "server-and-client";
@@ -1,6 +1,6 @@
1
1
  export default {
2
- routePath: "@alignable/bifrost/proxy/pages/restorationVisit/route",
3
- PagePath: "@alignable/bifrost/proxy/pages/Page",
2
+ route: "import:@alignable/bifrost/proxy/pages/restorationVisit/route",
3
+ Page: "import:@alignable/bifrost/proxy/pages/Page",
4
4
  meta: {
5
5
  onBeforeRender: {
6
6
  // We tell vite-plugin-ssr to load and execute onBeforeRender()
@@ -1,8 +1,8 @@
1
1
  declare const _default: {
2
2
  passToClient: string[];
3
- onRenderClientPath: string;
4
- onRenderHtmlPath: string;
5
- onBeforeRoutePath: string;
3
+ onRenderClient: "import:@alignable/bifrost/renderer/onRenderClient";
4
+ onRenderHtml: "import:@alignable/bifrost/renderer/onRenderHtml";
5
+ onBeforeRoute: "import:@alignable/bifrost/renderer/onBeforeRoute";
6
6
  clientRouting: true;
7
7
  hydrationCanBeAborted: true;
8
8
  meta: {
@@ -15,6 +15,12 @@ declare const _default: {
15
15
  documentProps: {
16
16
  env: "server-and-client";
17
17
  };
18
+ isLoggedIn: {
19
+ env: "server-and-client";
20
+ };
21
+ scripts: {
22
+ env: "server-and-client";
23
+ };
18
24
  };
19
25
  };
20
26
  export default _default;
@@ -1 +1 @@
1
- {"version":3,"file":"+config.d.ts","sourceRoot":"","sources":["../../renderer/+config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAEA,wBAYgC"}
1
+ {"version":3,"file":"+config.d.ts","sourceRoot":"","sources":["../../renderer/+config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAEA,wBAcgC"}
@@ -1,13 +1,15 @@
1
1
  export default {
2
- passToClient: ["layoutProps", "pageProps", "redirectTo", "documentProps"],
3
- onRenderClientPath: "@alignable/bifrost/renderer/onRenderClient",
4
- onRenderHtmlPath: "@alignable/bifrost/renderer/onRenderHtml",
5
- onBeforeRoutePath: "@alignable/bifrost/renderer/onBeforeRoute",
2
+ passToClient: ["layoutProps", "pageProps", "redirectTo", "documentProps", "isLoggedIn", "scripts"],
3
+ onRenderClient: "import:@alignable/bifrost/renderer/onRenderClient",
4
+ onRenderHtml: "import:@alignable/bifrost/renderer/onRenderHtml",
5
+ onBeforeRoute: "import:@alignable/bifrost/renderer/onBeforeRoute",
6
6
  clientRouting: true,
7
7
  hydrationCanBeAborted: true,
8
8
  meta: {
9
9
  Layout: { env: "server-and-client" },
10
10
  layoutProps: { env: "server-and-client" },
11
11
  documentProps: { env: "server-and-client" },
12
+ isLoggedIn: { env: "server-and-client" },
13
+ scripts: { env: "server-and-client" },
12
14
  },
13
15
  };
@@ -1 +1 @@
1
- {"version":3,"file":"onRenderClient.d.ts","sourceRoot":"","sources":["../../renderer/onRenderClient.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAUhE,wBAA8B,cAAc,CAC1C,WAAW,EAAE,wBAAwB,iBA8BtC"}
1
+ {"version":3,"file":"onRenderClient.d.ts","sourceRoot":"","sources":["../../renderer/onRenderClient.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAWhE,wBAA8B,cAAc,CAC1C,WAAW,EAAE,wBAAwB,iBAmCtC"}
@@ -6,6 +6,7 @@ import { getDocumentProps } from "./getDocumentProps.js";
6
6
  import { cacheProxiedBody } from "../lib/snapshots.js";
7
7
  import { navigateAnywhere } from "../lib/navigateAnywhere.js";
8
8
  import { setupTurbolinks } from "../lib/turbolinks.js";
9
+ import { formatMetaObject } from "./utils/formatMetaObject.js";
9
10
  setupTurbolinks();
10
11
  export default async function onRenderClient(pageContext) {
11
12
  if (navigateAnywhere(pageContext.redirectTo))
@@ -18,11 +19,16 @@ export default async function onRenderClient(pageContext) {
18
19
  throw new Error("Client-side render() hook expects Layout to be exported");
19
20
  document.removeEventListener("click", turbolinksClickListener);
20
21
  cacheProxiedBody();
21
- const { title = "", description = "" } = getDocumentProps(pageContext);
22
+ const { title = "", description = "", viewport } = getDocumentProps(pageContext);
22
23
  document.title = title;
23
24
  document.head
24
25
  .querySelector("meta[name='description']")
25
26
  ?.setAttribute("content", description);
27
+ if (viewport) {
28
+ document.head
29
+ .querySelector("meta[name='viewport']")
30
+ ?.setAttribute("content", formatMetaObject(viewport));
31
+ }
26
32
  const page = (React.createElement(PageShell, { pageContext: pageContext },
27
33
  React.createElement(Layout, { ...layoutProps },
28
34
  React.createElement(Page, { ...pageProps }))));
@@ -1 +1 @@
1
- {"version":3,"file":"onRenderHtml.d.ts","sourceRoot":"","sources":["../../renderer/onRenderHtml.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAGhE,wBAA8B,YAAY,CACxC,WAAW,EAAE,wBAAwB;;;GA0CtC"}
1
+ {"version":3,"file":"onRenderHtml.d.ts","sourceRoot":"","sources":["../../renderer/onRenderHtml.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAIhE,wBAA8B,YAAY,CACxC,WAAW,EAAE,wBAAwB;;;GAmDtC"}
@@ -3,6 +3,7 @@ import React from "react";
3
3
  import { PageShell } from "../lib/PageShell.js";
4
4
  import { escapeInject, dangerouslySkipEscape } from "vite-plugin-ssr/server";
5
5
  import { getDocumentProps } from "./getDocumentProps.js";
6
+ import { formatMetaObject } from "./utils/formatMetaObject.js";
6
7
  export default async function onRenderHtml(pageContext) {
7
8
  const { Page, pageProps } = pageContext;
8
9
  const { Layout, layoutProps } = pageContext.config;
@@ -13,17 +14,24 @@ export default async function onRenderHtml(pageContext) {
13
14
  const pageHtml = ReactDOMServer.renderToString(React.createElement(PageShell, { pageContext: pageContext },
14
15
  React.createElement(Layout, { ...layoutProps },
15
16
  React.createElement(Page, { ...pageProps }))));
17
+ const { googleAnalytics, osano } = pageContext.config.scripts;
18
+ const googleAnalyticsTag = dangerouslySkipEscape(googleAnalytics);
19
+ const osanoTag = dangerouslySkipEscape(osano);
16
20
  // // See https://vite-plugin-ssr.com/head
17
- const { title = "", description = "" } = getDocumentProps(pageContext);
21
+ const { title = "", description = "", viewport } = getDocumentProps(pageContext);
18
22
  if (!title) {
19
23
  console.warn(`No title set for ${pageContext.urlOriginal}!`);
20
24
  }
25
+ const viewportTag = !viewport ? "" : escapeInject `<meta content="${formatMetaObject(viewport)}" name="viewport">`;
21
26
  const documentHtml = escapeInject `<!DOCTYPE html>
22
27
  <html lang="en">
23
28
  <head>
29
+ ${googleAnalyticsTag}
30
+ ${osanoTag}
24
31
  <title>${title}</title>
25
32
  <meta name="title" property="og:title" content="${title}"/>
26
33
  <meta name="description" content="${description}"/>
34
+ ${viewportTag}
27
35
  </head>
28
36
  <body>
29
37
  <div id="page-view">${dangerouslySkipEscape(pageHtml)}</div>
@@ -6,5 +6,6 @@ declare function PageContextProvider({ pageContext, children }: {
6
6
  pageContext: PageContext;
7
7
  children: React.ReactNode;
8
8
  }): JSX.Element;
9
+ /** Access the pageContext from any React component */
9
10
  declare function usePageContext(): PageContext;
10
11
  //# sourceMappingURL=usePageContext.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"usePageContext.d.ts","sourceRoot":"","sources":["../../renderer/usePageContext.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAqB,MAAM,OAAO,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,EAAE,mBAAmB,EAAE,CAAA;AAC9B,OAAO,EAAE,cAAc,EAAE,CAAA;AAIzB,iBAAS,mBAAmB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE;IAAE,WAAW,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,eAE9G;AAED,iBAAS,cAAc,gBAGtB"}
1
+ {"version":3,"file":"usePageContext.d.ts","sourceRoot":"","sources":["../../renderer/usePageContext.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAqB,MAAM,OAAO,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGnD,OAAO,EAAE,mBAAmB,EAAE,CAAA;AAC9B,OAAO,EAAE,cAAc,EAAE,CAAA;AAMzB,iBAAS,mBAAmB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE;IAAE,WAAW,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,eAG9G;AAED,sDAAsD;AACtD,iBAAS,cAAc,gBAItB"}
@@ -1,13 +1,21 @@
1
1
  // `usePageContext` allows us to access `pageContext` in any React component.
2
2
  // See https://vite-plugin-ssr.com/pageContext-anywhere
3
3
  import React, { useContext } from 'react';
4
+ import { getGlobalObject } from './utils/getGlobalObject.js';
4
5
  export { PageContextProvider };
5
6
  export { usePageContext };
6
- const Context = React.createContext(undefined);
7
+ const { Context } = getGlobalObject('PageContextProvider.ts', {
8
+ Context: React.createContext(undefined)
9
+ });
7
10
  function PageContextProvider({ pageContext, children }) {
11
+ if (!pageContext)
12
+ throw new Error('Argument pageContext missing');
8
13
  return React.createElement(Context.Provider, { value: pageContext }, children);
9
14
  }
15
+ /** Access the pageContext from any React component */
10
16
  function usePageContext() {
11
17
  const pageContext = useContext(Context);
18
+ if (!pageContext)
19
+ throw new Error('<PageContextProvider> is needed for being able to use usePageContext()');
12
20
  return pageContext;
13
21
  }
@@ -0,0 +1,4 @@
1
+ export declare function formatMetaObject(obj: {
2
+ [key: string]: string;
3
+ }): string;
4
+ //# sourceMappingURL=formatMetaObject.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"formatMetaObject.d.ts","sourceRoot":"","sources":["../../../renderer/utils/formatMetaObject.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,GAAG,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,UAE9D"}
@@ -0,0 +1,3 @@
1
+ export function formatMetaObject(obj) {
2
+ return Object.entries(obj).map((e) => e.join("=")).join(", ");
3
+ }
@@ -0,0 +1,5 @@
1
+ export declare function getGlobalObject<T extends Record<string, unknown> = never>(key: `${string}.ts`, defaultValue: T): T;
2
+ declare global {
3
+ var __vite_plugin_ssr: undefined | Record<string, Record<string, unknown>>;
4
+ }
5
+ //# sourceMappingURL=getGlobalObject.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getGlobalObject.d.ts","sourceRoot":"","sources":["../../../renderer/utils/getGlobalObject.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAEvE,GAAG,EAAE,GAAG,MAAM,KAAK,EACnB,YAAY,EAAE,CAAC,GACd,CAAC,CAIH;AACD,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,iBAAiB,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC3E"}
@@ -0,0 +1,8 @@
1
+ // https://github.com/brillout/vike-react/blob/main/vike-react/renderer/utils/getGlobalObject.ts
2
+ export function getGlobalObject(
3
+ // We use the filename as key; each `getGlobalObject()` call should live in a unique filename.
4
+ key, defaultValue) {
5
+ const allGlobalObjects = (globalThis.__vite_plugin_ssr = globalThis.__vite_plugin_ssr || {});
6
+ const globalObject = (allGlobalObjects[key] = allGlobalObjects[key] || defaultValue);
7
+ return globalObject;
8
+ }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@alignable/bifrost",
3
3
  "repository": "https://github.com/Alignable/bifrost.git",
4
- "version": "0.0.8",
4
+ "version": "0.0.10",
5
5
  "type": "module",
6
6
  "types": "./dist/index.d.ts",
7
7
  "exports": {
@@ -76,12 +76,12 @@
76
76
  "react": "^18.x.x",
77
77
  "react-dom": "^18.x.x",
78
78
  "uuid": "^9.0.0",
79
- "vite-plugin-ssr": "0.4.127"
79
+ "vite-plugin-ssr": "0.4.130"
80
80
  },
81
81
  "peerDependencies": {
82
82
  "react": "^18.x.x",
83
83
  "react-dom": "^18.x.x",
84
- "vite-plugin-ssr": "0.4.127",
84
+ "vite-plugin-ssr": "0.4.130",
85
85
  "typescript": ">=4.7"
86
86
  },
87
87
  "devDependencies": {