@salesforce/lds-adapters-apex 0.1.0-dev1

package/sfdc/lds-apex-static-utils.js

@@ -0,0 +1,63 @@
+const { hasOwnProperty } = Object.prototype;
+
+/**
+ * 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) {
+    if (typeof value === 'string') {
+        return value;
+    }
+    else if (value &&
+        typeof value.objectApiName === 'string' &&
+        typeof value.fieldApiName === 'string') {
+        return value.objectApiName + '.' + value.fieldApiName;
+    }
+    throw new TypeError('Value is not a string or FieldId.');
+}
+/**
+ * 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)];
+}
+
+const { isArray: ArrayIsArray } = Array;
+function untrustedIsObject(untrusted) {
+    return typeof untrusted === 'object' && untrusted !== null && ArrayIsArray(untrusted) === false;
+}
+
+/**
+ * Gets a field value from an Apex sObject.
+ * @param sobject The sObject holding the field.
+ * @param field The qualified API name of the field to return.
+ * @returns The field's value. If it doesn't exist, undefined is returned.
+ */
+function getSObjectValue(sObject, field) {
+    if (untrustedIsObject(sObject) === false) {
+        return;
+    }
+    const unqualifiedField = splitQualifiedFieldApiName(getFieldApiName(field))[1];
+    const fields = unqualifiedField.split('.');
+    let ret = sObject;
+    for (let i = 0, fieldsLength = fields.length; i < fieldsLength; i++) {
+        const nextField = fields[i];
+        if (!hasOwnProperty.call(ret, nextField)) {
+            return undefined;
+        }
+        ret = ret[nextField];
+    }
+    return ret;
+}
+
+export { getSObjectValue };

package/src/raml/api.raml

@@ -0,0 +1,139 @@
+#%RAML 1.0
+securitySchemes:
+  OAuth:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://login.salesforce.com/services/oauth2/authorize
+      accessTokenUri: https://login.salesforce.com/services/oauth2/token
+      authorizationGrants:
+        - authorization_code
+    describedBy:
+      responses:
+        '401':
+          description: Bad or expired token.
+        '403':
+          description: Bad OAuth request.
+      headers:
+        Authorization:
+          description: Used to send a valid OAuth 2 access token.
+          example: 00Dxx0000001gEb!AQ4AQLlMunyjVCe5qEdoFJOtZG8fiypuvjsVZMqKHZFmKgv3SEfompm3_JBzYeAEdDbvV_o5q4oxo.Ese_5jI2E1lDjDDUZ
+          type: string
+  SID Cookie:
+    type: Basic Authentication
+    describedBy:
+      headers:
+        Cookie:
+          description: sid
+          example: 00DT0000000Dpvc!AQYAQG9Ut2qLrt7dV0Jh1z.nan7W04yLGUnBiKRxp6oaDQ4B988Wh24yhtnNHB3innkFy7Sd0HTAiBRh487mZ7p1.GT7td3r
+          type: string
+    settings: {}
+title: Apex Adapter API
+types:
+  ApexMethodExecuteRequest:
+    description: A JSON Object representing the parameters of an apex method as name-value pairs.
+    example:
+      strict: true
+      value:
+        paramName1: paramValue1
+        paramName2: paramValue2
+    type: object
+  ApexMethodExecuteErrorResponse:
+    description: Response in case of an error.
+    properties:
+      errorMessage:
+        example: User has insufficient permissions
+        type: string
+      debugInfo?:
+        example: "Cause: system.security.NoAccessException: Current user doesn't have access to entity. Check access before calling getApiName()"
+        type: string
+  ApexClassIdentifierWithoutNamespace:
+    description: Apex non-namespaced class identifier.
+    example: GreetingController
+    type: string
+  ApexClassIdentifierWithNamespace:
+    description: Apex namespaced class identifier.
+    example: myNS__GreetingController
+    type: string
+baseUri: /lwr/apex/v66.0
+description: |
+  Execute @AuraEnabled Apex Method.
+mediaType:
+  - application/json
+version: v1
+protocols:
+  - HTTPS
+securedBy:
+  - OAuth
+  - SID Cookie
+/{apexClass}/{apexMethod}:
+  post:
+    description: Invoke @AuraEnabled method on Apex Class
+    displayName: Invoke Apex Class Method (using imperative call from LWC)
+    headers:
+      X-SFDC-Allow-Continuation?:
+        example: 'true'
+        type: string
+    body:
+      application/json:
+        type: ApexMethodExecuteRequest
+    securedBy:
+      - OAuth
+      - SID Cookie
+    responses:
+      '200':
+        headers:
+          Cache-Control:
+            example: 'no-cache'
+        description: Apex Method Response
+        # empty body because the body type is any
+      '400':
+        description: Returned when there is something wrong with the request like misnamed parameters.
+        body:
+          application/json:
+            type: ApexMethodExecuteErrorResponse
+      '404':
+        description: If the apex class or method cannot be found. This can also be returned if the user does not permission to access the apex class.
+      '500':
+        description: Returned when the apex method execution results in an error.
+        body:
+          application/json:
+            type: ApexMethodExecuteErrorResponse
+  get:
+    displayName: Invoke Cacheable Apex Class Method (using @wire call from LWC)
+    description: Invoke @AuraEnabled(cacheable = true) method on Apex Class
+    headers:
+      X-SFDC-Allow-Continuation?:
+        example: 'true'
+        type: string
+    securedBy:
+      - OAuth
+      - SID Cookie
+    responses:
+      '200':
+        headers:
+          Cache-Control:
+            example: 'private max-age=30'
+        # empty body because the body type is any
+      '400':
+        description: Returned if the apex method is not cacheable or if there is something else wrong with the request like misnamed parameters.
+        body:
+          application/json:
+            type: ApexMethodExecuteErrorResponse
+      '404':
+        description: If the apex class or method cannot be found. This can also be returned if the user does not permission to access the apex class.
+      '500':
+        description: Returned when the apex method execution results in an error.
+        body:
+          application/json:
+            type: ApexMethodExecuteErrorResponse
+    queryParameters:
+      methodParams?:
+        type: ApexMethodExecuteRequest
+  uriParameters:
+    apexMethod:
+      description: Name of the Apex Method
+      example: getGreeting
+      type: string
+    apexClass:
+      description: Apex Class Name (can include a namespace prefix separated by __)
+      type: ApexClassIdentifierWithNamespace | ApexClassIdentifierWithoutNamespace

package/src/raml/luvio.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Apex'