@salesforce/lds-adapters-uiapi 0.131.0

package/sfdc/uiapi-static-functions.js

@@ -0,0 +1,327 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+var SnapshotState;
+(function (SnapshotState) {
+    SnapshotState["Fulfilled"] = "Fulfilled";
+    SnapshotState["Unfulfilled"] = "Unfulfilled";
+    SnapshotState["Error"] = "Error";
+    SnapshotState["Pending"] = "Pending";
+    SnapshotState["Stale"] = "Stale";
+})(SnapshotState || (SnapshotState = {}));
+
+Promise.resolve();
+
+var StoreErrorStatus;
+(function (StoreErrorStatus) {
+    StoreErrorStatus[StoreErrorStatus["RESOURCE_NOT_FOUND"] = 404] = "RESOURCE_NOT_FOUND";
+})(StoreErrorStatus || (StoreErrorStatus = {}));
+var StoreRecordType;
+(function (StoreRecordType) {
+    StoreRecordType["Error"] = "error";
+})(StoreRecordType || (StoreRecordType = {}));
+var StoreLinkStateValues$1;
+(function (StoreLinkStateValues) {
+    StoreLinkStateValues[StoreLinkStateValues["NotPresent"] = 0] = "NotPresent";
+    StoreLinkStateValues[StoreLinkStateValues["RefNotPresent"] = 1] = "RefNotPresent";
+    StoreLinkStateValues[StoreLinkStateValues["RefPresent"] = 2] = "RefPresent";
+    StoreLinkStateValues[StoreLinkStateValues["Null"] = 3] = "Null";
+    StoreLinkStateValues[StoreLinkStateValues["Missing"] = 4] = "Missing";
+    StoreLinkStateValues[StoreLinkStateValues["Pending"] = 5] = "Pending";
+})(StoreLinkStateValues$1 || (StoreLinkStateValues$1 = {}));
+var StoreResolveResultState;
+(function (StoreResolveResultState) {
+    StoreResolveResultState[StoreResolveResultState["Found"] = 0] = "Found";
+    StoreResolveResultState[StoreResolveResultState["Error"] = 1] = "Error";
+    StoreResolveResultState[StoreResolveResultState["Null"] = 2] = "Null";
+    StoreResolveResultState[StoreResolveResultState["NotPresent"] = 3] = "NotPresent";
+    StoreResolveResultState[StoreResolveResultState["Stale"] = 4] = "Stale";
+})(StoreResolveResultState || (StoreResolveResultState = {}));
+var HttpStatusCode;
+(function (HttpStatusCode) {
+    HttpStatusCode[HttpStatusCode["Ok"] = 200] = "Ok";
+    HttpStatusCode[HttpStatusCode["Created"] = 201] = "Created";
+    HttpStatusCode[HttpStatusCode["NoContent"] = 204] = "NoContent";
+    HttpStatusCode[HttpStatusCode["NotModified"] = 304] = "NotModified";
+    HttpStatusCode[HttpStatusCode["BadRequest"] = 400] = "BadRequest";
+    HttpStatusCode[HttpStatusCode["Unauthorized"] = 401] = "Unauthorized";
+    HttpStatusCode[HttpStatusCode["Forbidden"] = 403] = "Forbidden";
+    HttpStatusCode[HttpStatusCode["NotFound"] = 404] = "NotFound";
+    HttpStatusCode[HttpStatusCode["ServerError"] = 500] = "ServerError";
+    HttpStatusCode[HttpStatusCode["GatewayTimeout"] = 504] = "GatewayTimeout";
+})(HttpStatusCode || (HttpStatusCode = {}));
+var GraphNodeType;
+(function (GraphNodeType) {
+    GraphNodeType["Link"] = "Link";
+    GraphNodeType["Node"] = "Node";
+    GraphNodeType["Error"] = "Error";
+    GraphNodeType["Locked"] = "Locked";
+})(GraphNodeType || (GraphNodeType = {}));
+
+var StoreLinkStateValues;
+(function (StoreLinkStateValues) {
+    StoreLinkStateValues[StoreLinkStateValues["NotPresent"] = 0] = "NotPresent";
+    StoreLinkStateValues[StoreLinkStateValues["RefNotPresent"] = 1] = "RefNotPresent";
+    StoreLinkStateValues[StoreLinkStateValues["RefPresent"] = 2] = "RefPresent";
+    StoreLinkStateValues[StoreLinkStateValues["Null"] = 3] = "Null";
+    StoreLinkStateValues[StoreLinkStateValues["Missing"] = 4] = "Missing";
+    StoreLinkStateValues[StoreLinkStateValues["Pending"] = 5] = "Pending";
+})(StoreLinkStateValues || (StoreLinkStateValues = {}));
+var FragmentReadResultState;
+(function (FragmentReadResultState) {
+    FragmentReadResultState[FragmentReadResultState["Missing"] = 0] = "Missing";
+    FragmentReadResultState[FragmentReadResultState["Success"] = 1] = "Success";
+    FragmentReadResultState[FragmentReadResultState["Error"] = 2] = "Error";
+})(FragmentReadResultState || (FragmentReadResultState = {}));
+({
+    state: FragmentReadResultState.Missing,
+});
+// engine version: 0.138.8-244.1-492a715e
+
+const { keys: ObjectKeys, freeze: ObjectFreeze, create: ObjectCreate } = Object;
+
+const { assign, create, freeze, keys } = Object;
+
+function isString(value) {
+    return typeof value === 'string';
+}
+
+function isFieldId(unknown) {
+    if (typeof unknown !== 'object' || unknown === null) {
+        return false;
+    }
+    const value = unknown;
+    return isString(value.objectApiName) && isString(value.fieldApiName);
+}
+/**
+ * Split the object API name and field API name from a qualified field name.
+ * Eg: Opportunity.Title returns ['Opportunity', 'Title']
+ * Eg: Opportunity.Account.Name returns ['Opportunity', 'Account.Name']
+ * @param fieldApiName The qualified field name.
+ * @return The object and field API names.
+ */
+function splitQualifiedFieldApiName(fieldApiName) {
+    const idx = fieldApiName.indexOf('.');
+    if (idx < 1) {
+        // object api name must non-empty
+        throw new TypeError('Value does not include an object API name.');
+    }
+    return [fieldApiName.substring(0, idx), fieldApiName.substring(idx + 1)];
+}
+
+/**
+ * Returns the field API name, qualified with an object name if possible.
+ * @param value The value from which to get the qualified field API name.
+ * @return The qualified field API name.
+ */
+function getFieldApiName(value) {
+    // Note: tightening validation logic changes behavior from userland getting
+    // a server-provided error to the adapter noop'ing. In 224 we decided to not
+    // change the behavior.
+    if (isString(value)) {
+        const trimmed = value.trim();
+        if (trimmed.length > 0) {
+            return trimmed;
+        }
+    }
+    else if (isFieldId(value)) {
+        return value.objectApiName + '.' + value.fieldApiName;
+    }
+    return undefined;
+}
+
+ObjectCreate(null);
+
+ObjectCreate(null);
+
+ObjectFreeze({
+    name: '',
+    children: {},
+});
+/**
+ * Returns a new object that has a list of fields that has been filtered by
+ * edited fields. Only contains fields that have been edited from their original
+ * values (excluding Id which is always copied over).
+ * @param input The RecordInputRepresentation object to filter.
+ * @param original The Record object that contains the original field values.
+ * @returns RecordInputRepresentation, see the description
+ */
+function createRecordInputFilteredByEditedFields(input, original) {
+    const filteredRecordInput = getRecordInput();
+    // Always copy over any existing id.
+    if (original.id) {
+        filteredRecordInput.fields.Id = original.id;
+    }
+    const recordInputFields = input.fields;
+    const originalRecordFields = original.fields;
+    const recordInputFieldPropertyNames = keys(recordInputFields);
+    for (let i = 0, len = recordInputFieldPropertyNames.length; i < len; i++) {
+        const fieldName = recordInputFieldPropertyNames[i];
+        let originalRecordFieldsEntry;
+        if (originalRecordFields) {
+            originalRecordFieldsEntry = originalRecordFields[fieldName];
+        }
+        if (!originalRecordFieldsEntry ||
+            (originalRecordFields &&
+                recordInputFields[fieldName] !== originalRecordFieldsEntry.value)) {
+            filteredRecordInput.fields[fieldName] = recordInputFields[fieldName];
+        }
+    }
+    return filteredRecordInput;
+}
+/**
+ * Returns an object with its data populated from the given record. All fields
+ * with values that aren't nested records will be assigned. This object can be
+ * used to create a record.
+ * @param record The record that contains the source data.
+ * @param objectInfo The ObjectInfo corresponding to the apiName on the record.
+ *        If provided, only fields that are createable=true (excluding Id) will
+ *        be assigned to the object return value.
+ * @returns RecordInputRepresentation See description.
+ */
+function generateRecordInputForCreate(record, objectInfo) {
+    const recordInput = _generateRecordInput(record, (field) => field.createable === true, objectInfo);
+    recordInput.apiName = record.apiName;
+    // fields.Id is not required for CREATE which might have been copied over,
+    // so delete fields.Id
+    delete recordInput.fields.Id;
+    return recordInput;
+}
+/**
+ * Returns an object with its data populated from the given record. All fields
+ * with values that aren't nested records will be assigned. This object can be
+ * used to update a record.
+ * @param record The record that contains the source data.
+ * @param objectInfo The ObjectInfo corresponding to the apiName on the record.
+ *        If provided, only fields that are updateable=true (excluding Id) will
+ *        be assigned to the object return value.
+ * @returns RecordInputRepresentation See description.
+ */
+function generateRecordInputForUpdate(record, objectInfo) {
+    const recordInput = _generateRecordInput(record, (field) => field.updateable === true, objectInfo);
+    if (!record.id) {
+        if (process.env.NODE_ENV !== 'production') {
+            throw new Error('record must have id for update');
+        }
+    }
+    // Always copy over any existing id.
+    recordInput.fields.Id = record.id;
+    return recordInput;
+}
+function isRecordInputFieldValue(unknown) {
+    const type = typeof unknown;
+    return unknown === null || type === 'string' || type === 'number' || type === 'boolean';
+}
+/**
+ * Returns an object with its data populated from the given record. All fields
+ * with values that aren't nested records will be assigned.
+ * @param record The record that contains the source data.
+ * @param copyFieldPredicate predicate to determine if a field should be copied.
+ *        Required if "objectInfo" parameter is passed.
+ * @param objectInfo The ObjectInfo corresponding to the apiName on the record.
+ *        If provided, only fields that match the copyFieldPredicate (excluding
+ *        Id) will be assigned to the object return value.
+ * @returns RecordInputRepresentation
+ */
+function _generateRecordInput(record, copyFieldPredicate, objectInfo) {
+    const recordInput = getRecordInput();
+    const recordFields = record.fields;
+    let objectInfoFields;
+    if (objectInfo) {
+        objectInfoFields = objectInfo.fields;
+    }
+    const recordFieldPropertyNames = keys(recordFields);
+    for (let i = 0, len = recordFieldPropertyNames.length; i < len; i++) {
+        const fieldName = recordFieldPropertyNames[i];
+        const recordFieldsFieldNameEntry = recordFields[fieldName].value;
+        if (isRecordInputFieldValue(recordFieldsFieldNameEntry)) {
+            if (objectInfoFields && copyFieldPredicate) {
+                const objectInfoFieldsFieldNameValue = objectInfoFields[fieldName];
+                if (objectInfoFieldsFieldNameValue &&
+                    copyFieldPredicate(objectInfoFieldsFieldNameValue)) {
+                    recordInput.fields[fieldName] = recordFieldsFieldNameEntry;
+                }
+            }
+            else {
+                recordInput.fields[fieldName] = recordFieldsFieldNameEntry;
+            }
+        }
+    }
+    return recordInput;
+}
+/**
+ * Gets a new Record Input.
+ */
+function getRecordInput() {
+    return {
+        apiName: undefined,
+        fields: {},
+    };
+}
+/**
+ * Gets a field's value from a record.
+ * @param record The record.
+ * @param field The qualified API name of the field to return.
+ * @returns The field's value (which may be a record in the case of spanning
+ *          fields), or undefined if the field isn't found.
+ */
+function getFieldValue(record, field) {
+    const fieldValueRepresentation = getField(record, field);
+    if (fieldValueRepresentation === undefined) {
+        return undefined;
+    }
+    if (isFieldValueRepresentation(fieldValueRepresentation)) {
+        return fieldValueRepresentation.value;
+    }
+    return fieldValueRepresentation;
+}
+/**
+ * Gets a field's display value from a record.
+ * @param record The record.
+ * @param field The qualified API name of the field to return.
+ * @returns The field's display value, or undefined if the field isn't found.
+ */
+function getFieldDisplayValue(record, field) {
+    const fieldValueRepresentation = getField(record, field);
+    if (fieldValueRepresentation === undefined) {
+        return undefined;
+    }
+    if (isFieldValueRepresentation(fieldValueRepresentation)) {
+        return fieldValueRepresentation.displayValue;
+    }
+    return fieldValueRepresentation;
+}
+function isFieldValueRepresentation(unknown) {
+    if (typeof unknown !== 'object' || unknown === null) {
+        return false;
+    }
+    return 'value' in unknown && 'displayValue' in unknown;
+}
+function getField(record, field) {
+    const fieldApiName = getFieldApiName(field);
+    if (fieldApiName === undefined) {
+        return undefined;
+    }
+    const unqualifiedField = splitQualifiedFieldApiName(fieldApiName)[1];
+    const fields = unqualifiedField.split('.');
+    let r = record;
+    while (r && r.fields) {
+        const f = fields.shift();
+        const fvr = r.fields[f];
+        if (fvr === undefined) {
+            return undefined;
+        }
+        else if (fields.length > 0) {
+            r = fvr.value;
+        }
+        else {
+            return fvr;
+        }
+    }
+    return r;
+}
+
+export { createRecordInputFilteredByEditedFields, generateRecordInputForCreate, generateRecordInputForUpdate, getFieldDisplayValue, getFieldValue, getRecordInput };