@salesforce/lds-adapters-analytics-app-framework 1.303.0

package/src/raml/api.raml

@@ -0,0 +1,601 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v62.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:
+  AppCollectionRepresentation:
+    description: Representation for Next Gen applications.
+    type: object
+    properties:
+      apps:
+        description: The collection of applications available within this organization.
+        type: array
+        items:
+          type: AppRepresentation
+  AppInputRepresentation:
+    description: Input representation for creating an app from a template.
+    type: object
+    properties:
+      assetIcon:
+        description: The icon enumeration that best represents the new application.
+          Valid values are 1.png through 20.png.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      description:
+        description: The description of the new application.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      label:
+        description: The user-facing name of the new folder or application.
+        type: string
+      name:
+        description: The internal api name of the new application.
+        type: string
+      templateSourceId:
+        description: Template Id from which to create the app.
+        type: string
+      templateValues:
+        description: The runtime template values to use during application creation,
+          as specified by the individual template.
+        type: object
+        required: false # TODO Hand-rolled W-15955585
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+      templateVersion:
+        description: The version of the template this app was created from
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+  AppRepresentation:
+    description: Representation for a single app.
+    type: object
+    properties:
+      applicationStatus:
+        description: The status of this app.
+        type: string
+      assetUrl:
+        description: A link to the App Assets.
+        type: string
+      createdBy:
+        description: Who created this app.
+        type: UserRepresentation
+      createdDate:
+        description: When this app was created.
+        type: string
+      description:
+        description: The description of this app.
+        type: string | nil
+      id:
+        description: The ID or fully qualified API name of this app.
+        type: string
+      installationHistoryUrl:
+        description: A link to the App History Setup Page.
+        type: string
+      label:
+        description: The label of this app.
+        type: string
+      lastModifiedBy:
+        description: Who last modified this app.
+        type: UserRepresentation
+      lastModifiedDate:
+        description: When this app was last modified.
+        type: string
+      name:
+        description: The dev name of this app.
+        type: string
+      schedule:
+        description: The refresh scedhule for this app.
+        type: AppScheduleRepresentation | nil
+      templateSourceId:
+        description: The ID od the template used to create this app.
+        type: string
+      templateValues:
+        description: The Variable Values (Answers to Questions) used to customize
+          the app install.
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+      templateVersion:
+        description: The version of the template used to create the app.
+        type: string
+      url:
+        description: A self link to this App
+        type: string
+  AppResultRepresentation:
+    description: Representation for the results of an app creation.
+    type: object
+    properties:
+      app:
+        description: The App.
+        type: AppRepresentation
+      runtimeRequestId:
+        description: The Domino Runtime Request.
+        type: string
+      state:
+        description: The State.
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+  AppScheduleRepresentation:
+    description: Representaiton for an App Data Refresh schedule
+    type: object
+    properties:
+      dataRefreshSchedule:
+        description: Recurring schedule for performing data refreshes.
+        type: ScheduledItemRepresentation | nil
+      url:
+        description: Url to scheduling attributes of a folder.
+        type: string | nil
+  AssetCollectionRepresentation:
+    description: Representation list of assets created from a template.
+    type: object
+    properties:
+      appId:
+        description: The ID or fully qualified API name of the app to which these
+          assets belong.
+        type: string
+      assets:
+        description: The collection of assets created from the template.
+        type: array
+        items:
+          type: AssetRepresentation
+  AssetRepresentation:
+    description: Representation for a single template.
+    type: object
+    properties:
+      assetIdOrName:
+        description: The primary ID or Name of the asset
+        type: string
+      assetIdOrName2:
+        description: The secondary ID or Name of the asset
+        type: string | nil
+      assetIdOrName3:
+        description: The tertiary ID or Name of the asset
+        type: string | nil
+      id:
+        description: The ID of the asset association.
+        type: string
+      templateAssetSourceName:
+        description: The template asset name this asset was created from.
+        type: string | nil
+      type:
+        description: The asset type.
+        type: string | nil
+  ChainDefinitionInputRepresentation:
+    description: Input representation for a domino chain definition.
+    type: object
+    properties:
+      file:
+        description: The this file reference to the chain
+        type: string
+      name:
+        description: The name of the chain.
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+      type:
+        description: The type of chain.
+        type: string
+        enum:
+          - Create
+          - Delete
+          - RefreshData
+          - Update
+  NamespacedReferenceInputRepresentation:
+    description: Namespaced reference to resource.
+    type: object
+    properties:
+      name:
+        description: Developer Name.
+        type: string
+      namespace:
+        description: Developer Namespace
+        type: string
+  ReleaseInfoInputRepresentation:
+    description: Input representation for release notes and version.
+    type: object
+    properties:
+      notesFile:
+        description: Template release notes.
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+      templateVersion:
+        description: Template version.
+        type: string
+  RuleInfoInputRepresentation:
+    description: Input representation for rules.
+    type: object
+    properties:
+      file:
+        description: The JSON file holding the rules.
+        type: string
+      type:
+        description: The type of rules.
+        type: string
+  TemplateCollectionRepresentation:
+    description: Representation for Next Gen application templates.
+    type: object
+    properties:
+      templates:
+        description: The collection of application templates available within this
+          organization.
+        type: array
+        items:
+          type: TemplateRepresentation
+  TemplateConfigurationRepresentation:
+    description: Representation for app template configuration.
+    type: object
+    properties:
+      id:
+        description: The ID or fully qualified API name of this template.
+        type: string
+      name:
+        description: The local API name of the template.
+        type: string
+  TemplateIconsInputRepresentation:
+    description: Input representation template Icons.
+    type: object
+    properties:
+      appBadge:
+        description: Icon for the app.
+        required: false # TODO Hand-rolled W-15955585
+        type: NamespacedReferenceInputRepresentation
+      templateBadge:
+        description: Icon for the template
+        required: false # TODO Hand-rolled W-15955585
+        type: NamespacedReferenceInputRepresentation
+      templatePreviews:
+        description: Previews images an description of template
+        type: array
+        required: false # TODO Hand-rolled W-15955585
+        items:
+          type: TemplatePreviewInputRepresentation
+  TemplateInputRepresentation:
+    description: Input representation for Template Info.
+    type: object
+    properties:
+      assetVersion:
+        description: The version of the Template assets.
+        format: double
+        type: number
+      chainDefinitions:
+        description: The Template chain definitions
+        type: array
+        items:
+          type: ChainDefinitionInputRepresentation
+      description:
+        description: The Template description.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      icons:
+        description: The Template icons.
+        required: false # TODO Hand-rolled W-15955585
+        type: TemplateIconsInputRepresentation
+      id:
+        description: The Template Id.
+        type: string
+      label:
+        description: The Template label.
+        type: string
+      layoutDefinition:
+        description: The Template layout definition file.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      name:
+        description: The Template name.
+        type: string
+      namespace:
+        description: The Template developer namespace.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      releaseInfo:
+        description: The Template release notes
+        type: ReleaseInfoInputRepresentation
+      rules:
+        description: The Template rules file
+        type: array
+        required: false # TODO Hand-rolled W-15955585
+        items:
+          type: RuleInfoInputRepresentation
+      tags:
+        description: The Template Tags.
+        type: array
+        required: false # TODO Hand-rolled W-15955585
+        items:
+          type: string
+      templateType:
+        description: The Template Type.
+        type: string
+        enum:
+          - App
+          - Library
+      variableDefinition:
+        description: The Template variables file
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+  TemplatePreviewInputRepresentation:
+    description: Input representation for Template Previews.
+    type: object
+    properties:
+      description:
+        description: Preview description
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      label:
+        description: Preview title
+        type: string
+      name:
+        description: Developer Name.
+        type: string
+      namespace:
+        description: Developer Namespace
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+  TemplateRepresentation:
+    description: Representation for a single template.
+    type: object
+    properties:
+      configurationUrl:
+        description: Url for configuration information
+        type: string
+      description:
+        description: The description of the application template.
+        type: string | nil
+      id:
+        description: The ID or fully qualified API name of this template.
+        type: string
+      label:
+        description: The localized name of the application template.
+        type: string
+      name:
+        description: The local API name of the application template.
+        type: string
+      type:
+        description: The template type.
+        type: string
+        enum:
+          - App
+          - Library
+      url:
+        description: The this url.
+        type: string
+  UserRepresentation:
+    description: Information about 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 | nil
+  # TODO: hand-rolled
+  # ScheduleItemReresentation and its subtypes and related types come from the json-xform-connect-api
+  # module and are referenced in app-framework-connect-api. This means they don't get created in the
+  # app-framework-connect-api raml, so I'm copying them from the json-xform-connect-api raml here.
+  DailyScheduledItemRepresentation:
+    description: Representation for a scheduled item.
+    type: ScheduledItemRepresentation
+    discriminatorValue: Daily
+    properties: {}
+  HourlyScheduledItemRepresentation:
+    description: Representation for an hourly scheduled item.
+    type: ScheduledItemRepresentation
+    discriminatorValue: Hourly
+    properties:
+      daysOfWeek:
+        description: Collection of days of week for schedule.
+        type: array
+        items:
+          type: string
+          enum:
+            - Friday
+            - Monday
+            - Saturday
+            - Sunday
+            - Thursday
+            - Tuesday
+            - Wednesday
+      hourlyInterval:
+        description: Collection of days of week for schedule.
+        type: integer
+  ScheduledItemRepresentation:
+    description: Representation for a scheduled item.
+    type: object
+    discriminator: frequency
+    properties:
+      frequency:
+        description: The frequency of this scheduled item.
+        type: string
+        enum:
+          - Daily
+          - Hourly
+          - Weekly
+        # TODO: hand-rolled -- these are in the java enum, but do not have corresponding java
+        # subclasses so they won't be seen in responses for now
+        # - Monthly
+        # - MonthlyRelative
+      nextScheduledRun:
+        description: The next scheduled runtime.
+        type: string
+      time:
+        description: Collection of scheduled run time.
+        type: ScheduledTimeRepresentation
+  ScheduledTimeRepresentation:
+    description: Representation for a scheduled time of day.
+    type: object
+    properties:
+      hour:
+        description: Hour of day.
+        type: integer
+      minute:
+        description: Minute of hour.
+        type: integer
+      timezone:
+        description: String representation of timezone.
+        type: ScheduledTimezoneRepresentation
+  ScheduledTimezoneRepresentation:
+    description: Information about a time zone.
+    type: object
+    properties:
+      gmtOffset:
+        description: The signed offset, in hours, from GMT.
+        format: double
+        type: number
+      name:
+        description: The display name of this time zone.
+        type: string
+      zoneId:
+        description: The zone ID of this time zone.
+        type: string
+  WeeklyScheduledItemRepresentation:
+    description: Representation for a daily scheduled item.
+    type: ScheduledItemRepresentation
+    discriminatorValue: Weekly
+    properties:
+      daysOfWeek:
+        description: Collection of days of week for schedule.
+        type: array
+        items:
+          type: string
+          enum:
+            - Friday
+            - Monday
+            - Saturday
+            - Sunday
+            - Thursday
+            - Tuesday
+            - Wednesday
+/app-framework:
+  /apps:
+    get:
+      displayName: getAppFrameworkAppCollection
+      description: Get a list of applications
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppCollectionRepresentation
+      queryParameters:
+        templateSourceId:
+          type: string
+          required: false
+    post:
+      displayName: postAppFrameworkAppCollection
+      description: Creates an app from a template
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppResultRepresentation
+      body:
+        application/json:
+          type: AppInputRepresentation
+          (oas-body-name): app
+  /apps/{appIdOrApiName}:
+    delete:
+      displayName: deleteAppFrameworkApp
+      description: Delete an App.
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getAppFrameworkApp
+      description: Get an App
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppRepresentation
+    uriParameters:
+      appIdOrApiName:
+        type: string
+        required: true
+  /apps/{appIdOrApiName}/assets:
+    get:
+      displayName: getAppFrameworkAppAssetCollection
+      description: Get a list of assets included in the app
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AssetCollectionRepresentation
+      queryParameters:
+        assetType:
+          type: string
+          required: false
+        templateAssetName:
+          type: string
+          required: false
+    uriParameters:
+      appIdOrApiName:
+        type: string
+        required: true
+  /templates:
+    get:
+      displayName: getAppFrameworkTemplateCollection
+      description: Get a list of application templates
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateCollectionRepresentation
+  /templates/{templateIdOrApiName}:
+    get:
+      displayName: getAppFrameworkTemplate
+      description: Get an App Template
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateRepresentation
+    uriParameters:
+      templateIdOrApiName:
+        type: string
+        required: true
+  /templates/{templateIdOrApiName}/configuration:
+    get:
+      displayName: getAppFrameworkTemplateConfiguration
+      description: Returns the configuration for a specific template.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateConfigurationRepresentation
+    uriParameters:
+      templateIdOrApiName:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,80 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'AppFramework'
+(luvio.ttl): 2592000000
+
+types:
+  AppCollectionRepresentation:
+    (luvio.ttl): 5000
+  AppRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  AppResultRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: app.id
+  AssetCollectionRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: appId
+  AssetRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  TemplateCollectionRepresentation:
+    (luvio.ttl): 5000
+  TemplateRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  TemplateConfigurationRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+
+/app-framework:
+  /apps:
+    get:
+      (luvio.adapter):
+        name: getApps
+    post:
+      (luvio.adapter):
+        name: createApp
+  /apps/{appIdOrApiName}:
+    delete:
+      (luvio.adapter):
+        name: deleteApp
+      (luvio.key):
+        id: urlParams.appIdOrApiName
+    get:
+      (luvio.adapter):
+        name: getApp
+      (luvio.key):
+        id: urlParams.appIdOrApiName
+  /apps/{appIdOrApiName}/assets:
+    get:
+      (luvio.adapter):
+        name: getAppAssets
+      (luvio.key):
+        id: urlParams.appIdOrApiName
+  /templates:
+    get:
+      (luvio.adapter):
+        name: getTemplates
+  /templates/{templateIdOrApiName}:
+    get:
+      (luvio.adapter):
+        name: getTemplate
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+  /templates/{templateIdOrApiName}/configuration:
+    get:
+      (luvio.adapter):
+        name: getTemplateConfig
+      (luvio.key):
+        id: urlParams.templateIdOrApiName