@salesforce/lds-adapters-uiapi-lex 1.285.0

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/package.json

@@ -0,0 +1,49 @@
+{
+    "name": "@salesforce/lds-adapters-uiapi-lex",
+    "version": "1.285.0",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "UIAPI LWC Adapters built for LEX",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/lds-adapters-uiapi.git",
+        "directory": "packages/lds-adapters-uiapi-lex"
+    },
+    "type": "module",
+    "main": "sfdc/ldsAdaptersUiapiLex.js",
+    "types": "src/main.d.ts",
+    "files": [
+        "sfdc"
+    ],
+    "sfdc": {
+        "overrides": {
+            "artifacts": {
+                "ldsAdaptersUiapiLex.js": {
+                    "output": {
+                        "path": "ui-force-components/modules/force/ldsAdaptersUiapiLex/ldsAdaptersUiapiLex.js"
+                    }
+                }
+            }
+        }
+    },
+    "exports": {
+        "./sfdc": {
+            "types": "./sfdc/sfdc.d.ts",
+            "import": "./sfdc/ldsAdaptersUiapiLex.js",
+            "default": "./sfdc/ldsAdaptersUiapiLex.js"
+        }
+    },
+    "scripts": {
+        "prepare": "yarn build",
+        "build": "rollup --bundleConfigAsCjs --config rollup.config.js",
+        "clean": "rm -rf sfdc"
+    },
+    "nx": {
+        "targets": {
+            "build": {
+                "outputs": [
+                    "{projectRoot}/sfdc"
+                ]
+            }
+        }
+    }
+}

package/sfdc/ldsAdaptersUiapiLex.js

@@ -0,0 +1,307 @@
+/**
+ * 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.
+ *  *******************************************************************************************
+ */
+/* proxy-compat-disable */
+import { convertAuraResponseToData, TypeRegistryCachePolicyCommand, CachePolicyCommand, DataNotFoundError, toError } from 'force/luvioRuntime3';
+import { CommandWireAdapterConstructor } from 'force/luvioLwcBindings3';
+import { register } from 'force/luvioRegistry';
+
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+const UiApiNamespace = 'UiApi';
+
+const ObjectInfoRepresentationName = 'ObjectInfoRepresentation';
+const objectInfoType = {
+    namespace: UiApiNamespace,
+    typeName: ObjectInfoRepresentationName,
+    // 15 * 60 * 1000 = 15 minutes
+    ttl: 900000,
+    buildKey: function (config) {
+        return `${this.namespace}::${this.typeName}::${config.apiName}`;
+    },
+    equals: function (x, y, _typeRegistry) {
+        return x.apiName === y.apiName && x.eTag === y.eTag;
+    },
+    read: function (key, services) {
+        return services.store.get(key);
+    },
+    write: function (key, data, services) {
+        const now = Date.now();
+        const store = services.store;
+        services.metadataRepository.set(key, {
+            namespace: this.namespace,
+            typeName: this.typeName,
+            ingestionTime: now,
+            expirationTime: now + this.ttl,
+        });
+        const existing = store.get(key);
+        if (existing && this.equals(existing, data, services)) {
+            return;
+        }
+        store.set(key, data);
+    },
+};
+function dedupe(value) {
+    if (value === undefined) {
+        return value;
+    }
+    const result = {};
+    for (let i = 0, len = value.length; i < len; i += 1) {
+        result[value[i]] = true;
+    }
+    return Object.keys(result);
+}
+
+class GetObjectInfoCommand extends TypeRegistryCachePolicyCommand {
+    constructor() {
+        super(...arguments);
+        this.returnTypeNamespace = objectInfoType.namespace;
+        this.returnTypeName = objectInfoType.typeName;
+        this.configJsonSchema = {
+            type: 'object',
+            properties: {
+                objectApiName: {
+                    type: 'string',
+                },
+            },
+            required: ['objectApiName'],
+            additionalProperties: false,
+        };
+    }
+    buildKeyConfigFromInstance(instance) {
+        return {
+            apiName: instance.apiName,
+        };
+    }
+    buildKeyConfig() {
+        return {
+            apiName: this.config.objectApiName,
+        };
+    }
+}
+class GetObjectInfoCommandAura extends GetObjectInfoCommand {
+    fetch() {
+        return convertAuraResponseToData(
+            this.services.auraNetwork('RecordUiController.getObjectInfo', this.config)
+        );
+    }
+}
+
+function isUnknownResultRepresentation(result) {
+    return result.statusCode !== undefined && result.statusCode !== 200;
+}
+
+class UiApiCompositeCachingCommand extends CachePolicyCommand {
+    constructor() {
+        super(...arguments);
+        // errors don't get cached so we need to capture them during write so we can read then back out
+        this.capturedErrors = new Map();
+    }
+    areResultsEqual(data1, data2) {
+        const extractedData = this.extractDataFromEnvelope(data1);
+        const extractedData2 = this.extractDataFromEnvelope(data2);
+        if (extractedData.length !== extractedData2.length) {
+            return false;
+        }
+        for (let i = 0; i < extractedData.length; i++) {
+            if (!this.childReturnType.equals(extractedData[i], extractedData2[i], this.services)) {
+                return false;
+            }
+        }
+        return true;
+    }
+    readFromL1(services) {
+        try {
+            const childKeyConfigs = this.buildChildKeyConfigs();
+            const envelopeEntries = [];
+            let missingKeys = [];
+            for (const childKeyConfig of childKeyConfigs) {
+                const key = this.childReturnType.buildKey(childKeyConfig);
+                const data = this.childReturnType.read(key, {
+                    ...this.services,
+                    store: services.store,
+                });
+                if (data === undefined) {
+                    let error = this.capturedErrors.get(key);
+                    if (error !== undefined) {
+                        envelopeEntries.push(error);
+                    } else {
+                        //  TODO [W-14867120]: once commands cache errors we should check to see if there's a cached error
+                        // keep reading so other keys get picked up for revive and dedupe
+                        missingKeys.push(key);
+                        envelopeEntries.push(undefined);
+                    }
+                } else {
+                    envelopeEntries.push(data);
+                }
+            }
+            let envelopeData = this.envelopeData(envelopeEntries);
+            if (missingKeys.length > 0) {
+                return {
+                    dataComplete: false,
+                    data: envelopeData,
+                    // TODO [W-15288468]: DataNotFoundError should allow for an optional list of missing keys
+                    errors: [new DataNotFoundError(`missing keys: ${missingKeys.join(',')}`)],
+                };
+            }
+            return {
+                dataComplete: true,
+                data: envelopeData,
+                errors: [],
+            };
+        } catch (e) {
+            return {
+                dataComplete: false,
+                data: undefined,
+                errors: [toError(e)],
+            };
+        }
+    }
+    writeToL1(networkResult, services) {
+        const childKeyConfigs = this.buildChildKeyConfigs();
+        if (networkResult.errors.length === 0 && networkResult.data && networkResult.data.results) {
+            if (childKeyConfigs.length !== networkResult.data.results.length) {
+                if (process.env.NODE_ENV !== 'production') {
+                    throw new Error('Mismatched number of results');
+                }
+                return;
+            }
+            // Do we want to add a hook for a child command to define a validation fn if the
+            // composite response contains the correct data?
+            networkResult.dataComplete = true;
+        }
+        if (networkResult.dataComplete) {
+            for (let i = 0; i < childKeyConfigs.length; i++) {
+                const result = networkResult.data.results[i];
+                if (isUnknownResultRepresentation(result)) {
+                    const keyConfig = childKeyConfigs[i];
+                    const key = this.childReturnType.buildKey(keyConfig);
+                    this.capturedErrors.set(key, result);
+                } else {
+                    const keyConfig = this.buildChildKeyConfigFromInstance(result.result);
+                    const key = this.childReturnType.buildKey(keyConfig);
+                    this.childReturnType.write(key, result.result, services);
+                }
+            }
+        }
+    }
+    get childReturnType() {
+        return this.services.typeRegistry.get(this.compositeTypeNamespace, this.compositeTypeName);
+    }
+    envelopeData(data) {
+        const results = [];
+        for (let i = 0; i < data.length; i++) {
+            const result = data[i];
+            if (result === undefined || isUnknownResultRepresentation(result)) {
+                results.push(result);
+            } else {
+                results.push({
+                    statusCode: 200,
+                    result: result,
+                });
+            }
+        }
+        return { results };
+    }
+    extractDataFromEnvelope(envelope) {
+        return envelope.results.map((result) => {
+            if (isUnknownResultRepresentation(result)) {
+                return result;
+            } else {
+                return result.result;
+            }
+        });
+    }
+}
+
+class GetObjectInfosCommand extends UiApiCompositeCachingCommand {
+    constructor(config, commandContext, services) {
+        const coercedConfig = { objectApiNames: dedupe(config.objectApiNames) };
+        super(coercedConfig, commandContext, services);
+        this.configJsonSchema = {
+            type: 'object',
+            properties: {
+                objectApiNames: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    minItems: 1,
+                },
+            },
+            required: ['objectApiNames'],
+            additionalProperties: false,
+        };
+        this.compositeTypeNamespace = UiApiNamespace;
+        this.compositeTypeName = ObjectInfoRepresentationName;
+    }
+    buildChildKeyConfigs() {
+        return this.config.objectApiNames.map((objectApiName) => ({ apiName: objectApiName }));
+    }
+    buildChildKeyConfigFromInstance(instance) {
+        return { apiName: instance.apiName };
+    }
+}
+class GetObjectInfosCommandAura extends GetObjectInfosCommand {
+    fetch() {
+        return convertAuraResponseToData(
+            this.services.auraNetwork('RecordUiController.getObjectInfos', this.config)
+        );
+    }
+}
+
+const commandModuleRegistration = {
+    id: 'commandModule-uiapi',
+    services: {
+        // TODO [W-15288468]: version values need to be rolled up by the build
+        metadataRepository: '1.0.0',
+        store: '1.0.0',
+        keySubscription: '1.0.0',
+        typeRegistry: '1.0.0',
+        cacheInclusionPolicy: '1.0.0',
+        cachePolicy: '1.0.0',
+        auraNetwork: '1.0.0',
+    },
+    setServices: (services) => {
+        services.typeRegistry.register(objectInfoType);
+        return {
+            getObjectInfo: (getObjectInfo = class extends CommandWireAdapterConstructor {
+                getCommand() {
+                    return new GetObjectInfoCommandAura(this.config, {}, services);
+                }
+            }),
+            getObjectInfos: (getObjectInfos = class extends CommandWireAdapterConstructor {
+                getCommand() {
+                    return new GetObjectInfosCommandAura(this.config, {}, services);
+                }
+            }),
+        };
+    },
+};
+register(commandModuleRegistration);
+let getObjectInfo;
+let getObjectInfos;
+
+export { getObjectInfo, getObjectInfos };
+// version: 1.285.0-67d4d6869