@salesforce/lds-runtime-browser 0.1.0-dev1

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2022 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2022, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/dist/main.js

@@ -0,0 +1,122 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+/*
+ *  ATTENTION!
+ *  THIS IS A GENERATED FILE FROM https://github.com/salesforce-experience-platform-emu/lds-lightning-platform
+ *  If you would like to contribute to LDS, please follow the steps outlined in the git repo.
+ *  Any changes made to this file in p4 will be automatically overwritten.
+ *  *******************************************************************************************
+ */
+import { setDefaultLuvio, withRegistration, register } from '@salesforce/lds-default-luvio';
+import { instrumentLuvio, setLdsNetworkAdapterInstrumentation } from '@salesforce/lds-instrumentation';
+import salesforceNetworkAdapter, { instrument } from '@salesforce/lds-network-adapter';
+import { InMemoryStore, Environment, Luvio } from '@luvio/engine';
+import { makeDurable } from '@luvio/environments';
+import { fetchNetworkAdapter } from '@luvio/network-adapter-fetch';
+import { IndexedDbDurableStore } from '@luvio/durable-store-idb';
+
+/**
+ * A NetworkAdapter HOF that sets location.href to
+ * "/login?redirect_uri=<location.origin>/oauth" on 401 responses.
+ */
+function makeNetworkAdapterRedirectToLoginOn401(baseNetworkAdapter) {
+    return (resourceRequest, resourceRequestContext) => {
+        return baseNetworkAdapter(resourceRequest, resourceRequestContext).then((response) => {
+            if (response.status === 401) {
+                const redirectUrl = `${location.origin}/oauth`;
+                // eslint-disable-next-line no-console
+                console.log(`401 response detected, re-directing to /login page`);
+                location.href = `/login?redirect_uri=${encodeURIComponent(redirectUrl)}`;
+            }
+            return response;
+        });
+    };
+}
+
+/**
+ * A NetworkAdapter HOF that works with salesforce Core authentication sid cookie
+ */
+function makeNetworkAdapterCoreAuthenticated(baseNetworkAdapter) {
+    return (resourceRequest, resourceRequestContext) => {
+        const { headers } = resourceRequest;
+        const headersWithAuth = buildHeaders(headers);
+        resourceRequest.headers = headersWithAuth;
+        return baseNetworkAdapter(resourceRequest, resourceRequestContext);
+    };
+}
+function buildHeaders(additionalHeaders = {}) {
+    const headers = {
+        ...additionalHeaders,
+    };
+    if (headers.Authorization === undefined && document && document.cookie) {
+        // TODO [W-123]: need to work with auth team to come up with better way
+        // to do this... if LWR@Core followed the pattern that LWR@node auth middleware
+        // follows then this wouldn't be needed
+        const sidCookie = document.cookie.match(new RegExp('(^| )' + 'sid' + '=([^;]+)'));
+        if (sidCookie) {
+            const sid = sidCookie[2];
+            headers['Authorization'] = `Bearer ${sid}`;
+        }
+    }
+    return headers;
+}
+
+// so eslint doesn't complain about nimbus
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+/* global __nimbus */
+let lazyLuvio;
+let lazyEnvironment;
+/**
+ * This returns the LDS on Browser Runtime singleton object.
+ */
+function getRuntime() {
+    if (lazyLuvio === undefined || lazyEnvironment === undefined) {
+        const store = new InMemoryStore();
+        const networkAdapter = makeNetworkAdapterCoreAuthenticated(makeNetworkAdapterRedirectToLoginOn401(salesforceNetworkAdapter(
+        // TODO [W-123]: move the record field chunking code out of nimbus network
+        // adapter package and into the shared lds-network-adapter package
+        // makeNetworkAdapterChunkRecordFields(fetchNetworkAdapter)
+        fetchNetworkAdapter)));
+        const baseEnv = new Environment(store, networkAdapter);
+        lazyEnvironment = makeDurable(baseEnv, {
+            durableStore: new IndexedDbDurableStore(),
+        });
+        lazyEnvironment.setDefaultCachePolicy({ type: 'cache-then-network' });
+        lazyLuvio = new Luvio(lazyEnvironment, {
+            instrument: instrumentLuvio,
+        });
+    }
+    return {
+        luvio: lazyLuvio,
+        environment: lazyEnvironment,
+    };
+}
+function setupLuvio() {
+    const { luvio } = getRuntime();
+    setDefaultLuvio({ luvio });
+}
+
+// defer instrumentation setup on these modules unless/until other code causes
+// them to be loaded
+withRegistration('@salesforce/lds-network-adapter', (reg) => setLdsNetworkAdapterInstrumentation(reg));
+// This code *should* be in lds-network-adapter, but when combined with the Aura
+// component test workaround in lds-default-luvio it creates a circular dependency
+// between lds-default-luvio and lds-network-adapter. We do the register on behalf
+// of lds-network-adapter here to avoid the cycle.
+register({
+    id: '@salesforce/lds-network-adapter',
+    instrument: instrument,
+});
+// This loader hook sets the luvio instance for running in the browser.
+// This must run before any adapters are invoked, otherwise the adapter will be
+// undefined (adapter factories need a luvio instance to build adapters)
+function ldsRuntimeLoader(_serviceAPI) {
+    setupLuvio();
+}
+
+export { ldsRuntimeLoader as default, getRuntime };
+// version: 0.1.0-dev1-54c03dd38c

package/dist/types/main.d.ts

@@ -0,0 +1,3 @@
+import { getRuntime } from './runtime';
+export default function ldsRuntimeLoader(_serviceAPI: unknown): void;
+export { getRuntime };

package/dist/types/makeNetworkAdapterCoreAuthenticated.d.ts

@@ -0,0 +1,5 @@
+import type { NetworkAdapter } from '@luvio/engine';
+/**
+ * A NetworkAdapter HOF that works with salesforce Core authentication sid cookie
+ */
+export declare function makeNetworkAdapterCoreAuthenticated(baseNetworkAdapter: NetworkAdapter): NetworkAdapter;

package/dist/types/makeNetworkAdapterRedirectToLoginOn401.d.ts

@@ -0,0 +1,6 @@
+import type { NetworkAdapter } from '@luvio/engine';
+/**
+ * A NetworkAdapter HOF that sets location.href to
+ * "/login?redirect_uri=<location.origin>/oauth" on 401 responses.
+ */
+export declare function makeNetworkAdapterRedirectToLoginOn401(baseNetworkAdapter: NetworkAdapter): NetworkAdapter;

package/dist/types/runtime.d.ts

@@ -0,0 +1,10 @@
+import { Luvio, Environment } from '@luvio/engine';
+export interface Runtime {
+    luvio: Luvio;
+    environment: Environment;
+}
+/**
+ * This returns the LDS on Browser Runtime singleton object.
+ */
+export declare function getRuntime(): Runtime;
+export declare function setupLuvio(): void;

package/package.json

@@ -0,0 +1,59 @@
+{
+    "name": "@salesforce/lds-runtime-browser",
+    "version": "0.1.0-dev1",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "LDS runtime for browser environments (depends on IndexedDB and Fetch API).",
+    "main": "dist/main.js",
+    "module": "dist/main.js",
+    "types": "dist/types/main.d.ts",
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/types/main.d.ts",
+            "import": "./dist/main.js",
+            "default": "./dist/main.js"
+        }
+    },
+    "scripts": {
+        "prepare": "yarn build",
+        "build": "rollup --bundleConfigAsCjs --config rollup.config.js",
+        "test:debug": "node --inspect-brk ../../node_modules/.bin/jest --runInBand",
+        "test:unit": "NODE_ENV=production jest",
+        "test:size": "luvioBundlesize",
+        "clean": "rm -rf dist",
+        "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-runtime-browser"
+    },
+    "dependencies": {
+        "@luvio/durable-store-idb": "0.158.7",
+        "@luvio/engine": "0.158.7",
+        "@luvio/environments": "0.158.7",
+        "@luvio/network-adapter-fetch": "0.158.7",
+        "@salesforce/lds-default-luvio": "^0.1.0-dev1",
+        "@salesforce/lds-instrumentation": "^0.1.0-dev1",
+        "@salesforce/lds-network-adapter": "^0.1.0-dev1"
+    },
+    "luvioBundlesize": [
+        {
+            "path": "./dist/main.js",
+            "maxSize": {
+                "none": "650 kB",
+                "min": "255 kB",
+                "compressed": "100 kB"
+            }
+        }
+    ],
+    "nx": {
+        "targets": {
+            "build": {
+                "outputs": [
+                    "{projectRoot}/dist"
+                ]
+            }
+        }
+    },
+    "volta": {
+        "extends": "../../package.json"
+    }
+}