@salesforce/lds-adapters-platform-data-provider 1.100.2

package/dist/umd/es2018/platform-data-provider.js

@@ -0,0 +1,351 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+(function (global, factory) {
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@luvio/engine')) :
+    typeof define === 'function' && define.amd ? define(['exports', '@luvio/engine'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.platformDataProvider = {}, global.engine));
+})(this, (function (exports, engine) { 'use strict';
+
+    const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+    const { keys: ObjectKeys$1, freeze: ObjectFreeze$1, create: ObjectCreate$1 } = Object;
+    const { isArray: ArrayIsArray$1 } = Array;
+    /**
+     * Validates an adapter config is well-formed.
+     * @param config The config to validate.
+     * @param adapter The adapter validation configuration.
+     * @param oneOf The keys the config must contain at least one of.
+     * @throws A TypeError if config doesn't satisfy the adapter's config validation.
+     */
+    function validateConfig(config, adapter, oneOf) {
+        const { displayName } = adapter;
+        const { required, optional, unsupported } = adapter.parameters;
+        if (config === undefined ||
+            required.every(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+            throw new TypeError(`adapter ${displayName} configuration must specify ${required.sort().join(', ')}`);
+        }
+        if (oneOf && oneOf.some(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+            throw new TypeError(`adapter ${displayName} configuration must specify one of ${oneOf.sort().join(', ')}`);
+        }
+        if (unsupported !== undefined &&
+            unsupported.some(req => ObjectPrototypeHasOwnProperty.call(config, req))) {
+            throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
+        }
+        const supported = required.concat(optional);
+        if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
+            throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
+        }
+    }
+    function untrustedIsObject(untrusted) {
+        return typeof untrusted === 'object' && untrusted !== null && ArrayIsArray$1(untrusted) === false;
+    }
+    function areRequiredParametersPresent(config, configPropertyNames) {
+        return configPropertyNames.parameters.required.every(req => req in config);
+    }
+    const snapshotRefreshOptions = {
+        overrides: {
+            headers: {
+                'Cache-Control': 'no-cache',
+            },
+        }
+    };
+    const keyPrefix = 'DataProviders';
+
+    const { freeze: ObjectFreeze, keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
+    const { isArray: ArrayIsArray } = Array;
+    const { stringify: JSONStringify } = JSON;
+    function deepFreeze$1(value) {
+        // No need to freeze primitives
+        if (typeof value !== 'object' || value === null) {
+            return;
+        }
+        if (ArrayIsArray(value)) {
+            for (let i = 0, len = value.length; i < len; i += 1) {
+                deepFreeze$1(value[i]);
+            }
+        }
+        else {
+            const keys = ObjectKeys(value);
+            for (let i = 0, len = keys.length; i < len; i += 1) {
+                deepFreeze$1(value[keys[i]]);
+            }
+        }
+        ObjectFreeze(value);
+    }
+    function createLink(ref) {
+        return {
+            __ref: engine.serializeStructuredKey(ref),
+        };
+    }
+
+    const TTL = 3600000;
+    const VERSION = "fa63b622a17d190f6bafa7967153c8be";
+    function validate(obj, path = 'DataProviderSchemaRepresentation') {
+        const v_error = (() => {
+            if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+                return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+            }
+            const obj_schema = obj.schema;
+            const path_schema = path + '.schema';
+            if (typeof obj_schema !== 'object' || ArrayIsArray(obj_schema) || obj_schema === null) {
+                return new TypeError('Expected "object" but received "' + typeof obj_schema + '" (at "' + path_schema + '")');
+            }
+            const obj_schema_keys = ObjectKeys(obj_schema);
+            for (let i = 0; i < obj_schema_keys.length; i++) {
+                const key = obj_schema_keys[i];
+                const obj_schema_prop = obj_schema[key];
+                const path_schema_prop = path_schema + '["' + key + '"]';
+                if (obj_schema_prop === undefined) {
+                    return new TypeError('Expected "defined" but received "' + typeof obj_schema_prop + '" (at "' + path_schema_prop + '")');
+                }
+            }
+        })();
+        return v_error === undefined ? null : v_error;
+    }
+    const RepresentationType = 'DataProviderSchemaRepresentation';
+    function normalize(input, existing, path, luvio, store, timestamp) {
+        return input;
+    }
+    const select$1 = function DataProviderSchemaRepresentationSelect() {
+        return {
+            kind: 'Fragment',
+            version: VERSION,
+            private: [],
+            opaque: true
+        };
+    };
+    function equals(existing, incoming) {
+        if (JSONStringify(incoming) !== JSONStringify(existing)) {
+            return false;
+        }
+        return true;
+    }
+    function deepFreeze(input) {
+        const input_schema = input.schema;
+        const input_schema_keys = Object.keys(input_schema);
+        const input_schema_length = input_schema_keys.length;
+        for (let i = 0; i < input_schema_length; i++) {
+            const key = input_schema_keys[i];
+            const input_schema_prop = input_schema[key];
+            deepFreeze$1(input_schema_prop);
+        }
+        ObjectFreeze(input_schema);
+        ObjectFreeze(input);
+    }
+    const ingest = function DataProviderSchemaRepresentationIngest(input, path, luvio, store, timestamp) {
+        if (process.env.NODE_ENV !== 'production') {
+            const validateError = validate(input);
+            if (validateError !== null) {
+                throw validateError;
+            }
+        }
+        const key = path.fullPath;
+        const existingRecord = store.readEntry(key);
+        const ttlToUse = TTL;
+        let incomingRecord = normalize(input, store.readEntry(key), {
+            fullPath: key,
+            parent: path.parent,
+            propertyName: path.propertyName,
+            ttl: ttlToUse
+        });
+        deepFreeze(input);
+        if (existingRecord === undefined || equals(existingRecord, incomingRecord) === false) {
+            luvio.storePublish(key, incomingRecord);
+        }
+        {
+            const storeMetadataParams = {
+                ttl: ttlToUse,
+                namespace: "DataProviders",
+                version: VERSION,
+                representationName: RepresentationType,
+            };
+            luvio.publishStoreMetadata(key, storeMetadataParams);
+        }
+        return createLink(key);
+    };
+    function getTypeCacheKeys(luvio, input, fullPathFactory) {
+        const rootKeySet = new engine.StoreKeyMap();
+        // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+        const rootKey = fullPathFactory();
+        rootKeySet.set(rootKey, {
+            namespace: keyPrefix,
+            representationName: RepresentationType,
+            mergeable: false
+        });
+        return rootKeySet;
+    }
+
+    function select(luvio, params) {
+        return select$1();
+    }
+    function keyBuilder$1(luvio, params) {
+        return keyPrefix + '::DataProviderSchemaRepresentation:(' + 'config:' + params.queryParams.config + ',' + 'dataProviderFQN:' + params.urlParams.dataProviderFQN + ')';
+    }
+    function getResponseCacheKeys(luvio, resourceParams, response) {
+        return getTypeCacheKeys(luvio, response, () => keyBuilder$1(luvio, resourceParams));
+    }
+    function ingestSuccess(luvio, resourceParams, response, snapshotRefresh) {
+        const { body } = response;
+        const key = keyBuilder$1(luvio, resourceParams);
+        luvio.storeIngest(key, ingest, body);
+        const snapshot = luvio.storeLookup({
+            recordId: key,
+            node: select(),
+            variables: {},
+        }, snapshotRefresh);
+        if (process.env.NODE_ENV !== 'production') {
+            if (snapshot.state !== 'Fulfilled') {
+                throw new Error('Invalid network response. Expected resource response to result in Fulfilled snapshot');
+            }
+        }
+        return snapshot;
+    }
+    function ingestError(luvio, params, error, snapshotRefresh) {
+        const key = keyBuilder$1(luvio, params);
+        const errorSnapshot = luvio.errorSnapshot(error, snapshotRefresh);
+        const storeMetadataParams = {
+            ttl: TTL,
+            namespace: keyPrefix,
+            version: VERSION,
+            representationName: RepresentationType
+        };
+        luvio.storeIngestError(key, errorSnapshot, storeMetadataParams);
+        return errorSnapshot;
+    }
+    function createResourceRequest(config) {
+        const headers = {};
+        return {
+            baseUri: '/services/data/v58.0',
+            basePath: '/connect/data-providers/' + config.urlParams.dataProviderFQN + '/schema',
+            method: 'get',
+            body: null,
+            urlParams: config.urlParams,
+            queryParams: config.queryParams,
+            headers,
+            priority: 'normal',
+        };
+    }
+
+    const getSchema_ConfigPropertyNames = {
+        displayName: 'getSchema',
+        parameters: {
+            required: ['dataProviderFQN'],
+            optional: ['config']
+        }
+    };
+    function createResourceParams(config) {
+        const resourceParams = {
+            urlParams: {
+                dataProviderFQN: config.dataProviderFQN
+            },
+            queryParams: {
+                config: config.config
+            }
+        };
+        return resourceParams;
+    }
+    function keyBuilder(luvio, config) {
+        const resourceParams = createResourceParams(config);
+        return keyBuilder$1(luvio, resourceParams);
+    }
+    function typeCheckConfig(untrustedConfig) {
+        const config = {};
+        const untrustedConfig_dataProviderFQN = untrustedConfig.dataProviderFQN;
+        if (typeof untrustedConfig_dataProviderFQN === 'string') {
+            config.dataProviderFQN = untrustedConfig_dataProviderFQN;
+        }
+        const untrustedConfig_config = untrustedConfig.config;
+        if (typeof untrustedConfig_config === 'string') {
+            config.config = untrustedConfig_config;
+        }
+        return config;
+    }
+    function validateAdapterConfig(untrustedConfig, configPropertyNames) {
+        if (!untrustedIsObject(untrustedConfig)) {
+            return null;
+        }
+        if (process.env.NODE_ENV !== 'production') {
+            validateConfig(untrustedConfig, configPropertyNames);
+        }
+        const config = typeCheckConfig(untrustedConfig);
+        if (!areRequiredParametersPresent(config, configPropertyNames)) {
+            return null;
+        }
+        return config;
+    }
+    function adapterFragment(luvio, config) {
+        createResourceParams(config);
+        return select();
+    }
+    function onFetchResponseSuccess(luvio, config, resourceParams, response) {
+        const snapshot = ingestSuccess(luvio, resourceParams, response, {
+            config,
+            resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+        });
+        return luvio.storeBroadcast().then(() => snapshot);
+    }
+    function onFetchResponseError(luvio, config, resourceParams, response) {
+        const snapshot = ingestError(luvio, resourceParams, response, {
+            config,
+            resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+        });
+        return luvio.storeBroadcast().then(() => snapshot);
+    }
+    function buildNetworkSnapshot(luvio, config, options) {
+        const resourceParams = createResourceParams(config);
+        const request = createResourceRequest(resourceParams);
+        return luvio.dispatchResourceRequest(request, options)
+            .then((response) => {
+            return luvio.handleSuccessResponse(() => onFetchResponseSuccess(luvio, config, resourceParams, response), () => getResponseCacheKeys(luvio, resourceParams, response.body));
+        }, (response) => {
+            return luvio.handleErrorResponse(() => onFetchResponseError(luvio, config, resourceParams, response));
+        });
+    }
+    function buildNetworkSnapshotCachePolicy(context, coercedAdapterRequestContext) {
+        const { luvio, config } = context;
+        const { networkPriority, requestCorrelator, eventObservers } = coercedAdapterRequestContext;
+        const dispatchOptions = {
+            resourceRequestContext: {
+                requestCorrelator,
+                luvioRequestMethod: undefined,
+            },
+            eventObservers
+        };
+        if (networkPriority !== 'normal') {
+            dispatchOptions.overrides = {
+                priority: networkPriority
+            };
+        }
+        return buildNetworkSnapshot(luvio, config, dispatchOptions);
+    }
+    function buildCachedSnapshotCachePolicy(context, storeLookup) {
+        const { luvio, config } = context;
+        const selector = {
+            recordId: keyBuilder(luvio, config),
+            node: adapterFragment(luvio, config),
+            variables: {},
+        };
+        const cacheSnapshot = storeLookup(selector, {
+            config,
+            resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+        });
+        return cacheSnapshot;
+    }
+    const getSchemaAdapterFactory = (luvio) => function DataProviders__getSchema(untrustedConfig, requestContext) {
+        const config = validateAdapterConfig(untrustedConfig, getSchema_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            return null;
+        }
+        return luvio.applyCachePolicy((requestContext || {}), { config, luvio }, // BuildSnapshotContext
+        buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy);
+    };
+
+    exports.getSchemaAdapterFactory = getSchemaAdapterFactory;
+
+    Object.defineProperty(exports, '__esModule', { value: true });
+
+}));