@salesforce/pwa-kit-react-sdk 3.9.0-nightly-20241209080219 → 4.0.0-extensibility-preview.1

package/ssr/universal/events.d.ts

@@ -0,0 +1,11 @@
+export namespace PAGEEVENTS {
+    const PAGELOAD: string;
+    const ERROR: string;
+}
+export const pages: Pages;
+declare class Pages {
+    pageLoad(templateName: any, start: any, end: any): void;
+    error(name: any, content: any): void;
+}
+export {};
+//# sourceMappingURL=events.d.ts.map

package/ssr/universal/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/ssr/universal/events.js"],"names":[],"mappings":";;;;AAiCA,0BAAgC;AApBhC;IACI,wDAOC;IACD,qCAMC;CACJ"}

package/ssr/universal/hooks/index.d.ts

@@ -0,0 +1,17 @@
+export function useCorrelationId(): object;
+export function useServerContext(): ServerContext;
+/**
+ * Server context
+ */
+export type ServerContext = {
+    /**
+     * - Request object
+     */
+    req: Object;
+    /**
+     * - Response object
+     */
+    res: Object;
+};
+import { ServerContext } from "../contexts";
+//# sourceMappingURL=index.d.ts.map

package/ssr/universal/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ssr/universal/hooks/index.js"],"names":[],"mappings":"AAgBO,oCAFM,MAAM,CAQlB;AAiBM,oCANM,aAAa,CAUzB;;;;;;;;SAhBa,MAAM;;;;SACN,MAAM"}

package/ssr/universal/hooks/index.js

@@ -3,13 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useServerContext = exports.useOrigin = exports.useCorrelationId = void 0;
+exports.useServerContext = 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.
+ * 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
@@ -49,36 +49,4 @@ 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;
+exports.useServerContext = useServerContext;

package/ssr/universal/routes.d.ts

@@ -0,0 +1,3 @@
+export default routes;
+declare const routes: any[];
+//# sourceMappingURL=routes.d.ts.map

package/ssr/universal/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../../src/ssr/universal/routes.js"],"names":[],"mappings":";AAOA,4BAAiB"}

package/ssr/universal/utils.client.test.js

@@ -43,4 +43,34 @@ describe('getAssetUrl (client-side)', () => {
   test('should return origin + path', () => {
     expect(utils.getAssetUrl('/path')).toBe('test.com/path');
   });
+});
+describe('getStaticAssetUrl (client-side)', () => {
+  beforeEach(() => {
+    global.Progressive = {
+      buildOrigin: 'test.com'
+    };
+  });
+  afterEach(() => {
+    delete global.Progressive;
+  });
+  test('should return build origin when path is undefined', () => {
+    expect(utils.getStaticAssetUrl()).toBe('test.com/static');
+  });
+  test('should return origin + path', () => {
+    expect(utils.getStaticAssetUrl('/path')).toBe('test.com/static/path');
+    expect(utils.getStaticAssetUrl('path')).toBe('test.com/static/path');
+  });
+  test('should return build origin with extension prefix when no path is defined, but an extension package name is', () => {
+    expect(utils.getStaticAssetUrl('', {
+      appExtensionPackageName: '@salesforce/sample-extension'
+    })).toBe('test.com/static/__extensions/@salesforce/sample-extension');
+  });
+  test('should return origin + extension prefix + path', () => {
+    expect(utils.getStaticAssetUrl('/path', {
+      appExtensionPackageName: '@salesforce/sample-extension'
+    })).toBe('test.com/static/__extensions/@salesforce/sample-extension/path');
+    expect(utils.getStaticAssetUrl('path', {
+      appExtensionPackageName: '@salesforce/sample-extension'
+    })).toBe('test.com/static/__extensions/@salesforce/sample-extension/path');
+  });
 });

package/ssr/universal/utils.d.ts

@@ -0,0 +1,41 @@
+type GetAssetUrlOptions = {
+    appExtensionPackageName?: string;
+};
+/**
+ * Get the URL that should be used to load an asset from the bundle.
+ *
+ * @param {string} path - relative path from the build directory to the asset
+ * @function
+ * @returns {string}
+ */
+export declare const getAssetUrl: (path: string) => string;
+/**
+ * Get the URL that should be used to load a static asset from the bundle.
+ *
+ * @param {string} path - Relative path from the build directory to the asset.
+ * @param {Object} opts - Options for generating the asset URL.
+ * @param {string} [opts.appExtensionPackageName] - Optional package name for an application extension.
+ * @function
+ * @returns {string} The full URL to the static asset.
+ */
+export declare const getStaticAssetUrl: (path: string, opts: GetAssetUrlOptions) => string;
+/**
+ * @typedef {Object} ProxyConfig
+ * @property {String} protocol - http or https
+ * @property {String} host - the hostname
+ * @property {String} path - the path element that follows "mobify/proxy"
+ */
+/**
+ * Return the set of proxies configured for the app.
+ *
+ * The result is an array of objects, each of which has 'protocol'
+ * (either 'http' or 'https'), 'host' (the hostname) and 'path' (the
+ * path element that follows "/mobify/proxy/", defaulting to 'base' for
+ * the first proxy, and 'base2' for the next).
+ *
+ * @function
+ * @returns {Array<ProxyConfig>}
+ */
+export declare const getProxyConfigs: () => any;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/ssr/universal/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/ssr/universal/utils.ts"],"names":[],"mappings":"AAuBA,KAAK,kBAAkB,GAAG;IACtB,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACnC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,WAQvC,CAAA;AAID;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,SAAU,MAAM,QAAQ,kBAAkB,WAiBvE,CAAA;AAED;;;;;GAKG;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,WAS3B,CAAA"}

package/ssr/universal/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getProxyConfigs = exports.getAssetUrl = void 0;
+exports.getStaticAssetUrl = exports.getProxyConfigs = exports.getAssetUrl = void 0;
 var _ssrShared = require("@salesforce/pwa-kit-runtime/utils/ssr-shared");
 var _ssrNamespacePaths = require("@salesforce/pwa-kit-runtime/utils/ssr-namespace-paths");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -17,9 +17,11 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */ /**
  * @module progressive-web-sdk/ssr/universal/utils
- */
+ */ /* eslint-disable @typescript-eslint/ban-ts-comment */ // @ts-ignore
+// @ts-ignore
 const onClient = typeof window !== 'undefined';
-
+const EXTENIONS_NAMESPACE = '__extensions';
+const STATIC_FOLDER = 'static';
 /**
  * Get the URL that should be used to load an asset from the bundle.
  *
@@ -29,10 +31,41 @@ const onClient = typeof window !== 'undefined';
  */
 const getAssetUrl = path => {
   /* istanbul ignore next */
-  const publicPath = onClient ? `${window.Progressive.buildOrigin}` : `${_ssrNamespacePaths.bundleBasePath}/${process.env.BUNDLE_ID || 'development'}/`;
+  const publicPath = onClient ?
+  // @ts-ignore
+  `${window.Progressive.buildOrigin}` : `${_ssrNamespacePaths.bundleBasePath}/${process.env.BUNDLE_ID || 'development'}/`;
   return path ? `${publicPath}${path}` : publicPath;
 };
 
+// TODO: Once we establish that we have a new @salesforce/pwa-kit-extensibility package, we can move this utility to
+// it as to not have direct references to extensibilty in the sdk. This will also reduce duplicate code.
+/**
+ * Get the URL that should be used to load a static asset from the bundle.
+ *
+ * @param {string} path - Relative path from the build directory to the asset.
+ * @param {Object} opts - Options for generating the asset URL.
+ * @param {string} [opts.appExtensionPackageName] - Optional package name for an application extension.
+ * @function
+ * @returns {string} The full URL to the static asset.
+ */
+exports.getAssetUrl = getAssetUrl;
+const getStaticAssetUrl = (path, opts) => {
+  const {
+    appExtensionPackageName = ''
+  } = opts || {};
+
+  /* istanbul ignore next */
+  const publicPath = onClient ?
+  // @ts-ignore
+  `${window.Progressive.buildOrigin}` : `${_ssrNamespacePaths.bundleBasePath}/${process.env.BUNDLE_ID || 'development'}/`;
+
+  // Ensure all defined path arguments start with `/`.
+  if (path && !path.startsWith('/')) {
+    path = `/${path}`;
+  }
+  return `${publicPath}/${STATIC_FOLDER}${appExtensionPackageName ? `/${EXTENIONS_NAMESPACE}/${appExtensionPackageName}` : ''}${path ? path : ''}`;
+};
+
 /**
  * @typedef {Object} ProxyConfig
  * @property {String} protocol - http or https
@@ -51,9 +84,13 @@ const getAssetUrl = path => {
  * @function
  * @returns {Array<ProxyConfig>}
  */
-exports.getAssetUrl = getAssetUrl;
+exports.getStaticAssetUrl = getStaticAssetUrl;
 const getProxyConfigs = () => {
-  const configs = onClient ? (window.Progressive.ssrOptions || {}).proxyConfigs || [] : _ssrShared.proxyConfigs;
+  const configs = onClient ?
+  // @ts-ignore
+  (window.Progressive.ssrOptions || {}).proxyConfigs || [] :
+  // @ts-ignore
+  _ssrShared.proxyConfigs;
 
   // Clone to avoid accidental mutation of important configuration variables.
   return configs.map(config => _objectSpread({}, config));

package/utils/assets.d.ts

@@ -0,0 +1,2 @@
+export function loadScript({ id, src, isAsync, docwrite, onload, onerror }: string): void;
+//# sourceMappingURL=assets.d.ts.map

package/utils/assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/utils/assets.js"],"names":[],"mappings":"AAgCO,4EAdI,MAAM,QAmGhB"}

package/utils/logger-instance.d.ts

@@ -0,0 +1,3 @@
+export default logger;
+declare const logger: Readonly<import("@salesforce/pwa-kit-runtime/utils/logger-factory").PWAKitLogger>;
+//# sourceMappingURL=logger-instance.d.ts.map

package/utils/logger-instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger-instance.d.ts","sourceRoot":"","sources":["../../src/utils/logger-instance.js"],"names":[],"mappings":";AAQA,wGAA8E"}

package/utils/performance.d.ts

@@ -0,0 +1,60 @@
+export namespace PERFORMANCE_MARKS {
+    const total: string;
+    const renderToString: string;
+    const routeMatching: string;
+    const loadComponent: string;
+    const fetchStrategies: string;
+    const reactQueryPrerender: string;
+    const reactQueryUseQuery: string;
+    const getProps: string;
+}
+/**
+ * This is an SDK internal class that is responsible for measuring server side performance.
+ *
+ * This class manages two types of performance marks: start and end.
+ *
+ * By default, this timer is disabled. Only certain environment variables and feature flags turns it on.
+ *
+ * @private
+ */
+export default class PerformanceTimer {
+    constructor(options?: {});
+    MARKER_TYPES: {
+        START: string;
+        END: string;
+    };
+    enabled: any;
+    marks: {
+        start: Map<any, any>;
+        end: Map<any, any>;
+    };
+    metrics: any[];
+    /**
+     * This is a utility function to build the Server-Timing header.
+     * The function receives an array of performance metrics and returns a string that represents the Server-Timing header.
+     *
+     * see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing
+     *
+     * @function
+     * @private
+     *
+     * @return {String}
+     */
+    private buildServerTimingHeader;
+    /**
+     * A utility function to format and log the performance metrics.
+     *
+     * @function
+     * @private
+     */
+    private log;
+    /**
+     * This is a utility function to create performance marks.
+     * The data will be used in console logs and the http response header `server-timing`.
+     *
+     * @function
+     * @private
+     */
+    private mark;
+}
+//# sourceMappingURL=performance.d.ts.map

package/utils/performance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.d.ts","sourceRoot":"","sources":["../../src/utils/performance.js"],"names":[],"mappings":";;;;;;;;;;AAkBA;;;;;;;;GAQG;AACH;IAKI,0BAOC;IAXD;;;MAGC;IAEG,aAAuC;IACvC;;;MAGC;IACD,eAAiB;IAGrB;;;;;;;;;;OAUG;IACH,gCAQC;IAED;;;;;OAKG;IACH,YAMC;IAED;;;;;;OAMG;IACH,aA0CC;CACJ"}

package/utils/url.d.ts

@@ -0,0 +1,2 @@
+export function getAppOrigin(): string;
+//# sourceMappingURL=url.d.ts.map

package/utils/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../src/utils/url.js"],"names":[],"mappings":"AAoBO,gCANM,MAAM,CAoBlB"}

package/utils/url.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getAppOrigin = void 0;
 /*
- * Copyright (c) 2024, salesforce.com, inc.
+ * 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
@@ -18,8 +18,6 @@ exports.getAppOrigin = void 0;
  * initialized using the `_createApp` method (This happens in your /app/ssr.js file).
  *
  * @function
- * @deprecated use `useOrigin()` instead.
- * This function will be removed in version 4.0.0.
  * @returns {string} Returns the ORIGIN under which we are serving the page.
  * @example
  * import {getAppOrigin} from '@salesforce/pwa-kit-react-sdk/utils/url'

package/utils/uuidv4.client.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Simple implementation to create a uuid using crypto
+ * See: https://stackoverflow.com/questions/105034/how-do-i-create-a-guid-uuid
+ * @returns {*}
+ */
+export function uuidv4(): any;
+//# sourceMappingURL=uuidv4.client.d.ts.map

package/utils/uuidv4.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuidv4.client.d.ts","sourceRoot":"","sources":["../../src/utils/uuidv4.client.js"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,8BAIC"}

package/utils/warnings.d.ts

@@ -0,0 +1,3 @@
+export function deprecated(message: string): void;
+export function experimental(message: string): void;
+//# sourceMappingURL=warnings.d.ts.map

package/utils/warnings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"warnings.d.ts","sourceRoot":"","sources":["../../src/utils/warnings.js"],"names":[],"mappings":"AAuBO,kDAEN;AAQM,oDAEN"}