@salesforce/lds-adapters-cdp-byoc 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,493 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  CdpUserRepresentation:
+    description: Represents a user
+    type: object
+    properties:
+      id:
+        description: The 18 character user ID
+        type: string
+      name:
+        description: The name of the user
+        type: string
+      profilePhotoUrl:
+        description: The Chatter profile photo of the user
+        type: string
+  CustomCodeDeploymentInputRepresentation:
+    description: Input representation for creating a Custom Code Deployment
+    # Hand-rolled: Combines this object with the original
+    # base object (CdpAssetBaseInputRepresentation) as Luvio
+    # does not like multiple levels of inheritance in objects
+    type: object
+    properties:
+      # Hand-rolled: Our Connect API does not require a value be passed in here
+      codeType?:
+        description: Custom code type
+        type: string
+        enum:
+          - Function
+          - Script
+      functionInvokeOptions?:
+        description: List of function invoke options
+        type: array
+        items:
+          type: string
+          enum:
+            - UnstructuredChunking
+      computeType:
+        description: Compute type for executions of the custom code
+        type: string
+        enum:
+          - Cpu_l
+          - Cpu_m
+          - Cpu_s
+          - Cpu_xs
+          - High_cpu_l
+          - High_cpu_m
+          - High_cpu_s
+          - High_cpu_xs
+          - High_memory_cpu_l
+          - High_memory_cpu_m
+          - High_memory_cpu_s
+          - High_memory_cpu_xs
+      # Hand-rolled: Our Connect API does not require a value be passed in here
+      description?:
+        description: Description of the custom code deployment
+        type: string
+      # Hand-rolled: Our Connect API does not require an ID for all endpoints
+      id?:
+        description: Id
+        type: string
+      label:
+        description: Label of the custom code deployment
+        type: string
+      name:
+        description: Name
+        type: string
+      # Hand-rolled: Our Connect API does not use the namespace field currently
+      namespace?:
+        description: Namespace
+        type: string
+      # Hand-rolled: Our Connect API does not require a value be passed in here
+      parameters?:
+        description: Parameters of the custom code deployment
+        type: object
+        properties:
+          //:
+            type: string
+      version:
+        description: Version of the custom code
+        type: string
+  CustomCodeDeploymentRepresentation:
+    description: A custom code deployment.
+    # Hand-rolled: Combines this object with the original
+    # base object (CdpAssetBaseRepresentation) as Luvio
+    # does not like multiple levels of inheritance in objects
+    type: object
+    properties:
+      # Hand-rolled: Our Connect API does not always return a value here
+      codeType:
+        description: Custom code type
+        type: string
+        enum:
+          - Function
+          - Script
+      functionInvokeOptions?:
+        description: List of function invoke options
+        type: array
+        items:
+          type: string
+          enum:
+            - UnstructuredChunking
+      computeType:
+        description: Compute type for executions of the custom code
+        type: string
+        enum:
+          - Cpu_l
+          - Cpu_m
+          - Cpu_s
+          - Cpu_xs
+          - High_cpu_l
+          - High_cpu_m
+          - High_cpu_s
+          - High_cpu_xs
+          - High_memory_cpu_l
+          - High_memory_cpu_m
+          - High_memory_cpu_s
+          - High_memory_cpu_xs
+      createdBy:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate:
+        description: Created date
+        type: string
+      # Hand-rolled: Connect API does not return this value when null
+      deploymentFailureCode?:
+        description: Failure code for the custom code deployment
+        type: integer
+      # Hand-rolled: Connect API does not return this value when null
+      deploymentFailureReason?:
+        description: Failure reason for the custom code deployment
+        type: string
+      deploymentStatus:
+        description: Deployment status of the custom code
+        type: string
+        enum:
+          - Deployed
+          - Error
+          - Initializing
+          - Scanning
+      # Hand-rolled: Connect API does not return this value when not provided on input
+      description?:
+        description: Description of the custom code deployment
+        type: string
+      fileUploadUrl:
+        description: URL to use for custom code file upload
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label:
+        description: Label of the asset
+        type: string
+      lastModifiedBy:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate:
+        description: Last modified date
+        type: string
+      name:
+        description: Name of the asset
+        type: string
+      # Hand-rolled: namespace is not returned by our Connect API implementation
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      parameters:
+        description: Parameters of custom code deployment
+        type: object
+        properties:
+          //:
+            # Hand rolled as we are using the Object type in Java which can refer to any data class
+            type: any
+      status:
+        description: Sync status of the custom code deployment
+        type: string
+        enum:
+          - Active
+          - Deleting
+          - Error
+          - Processing
+      url:
+        description: Url
+        type: string
+      version:
+        description: Version of the custom code
+        type: string
+  CustomCodeDeploymentCollectionRepresentation:
+    description: Custom Code Deployment collection
+    # Hand-rolled: Combines this object with the original
+    # base object (CdpPaginatedResponseBaseRepresentation) as Luvio
+    # does not like multiple levels of inheritance in objects
+    type: object
+    properties:
+      customCodeDeployments:
+        description: The custom code deployments.
+        type: array
+        items:
+          type: CustomCodeDeploymentRepresentation
+      currentPageUrl:
+        description: Current page url
+        type: string
+      nextPageUrl?:
+        description: Next page url if it exists
+        type: string
+      totalSize:
+        description: Total size of collection
+        type: integer
+  CustomCodeExecutionBaseRepresentation:
+    description: BYOC Custom Code Executions
+    type: object
+    properties:
+      durationInSeconds:
+        description: duration of code execution in seconds
+        type: integer
+      endTime:
+        description: end time of code execution
+        type: string
+      errorCode?:
+        description: error code
+        type: integer
+      errorMessage?:
+        description: detailed error message
+        type: string
+      id:
+        description: BYOC Custom Code Execution Id
+        type: string
+      rowsRead:
+        description: number of objects read
+        # Hand-rolled: The current API spec defines this are int64 but Luvio
+        # only supports a max of int32. The actual service producing the value
+        # casts this as a standard Java int which allows us to use the default
+        # of int32
+        # format: int64
+        type: integer
+      rowsWritten:
+        description: number of objects written
+        # Hand-rolled: The current API spec defines this are int64 but Luvio
+        # only supports a max of int32. The actual service producing the value
+        # casts this as a standard Java int which allows us to use the default
+        # of int32
+        # format: int64
+        type: integer
+      startTime:
+        description: start time of code execution
+        type: string
+      status:
+        description: BYOC Custom Code Execution Status
+        type: string
+        enum:
+          - Cancelled
+          - Failure
+          - Running
+          - Success
+      submittedTime:
+        description: time when execution was submitted
+        type: string
+  CustomCodeExecutionCollectionRepresentation:
+    description: BYOC Custom Code Execution Collection
+    # Hand-rolled: Combines this object with the original
+    # base object (CdpPaginatedResponseBaseRepresentation) as Luvio
+    # does not like multiple levels of inheritance in objects
+    type: object
+    properties:
+      currentPageUrl?:
+        description: Current page url
+        type: string
+      executions:
+        description: BYOC Custom Code Collection of Executions
+        type: array
+        items:
+          type: CustomCodeExecutionBaseRepresentation
+      nextPageUrl?:
+        description: Next page url if it exists
+        type: string
+      totalSize?:
+        description: Total size of collection
+        type: integer
+  CustomCodeExecutionLogRepresentation:
+    description: BYOC Custom Code Execution Log
+    type: object
+    properties:
+      downloadUrl:
+        description: BYOC Custom Code Execution Log
+        type: string
+  CustomCodePatchInputRepresentation:
+    description: Input representation for updating a Custom Code Deployment
+    type: object
+    properties:
+      # Hand-rolled: None of these props are required
+      computeType?:
+        description: Compute type for executions of the custom code
+        type: string
+        enum:
+          - Cpu_l
+          - Cpu_m
+          - Cpu_s
+          - Cpu_xs
+          - High_cpu_l
+          - High_cpu_m
+          - High_cpu_s
+          - High_cpu_xs
+          - High_memory_cpu_l
+          - High_memory_cpu_m
+          - High_memory_cpu_s
+          - High_memory_cpu_xs
+      functionInvokeOptions?:
+        description: List of function invoke options
+        type: array
+        items:
+          type: string
+          enum:
+            - UnstructuredChunking
+      description?:
+        description: Description of the custom code deployment
+        type: string
+      label?:
+        description: Label of the custom code deployment
+        type: string
+      version?:
+        description: Version of the custom code
+        type: string
+/ssot:
+  /data-custom-code:
+    post:
+      displayName: postCdpCustomCodeDeploymentCollection
+      description: Create a new custom code deployment
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeDeploymentRepresentation
+      body:
+        application/json:
+          type: CustomCodeDeploymentInputRepresentation
+          # TODO Hand-rolled W-9271732
+          # required: false
+          (oas-body-name): customCodeDeployment
+    get:
+      displayName: getCdpCustomCodeDeploymentCollection
+      description: Get a list of custom code deployments
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeDeploymentCollectionRepresentation
+      queryParameters:
+        codeType:
+          type: string
+          required: false
+          enum:
+            - Function
+            - Script
+        deploymentStatus:
+          type: string
+          required: false
+          enum:
+            - Deployed
+            - Error
+            - Initializing
+            - Pending
+            - Scanning
+        label:
+          type: string
+          required: false
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+        orderBy:
+          type: string
+          required: false
+          enum:
+            - NameDesc
+            - VersionDesc
+  /data-custom-code/{customCodeNameOrId}:
+    delete:
+      displayName: deleteCdpCustomCodeDeployment
+      description: Delete a data custom code
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getCdpCustomCodeDeployment
+      description: Get a data custom code
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeDeploymentRepresentation
+    patch:
+      displayName: patchCdpCustomCodeDeployment
+      description: Patch a data custom code
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeDeploymentRepresentation
+      body:
+        application/json:
+          type: CustomCodePatchInputRepresentation
+          # TODO Hand-rolled W-9271732
+          # required: false
+          (oas-body-name): customCodeDeployment
+    uriParameters:
+      customCodeNameOrId:
+        type: string
+        required: true
+  /data-custom-code/{customCodeNameOrId}/executions:
+    get:
+      displayName: getCdpCustomCodeExecution
+      description: BYOC Custom Code Executions
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeExecutionCollectionRepresentation
+      queryParameters:
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+    uriParameters:
+      customCodeNameOrId:
+        type: string
+        required: true
+  /data-custom-code/{customCodeNameOrId}/executions/{customCodeExecutionId}:
+    get:
+      displayName: getCdpCustomCodeExecutionSingle
+      description: BYOC Custom Code Execution
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeExecutionBaseRepresentation
+    uriParameters:
+      customCodeExecutionId:
+        type: string
+        required: true
+      customCodeNameOrId:
+        type: string
+        required: true
+  /data-custom-code/{customCodeNameOrId}/executions/{customCodeExecutionId}/logs:
+    get:
+      displayName: getCdpCustomCodeExecutionLog
+      description: BYOC Custom Code logs for an Execution
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeExecutionLogRepresentation
+    uriParameters:
+      customCodeExecutionId:
+        type: string
+        required: true
+      customCodeNameOrId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,54 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'byoc'
+(luvio.ttl): 60000
+
+types:
+  CdpAssetBaseRepresentation:
+    (luvio.key):
+      id: id
+  CustomCodeDeploymentInputRepresentation:
+    (luvio.key):
+      name: name
+  CustomCodeDeploymentRepresentation:
+    (luvio.key):
+      id: id
+
+/ssot:
+  /data-custom-code:
+    get:
+      (luvio.adapter):
+        name: getCustomCodeDeployments
+    post:
+      (luvio.adapter):
+        name: createCustomCodeDeployment
+    /{customCodeNameOrId}:
+      get:
+        (luvio.adapter):
+          name: getCustomCodeDeployment
+        (luvio.key):
+          id: urlParams.customCodeNameOrId
+      patch:
+        (luvio.adapter):
+          name: updateCustomCodeDeployment
+      delete:
+        (luvio.adapter):
+          name: deleteCustomCodeDeployment
+        (luvio.key):
+          id: urlParams.customCodeNameOrId
+      /executions:
+        get:
+          (luvio.adapter):
+            name: getCustomCodeExecutions
+        /{customCodeExecutionId}:
+          get:
+            (luvio.adapter):
+              name: getCustomCodeExecution
+          /logs:
+            get:
+              (luvio.adapter):
+                name: getCustomCodeExecutionLogs