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

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

@@ -0,0 +1,352 @@
+/**
+ * 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';
+
+    var ObjectPrototypeHasOwnProperty = Object.prototype.hasOwnProperty;
+    var ObjectKeys$1 = Object.keys;
+    var ArrayIsArray$1 = Array.isArray;
+    /**
+     * 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) {
+        var displayName = adapter.displayName;
+        var _a = adapter.parameters, required = _a.required, optional = _a.optional, unsupported = _a.unsupported;
+        if (config === undefined ||
+            required.every(function (req) { return ObjectPrototypeHasOwnProperty.call(config, req); }) === false) {
+            throw new TypeError("adapter ".concat(displayName, " configuration must specify ").concat(required.sort().join(', ')));
+        }
+        if (oneOf && oneOf.some(function (req) { return ObjectPrototypeHasOwnProperty.call(config, req); }) === false) {
+            throw new TypeError("adapter ".concat(displayName, " configuration must specify one of ").concat(oneOf.sort().join(', ')));
+        }
+        if (unsupported !== undefined &&
+            unsupported.some(function (req) { return ObjectPrototypeHasOwnProperty.call(config, req); })) {
+            throw new TypeError("adapter ".concat(displayName, " does not yet support ").concat(unsupported.sort().join(', ')));
+        }
+        var supported = required.concat(optional);
+        if (ObjectKeys$1(config).some(function (key) { return !supported.includes(key); })) {
+            throw new TypeError("adapter ".concat(displayName, " configuration supports only ").concat(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(function (req) { return req in config; });
+    }
+    var snapshotRefreshOptions = {
+        overrides: {
+            headers: {
+                'Cache-Control': 'no-cache',
+            },
+        }
+    };
+    var keyPrefix = 'DataProviders';
+
+    var ObjectFreeze = Object.freeze, ObjectKeys = Object.keys;
+    var ArrayIsArray = Array.isArray;
+    var JSONStringify = JSON.stringify;
+    function deepFreeze$1(value) {
+        // No need to freeze primitives
+        if (typeof value !== 'object' || value === null) {
+            return;
+        }
+        if (ArrayIsArray(value)) {
+            for (var i = 0, len = value.length; i < len; i += 1) {
+                deepFreeze$1(value[i]);
+            }
+        }
+        else {
+            var keys = ObjectKeys(value);
+            for (var i = 0, len = keys.length; i < len; i += 1) {
+                deepFreeze$1(value[keys[i]]);
+            }
+        }
+        ObjectFreeze(value);
+    }
+    function createLink(ref) {
+        return {
+            __ref: engine.serializeStructuredKey(ref),
+        };
+    }
+
+    var TTL = 3600000;
+    var VERSION = "fa63b622a17d190f6bafa7967153c8be";
+    function validate(obj, path) {
+        if (path === void 0) { path = 'DataProviderSchemaRepresentation'; }
+        var v_error = (function () {
+            if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+                return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+            }
+            var obj_schema = obj.schema;
+            var 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 + '")');
+            }
+            var obj_schema_keys = ObjectKeys(obj_schema);
+            for (var i = 0; i < obj_schema_keys.length; i++) {
+                var key = obj_schema_keys[i];
+                var obj_schema_prop = obj_schema[key];
+                var 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;
+    }
+    var RepresentationType = 'DataProviderSchemaRepresentation';
+    function normalize(input, existing, path, luvio, store, timestamp) {
+        return input;
+    }
+    var 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) {
+        var input_schema = input.schema;
+        var input_schema_keys = Object.keys(input_schema);
+        var input_schema_length = input_schema_keys.length;
+        for (var i = 0; i < input_schema_length; i++) {
+            var key = input_schema_keys[i];
+            var input_schema_prop = input_schema[key];
+            deepFreeze$1(input_schema_prop);
+        }
+        ObjectFreeze(input_schema);
+        ObjectFreeze(input);
+    }
+    var ingest = function DataProviderSchemaRepresentationIngest(input, path, luvio, store, timestamp) {
+        if (process.env.NODE_ENV !== 'production') {
+            var validateError = validate(input);
+            if (validateError !== null) {
+                throw validateError;
+            }
+        }
+        var key = path.fullPath;
+        var existingRecord = store.readEntry(key);
+        var ttlToUse = TTL;
+        var 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);
+        }
+        {
+            var storeMetadataParams = {
+                ttl: ttlToUse,
+                namespace: "DataProviders",
+                version: VERSION,
+                representationName: RepresentationType,
+            };
+            luvio.publishStoreMetadata(key, storeMetadataParams);
+        }
+        return createLink(key);
+    };
+    function getTypeCacheKeys(luvio, input, fullPathFactory) {
+        var rootKeySet = new engine.StoreKeyMap();
+        // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+        var 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, function () { return keyBuilder$1(luvio, resourceParams); });
+    }
+    function ingestSuccess(luvio, resourceParams, response, snapshotRefresh) {
+        var body = response.body;
+        var key = keyBuilder$1(luvio, resourceParams);
+        luvio.storeIngest(key, ingest, body);
+        var 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) {
+        var key = keyBuilder$1(luvio, params);
+        var errorSnapshot = luvio.errorSnapshot(error, snapshotRefresh);
+        var storeMetadataParams = {
+            ttl: TTL,
+            namespace: keyPrefix,
+            version: VERSION,
+            representationName: RepresentationType
+        };
+        luvio.storeIngestError(key, errorSnapshot, storeMetadataParams);
+        return errorSnapshot;
+    }
+    function createResourceRequest(config) {
+        var 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: headers,
+            priority: 'normal',
+        };
+    }
+
+    var getSchema_ConfigPropertyNames = {
+        displayName: 'getSchema',
+        parameters: {
+            required: ['dataProviderFQN'],
+            optional: ['config']
+        }
+    };
+    function createResourceParams(config) {
+        var resourceParams = {
+            urlParams: {
+                dataProviderFQN: config.dataProviderFQN
+            },
+            queryParams: {
+                config: config.config
+            }
+        };
+        return resourceParams;
+    }
+    function keyBuilder(luvio, config) {
+        var resourceParams = createResourceParams(config);
+        return keyBuilder$1(luvio, resourceParams);
+    }
+    function typeCheckConfig(untrustedConfig) {
+        var config = {};
+        var untrustedConfig_dataProviderFQN = untrustedConfig.dataProviderFQN;
+        if (typeof untrustedConfig_dataProviderFQN === 'string') {
+            config.dataProviderFQN = untrustedConfig_dataProviderFQN;
+        }
+        var 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);
+        }
+        var 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) {
+        var snapshot = ingestSuccess(luvio, resourceParams, response, {
+            config: config,
+            resolve: function () { return buildNetworkSnapshot(luvio, config, snapshotRefreshOptions); }
+        });
+        return luvio.storeBroadcast().then(function () { return snapshot; });
+    }
+    function onFetchResponseError(luvio, config, resourceParams, response) {
+        var snapshot = ingestError(luvio, resourceParams, response, {
+            config: config,
+            resolve: function () { return buildNetworkSnapshot(luvio, config, snapshotRefreshOptions); }
+        });
+        return luvio.storeBroadcast().then(function () { return snapshot; });
+    }
+    function buildNetworkSnapshot(luvio, config, options) {
+        var resourceParams = createResourceParams(config);
+        var request = createResourceRequest(resourceParams);
+        return luvio.dispatchResourceRequest(request, options)
+            .then(function (response) {
+            return luvio.handleSuccessResponse(function () { return onFetchResponseSuccess(luvio, config, resourceParams, response); }, function () { return getResponseCacheKeys(luvio, resourceParams, response.body); });
+        }, function (response) {
+            return luvio.handleErrorResponse(function () { return onFetchResponseError(luvio, config, resourceParams, response); });
+        });
+    }
+    function buildNetworkSnapshotCachePolicy(context, coercedAdapterRequestContext) {
+        var luvio = context.luvio, config = context.config;
+        var networkPriority = coercedAdapterRequestContext.networkPriority, requestCorrelator = coercedAdapterRequestContext.requestCorrelator, eventObservers = coercedAdapterRequestContext.eventObservers;
+        var dispatchOptions = {
+            resourceRequestContext: {
+                requestCorrelator: requestCorrelator,
+                luvioRequestMethod: undefined,
+            },
+            eventObservers: eventObservers
+        };
+        if (networkPriority !== 'normal') {
+            dispatchOptions.overrides = {
+                priority: networkPriority
+            };
+        }
+        return buildNetworkSnapshot(luvio, config, dispatchOptions);
+    }
+    function buildCachedSnapshotCachePolicy(context, storeLookup) {
+        var luvio = context.luvio, config = context.config;
+        var selector = {
+            recordId: keyBuilder(luvio, config),
+            node: adapterFragment(luvio, config),
+            variables: {},
+        };
+        var cacheSnapshot = storeLookup(selector, {
+            config: config,
+            resolve: function () { return buildNetworkSnapshot(luvio, config, snapshotRefreshOptions); }
+        });
+        return cacheSnapshot;
+    }
+    var getSchemaAdapterFactory = function (luvio) { return function DataProviders__getSchema(untrustedConfig, requestContext) {
+        var config = validateAdapterConfig(untrustedConfig, getSchema_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            return null;
+        }
+        return luvio.applyCachePolicy((requestContext || {}), { config: config, luvio: luvio }, // BuildSnapshotContext
+        buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy);
+    }; };
+
+    exports.getSchemaAdapterFactory = getSchemaAdapterFactory;
+
+    Object.defineProperty(exports, '__esModule', { value: true });
+
+}));

package/package.json

@@ -0,0 +1,64 @@
+{
+    "name": "@salesforce/lds-adapters-platform-data-provider",
+    "version": "1.100.2",
+    "description": "Data Provider connect api resource family",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "main": "dist/umd/es2018/platform-data-provider.js",
+    "module": "dist/es/es2018/platform-data-provider.js",
+    "types": "dist/types/src/generated/artifacts/main.d.ts",
+    "files": [
+        "dist",
+        "sfdc",
+        "src/raml/*"
+    ],
+    "exports": {
+        ".": {
+            "import": "./dist/es/es2018/platform-data-provider.js",
+            "require": "./dist/umd/es2018/platform-data-provider.js",
+            "types": "./dist/types/src/generated/artifacts/main.d.ts"
+        },
+        "./sfdc": {
+            "import": "./sfdc/index.js",
+            "types": "./sfdc/index.d.ts",
+            "default": "./sfdc/index.js"
+        }
+    },
+    "contributors": [
+        "t.garg@salesforce.com"
+    ],
+    "scripts": {
+        "build": "yarn build:raml && yarn build:services && yarn build:karma",
+        "build:karma": "rollup --config rollup.config.karma.js",
+        "build:raml": "luvio generate src/raml/luvio.raml src/generated -p '../lds-compiler-plugins'",
+        "build:services": "rollup --config rollup.config.js",
+        "clean": "rm -rf dist sfdc src/generated karma/dist",
+        "release:core": "../../scripts/release/core.js --adapter=lds-adapters-platform-data-provider",
+        "release:corejar": "yarn build && ../core-build/scripts/core.js --adapter=lds-adapters-platform-data-provider",
+        "start": "karma start",
+        "test": "karma start --single-run",
+        "test:compat": "karma start --single-run --compat",
+        "test:unit": "jest"
+    },
+    "dependencies": {
+        "@salesforce/lds-bindings": "^1.100.2"
+    },
+    "devDependencies": {
+        "@luvio/cli": "0.135.4",
+        "@luvio/compiler": "0.135.4",
+        "@luvio/engine": "0.135.4",
+        "@luvio/lwc-luvio": "0.135.4",
+        "@salesforce/lds-karma": "^1.100.2"
+    },
+    "nx": {
+        "targets": {
+            "build": {
+                "outputs": [
+                    "packages/lds-adapters-platform-data-provider/dist",
+                    "packages/lds-adapters-platform-data-provider/karma/dist",
+                    "packages/lds-adapters-platform-data-provider/sfdc",
+                    "packages/lds-adapters-platform-data-provider/src/generated"
+                ]
+            }
+        }
+    }
+}

package/sfdc/index.d.ts

@@ -0,0 +1 @@
+export * from '../dist/types/src/generated/artifacts/sfdc';