@salesforce/lds-adapters-analytics-wave-private 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,278 @@
+#%RAML 1.0
+# This RAML has been modified and "ELT Foundation - Analytics" is responsible for maintaining it
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '52.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:
+  # TODO: Intentionally hand-rolled
+  # The java source has a single 'json' string field, but uses a custom serializer which outputs that as
+  # the actual json. The json output is not defined in the connect annotations.
+  # Similar to SaqlQueryResultsRepresentation in lds-adapters-analytics-wave
+  SoqlQueryResultRepresentation:
+    description: Represents a string of JSON content that will be serialized as-is.
+    type: object
+    properties:
+      totalSize:
+        type: number
+        required: false
+      done:
+        type: boolean
+        required: false
+      records:
+        description: The result records
+        type: array
+        items:
+          type: any
+      # depending on the type of query and the underlying data, there might be other properties
+      //:
+        type: any
+  SoqlQueryInputRepresentation:
+    description: A query input representation SOQL
+    type: object
+    properties:
+      query:
+        description: The query
+        type: string
+  TemplateSetupJobRepresentation:
+    description: The configuration and status of a template setup job.
+    type: object
+    properties:
+      description:
+        description: The job description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      duration:
+        description: The job's last execution time duration.
+        # format: int64
+        # type: integer
+        # TODO Hand-rolled W-8274943
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-8253396
+      name:
+        description: The job name.
+        type: string
+      status:
+        description: The job's last execution status
+        type: string
+        enum:
+          - Completed
+          - ExistingSetup
+          - Failed
+          - InProgress
+          - NotExecuted
+          - PreConditionNotMet
+      tasks:
+        description: The tasks in this job.
+        type: array
+        items:
+          type: TemplateSetupTaskRepresentation
+  TemplateSetupPlanRepresentation:
+    description: The configuration and current status of a template setup plan.
+    type: object
+    properties:
+      description:
+        description: The setup plan description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      details:
+        description: The task detailed description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      duration:
+        description: The setup plan's last execution duration.
+        # format: int64
+        # type: integer
+        # TODO Hand-rolled W-8274943
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-8253396
+      jobs:
+        description: The jobs in this plan.
+        type: array
+        items:
+          type: TemplateSetupJobRepresentation
+      name:
+        description: The setup plan name.
+        type: string
+      status:
+        description: The setup plan's last execution status.
+        type: string
+        enum:
+          - Completed
+          - ExistingSetup
+          - Failed
+          - InProgress
+          - NotExecuted
+          - PreConditionNotMet
+      templateId:
+        description: The template id for this setup plan.
+        type: string
+  TemplateSetupTaskRepresentation:
+    description: The configuration and status of a template setup task.
+    type: object
+    properties:
+      description:
+        description: The task description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      details:
+        description: The task detailed description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      duration:
+        description: The task's last execution time duration.
+        # format: int64
+        # type: integer
+        # TODO Hand-rolled W-8274943
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-8253396
+      enabled:
+        description: Is the resulting setup for this task enabled.
+        type: boolean
+        required: false # TODO Hand-rolled W-8253396
+      endDate:
+        description: The End Date timestamp of the task.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      error:
+        description: Any error message if the task's last execution failed.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      name:
+        description: The task name.
+        type: string
+      setupUrl:
+        description: The url or url path to perform the task configuration manually.
+          Typically only shown on error.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      startDate:
+        description: The Start Date timestamp of the task.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      status:
+        description: The task's last execution status.
+        type: string
+        enum:
+          - Completed
+          - ExistingSetup
+          - Failed
+          - InProgress
+          - NotExecuted
+          - PreConditionNotMet
+  BaseDashboardInputRepresentation:
+    description: Wave Dashboard Asset Representation
+    type: object
+    discriminator: name
+    properties:
+      folder:
+        description: Folder in which this dashboard is stored.
+        type: any
+      label:
+        description: The label of the asset.
+        type: string
+      name:
+        description: The name of the asset.
+        type: string
+      description:
+        description: Short Description of the asset.
+        type: string
+      templateSourceId:
+        description: The source template ID or api name used to create the dashboard.
+        type: string
+      templateValues:
+        description: The runtime template values to use during dashboard creation,
+          as specified by the individual dashboard template.
+        type: object
+        properties:
+          //:
+            type: any
+  DashboardRepresentation:
+    description: Wave dashboard asset representation.
+    type: object
+    properties:
+      id:
+        description: The 18 character asset ID.
+        type: string | nil
+      //:
+        type: any
+
+/wave:
+  /soql:
+    post:
+      description: Execute a query.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SoqlQueryResultRepresentation
+      body:
+        application/json:
+          type: SoqlQueryInputRepresentation
+          (oas-body-name): query
+  /templates/{templateIdOrApiName}/plans/{planName}:
+    get:
+      displayName: getWaveTemplateSetupPlan
+      description: Returns the plan.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateSetupPlanRepresentation
+    post:
+      displayName: postWaveTemplateSetupPlan
+      description: Execute a plan.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateSetupPlanRepresentation
+    uriParameters:
+      planName:
+        type: string
+        required: true
+      templateIdOrApiName:
+        type: string
+        required: true
+  /dashboards:
+    post:
+      displayName: postDashboardCollection
+      description: Create a new Dashboard.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DashboardRepresentation
+      body:
+        application/json:
+          type: BaseDashboardInputRepresentation
+          (oas-body-name): dashboard

package/src/raml/luvio.raml

@@ -0,0 +1,43 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'WAVE'
+(luvio.ttl): 2592000000
+
+types:
+  SoqlQueryResultRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 5000
+  TemplateSetupPlanRepresentation:
+    (luvio.key):
+      templateId: templateId
+      planName: name
+    (luvio.ttl): 1000
+  DashboardRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+
+/wave:
+  /soql:
+    post:
+      (luvio.adapter):
+        name: executeSoqlQueryPost
+      (luvio.method): get
+  /templates/{templateIdOrApiName}/plans/{planName}:
+    get:
+      (luvio.adapter):
+        name: getTemplateSetupPlan
+      (luvio.key):
+        templateId: urlParams.templateIdOrApiName
+        planName: urlParams.planName
+    post:
+      (luvio.adapter):
+        name: executeTemplateSetupPlan
+  /dashboards:
+    post:
+      (luvio.adapter):
+        name: createDashboard