@salesforce/lds-adapters-platform-formula 1.270.1 → 1.271.0

package/dist/es/es2018/platform-formula.js

@@ -4,7 +4,7 @@
  * For full license text, see the LICENSE.txt file
  */
 
-import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$1, typeCheckConfig as typeCheckConfig$1 } from '@luvio/engine';
+import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$2, typeCheckConfig as typeCheckConfig$2 } from '@luvio/engine';
 
 const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
 const { keys: ObjectKeys, create: ObjectCreate } = Object;
@@ -71,9 +71,9 @@ function createLink(ref) {
     };
 }
 
-const TTL = 100;
-const VERSION = "c06ad095a0c68e00a7cf4b94f01f937b";
-function validate(obj, path = 'FormulaExplanationRepresentation') {
+const TTL$1 = 100;
+const VERSION$1 = "c06ad095a0c68e00a7cf4b94f01f937b";
+function validate$1(obj, path = 'FormulaExplanationRepresentation') {
     const v_error = (() => {
         if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
             return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
@@ -91,23 +91,23 @@ function validate(obj, path = 'FormulaExplanationRepresentation') {
     })();
     return v_error === undefined ? null : v_error;
 }
-const RepresentationType = 'FormulaExplanationRepresentation';
-function keyBuilder(luvio, config) {
-    return keyPrefix + '::' + RepresentationType + ':' + config.generationId;
+const RepresentationType$1 = 'FormulaExplanationRepresentation';
+function keyBuilder$1(luvio, config) {
+    return keyPrefix + '::' + RepresentationType$1 + ':' + config.generationId;
 }
-function keyBuilderFromType(luvio, object) {
+function keyBuilderFromType$1(luvio, object) {
     const keyParams = {
         generationId: object.generationId
     };
-    return keyBuilder(luvio, keyParams);
+    return keyBuilder$1(luvio, keyParams);
 }
-function normalize(input, existing, path, luvio, store, timestamp) {
+function normalize$1(input, existing, path, luvio, store, timestamp) {
     return input;
 }
-const select$1 = function FormulaExplanationRepresentationSelect() {
+const select$3 = function FormulaExplanationRepresentationSelect() {
     return {
         kind: 'Fragment',
-        version: VERSION,
+        version: VERSION$1,
         private: [],
         selections: [
             {
@@ -121,7 +121,7 @@ const select$1 = function FormulaExplanationRepresentationSelect() {
         ]
     };
 };
-function equals(existing, incoming) {
+function equals$1(existing, incoming) {
     const existing_explanation = existing.explanation;
     const incoming_explanation = incoming.explanation;
     if (!(existing_explanation === incoming_explanation)) {
@@ -134,7 +134,217 @@ function equals(existing, incoming) {
     }
     return true;
 }
-const ingest = function FormulaExplanationRepresentationIngest(input, path, luvio, store, timestamp) {
+const ingest$1 = function FormulaExplanationRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate$1(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = keyBuilderFromType$1(luvio, input);
+    const ttlToUse = TTL$1;
+    ingestShape(input, path, luvio, store, timestamp, ttlToUse, key, normalize$1, "Formula", VERSION$1, RepresentationType$1, equals$1);
+    return createLink(key);
+};
+function getTypeCacheKeys$1(rootKeySet, luvio, input, fullPathFactory) {
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = keyBuilderFromType$1(luvio, input);
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType$1,
+        mergeable: false
+    });
+}
+
+function select$2(luvio, params) {
+    return select$3();
+}
+function getResponseCacheKeys$1(storeKeyMap, luvio, resourceParams, response) {
+    getTypeCacheKeys$1(storeKeyMap, luvio, response);
+}
+function ingestSuccess$1(luvio, resourceParams, response) {
+    const { body } = response;
+    const key = keyBuilderFromType$1(luvio, body);
+    luvio.storeIngest(key, ingest$1, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select$2(),
+        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$1(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v61.0',
+        basePath: '/connect/formula/einstein/explain',
+        method: 'post',
+        body: config.body,
+        urlParams: {},
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName$1 = 'getExplanation';
+const getExplanation_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('entityName', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('formula', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('formulaType', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('returnType', true, 2 /* Body */, 0 /* String */),
+];
+const getExplanation_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName$1, getExplanation_ConfigPropertyMetadata);
+const createResourceParams$1 = /*#__PURE__*/ createResourceParams$2(getExplanation_ConfigPropertyMetadata);
+function typeCheckConfig$1(untrustedConfig) {
+    const config = {};
+    typeCheckConfig$2(untrustedConfig, config, getExplanation_ConfigPropertyMetadata);
+    return config;
+}
+function validateAdapterConfig$1(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig$1(untrustedConfig);
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function buildNetworkSnapshot$1(luvio, config, options) {
+    const resourceParams = createResourceParams$1(config);
+    const request = createResourceRequest$1(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => {
+            const snapshot = ingestSuccess$1(luvio, resourceParams, response);
+            return luvio.storeBroadcast().then(() => snapshot);
+        }, () => {
+            const cache = new StoreKeyMap();
+            getResponseCacheKeys$1(cache, luvio, resourceParams, response.body);
+            return cache;
+        });
+    }, (response) => {
+        deepFreeze(response);
+        throw response;
+    });
+}
+const getExplanationAdapterFactory = (luvio) => {
+    return function getExplanation(untrustedConfig) {
+        const config = validateAdapterConfig$1(untrustedConfig, getExplanation_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "getExplanation"');
+        }
+        return buildNetworkSnapshot$1(luvio, config);
+    };
+};
+
+const TTL = 100;
+const VERSION = "6fae0fe9f113df4590f7d92a6005ddeb";
+function validate(obj, path = 'FormulaValidationRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_isFormulaValid = obj.isFormulaValid;
+        const path_isFormulaValid = path + '.isFormulaValid';
+        if (typeof obj_isFormulaValid !== 'boolean') {
+            return new TypeError('Expected "boolean" but received "' + typeof obj_isFormulaValid + '" (at "' + path_isFormulaValid + '")');
+        }
+        if (obj.message !== undefined) {
+            const obj_message = obj.message;
+            const path_message = path + '.message';
+            let obj_message_union0 = null;
+            const obj_message_union0_error = (() => {
+                if (typeof obj_message !== 'string') {
+                    return new TypeError('Expected "string" but received "' + typeof obj_message + '" (at "' + path_message + '")');
+                }
+            })();
+            if (obj_message_union0_error != null) {
+                obj_message_union0 = obj_message_union0_error.message;
+            }
+            let obj_message_union1 = null;
+            const obj_message_union1_error = (() => {
+                if (obj_message !== null) {
+                    return new TypeError('Expected "null" but received "' + typeof obj_message + '" (at "' + path_message + '")');
+                }
+            })();
+            if (obj_message_union1_error != null) {
+                obj_message_union1 = obj_message_union1_error.message;
+            }
+            if (obj_message_union0 && obj_message_union1) {
+                let message = 'Object doesn\'t match union (at "' + path_message + '")';
+                message += '\n' + obj_message_union0.split('\n').map((line) => '\t' + line).join('\n');
+                message += '\n' + obj_message_union1.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'FormulaValidationRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.isFormulaValid;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        isFormulaValid: object.isFormulaValid
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function FormulaValidationRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'isFormulaValid',
+                kind: 'Scalar'
+            },
+            {
+                name: 'message',
+                kind: 'Scalar',
+                required: false
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_isFormulaValid = existing.isFormulaValid;
+    const incoming_isFormulaValid = incoming.isFormulaValid;
+    if (!(existing_isFormulaValid === incoming_isFormulaValid)) {
+        return false;
+    }
+    const existing_message = existing.message;
+    const incoming_message = incoming.message;
+    // if at least one of these optionals is defined
+    if (existing_message !== undefined || incoming_message !== undefined) {
+        // if one of these is not defined we know the other is defined and therefore
+        // not equal
+        if (existing_message === undefined || incoming_message === undefined) {
+            return false;
+        }
+        if (!(existing_message === incoming_message)) {
+            return false;
+        }
+    }
+    return true;
+}
+const ingest = function FormulaValidationRepresentationIngest(input, path, luvio, store, timestamp) {
     if (process.env.NODE_ENV !== 'production') {
         const validateError = validate(input);
         if (validateError !== null) {
@@ -183,7 +393,7 @@ function createResourceRequest(config) {
     const headers = {};
     return {
         baseUri: '/services/data/v61.0',
-        basePath: '/connect/formula/einstein/explain',
+        basePath: '/connect/formula/validate',
         method: 'post',
         body: config.body,
         urlParams: {},
@@ -193,18 +403,19 @@ function createResourceRequest(config) {
     };
 }
 
-const adapterName = 'getExplanation';
-const getExplanation_ConfigPropertyMetadata = [
+const adapterName = 'validateFormula';
+const validateFormula_ConfigPropertyMetadata = [
     generateParamConfigMetadata('entityName', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('fieldName', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('formula', true, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('formulaType', true, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('returnType', true, 2 /* Body */, 0 /* String */),
 ];
-const getExplanation_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, getExplanation_ConfigPropertyMetadata);
-const createResourceParams = /*#__PURE__*/ createResourceParams$1(getExplanation_ConfigPropertyMetadata);
+const validateFormula_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, validateFormula_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$2(validateFormula_ConfigPropertyMetadata);
 function typeCheckConfig(untrustedConfig) {
     const config = {};
-    typeCheckConfig$1(untrustedConfig, config, getExplanation_ConfigPropertyMetadata);
+    typeCheckConfig$2(untrustedConfig, config, validateFormula_ConfigPropertyMetadata);
     return config;
 }
 function validateAdapterConfig(untrustedConfig, configPropertyNames) {
@@ -238,15 +449,15 @@ function buildNetworkSnapshot(luvio, config, options) {
         throw response;
     });
 }
-const getExplanationAdapterFactory = (luvio) => {
-    return function getExplanation(untrustedConfig) {
-        const config = validateAdapterConfig(untrustedConfig, getExplanation_ConfigPropertyNames);
+const validateFormulaAdapterFactory = (luvio) => {
+    return function validateFormula(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, validateFormula_ConfigPropertyNames);
         // Invalid or incomplete config
         if (config === null) {
-            throw new Error('Invalid config for "getExplanation"');
+            throw new Error('Invalid config for "validateFormula"');
         }
         return buildNetworkSnapshot(luvio, config);
     };
 };
 
-export { getExplanationAdapterFactory };
+export { getExplanationAdapterFactory, validateFormulaAdapterFactory };

package/dist/es/es2018/types/src/generated/adapters/validateFormula.d.ts

@@ -0,0 +1,19 @@
+import { AdapterConfigMetadata as $64$luvio_engine_AdapterConfigMetadata, Luvio as $64$luvio_engine_Luvio, DispatchResourceRequestContext as $64$luvio_engine_DispatchResourceRequestContext, AdapterFactory as $64$luvio_engine_AdapterFactory } from '@luvio/engine';
+import { Untrusted as adapter$45$utils_Untrusted, AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig } from './adapter-utils';
+import { ResourceRequestConfig as resources_postConnectFormulaValidate_ResourceRequestConfig } from '../resources/postConnectFormulaValidate';
+import { FormulaValidationRepresentation as types_FormulaValidationRepresentation_FormulaValidationRepresentation } from '../types/FormulaValidationRepresentation';
+export declare const adapterName = "validateFormula";
+export declare const validateFormula_ConfigPropertyMetadata: $64$luvio_engine_AdapterConfigMetadata[];
+export declare const validateFormula_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
+export interface ValidateFormulaConfig {
+    entityName: string;
+    fieldName?: string;
+    formula: string;
+    formulaType: string;
+    returnType: string;
+}
+export declare const createResourceParams: (config: ValidateFormulaConfig) => resources_postConnectFormulaValidate_ResourceRequestConfig;
+export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<ValidateFormulaConfig>): adapter$45$utils_Untrusted<ValidateFormulaConfig>;
+export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): ValidateFormulaConfig | null;
+export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: ValidateFormulaConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<import("@luvio/engine").FulfilledSnapshot<types_FormulaValidationRepresentation_FormulaValidationRepresentation, {}> | import("@luvio/engine").StaleSnapshot<types_FormulaValidationRepresentation_FormulaValidationRepresentation, {}> | import("@luvio/engine").PendingSnapshot<types_FormulaValidationRepresentation_FormulaValidationRepresentation, any>>;
+export declare const validateFormulaAdapterFactory: $64$luvio_engine_AdapterFactory<ValidateFormulaConfig, types_FormulaValidationRepresentation_FormulaValidationRepresentation>;

package/dist/es/es2018/types/src/generated/artifacts/main.d.ts

@@ -1 +1,2 @@
 export { getExplanationAdapterFactory } from '../adapters/getExplanation';
+export { validateFormulaAdapterFactory } from '../adapters/validateFormula';

package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts

@@ -1,2 +1,3 @@
 declare let getExplanation: any;
-export { getExplanation };
+declare let validateFormula: any;
+export { getExplanation, validateFormula };

package/dist/es/es2018/types/src/generated/resources/postConnectFormulaValidate.d.ts

@@ -0,0 +1,16 @@
+import { Luvio as $64$luvio_engine_Luvio, Fragment as $64$luvio_engine_Fragment, FetchResponse as $64$luvio_engine_FetchResponse, FulfilledSnapshot as $64$luvio_engine_FulfilledSnapshot, StaleSnapshot as $64$luvio_engine_StaleSnapshot, PendingSnapshot as $64$luvio_engine_PendingSnapshot, ResourceRequest as $64$luvio_engine_ResourceRequest } from '@luvio/engine';
+import { FormulaValidationRepresentation as types_FormulaValidationRepresentation_FormulaValidationRepresentation } from '../types/FormulaValidationRepresentation';
+export interface ResourceRequestConfig {
+    body: {
+        entityName: string;
+        fieldName?: string;
+        formula: string;
+        formulaType: string;
+        returnType: string;
+    };
+}
+export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;
+export declare function getResponseCacheKeys(storeKeyMap: any, luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: types_FormulaValidationRepresentation_FormulaValidationRepresentation): void;
+export declare function ingestSuccess(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_FormulaValidationRepresentation_FormulaValidationRepresentation>): $64$luvio_engine_FulfilledSnapshot<types_FormulaValidationRepresentation_FormulaValidationRepresentation, {}> | $64$luvio_engine_StaleSnapshot<types_FormulaValidationRepresentation_FormulaValidationRepresentation, {}> | $64$luvio_engine_PendingSnapshot<types_FormulaValidationRepresentation_FormulaValidationRepresentation, any>;
+export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;
+export default createResourceRequest;

package/dist/es/es2018/types/src/generated/types/FormulaValidationInputRepresentation.d.ts

@@ -0,0 +1,40 @@
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "f95f5caef5f98eab47c21c9e1035768b";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: FormulaValidationInputRepresentation, existing: FormulaValidationInputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): FormulaValidationInputRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: FormulaValidationInputRepresentationNormalized, incoming: FormulaValidationInputRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: FormulaValidationInputRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * The input representation for validating a formula
+ *
+ * Keys:
+ *    (none)
+ */
+export interface FormulaValidationInputRepresentationNormalized {
+    /** Entity Name from the formula builder */
+    entityName: string;
+    /** Field name if the formula is already saved */
+    fieldName?: string;
+    /** Formula which needs to be validated */
+    formula: string;
+    /** Formula Type */
+    formulaType: string;
+    /** Return type of the formula */
+    returnType: string;
+}
+/**
+ * The input representation for validating a formula
+ *
+ * Keys:
+ *    (none)
+ */
+export interface FormulaValidationInputRepresentation {
+    entityName: string;
+    fieldName?: string;
+    formula: string;
+    formulaType: string;
+    returnType: string;
+}

package/dist/es/es2018/types/src/generated/types/FormulaValidationRepresentation.d.ts

@@ -0,0 +1,41 @@
+import { KeyMetadata as $64$luvio_engine_KeyMetadata, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, Luvio as $64$luvio_engine_Luvio, IngestPath as $64$luvio_engine_IngestPath, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap } from '@luvio/engine';
+export declare const TTL = 100;
+export declare const VERSION = "6fae0fe9f113df4590f7d92a6005ddeb";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export interface KeyParams extends $64$luvio_engine_KeyMetadata {
+    isFormulaValid: boolean;
+}
+export type FormulaValidationRepresentationNormalizedKeyMetadata = KeyParams & $64$luvio_engine_NormalizedKeyMetadata;
+export type PartialFormulaValidationRepresentationNormalizedKeyMetadata = Partial<KeyParams> & $64$luvio_engine_NormalizedKeyMetadata;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, config: KeyParams): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, config: KeyParams): FormulaValidationRepresentationNormalizedKeyMetadata;
+export declare function keyBuilderFromType(luvio: $64$luvio_engine_Luvio, object: FormulaValidationRepresentation): string;
+export declare function keyBuilderFromType_StructuredKey(luvio: $64$luvio_engine_Luvio, object: FormulaValidationRepresentation): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function normalize(input: FormulaValidationRepresentation, existing: FormulaValidationRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): FormulaValidationRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: FormulaValidationRepresentationNormalized, incoming: FormulaValidationRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: FormulaValidationRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Formula Validation
+ *
+ * Keys:
+ *    isFormulaValid (boolean): isFormulaValid
+ */
+export interface FormulaValidationRepresentationNormalized {
+    /** Returns if the formula is valid */
+    isFormulaValid: boolean;
+    /** Failure message if validation was unsuccessful.  If validation passes, this should be null/empty */
+    message?: string | null;
+}
+/**
+ * Formula Validation
+ *
+ * Keys:
+ *    isFormulaValid (boolean): isFormulaValid
+ */
+export interface FormulaValidationRepresentation {
+    isFormulaValid: boolean;
+    message?: string | null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-platform-formula",
-    "version": "1.270.1",
+    "version": "1.271.0",
     "description": "APIs related to core Salesforce Formulas",
     "license": "SEE LICENSE IN LICENSE.txt",
     "main": "dist/es/es2018/platform-formula.js",
@@ -40,11 +40,11 @@
         "test:unit": "jest"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "^1.270.1"
+        "@salesforce/lds-bindings": "^1.271.0"
     },
     "devDependencies": {
-        "@salesforce/lds-compiler-plugins": "^1.270.1",
-        "@salesforce/lds-karma": "^1.270.1"
+        "@salesforce/lds-compiler-plugins": "^1.271.0",
+        "@salesforce/lds-karma": "^1.271.0"
     },
     "nx": {
         "targets": {

package/sfdc/index.js

@@ -13,7 +13,7 @@
  */
 /* proxy-compat-disable */
 import { withDefaultLuvio } from 'force/ldsEngine';
-import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$1, typeCheckConfig as typeCheckConfig$1 } from 'force/luvioEngine';
+import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$2, typeCheckConfig as typeCheckConfig$2 } from 'force/luvioEngine';
 
 const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
 const { keys: ObjectKeys, create: ObjectCreate } = Object;
@@ -80,9 +80,9 @@ function createLink(ref) {
     };
 }
 
-const TTL = 100;
-const VERSION = "c06ad095a0c68e00a7cf4b94f01f937b";
-function validate(obj, path = 'FormulaExplanationRepresentation') {
+const TTL$1 = 100;
+const VERSION$1 = "c06ad095a0c68e00a7cf4b94f01f937b";
+function validate$1(obj, path = 'FormulaExplanationRepresentation') {
     const v_error = (() => {
         if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
             return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
@@ -100,23 +100,23 @@ function validate(obj, path = 'FormulaExplanationRepresentation') {
     })();
     return v_error === undefined ? null : v_error;
 }
-const RepresentationType = 'FormulaExplanationRepresentation';
-function keyBuilder(luvio, config) {
-    return keyPrefix + '::' + RepresentationType + ':' + config.generationId;
+const RepresentationType$1 = 'FormulaExplanationRepresentation';
+function keyBuilder$1(luvio, config) {
+    return keyPrefix + '::' + RepresentationType$1 + ':' + config.generationId;
 }
-function keyBuilderFromType(luvio, object) {
+function keyBuilderFromType$1(luvio, object) {
     const keyParams = {
         generationId: object.generationId
     };
-    return keyBuilder(luvio, keyParams);
+    return keyBuilder$1(luvio, keyParams);
 }
-function normalize(input, existing, path, luvio, store, timestamp) {
+function normalize$1(input, existing, path, luvio, store, timestamp) {
     return input;
 }
-const select$1 = function FormulaExplanationRepresentationSelect() {
+const select$3 = function FormulaExplanationRepresentationSelect() {
     return {
         kind: 'Fragment',
-        version: VERSION,
+        version: VERSION$1,
         private: [],
         selections: [
             {
@@ -130,7 +130,7 @@ const select$1 = function FormulaExplanationRepresentationSelect() {
         ]
     };
 };
-function equals(existing, incoming) {
+function equals$1(existing, incoming) {
     const existing_explanation = existing.explanation;
     const incoming_explanation = incoming.explanation;
     if (!(existing_explanation === incoming_explanation)) {
@@ -143,7 +143,217 @@ function equals(existing, incoming) {
     }
     return true;
 }
-const ingest = function FormulaExplanationRepresentationIngest(input, path, luvio, store, timestamp) {
+const ingest$1 = function FormulaExplanationRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate$1(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = keyBuilderFromType$1(luvio, input);
+    const ttlToUse = TTL$1;
+    ingestShape(input, path, luvio, store, timestamp, ttlToUse, key, normalize$1, "Formula", VERSION$1, RepresentationType$1, equals$1);
+    return createLink(key);
+};
+function getTypeCacheKeys$1(rootKeySet, luvio, input, fullPathFactory) {
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = keyBuilderFromType$1(luvio, input);
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType$1,
+        mergeable: false
+    });
+}
+
+function select$2(luvio, params) {
+    return select$3();
+}
+function getResponseCacheKeys$1(storeKeyMap, luvio, resourceParams, response) {
+    getTypeCacheKeys$1(storeKeyMap, luvio, response);
+}
+function ingestSuccess$1(luvio, resourceParams, response) {
+    const { body } = response;
+    const key = keyBuilderFromType$1(luvio, body);
+    luvio.storeIngest(key, ingest$1, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select$2(),
+        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$1(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v61.0',
+        basePath: '/connect/formula/einstein/explain',
+        method: 'post',
+        body: config.body,
+        urlParams: {},
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName$1 = 'getExplanation';
+const getExplanation_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('entityName', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('formula', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('formulaType', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('returnType', true, 2 /* Body */, 0 /* String */),
+];
+const getExplanation_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName$1, getExplanation_ConfigPropertyMetadata);
+const createResourceParams$1 = /*#__PURE__*/ createResourceParams$2(getExplanation_ConfigPropertyMetadata);
+function typeCheckConfig$1(untrustedConfig) {
+    const config = {};
+    typeCheckConfig$2(untrustedConfig, config, getExplanation_ConfigPropertyMetadata);
+    return config;
+}
+function validateAdapterConfig$1(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig$1(untrustedConfig);
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function buildNetworkSnapshot$1(luvio, config, options) {
+    const resourceParams = createResourceParams$1(config);
+    const request = createResourceRequest$1(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => {
+            const snapshot = ingestSuccess$1(luvio, resourceParams, response);
+            return luvio.storeBroadcast().then(() => snapshot);
+        }, () => {
+            const cache = new StoreKeyMap();
+            getResponseCacheKeys$1(cache, luvio, resourceParams, response.body);
+            return cache;
+        });
+    }, (response) => {
+        deepFreeze(response);
+        throw response;
+    });
+}
+const getExplanationAdapterFactory = (luvio) => {
+    return function getExplanation(untrustedConfig) {
+        const config = validateAdapterConfig$1(untrustedConfig, getExplanation_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "getExplanation"');
+        }
+        return buildNetworkSnapshot$1(luvio, config);
+    };
+};
+
+const TTL = 100;
+const VERSION = "6fae0fe9f113df4590f7d92a6005ddeb";
+function validate(obj, path = 'FormulaValidationRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_isFormulaValid = obj.isFormulaValid;
+        const path_isFormulaValid = path + '.isFormulaValid';
+        if (typeof obj_isFormulaValid !== 'boolean') {
+            return new TypeError('Expected "boolean" but received "' + typeof obj_isFormulaValid + '" (at "' + path_isFormulaValid + '")');
+        }
+        if (obj.message !== undefined) {
+            const obj_message = obj.message;
+            const path_message = path + '.message';
+            let obj_message_union0 = null;
+            const obj_message_union0_error = (() => {
+                if (typeof obj_message !== 'string') {
+                    return new TypeError('Expected "string" but received "' + typeof obj_message + '" (at "' + path_message + '")');
+                }
+            })();
+            if (obj_message_union0_error != null) {
+                obj_message_union0 = obj_message_union0_error.message;
+            }
+            let obj_message_union1 = null;
+            const obj_message_union1_error = (() => {
+                if (obj_message !== null) {
+                    return new TypeError('Expected "null" but received "' + typeof obj_message + '" (at "' + path_message + '")');
+                }
+            })();
+            if (obj_message_union1_error != null) {
+                obj_message_union1 = obj_message_union1_error.message;
+            }
+            if (obj_message_union0 && obj_message_union1) {
+                let message = 'Object doesn\'t match union (at "' + path_message + '")';
+                message += '\n' + obj_message_union0.split('\n').map((line) => '\t' + line).join('\n');
+                message += '\n' + obj_message_union1.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'FormulaValidationRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.isFormulaValid;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        isFormulaValid: object.isFormulaValid
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function FormulaValidationRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'isFormulaValid',
+                kind: 'Scalar'
+            },
+            {
+                name: 'message',
+                kind: 'Scalar',
+                required: false
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_isFormulaValid = existing.isFormulaValid;
+    const incoming_isFormulaValid = incoming.isFormulaValid;
+    if (!(existing_isFormulaValid === incoming_isFormulaValid)) {
+        return false;
+    }
+    const existing_message = existing.message;
+    const incoming_message = incoming.message;
+    // if at least one of these optionals is defined
+    if (existing_message !== undefined || incoming_message !== undefined) {
+        // if one of these is not defined we know the other is defined and therefore
+        // not equal
+        if (existing_message === undefined || incoming_message === undefined) {
+            return false;
+        }
+        if (!(existing_message === incoming_message)) {
+            return false;
+        }
+    }
+    return true;
+}
+const ingest = function FormulaValidationRepresentationIngest(input, path, luvio, store, timestamp) {
     if (process.env.NODE_ENV !== 'production') {
         const validateError = validate(input);
         if (validateError !== null) {
@@ -192,7 +402,7 @@ function createResourceRequest(config) {
     const headers = {};
     return {
         baseUri: '/services/data/v61.0',
-        basePath: '/connect/formula/einstein/explain',
+        basePath: '/connect/formula/validate',
         method: 'post',
         body: config.body,
         urlParams: {},
@@ -202,18 +412,19 @@ function createResourceRequest(config) {
     };
 }
 
-const adapterName = 'getExplanation';
-const getExplanation_ConfigPropertyMetadata = [
+const adapterName = 'validateFormula';
+const validateFormula_ConfigPropertyMetadata = [
     generateParamConfigMetadata('entityName', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('fieldName', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('formula', true, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('formulaType', true, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('returnType', true, 2 /* Body */, 0 /* String */),
 ];
-const getExplanation_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, getExplanation_ConfigPropertyMetadata);
-const createResourceParams = /*#__PURE__*/ createResourceParams$1(getExplanation_ConfigPropertyMetadata);
+const validateFormula_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, validateFormula_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$2(validateFormula_ConfigPropertyMetadata);
 function typeCheckConfig(untrustedConfig) {
     const config = {};
-    typeCheckConfig$1(untrustedConfig, config, getExplanation_ConfigPropertyMetadata);
+    typeCheckConfig$2(untrustedConfig, config, validateFormula_ConfigPropertyMetadata);
     return config;
 }
 function validateAdapterConfig(untrustedConfig, configPropertyNames) {
@@ -247,18 +458,19 @@ function buildNetworkSnapshot(luvio, config, options) {
         throw response;
     });
 }
-const getExplanationAdapterFactory = (luvio) => {
-    return function getExplanation(untrustedConfig) {
-        const config = validateAdapterConfig(untrustedConfig, getExplanation_ConfigPropertyNames);
+const validateFormulaAdapterFactory = (luvio) => {
+    return function validateFormula(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, validateFormula_ConfigPropertyNames);
         // Invalid or incomplete config
         if (config === null) {
-            throw new Error('Invalid config for "getExplanation"');
+            throw new Error('Invalid config for "validateFormula"');
         }
         return buildNetworkSnapshot(luvio, config);
     };
 };
 
 let getExplanation;
+let validateFormula;
 // Notify Update Available
 function bindExportsTo(luvio) {
     // LDS Adapters
@@ -268,13 +480,14 @@ function bindExportsTo(luvio) {
     }
     return {
         getExplanation: unwrapSnapshotData(getExplanationAdapterFactory),
+        validateFormula: unwrapSnapshotData(validateFormulaAdapterFactory),
         // Imperative GET Adapters
         // Notify Update Availables
     };
 }
 withDefaultLuvio((luvio) => {
-    ({ getExplanation } = bindExportsTo(luvio));
+    ({ getExplanation, validateFormula } = bindExportsTo(luvio));
 });
 
-export { getExplanation };
-// version: 1.270.1-abfb311e8
+export { getExplanation, validateFormula };
+// version: 1.271.0-c2f810db8

package/src/raml/api.raml

@@ -64,17 +64,77 @@ types:
       generationId:
         description: Generation ID of response from open ai
         type: string
-/connect/formula/einstein/explain:
-  post:
-    displayName: postFormulaExplanation
-    description: Gets explanation for a salesforce formula
-    responses:
-      '200':
-        description: Success
-        body:
-          application/json:
-            type: FormulaExplanationRepresentation
-    body:
-      application/json:
-        type: ExplainPromptInputRepresentation
-        (oas-body-name): formulaExplainInput
+  FormulaValidationInputRepresentation:
+    description: The input representation for validating a formula
+    type: object
+    properties:
+      entityName:
+        description: Entity Name from the formula builder
+        type: string
+      fieldName:
+        description: Field name if the formula is already saved
+        type: string
+        required: false
+      formula:
+        description: Formula which needs to be validated
+        type: string
+      formulaType:
+        description: Formula Type
+        type: string
+        enum:
+          - CustomField
+          - DefaultValue
+          - Validation
+      returnType:
+        description: Return type of the formula
+        type: string
+        enum:
+          - Boolean
+          - Currency
+          - Date
+          - DateTime
+          - Number
+          - Percent
+          - Text
+          - Time
+  FormulaValidationRepresentation:
+    description: Formula Validation
+    type: object
+    properties:
+      isFormulaValid:
+        description: Returns if the formula is valid
+        type: boolean
+      message:
+        description: Failure message if validation was unsuccessful.  If validation
+          passes, this should be null/empty
+        type: string | nil
+        required: false
+/connect/formula:
+  /einstein/explain:
+    post:
+      displayName: postFormulaExplanation
+      description: Gets explanation for a salesforce formula
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FormulaExplanationRepresentation
+      body:
+        application/json:
+          type: ExplainPromptInputRepresentation
+          (oas-body-name): formulaExplainInput
+  /validate:
+    post:
+      displayName: postFormulaValidation
+      description: Validates a Salesforce formula
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FormulaValidationRepresentation
+      body:
+        application/json:
+          type: FormulaValidationInputRepresentation
+          (oas-body-name): formulaValidateInput

package/src/raml/luvio.raml

@@ -12,8 +12,17 @@ types:
     (luvio.ttl): 100
     (luvio.key):
       generationId: generationId
+  FormulaValidationRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      isFormulaValid: isFormulaValid
 
-/connect/formula/einstein/explain:
-  post:
-    (luvio.adapter):
-      name: getExplanation
+/connect/formula:
+  /einstein/explain:
+    post:
+      (luvio.adapter):
+        name: getExplanation
+  /validate:
+    post:
+      (luvio.adapter):
+        name: validateFormula