@salesforce/pwa-kit-react-sdk 3.8.0-preview.0-basepath → 3.8.0-preview.0

package/ssr/universal/components/with-react-query/index.js

@@ -0,0 +1,130 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.withReactQuery = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _hoistNonReactStatics = _interopRequireDefault(require("hoist-non-react-statics"));
+var _reactSsrPrepass = _interopRequireDefault(require("react-ssr-prepass"));
+var _reactQuery = require("@tanstack/react-query");
+var _fetchStrategy = require("../fetch-strategy");
+var _performance = require("../../../../utils/performance");
+var _loggerInstance = _interopRequireDefault(require("../../../../utils/logger-instance"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; } /*
+ * Copyright (c) 2022, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const STATE_KEY = '__reactQuery';
+const passthrough = input => input;
+
+/**
+ * A HoC for adding React Query support to your application.
+ *
+ * @param {React.ReactElement} Wrapped The component to be wrapped
+ * @param {Object} options
+ * @param {Object} options.queryClientConfig The react query client configuration object to be used.
+ *
+ * @returns {React.ReactElement}
+ */
+const withReactQuery = (Wrapped, options = {}) => {
+  const isServerSide = typeof window === 'undefined';
+  /* istanbul ignore next */
+  const wrappedComponentName = Wrapped.displayName || Wrapped.name;
+  const queryClientConfig = options.queryClientConfig;
+  const beforeHydrate = options.beforeHydrate || passthrough;
+
+  /**
+   * @private
+   */
+  class WithReactQuery extends _fetchStrategy.FetchStrategy {
+    render() {
+      let preloadedState = {};
+      this.props.locals.__queryClient = this.props.locals.__queryClient || new _reactQuery.QueryClient(queryClientConfig);
+      if (!isServerSide) {
+        try {
+          var _window$__PRELOADED_S;
+          preloadedState = beforeHydrate(((_window$__PRELOADED_S = window.__PRELOADED_STATE__) === null || _window$__PRELOADED_S === void 0 ? void 0 : _window$__PRELOADED_S[STATE_KEY]) || {});
+        } catch (e) {
+          _loggerInstance.default.error('Client `beforeHydrate` failed', {
+            namespace: 'with-react-query.render',
+            additionalProperties: {
+              error: e
+            }
+          });
+        }
+      }
+      return /*#__PURE__*/_react.default.createElement(_reactQuery.QueryClientProvider, {
+        client: this.props.locals.__queryClient
+      }, /*#__PURE__*/_react.default.createElement(_reactQuery.Hydrate, {
+        state: preloadedState
+      }, /*#__PURE__*/_react.default.createElement(Wrapped, this.props)));
+    }
+
+    /**
+     * @private
+     */
+    static doInitAppState({
+      res,
+      appJSX
+    }) {
+      return _asyncToGenerator(function* () {
+        const queryClient = res.locals.__queryClient = res.locals.__queryClient || new _reactQuery.QueryClient(queryClientConfig);
+        res.__performanceTimer.mark(_performance.PERFORMANCE_MARKS.reactQueryPrerender, 'start');
+        // Use `ssrPrepass` to collect all uses of `useQuery`.
+        yield (0, _reactSsrPrepass.default)(appJSX);
+        res.__performanceTimer.mark(_performance.PERFORMANCE_MARKS.reactQueryPrerender, 'end');
+        const queryCache = queryClient.getQueryCache();
+        const queries = queryCache.getAll().filter(q => q.options.enabled !== false);
+        yield Promise.all(queries.map((q, i) => {
+          var _q$meta, _q$meta2;
+          // always include the index to avoid duplicate entries
+          const displayName = (_q$meta = q.meta) !== null && _q$meta !== void 0 && _q$meta.displayName ? `${(_q$meta2 = q.meta) === null || _q$meta2 === void 0 ? void 0 : _q$meta2.displayName}:${i}` : `${i}`;
+          res.__performanceTimer.mark(`${_performance.PERFORMANCE_MARKS.reactQueryUseQuery}::${displayName}`, 'start');
+          return q.fetch().then(result => {
+            res.__performanceTimer.mark(`${_performance.PERFORMANCE_MARKS.reactQueryUseQuery}::${displayName}`, 'end', {
+              detail: q.queryHash
+            });
+            return result;
+          }).catch(() => {
+            // If there's an error in this fetch, react-query will log the error
+            // On our end, simply catch any error and move on to the next query
+          });
+        }));
+        return {
+          [STATE_KEY]: (0, _reactQuery.dehydrate)(queryClient)
+        };
+      })();
+    }
+
+    /**
+     * @private
+     */
+    static getInitializers() {
+      var _Wrapped$getInitializ;
+      return [WithReactQuery.doInitAppState, ...(((_Wrapped$getInitializ = Wrapped.getInitializers) === null || _Wrapped$getInitializ === void 0 ? void 0 : _Wrapped$getInitializ.call(Wrapped)) ?? [])];
+    }
+
+    /**
+     * @private
+     */
+    static getHOCsInUse() {
+      var _Wrapped$getHOCsInUse;
+      return [withReactQuery, ...(((_Wrapped$getHOCsInUse = Wrapped.getHOCsInUse) === null || _Wrapped$getHOCsInUse === void 0 ? void 0 : _Wrapped$getHOCsInUse.call(Wrapped)) ?? [])];
+    }
+  }
+  WithReactQuery.displayName = `withReactQuery(${wrappedComponentName})`;
+  const exclude = {
+    doInitAppState: true,
+    getInitializers: true,
+    initAppState: true,
+    getHOCsInUse: true
+  };
+  (0, _hoistNonReactStatics.default)(WithReactQuery, Wrapped, exclude);
+  return WithReactQuery;
+};
+exports.withReactQuery = withReactQuery;

package/ssr/universal/components/with-react-query/index.test.js

@@ -0,0 +1,101 @@
+"use strict";
+
+var _index = require("./index");
+var _react = require("@testing-library/react");
+var _react2 = _interopRequireDefault(require("react"));
+var _loggerInstance = _interopRequireDefault(require("../../../../utils/logger-instance"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/*
+ * Copyright (c) 2022, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+jest.mock('../../../../utils/logger-instance', () => {
+  return {
+    error: jest.fn()
+  };
+});
+describe('withReactQuery', function () {
+  let windowSpy;
+  let oldPreloadedState = window.__PRELOADED_STATE__;
+  beforeEach(() => {
+    windowSpy = jest.spyOn(window, 'window', 'get');
+    jest.spyOn(console, 'warn').mockImplementation(jest.fn());
+  });
+  afterEach(() => {
+    console.warn.mockRestore();
+    windowSpy.mockRestore();
+    window.__PRELOADED_STATE__ = oldPreloadedState;
+  });
+  test('Renders correctly', () => {
+    const Wrapped = () => /*#__PURE__*/_react2.default.createElement("p", null, "Hello world");
+    const Component = (0, _index.withReactQuery)(Wrapped);
+    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(Component, {
+      locals: {}
+    }));
+    expect(_react.screen.getByText(/Hello world/i)).toBeInTheDocument();
+  });
+  test('`beforeHydrate` called on mount', () => {
+    const mockPreloadedState = {
+      payload: {}
+    };
+    const mockBeforeHydrate = jest.fn();
+    const Wrapped = () => /*#__PURE__*/_react2.default.createElement("p", null, "Hello world");
+    const Component = (0, _index.withReactQuery)(Wrapped, {
+      beforeHydrate: mockBeforeHydrate
+    });
+    window.__PRELOADED_STATE__ = {
+      __reactQuery: mockPreloadedState
+    };
+    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(Component, {
+      locals: {}
+    }));
+    expect(_react.screen.getByText(/Hello world/i)).toBeInTheDocument();
+    expect(mockBeforeHydrate).toHaveBeenCalledTimes(1);
+    expect(mockBeforeHydrate).toHaveBeenCalledWith(mockPreloadedState);
+  });
+  test('Renders correctly when `beforeHydrate` throws', () => {
+    const mockPreloadedState = {
+      payload: {}
+    };
+    const mockError = new Error('Test Error');
+    const mockBeforeHydrate = jest.fn().mockImplementation(() => {
+      throw mockError;
+    });
+    const Wrapped = () => /*#__PURE__*/_react2.default.createElement("p", null, "Hello world");
+    const Component = (0, _index.withReactQuery)(Wrapped, {
+      beforeHydrate: mockBeforeHydrate
+    });
+    window.__PRELOADED_STATE__ = {
+      __reactQuery: mockPreloadedState
+    };
+    _loggerInstance.default.error = jest.fn();
+    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(Component, {
+      locals: {}
+    }));
+    expect(_react.screen.getByText(/Hello world/i)).toBeInTheDocument();
+    expect(mockBeforeHydrate).toHaveBeenCalledTimes(1);
+    expect(mockBeforeHydrate).toHaveBeenCalledWith(mockPreloadedState);
+    expect(_loggerInstance.default.error).toHaveBeenCalledTimes(1);
+    expect(_loggerInstance.default.error).toHaveBeenCalledWith('Client `beforeHydrate` failed', {
+      additionalProperties: {
+        error: mockError
+      },
+      namespace: 'with-react-query.render'
+    });
+  });
+  test(`Has working getInitializers method`, () => {
+    expect((0, _index.withReactQuery)({}).getInitializers()).toHaveLength(1);
+    expect((0, _index.withReactQuery)({
+      getInitializers: () => ['xyz']
+    }).getInitializers()).toHaveLength(2);
+  });
+  test(`Has working getHOCsInUse method`, () => {
+    expect((0, _index.withReactQuery)({}).getHOCsInUse()).toHaveLength(1);
+    expect((0, _index.withReactQuery)({
+      getHOCsInUse: () => ['xyz']
+    }).getHOCsInUse()).toHaveLength(2);
+  });
+});

package/ssr/universal/contexts/index.js

@@ -0,0 +1,72 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ServerContext = exports.CorrelationIdProvider = exports.CorrelationIdContext = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _reactRouterDom = require("react-router-dom");
+var _loggerInstance = _interopRequireDefault(require("../../../utils/logger-instance"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+const CorrelationIdContext = exports.CorrelationIdContext = /*#__PURE__*/_react.default.createContext();
+const ServerContext = exports.ServerContext = /*#__PURE__*/_react.default.createContext();
+
+/**
+ * This provider initializes the correlation id,
+ * and will generate a new id whenever there is a location change
+ * @private
+ * @param children
+ * @param correlationId - default correlation id
+ * @param resetOnPageChange - a boolean to indicate if it needs to generate a new id when navigating to a new page
+ */
+const CorrelationIdProvider = ({
+  children,
+  correlationId,
+  resetOnPageChange = true
+}) => {
+  const _correlationIdFn = typeof correlationId === 'function' && correlationId;
+  const _correlationId = typeof correlationId !== 'function' && correlationId;
+  if (resetOnPageChange && !_correlationIdFn) {
+    _loggerInstance.default.warn('correlationId needs to be a function returning a uuid string when resetOnPageChange is true', {
+      namespace: 'contexts.CorrelationIdProvider'
+    });
+  }
+  const [id, setId] = _react.default.useState(_correlationId || _correlationIdFn());
+  const location = (0, _reactRouterDom.useLocation)();
+  const isFirstRun = (0, _react.useRef)(true);
+  (0, _react.useEffect)(() => {
+    // this hook only runs on client-side
+    // don't run this on first render
+    if (isFirstRun.current) {
+      isFirstRun.current = false;
+      return;
+    }
+    if (resetOnPageChange && _correlationIdFn) {
+      // NOTE: the function needs to be an uuid v4.
+      const newId = _correlationIdFn();
+      setId(newId);
+    }
+  }, [location.pathname]);
+  return /*#__PURE__*/_react.default.createElement(CorrelationIdContext.Provider, {
+    value: {
+      correlationId: id
+    }
+  }, children);
+};
+exports.CorrelationIdProvider = CorrelationIdProvider;
+CorrelationIdProvider.propTypes = {
+  children: _propTypes.default.element.isRequired,
+  resetOnPageChange: _propTypes.default.bool,
+  correlationId: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.func]).isRequired,
+  location: _propTypes.default.object
+};

package/ssr/universal/contexts/index.test.js

@@ -0,0 +1,101 @@
+"use strict";
+
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _reactRouterDom = require("react-router-dom");
+var _history = require("history");
+var _index = require("./index");
+var _hooks = require("../hooks");
+var _crypto = _interopRequireDefault(require("crypto"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; } /*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const SampleProvider = props => {
+  const {
+    correlationId,
+    resetOnPageChange
+  } = props;
+  return /*#__PURE__*/_react.default.createElement(_index.CorrelationIdProvider, {
+    correlationId: correlationId,
+    resetOnPageChange: resetOnPageChange
+  }, props.children);
+};
+SampleProvider.propTypes = {
+  children: _propTypes.default.element.isRequired,
+  resetOnPageChange: _propTypes.default.bool,
+  correlationId: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.func]).isRequired
+};
+const Component = () => {
+  const {
+    correlationId
+  } = (0, _hooks.useCorrelationId)();
+  return /*#__PURE__*/_react.default.createElement("div", {
+    className: 'correlation-id'
+  }, correlationId);
+};
+describe('CorrelationIdProvider', function () {
+  test('Renders without errors', () => {
+    const history = (0, _history.createMemoryHistory)();
+    const id = _crypto.default.randomUUID();
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_reactRouterDom.Router, {
+      history: history
+    }, /*#__PURE__*/_react.default.createElement(SampleProvider, {
+      correlationId: () => id
+    }, /*#__PURE__*/_react.default.createElement(Component, null))));
+    expect(_react2.screen.getByText(id)).toBeInTheDocument();
+  });
+  test('renders when correlationId is passed as a function', () => {
+    const id = _crypto.default.randomUUID();
+    const history = (0, _history.createMemoryHistory)();
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_reactRouterDom.Router, {
+      history: history
+    }, /*#__PURE__*/_react.default.createElement(SampleProvider, {
+      correlationId: () => id
+    }, /*#__PURE__*/_react.default.createElement(Component, null))));
+    expect(_react2.screen.getByText(id)).toBeInTheDocument();
+  });
+  test('renders when correlationId is passed as a string', () => {
+    const id = _crypto.default.randomUUID();
+    const history = (0, _history.createMemoryHistory)();
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_reactRouterDom.Router, {
+      history: history
+    }, /*#__PURE__*/_react.default.createElement(SampleProvider, {
+      correlationId: id,
+      resetOnPageChange: false
+    }, /*#__PURE__*/_react.default.createElement(Component, null))));
+    expect(_react2.screen.getByText(id)).toBeInTheDocument();
+  });
+  test('generates a new id when changing page', /*#__PURE__*/_asyncToGenerator(function* () {
+    const user = _userEvent.default.setup();
+    const history = (0, _history.createMemoryHistory)();
+    const Component = () => {
+      const {
+        correlationId
+      } = (0, _hooks.useCorrelationId)();
+      return /*#__PURE__*/_react.default.createElement("div", null, /*#__PURE__*/_react.default.createElement("div", {
+        "data-testid": "correlation-id"
+      }, correlationId), /*#__PURE__*/_react.default.createElement("button", {
+        className: "button",
+        onClick: () => history.push('/page-1')
+      }, "Go to another page"));
+    };
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_reactRouterDom.Router, {
+      history: history
+    }, /*#__PURE__*/_react.default.createElement(SampleProvider, {
+      correlationId: () => _crypto.default.randomUUID()
+    }, /*#__PURE__*/_react.default.createElement(Component, null))));
+    const firstRenderedId = _react2.screen.getByTestId('correlation-id').innerHTML;
+    const button = _react2.screen.getByText(/go to another page/i);
+    yield user.click(button);
+    const secondRenderedId = _react2.screen.getByTestId('correlation-id').innerHTML;
+    // expecting the provider to have a different correlation id when a page navigation happens
+    expect(firstRenderedId).not.toEqual(secondRenderedId);
+  }));
+});

package/ssr/universal/errors.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HTTPNotFound = exports.HTTPError = void 0;
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+class HTTPError extends Error {
+  constructor(status, message) {
+    super(message);
+    this.constructor = HTTPError;
+    this.__proto__ = HTTPError.prototype;
+    this.message = message;
+    this.status = status;
+  }
+  toString() {
+    return `HTTPError ${this.status}: ${this.message}`;
+  }
+}
+exports.HTTPError = HTTPError;
+class HTTPNotFound extends HTTPError {
+  constructor(message) {
+    super(404, message);
+    this.constructor = HTTPNotFound;
+    this.__proto__ = HTTPNotFound.prototype;
+  }
+}
+exports.HTTPNotFound = HTTPNotFound;

package/ssr/universal/errors.test.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var errors = _interopRequireWildcard(require("./errors"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+describe('Errors', () => {
+  test('HTTP Errors should have a working toString()', () => {
+    const status = 400;
+    const msg = 'This is a bad request';
+    const err = new errors.HTTPError(status, msg);
+    expect(err.toString()).toBe(`HTTPError ${status}: ${msg}`);
+  });
+});

package/ssr/universal/events.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pages = exports.PAGEEVENTS = void 0;
+var _eventEmitter = _interopRequireDefault(require("event-emitter"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+const PAGEEVENTS = exports.PAGEEVENTS = {
+  PAGELOAD: 'PAGELOAD',
+  ERROR: 'ERROR'
+};
+class Pages {
+  pageLoad(templateName, start, end) {
+    const payload = {
+      templateName,
+      start,
+      end
+    };
+    this.emit(PAGEEVENTS.PAGELOAD, payload);
+  }
+  error(name, content) {
+    const payload = {
+      name,
+      content
+    };
+    this.emit(PAGEEVENTS.ERROR, payload);
+  }
+}
+(0, _eventEmitter.default)(Pages.prototype);
+const pages = exports.pages = new Pages();

package/ssr/universal/events.test.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _events = require("./events");
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+describe('Page Events', () => {
+  test('emit and receive a PAGELOAD Page Event', () => {
+    expect.assertions(1);
+    return new Promise(resolve => {
+      _events.pages.on(_events.PAGEEVENTS.PAGELOAD, evt => {
+        expect(JSON.stringify(evt)).toEqual(JSON.stringify({
+          templateName: 'blah',
+          start: 123,
+          end: 456
+        }));
+        return resolve();
+      });
+      _events.pages.pageLoad('blah', 123, 456);
+    });
+  });
+  test('emit and receive a ERROR Page Event', () => {
+    expect.assertions(1);
+    return new Promise(resolve => {
+      _events.pages.on(_events.PAGEEVENTS.ERROR, evt => {
+        expect(JSON.stringify(evt)).toEqual(JSON.stringify({
+          name: 'blah',
+          content: 'more blah'
+        }));
+        return resolve();
+      });
+      _events.pages.error('blah', 'more blah');
+    });
+  });
+});

package/ssr/universal/hooks/index.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useServerContext = exports.useOrigin = exports.useCorrelationId = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _contexts = require("../contexts");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/* istanbul ignore file */
+
+/**
+ * Use this hook to get the correlation id value of the closest CorrelationIdProvider component.
+ *
+ * @returns {object} The correlation id
+ */
+const useCorrelationId = () => {
+  const context = _react.default.useContext(_contexts.CorrelationIdContext);
+  if (context === undefined) {
+    throw new Error('useCorrelationId needs to be used within CorrelationIdProvider');
+  }
+  return context;
+};
+
+/**
+ * Server context
+ * @typedef {Object} ServerContext
+ * @property {Object} req - Request object
+ * @property {Object} res - Response object
+ */
+
+/**
+ * Get the server context
+ * @returns {ServerContext} ServerContext object
+ *
+ * @example
+ * const {res} = useServerContext()
+ * if (res && query.error) { res.status(404) }
+ */
+exports.useCorrelationId = useCorrelationId;
+const useServerContext = () => {
+  const serverContext = (0, _react.useContext)(_contexts.ServerContext);
+  return serverContext;
+};
+
+/**
+ * Returns the application's origin.
+ *
+ * By default, it will return the ORIGIN under which we are serving the page.
+ *
+ * If `fromXForwardedHeader` is true, it will use the value of `x-forwarded-proto` and `x-forwarded-host` headers in req
+ * to build origin. (it is false by default)
+ *
+ * NOTE: this is a React hook, so it has to be used in a React rendering pipeline.
+ * @returns {string} origin string
+ *
+ */
+exports.useServerContext = useServerContext;
+const useOrigin = ({
+  fromXForwardedHeader = false
+}) => {
+  const {
+    res
+  } = useServerContext();
+  if (typeof window !== 'undefined') {
+    return window.location.origin;
+  }
+  const {
+    APP_ORIGIN
+  } = process.env;
+  const xForwardedOrigin = res.locals.xForwardedOrigin;
+  if (fromXForwardedHeader && xForwardedOrigin) {
+    return xForwardedOrigin;
+  }
+  return APP_ORIGIN;
+};
+exports.useOrigin = useOrigin;

package/ssr/universal/routes.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+const routes = [];
+var _default = exports.default = routes;