@salesforce/lds-adapters-industries-data-processing-engine 1.320.0

package/sfdc/index.js

@@ -0,0 +1,482 @@
+/**
+ * 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 { withDefaultLuvio } from 'force/ldsEngine';
+import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$1, typeCheckConfig as typeCheckConfig$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);
+}
+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 = 'data-processing-engine';
+
+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$3 = "6e8414bbd871d95b4bb093b7da259091";
+function validate$3(obj, path = 'WritebackSuggestionMetadataOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_generationId = obj.generationId;
+        const path_generationId = path + '.generationId';
+        if (typeof obj_generationId !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_generationId + '" (at "' + path_generationId + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$4 = function WritebackSuggestionMetadataOutputRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION$3,
+        private: [],
+        selections: [
+            {
+                name: 'generationId',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$3(existing, incoming) {
+    const existing_generationId = existing.generationId;
+    const incoming_generationId = incoming.generationId;
+    if (!(existing_generationId === incoming_generationId)) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION$2 = "8f1160d49995b9f2c5baa4c775e203a6";
+function validate$2(obj, path = 'TargetFieldOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_confidence = obj.confidence;
+        const path_confidence = path + '.confidence';
+        if (typeof obj_confidence !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_confidence + '" (at "' + path_confidence + '")');
+        }
+        const obj_fieldName = obj.fieldName;
+        const path_fieldName = path + '.fieldName';
+        if (typeof obj_fieldName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_fieldName + '" (at "' + path_fieldName + '")');
+        }
+        obj.percent;
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$3 = function TargetFieldOutputRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION$2,
+        private: [],
+        selections: [
+            {
+                name: 'confidence',
+                kind: 'Scalar'
+            },
+            {
+                name: 'fieldName',
+                kind: 'Scalar'
+            },
+            {
+                name: 'percent',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$2(existing, incoming) {
+    const existing_confidence = existing.confidence;
+    const incoming_confidence = incoming.confidence;
+    if (!(existing_confidence === incoming_confidence)) {
+        return false;
+    }
+    const existing_fieldName = existing.fieldName;
+    const incoming_fieldName = incoming.fieldName;
+    if (!(existing_fieldName === incoming_fieldName)) {
+        return false;
+    }
+    const existing_percent = existing.percent;
+    const incoming_percent = incoming.percent;
+    if (!(existing_percent === incoming_percent)) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION$1 = "7dee26f6959116c39fc624103953ffa7";
+function validate$1(obj, path = 'MappingSuggestionOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_sourceFieldName = obj.sourceFieldName;
+        const path_sourceFieldName = path + '.sourceFieldName';
+        if (typeof obj_sourceFieldName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_sourceFieldName + '" (at "' + path_sourceFieldName + '")');
+        }
+        const obj_targetField = obj.targetField;
+        const path_targetField = path + '.targetField';
+        if (!ArrayIsArray(obj_targetField)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_targetField + '" (at "' + path_targetField + '")');
+        }
+        for (let i = 0; i < obj_targetField.length; i++) {
+            const obj_targetField_item = obj_targetField[i];
+            const path_targetField_item = path_targetField + '[' + i + ']';
+            const referencepath_targetField_itemValidationError = validate$2(obj_targetField_item, path_targetField_item);
+            if (referencepath_targetField_itemValidationError !== null) {
+                let message = 'Object doesn\'t match TargetFieldOutputRepresentation (at "' + path_targetField_item + '")\n';
+                message += referencepath_targetField_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$2 = function MappingSuggestionOutputRepresentationSelect() {
+    const { selections: TargetFieldOutputRepresentation__selections, opaque: TargetFieldOutputRepresentation__opaque, } = select$3();
+    return {
+        kind: 'Fragment',
+        version: VERSION$1,
+        private: [],
+        selections: [
+            {
+                name: 'sourceFieldName',
+                kind: 'Scalar'
+            },
+            {
+                name: 'targetField',
+                kind: 'Object',
+                plural: true,
+                selections: TargetFieldOutputRepresentation__selections
+            }
+        ]
+    };
+};
+function equals$1(existing, incoming) {
+    const existing_sourceFieldName = existing.sourceFieldName;
+    const incoming_sourceFieldName = incoming.sourceFieldName;
+    if (!(existing_sourceFieldName === incoming_sourceFieldName)) {
+        return false;
+    }
+    const existing_targetField = existing.targetField;
+    const incoming_targetField = incoming.targetField;
+    const equals_targetField_items = equalsArray(existing_targetField, incoming_targetField, (existing_targetField_item, incoming_targetField_item) => {
+        if (!(equals$2(existing_targetField_item, incoming_targetField_item))) {
+            return false;
+        }
+    });
+    if (equals_targetField_items === false) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION = "bd4959a9a554d32599665f66f825848b";
+function validate(obj, path = 'WritebackSuggestionOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_metadata = obj.metadata;
+        const path_metadata = path + '.metadata';
+        const referencepath_metadataValidationError = validate$3(obj_metadata, path_metadata);
+        if (referencepath_metadataValidationError !== null) {
+            let message = 'Object doesn\'t match WritebackSuggestionMetadataOutputRepresentation (at "' + path_metadata + '")\n';
+            message += referencepath_metadataValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+        const obj_suggestions = obj.suggestions;
+        const path_suggestions = path + '.suggestions';
+        if (!ArrayIsArray(obj_suggestions)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_suggestions + '" (at "' + path_suggestions + '")');
+        }
+        for (let i = 0; i < obj_suggestions.length; i++) {
+            const obj_suggestions_item = obj_suggestions[i];
+            const path_suggestions_item = path_suggestions + '[' + i + ']';
+            const referencepath_suggestions_itemValidationError = validate$1(obj_suggestions_item, path_suggestions_item);
+            if (referencepath_suggestions_itemValidationError !== null) {
+                let message = 'Object doesn\'t match MappingSuggestionOutputRepresentation (at "' + path_suggestions_item + '")\n';
+                message += referencepath_suggestions_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'WritebackSuggestionOutputRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.generationId;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        generationId: object.metadata.generationId
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function WritebackSuggestionOutputRepresentationSelect() {
+    const { selections: WritebackSuggestionMetadataOutputRepresentation__selections, opaque: WritebackSuggestionMetadataOutputRepresentation__opaque, } = select$4();
+    const { selections: MappingSuggestionOutputRepresentation__selections, opaque: MappingSuggestionOutputRepresentation__opaque, } = select$2();
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'metadata',
+                kind: 'Object',
+                selections: WritebackSuggestionMetadataOutputRepresentation__selections
+            },
+            {
+                name: 'suggestions',
+                kind: 'Object',
+                plural: true,
+                selections: MappingSuggestionOutputRepresentation__selections
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_metadata = existing.metadata;
+    const incoming_metadata = incoming.metadata;
+    if (!(equals$3(existing_metadata, incoming_metadata))) {
+        return false;
+    }
+    const existing_suggestions = existing.suggestions;
+    const incoming_suggestions = incoming.suggestions;
+    const equals_suggestions_items = equalsArray(existing_suggestions, incoming_suggestions, (existing_suggestions_item, incoming_suggestions_item) => {
+        if (!(equals$1(existing_suggestions_item, incoming_suggestions_item))) {
+            return false;
+        }
+    });
+    if (equals_suggestions_items === false) {
+        return false;
+    }
+    return true;
+}
+const ingest = function WritebackSuggestionOutputRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = keyBuilderFromType(luvio, input);
+    const ttlToUse = path.ttl !== undefined ? path.ttl : 360000;
+    ingestShape(input, path, luvio, store, timestamp, ttlToUse, key, normalize, "data-processing-engine", VERSION, RepresentationType, equals);
+    return createLink(key);
+};
+function getTypeCacheKeys(rootKeySet, luvio, input, fullPathFactory) {
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = keyBuilderFromType(luvio, input);
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType,
+        mergeable: false
+    });
+}
+
+function select(luvio, params) {
+    return select$1();
+}
+function getResponseCacheKeys(storeKeyMap, luvio, resourceParams, response) {
+    getTypeCacheKeys(storeKeyMap, luvio, response);
+}
+function ingestSuccess(luvio, resourceParams, response) {
+    const { body } = response;
+    const key = keyBuilderFromType(luvio, body);
+    luvio.storeIngest(key, ingest, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select(),
+        variables: {},
+    });
+    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 createResourceRequest(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v63.0',
+        basePath: '/connect/industries/data-processing-engine/writeback-mapping-suggestions',
+        method: 'post',
+        body: config.body,
+        urlParams: {},
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName = 'generateMappingSuggestions';
+const generateMappingSuggestions_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('datasource', true, 2 /* Body */, 4 /* Unsupported */),
+    generateParamConfigMetadata('processType', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('target', true, 2 /* Body */, 4 /* Unsupported */),
+];
+const generateMappingSuggestions_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, generateMappingSuggestions_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$1(generateMappingSuggestions_ConfigPropertyMetadata);
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    typeCheckConfig$1(untrustedConfig, config, generateMappingSuggestions_ConfigPropertyMetadata);
+    const untrustedConfig_datasource = untrustedConfig.datasource;
+    config.datasource = untrustedConfig_datasource;
+    const untrustedConfig_target = untrustedConfig.target;
+    config.target = untrustedConfig_target;
+    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 buildNetworkSnapshot(luvio, config, options) {
+    const resourceParams = createResourceParams(config);
+    const request = createResourceRequest(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => {
+            const snapshot = ingestSuccess(luvio, resourceParams, response);
+            return luvio.storeBroadcast().then(() => snapshot);
+        }, () => {
+            const cache = new StoreKeyMap();
+            getResponseCacheKeys(cache, luvio, resourceParams, response.body);
+            return cache;
+        });
+    }, (response) => {
+        deepFreeze(response);
+        throw response;
+    });
+}
+const generateMappingSuggestionsAdapterFactory = (luvio) => {
+    return function generateMappingSuggestions(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, generateMappingSuggestions_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "generateMappingSuggestions"');
+        }
+        return buildNetworkSnapshot(luvio, config);
+    };
+};
+
+let generateMappingSuggestions;
+// Notify Update Available
+function bindExportsTo(luvio) {
+    // LDS Adapters
+    function unwrapSnapshotData(factory) {
+        const adapter = factory(luvio);
+        return (config) => adapter(config).then((snapshot) => snapshot.data);
+    }
+    return {
+        generateMappingSuggestions: unwrapSnapshotData(generateMappingSuggestionsAdapterFactory),
+        // Imperative GET Adapters
+        // Notify Update Availables
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({ generateMappingSuggestions } = bindExportsTo(luvio));
+});
+
+export { generateMappingSuggestions };
+// version: 1.320.0-e3e5f3d984

package/src/raml/api.raml

@@ -0,0 +1,116 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v63.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:
+  FieldDetailsInputRepresentation:
+    description: An Input Representation of the field details for writeback mapping
+      suggestions
+    type: object
+    properties:
+      name:
+        description: Name of the Field
+        type: string
+  FieldsDataInputRepresentation:
+    description: An Input Representation of the fields for writeback mapping suggestions
+    type: object
+    properties:
+      fields:
+        description: Field data for Writeback suggestion input
+        type: array
+        items:
+          type: FieldDetailsInputRepresentation
+  MappingSuggestionOutputRepresentation:
+    description: Output Representation for mapping suggestion
+    type: object
+    properties:
+      sourceFieldName:
+        description: Name of the Source field in mapping suggestion
+        type: string
+      targetField:
+        description: Target field of the mapping suggestions
+        type: array
+        items:
+          type: TargetFieldOutputRepresentation
+  TargetFieldOutputRepresentation:
+    description: Output Representation for mapping suggestions target field
+    type: object
+    properties:
+      confidence:
+        description: Confidence level of the mapping suggestions
+        type: string
+      fieldName:
+        description: Name of the target field in mapping suggestion
+        type: string
+      percent:
+        description: Confidence in percentage of the mapping suggestions
+        format: double
+        type: number
+  WritebackSuggestionInputRepresentation:
+    description: An Input Representation for writeback mapping suggestions
+    type: object
+    properties:
+      datasource:
+        description: Datasource fields for Writeback suggestion input
+        type: any
+      processType:
+        description: ProcessType of the DPE definition
+        type: string
+      target:
+        description: Target fields for Writeback suggestion input
+        type: any
+  WritebackSuggestionMetadataOutputRepresentation:
+    description: Output Representation for writeback mapping suggestions metadata
+    type: object
+    properties:
+      generationId:
+        description: Generation id of the LLM response used for feedback
+        type: string
+  WritebackSuggestionOutputRepresentation:
+    description: Output Representation for writeback mapping suggestions
+    type: object
+    properties:
+      metadata:
+        description: Metadata about generated writeback mapping suggestions
+        type: WritebackSuggestionMetadataOutputRepresentation
+      suggestions:
+        description: Generated writeback mapping suggestions
+        type: array
+        items:
+          type: MappingSuggestionOutputRepresentation
+/connect/industries/data-processing-engine/writeback-mapping-suggestions:
+  post:
+    displayName: postDPEWritebackMapping
+    description: Generate mapping suggestions
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: WritebackSuggestionOutputRepresentation
+    body:
+      application/json:
+        type: WritebackSuggestionInputRepresentation
+        (oas-body-name): mappingSuggestionInput

package/src/raml/luvio.raml

@@ -0,0 +1,18 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'data-processing-engine'
+(luvio.ttl): 360000
+
+types:
+  WritebackSuggestionOutputRepresentation:
+    (luvio.key):
+      generationId: metadata.generationId
+
+/connect/industries/data-processing-engine/writeback-mapping-suggestions:
+  post:
+    (luvio.adapter):
+      name: generateMappingSuggestions