@salesforce/lds-adapters-analytics-app-framework 1.308.0 → 1.309.0-dev10

package/src/raml/api.raml

@@ -25,6 +25,74 @@ annotationTypes:
     type: string
     allowedTargets: TypeDeclaration
 types:
+  AppActivityCollectionRepresentation:
+    description: Representation for an app's activity or history records.
+    type: object
+    properties:
+      appId:
+        description: The ID or fully qualified API name of the app to which
+          these activities belong.
+        type: string
+      items:
+        description: The collection of app activity records.
+        type: array
+        items:
+          type: AppActivityItemRepresentation
+  AppActivityItemInputRepresentation:
+    description: Input representation for creating an app activity record.
+    type: object
+    properties:
+      activityType:
+        description: The type of application activity.
+        type: string
+        enum:
+          - Create
+          - Delete
+          - RefreshData
+          - Update
+      appId:
+        description: The application id.
+        type: string
+      dominoRuntimeRequestId:
+        description: The associated domino runtime request id.
+        type: string
+      id:
+        description: Id of the application activity.
+        type: string
+  AppActivityItemRepresentation:
+    description: Representation for a single app activity record.
+    type: object
+    properties:
+      activityType:
+        description: The type of the app activity item.
+        type: string
+        enum:
+          - Create
+          - Delete
+          - RefreshData
+          - Update
+      appId:
+        description: The application id of the activity record.
+        type: string
+      id:
+        description: The ID of the app activity item record.
+        type: string
+      runtimeRequest:
+        description: The associated domino runtime request associated with the app
+          activity item record.
+        # TODO: hand-rolled
+        # DominoRuntimeRequestRepresentation and it's subtypes and related types come from the
+        # json-xform-connect-api modules and are referenced in app-framework-connect-api, which
+        # means they don't get created in this raml. For our usage purposes here currently, we
+        # don't need this type defined and having it as an open-ended object is sufficient.
+        #type: DominoRuntimeRequestRepresentation
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+      url:
+        description: The url for the app activity item.
+        type: string
   AppCollectionRepresentation:
     description: Representation for Next Gen applications.
     type: object
@@ -50,12 +118,28 @@ types:
       label:
         description: The user-facing name of the new folder or application.
         type: string
+      logLevel:
+        description: Specifies the runtime logging level for debug.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
       name:
         description: The internal api name of the new application.
         type: string
+      runtimeMethod:
+        description: The runtime method async or sync
+        required: false # TODO Hand-rolled W-15955585
+        type: string
       templateSourceId:
         description: Template Id from which to create the app.
         type: string
+      templateType:
+        description: The type of the template this app was created from
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+        enum:
+          - App
+          - Library
+          - Unknown
       templateValues:
         description: The runtime template values to use during application creation,
           as specified by the individual template.
@@ -72,6 +156,9 @@ types:
     description: Representation for a single app.
     type: object
     properties:
+      activitiesUrl:
+        description: Url to get collection of most recent installation activities
+        type: string
       applicationStatus:
         description: The status of this app.
         type: string
@@ -102,6 +189,9 @@ types:
       lastModifiedDate:
         description: When this app was last modified.
         type: string
+      latestActivityUrl:
+        description: Url to get the most recent activity.
+        type: string
       name:
         description: The dev name of this app.
         type: string
@@ -111,6 +201,13 @@ types:
       templateSourceId:
         description: The ID od the template used to create this app.
         type: string
+      templateType:
+        description: The type of the template used to create the app.
+        type: string
+        enum:
+          - App
+          - Library
+          - Unknown
       templateValues:
         description: The Variable Values (Answers to Questions) used to customize
           the app install.
@@ -131,6 +228,10 @@ types:
       app:
         description: The App.
         type: AppRepresentation
+      failureMessage:
+        description: The Failure message if the app has failed. If this app was created
+          Async it may not have completed yet.
+        type: string | nil
       runtimeRequestId:
         description: The Domino Runtime Request.
         type: string
@@ -167,6 +268,9 @@ types:
     description: Representation for a single template.
     type: object
     properties:
+      appId:
+        description: The App ID associated with this
+        type: string
       assetIdOrName:
         description: The primary ID or Name of the asset
         type: string
@@ -304,6 +408,10 @@ types:
         description: The Template layout definition file.
         required: false # TODO Hand-rolled W-15955585
         type: string
+      maxAppCount:
+        description: The maximum number of apps that can be creatd from this template.
+        required: false # TODO Hand-rolled W-15955585
+        type: integer
       name:
         description: The Template name.
         type: string
@@ -332,6 +440,7 @@ types:
         enum:
           - App
           - Library
+          - Unknown
       variableDefinition:
         description: The Template variables file
         required: false # TODO Hand-rolled W-15955585
@@ -373,12 +482,13 @@ types:
       name:
         description: The local API name of the application template.
         type: string
-      type:
+      templateType:
         description: The template type.
         type: string
         enum:
           - App
           - Library
+          - Unknown
       url:
         description: The this url.
         type: string
@@ -507,6 +617,13 @@ types:
         templateSourceId:
           type: string
           required: false
+        type:
+          type: string
+          required: false
+          enum:
+            - App
+            - Library
+            - Unknown
     post:
       displayName: postAppFrameworkAppCollection
       description: Creates an app from a template
@@ -540,6 +657,37 @@ types:
       appIdOrApiName:
         type: string
         required: true
+  /apps/{appIdOrApiName}/activities:
+    get:
+      displayName: getAppFrameworkAppActivityCollection
+      description: Get a list of app activity records
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppActivityCollectionRepresentation
+    uriParameters:
+      appIdOrApiName:
+        type: string
+        required: true
+    /{id}:
+      get:
+        displayName: getAppFrameworkAppActivityItem
+        description: Get a specific App's activity
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AppActivityItemRepresentation
+      uriParameters:
+        appIdOrApiName:
+          type: string
+          required: true
+        id:
+          type: string
+          required: true
   /apps/{appIdOrApiName}/assets:
     get:
       displayName: getAppFrameworkAppAssetCollection

package/src/raml/luvio.raml

@@ -8,6 +8,15 @@ uses:
 (luvio.ttl): 2592000000
 
 types:
+  AppActivityCollectionRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      appId: appId
+  AppActivityItemRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      appId: appId
+      id: id
   AppCollectionRepresentation:
     (luvio.ttl): 5000
   AppRepresentation:
@@ -21,7 +30,7 @@ types:
   AssetCollectionRepresentation:
     (luvio.ttl): 5000
     (luvio.key):
-      id: appId
+      appId: appId
   AssetRepresentation:
     (luvio.ttl): 5000
     (luvio.key):
@@ -61,7 +70,20 @@ types:
       (luvio.adapter):
         name: getAppAssets
       (luvio.key):
-        id: urlParams.appIdOrApiName
+        appId: urlParams.appIdOrApiName
+  /apps/{appIdOrApiName}/activities:
+    get:
+      (luvio.adapter):
+        name: getAppActivities
+      (luvio.key):
+        appId: urlParams.appIdOrApiName
+  /apps/{appIdOrApiName}/activities/{id}:
+    get:
+      (luvio.adapter):
+        name: getAppActivity
+      (luvio.key):
+        appId: urlParams.appIdOrApiName
+        id: urlParams.id
   /templates:
     get:
       (luvio.adapter):