@salesforce/lds-adapters-industries-omnidesigner 1.281.0

package/sfdc/index.js

@@ -0,0 +1,487 @@
+/**
+ * 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 { createInstrumentedAdapter, createLDSAdapter, createWireAdapterConstructor, createImperativeAdapter } from 'force/ldsBindings';
+import { withDefaultLuvio } from 'force/ldsEngine';
+import { serializeStructuredKey, ingestShape, deepFreeze, buildNetworkSnapshotCachePolicy as buildNetworkSnapshotCachePolicy$1, typeCheckConfig as typeCheckConfig$1, StoreKeyMap, createResourceParams as createResourceParams$1 } from 'force/luvioEngine';
+
+const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+const { keys: ObjectKeys, create: ObjectCreate } = 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(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',
+        },
+    }
+};
+function generateParamConfigMetadata(name, required, resourceType, typeCheckShape, isArrayShape = false, coerceFn) {
+    return {
+        name,
+        required,
+        resourceType,
+        typeCheckShape,
+        isArrayShape,
+        coerceFn,
+    };
+}
+function buildAdapterValidationConfig(displayName, paramsMeta) {
+    const required = paramsMeta.filter(p => p.required).map(p => p.name);
+    const optional = paramsMeta.filter(p => !p.required).map(p => p.name);
+    return {
+        displayName,
+        parameters: {
+            required,
+            optional,
+        }
+    };
+}
+const keyPrefix = 'OmniDesigner';
+
+const { isArray: ArrayIsArray } = Array;
+function equalsArray(a, b, equalsItem) {
+    const aLength = a.length;
+    const bLength = b.length;
+    if (aLength !== bLength) {
+        return false;
+    }
+    for (let i = 0; i < aLength; i++) {
+        if (equalsItem(a[i], b[i]) === false) {
+            return false;
+        }
+    }
+    return true;
+}
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+const VERSION$2 = "82ae2dc85f99633c65d4dd65d4ea7723";
+function validate$2(obj, path = 'OmniDesignerEntityInfoDetailRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_entityInfoName = obj.entityInfoName;
+        const path_entityInfoName = path + '.entityInfoName';
+        if (typeof obj_entityInfoName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_entityInfoName + '" (at "' + path_entityInfoName + '")');
+        }
+        const obj_entityInfoValue = obj.entityInfoValue;
+        const path_entityInfoValue = path + '.entityInfoValue';
+        if (typeof obj_entityInfoValue !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_entityInfoValue + '" (at "' + path_entityInfoValue + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$3 = function OmniDesignerEntityInfoDetailRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION$2,
+        private: [],
+        selections: [
+            {
+                name: 'entityInfoName',
+                kind: 'Scalar'
+            },
+            {
+                name: 'entityInfoValue',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$2(existing, incoming) {
+    const existing_entityInfoName = existing.entityInfoName;
+    const incoming_entityInfoName = incoming.entityInfoName;
+    if (!(existing_entityInfoName === incoming_entityInfoName)) {
+        return false;
+    }
+    const existing_entityInfoValue = existing.entityInfoValue;
+    const incoming_entityInfoValue = incoming.entityInfoValue;
+    if (!(existing_entityInfoValue === incoming_entityInfoValue)) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION$1 = "4d8b4cf8a4cb069856885e2ea0da8a80";
+function validate$1(obj, path = 'OmniDesignerEntitiesInfoDetailRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_entityInfo = obj.entityInfo;
+        const path_entityInfo = path + '.entityInfo';
+        if (!ArrayIsArray(obj_entityInfo)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_entityInfo + '" (at "' + path_entityInfo + '")');
+        }
+        for (let i = 0; i < obj_entityInfo.length; i++) {
+            const obj_entityInfo_item = obj_entityInfo[i];
+            const path_entityInfo_item = path_entityInfo + '[' + i + ']';
+            const referencepath_entityInfo_itemValidationError = validate$2(obj_entityInfo_item, path_entityInfo_item);
+            if (referencepath_entityInfo_itemValidationError !== null) {
+                let message = 'Object doesn\'t match OmniDesignerEntityInfoDetailRepresentation (at "' + path_entityInfo_item + '")\n';
+                message += referencepath_entityInfo_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+        const obj_entityName = obj.entityName;
+        const path_entityName = path + '.entityName';
+        if (typeof obj_entityName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_entityName + '" (at "' + path_entityName + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$2 = function OmniDesignerEntitiesInfoDetailRepresentationSelect() {
+    const { selections: OmniDesignerEntityInfoDetailRepresentation__selections, opaque: OmniDesignerEntityInfoDetailRepresentation__opaque, } = select$3();
+    return {
+        kind: 'Fragment',
+        version: VERSION$1,
+        private: [],
+        selections: [
+            {
+                name: 'entityInfo',
+                kind: 'Object',
+                plural: true,
+                selections: OmniDesignerEntityInfoDetailRepresentation__selections
+            },
+            {
+                name: 'entityName',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$1(existing, incoming) {
+    const existing_entityName = existing.entityName;
+    const incoming_entityName = incoming.entityName;
+    if (!(existing_entityName === incoming_entityName)) {
+        return false;
+    }
+    const existing_entityInfo = existing.entityInfo;
+    const incoming_entityInfo = incoming.entityInfo;
+    const equals_entityInfo_items = equalsArray(existing_entityInfo, incoming_entityInfo, (existing_entityInfo_item, incoming_entityInfo_item) => {
+        if (!(equals$2(existing_entityInfo_item, incoming_entityInfo_item))) {
+            return false;
+        }
+    });
+    if (equals_entityInfo_items === false) {
+        return false;
+    }
+    return true;
+}
+
+const TTL = 10000;
+const VERSION = "2ed0e3bb8be6d1c5a8e7b538d4a59f17";
+function validate(obj, path = 'OmniDesignerEntityInfoRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_entitiesInfo = obj.entitiesInfo;
+        const path_entitiesInfo = path + '.entitiesInfo';
+        if (!ArrayIsArray(obj_entitiesInfo)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_entitiesInfo + '" (at "' + path_entitiesInfo + '")');
+        }
+        for (let i = 0; i < obj_entitiesInfo.length; i++) {
+            const obj_entitiesInfo_item = obj_entitiesInfo[i];
+            const path_entitiesInfo_item = path_entitiesInfo + '[' + i + ']';
+            const referencepath_entitiesInfo_itemValidationError = validate$1(obj_entitiesInfo_item, path_entitiesInfo_item);
+            if (referencepath_entitiesInfo_itemValidationError !== null) {
+                let message = 'Object doesn\'t match OmniDesignerEntitiesInfoDetailRepresentation (at "' + path_entitiesInfo_item + '")\n';
+                message += referencepath_entitiesInfo_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+        if (obj.queryMore !== undefined) {
+            const obj_queryMore = obj.queryMore;
+            const path_queryMore = path + '.queryMore';
+            if (typeof obj_queryMore !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_queryMore + '" (at "' + path_queryMore + '")');
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'OmniDesignerEntityInfoRepresentation';
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function OmniDesignerEntityInfoRepresentationSelect() {
+    const { selections: OmniDesignerEntitiesInfoDetailRepresentation__selections, opaque: OmniDesignerEntitiesInfoDetailRepresentation__opaque, } = select$2();
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'entitiesInfo',
+                kind: 'Object',
+                plural: true,
+                selections: OmniDesignerEntitiesInfoDetailRepresentation__selections
+            },
+            {
+                name: 'queryMore',
+                kind: 'Scalar',
+                required: false
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_queryMore = existing.queryMore;
+    const incoming_queryMore = incoming.queryMore;
+    // if at least one of these optionals is defined
+    if (existing_queryMore !== undefined || incoming_queryMore !== undefined) {
+        // if one of these is not defined we know the other is defined and therefore
+        // not equal
+        if (existing_queryMore === undefined || incoming_queryMore === undefined) {
+            return false;
+        }
+        if (!(existing_queryMore === incoming_queryMore)) {
+            return false;
+        }
+    }
+    const existing_entitiesInfo = existing.entitiesInfo;
+    const incoming_entitiesInfo = incoming.entitiesInfo;
+    const equals_entitiesInfo_items = equalsArray(existing_entitiesInfo, incoming_entitiesInfo, (existing_entitiesInfo_item, incoming_entitiesInfo_item) => {
+        if (!(equals$1(existing_entitiesInfo_item, incoming_entitiesInfo_item))) {
+            return false;
+        }
+    });
+    if (equals_entitiesInfo_items === false) {
+        return false;
+    }
+    return true;
+}
+const ingest = function OmniDesignerEntityInfoRepresentationIngest(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 ttlToUse = TTL;
+    ingestShape(input, path, luvio, store, timestamp, ttlToUse, key, normalize, "OmniDesigner", VERSION, RepresentationType, equals);
+    return createLink(key);
+};
+function getTypeCacheKeys(rootKeySet, luvio, input, fullPathFactory) {
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = fullPathFactory();
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType,
+        mergeable: false
+    });
+}
+
+function select(luvio, params) {
+    return select$1();
+}
+function keyBuilder$1(luvio, params) {
+    return keyPrefix + '::OmniDesignerEntityInfoRepresentation:(' + 'pageSize:' + params.queryParams.pageSize + ',' + 'queryMore:' + params.queryParams.queryMore + ')';
+}
+function getResponseCacheKeys(storeKeyMap, luvio, resourceParams, response) {
+    getTypeCacheKeys(storeKeyMap, 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');
+        }
+    }
+    deepFreeze(snapshot.data);
+    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/v61.0',
+        basePath: '/connect/omni-designer/entity-info',
+        method: 'get',
+        body: null,
+        urlParams: {},
+        queryParams: config.queryParams,
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName = 'fetchEntityInfo';
+const fetchEntityInfo_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('pageSize', false, 1 /* QueryParameter */, 3 /* Integer */),
+    generateParamConfigMetadata('queryMore', false, 1 /* QueryParameter */, 0 /* String */),
+];
+const fetchEntityInfo_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, fetchEntityInfo_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$1(fetchEntityInfo_ConfigPropertyMetadata);
+function keyBuilder(luvio, config) {
+    const resourceParams = createResourceParams(config);
+    return keyBuilder$1(luvio, resourceParams);
+}
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    typeCheckConfig$1(untrustedConfig, config, fetchEntityInfo_ConfigPropertyMetadata);
+    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), () => {
+            const cache = new StoreKeyMap();
+            getResponseCacheKeys(cache, luvio, resourceParams, response.body);
+            return cache;
+        });
+    }, (response) => {
+        return luvio.handleErrorResponse(() => onFetchResponseError(luvio, config, resourceParams, response));
+    });
+}
+function buildNetworkSnapshotCachePolicy(context, coercedAdapterRequestContext) {
+    return buildNetworkSnapshotCachePolicy$1(context, coercedAdapterRequestContext, buildNetworkSnapshot, undefined, false);
+}
+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 fetchEntityInfoAdapterFactory = (luvio) => function OmniDesigner__fetchEntityInfo(untrustedConfig, requestContext) {
+    const config = validateAdapterConfig(untrustedConfig, fetchEntityInfo_ConfigPropertyNames);
+    // Invalid or incomplete config
+    if (config === null) {
+        return null;
+    }
+    return luvio.applyCachePolicy((requestContext || {}), { config, luvio }, // BuildSnapshotContext
+    buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy);
+};
+
+let fetchEntityInfo;
+// Imperative GET Adapters
+let fetchEntityInfo_imperative;
+// Adapter Metadata
+const fetchEntityInfoMetadata = { apiFamily: 'OmniDesigner', name: 'fetchEntityInfo', ttl: 10000 };
+// Notify Update Available
+function bindExportsTo(luvio) {
+    // LDS Adapters
+    const fetchEntityInfo_ldsAdapter = createInstrumentedAdapter(createLDSAdapter(luvio, 'fetchEntityInfo', fetchEntityInfoAdapterFactory), fetchEntityInfoMetadata);
+    return {
+        fetchEntityInfo: createWireAdapterConstructor(luvio, fetchEntityInfo_ldsAdapter, fetchEntityInfoMetadata),
+        // Imperative GET Adapters
+        fetchEntityInfo_imperative: createImperativeAdapter(luvio, fetchEntityInfo_ldsAdapter, fetchEntityInfoMetadata),
+        // Notify Update Availables
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({ fetchEntityInfo, fetchEntityInfo_imperative } = bindExportsTo(luvio));
+});
+
+export { fetchEntityInfo, fetchEntityInfo_imperative };
+// version: 1.281.0-bcef40769

package/src/raml/api.raml

@@ -0,0 +1,82 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v61.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  OmniDesignerEntitiesInfoDetailRepresentation:
+    description: List of enities
+    type: object
+    properties:
+      entityInfo:
+        description: Information about the entity as a List of name value pairs.
+        type: array
+        items:
+          type: OmniDesignerEntityInfoDetailRepresentation
+      entityName:
+        description: The name of the entity
+        type: string
+  OmniDesignerEntityInfoDetailRepresentation:
+    description: Information about an entity
+    type: object
+    properties:
+      entityInfoName:
+        description: The name of the property of the entity like the label
+        type: string
+      entityInfoValue:
+        description: The value of the property
+        type: string
+  OmniDesignerEntityInfoRepresentation:
+    description: Entity Info output
+    type: object
+    properties:
+      entitiesInfo:
+        description: A list of OmniDesignerEntityInfoDetailRepresentation
+        type: array
+        items:
+          type: OmniDesignerEntitiesInfoDetailRepresentation
+      queryMore:
+        description: A string in an internal format that should be returned by the
+          caller as is to fetch the next set of entities
+        type: string
+        required: false
+
+/connect/omni-designer:
+  /entity-info:
+    get:
+      displayName: fetchEntityInfo
+      description: Fetches metadata about Entity Objects
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: OmniDesignerEntityInfoRepresentation
+      queryParameters:
+        pageSize:
+          type: integer
+          required: false
+        queryMore:
+          type: string
+          required: false

package/src/raml/luvio.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'OmniDesigner'
+
+types:
+  OmniDesignerEntityInfoRepresentation:
+    (luvio.ttl): 10000
+
+/connect/omni-designer:
+  /entity-info:
+    get:
+      (luvio.adapter):
+        name: fetchEntityInfo