@salesforce/lds-adapters-analytics-tableau-embedding 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,171 @@
+#%RAML 1.0
+# EUREKA: Contents of this file have been manually edited and are different from Core generated RAML!
+# Please make sure these changes are kept if they are still needed and don't just override with new contents!
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.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:
+  TableauEASRepresentation:
+    description: Tableau EAS trust registration details
+    type: object
+    properties:
+      issuer:
+        description: Issuer URL
+        type: string
+      jwks:
+        description: JWKS URI
+        type: string
+  TableauJWTInputRepresentation:
+    description: Tableau embedding JWT inputs
+    type: object
+    properties:
+      cb:
+        description: Cache buster
+        type: string
+        # This was edited to specify the property is not required! Tests will fail with network mock issues if this is removed!
+        required: false
+      siteId:
+        description: Tableau Site ID
+        type: string
+        # This was edited to specify the property is not required! Tests will fail with network mock issues if this is removed!
+        required: false
+      tabUrl:
+        description: Tableau Embedding URL
+        type: string
+        # This was edited to specify the property is not required! Tests will fail with network mock issues if this is removed!
+        required: false
+      uafDefinitionNames:
+        description: UAF Claim definition names
+        type: string
+        required: false
+      jwtAccessScopeSet:
+        description: Scopes set
+        type: string
+        required: false
+  TableauJWTRepresentation:
+    description: Tableau embedding JWT
+    type: object
+    properties:
+      cb:
+        description: The cache buster parameter used when the JWT was requested, if
+          available
+        type: string
+      jti:
+        description: The jti claim in the JWT
+        type: string
+      siteId:
+        description: The Tableau Site ID this JWT was created for
+        type: string
+      tabUrl:
+        description: The Tableau URL this JWT was created for
+        type: string
+      token:
+        description: Tableau embedding JWT
+        type: string
+      uafClaims:
+        description: The UAF claims that were added to the JWT
+        type: string
+  # This type should always be a clone of TableauJWTRepresentation above, just configured differently in luvio.raml. Inheritance via base type is not possible!
+  TableauJWTRepresentation2:
+    description: Tableau embedding JWT
+    type: object
+    properties:
+      cb:
+        description: The cache buster parameter used when the JWT was requested, if
+          available
+        type: string
+      jti:
+        description: The jti claim in the JWT
+        type: string
+      siteId:
+        description: The Tableau Site ID this JWT was created for
+        type: string
+      tabUrl:
+        description: The Tableau URL this JWT was created for
+        type: string
+      token:
+        description: Tableau embedding JWT
+        type: string
+      uafClaims:
+        description: The UAF claims that were added to the JWT
+        type: string
+/tableau:
+  /eas:
+    get:
+      displayName: getTableauEAS
+      description: Get the Tableau EAS trust details
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TableauEASRepresentation
+  /jwt:
+    get:
+      displayName: getTableauJWT
+      description: GET method to retrieve the custom Tableau embedding JWT
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TableauJWTRepresentation
+      queryParameters:
+        cb:
+          description: Cache buster
+          type: string
+          required: false
+        siteId:
+          description: Tableau Site ID
+          type: string
+          required: false
+        tabUrl:
+          description: Tableau Embedding URL
+          type: string
+          required: false
+        uafDefinitionNames:
+          description: UAF Claim definition names
+          type: string
+          required: false
+        jwtAccessScopeSet:
+          description: Access scope set for the generated JWT token
+          type: string
+          required: false
+    post:
+      displayName: postTableauJWT
+      description: POST method for generating the custom Tableau embedding JWT
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TableauJWTRepresentation2
+      body:
+        application/json:
+          description: Tableau embedding JWT inputs
+          type: TableauJWTInputRepresentation
+          # The line below is from Core RAML but is commented out because it causes compilation errors in this repo!
+          #          required: false
+          (oas-body-name): tableauJwtArgs

package/src/raml/luvio.raml

@@ -0,0 +1,39 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'TableauEmbedding'
+
+types:
+  TableauEASRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 180000
+
+  TableauJWTRepresentation:
+    (luvio.opaque): true
+    # logically this is going to be ZERO because of `no-cache` forced policy, but using the min recommended here
+    (luvio.ttl): 100
+
+  # This type should always be a clone of TableauJWTRepresentation above, just configured differently
+  TableauJWTRepresentation2:
+    (luvio.opaque): true
+    # logically this is going to be ZERO because of `no-cache` forced policy, but using the min recommended here
+    (luvio.ttl): 100
+    (luvio.key):
+      id: jti
+
+/tableau:
+  /eas:
+    get:
+      (luvio.adapter):
+        name: getEAS
+
+  /jwt:
+    get:
+      (luvio.adapter):
+        name: getJWT
+    post:
+      (luvio.adapter):
+        name: postJWT