@salesforce/lds-adapters-service-gis 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,270 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '65.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:
+  ErrorResponse:
+    description: Error response
+    type: object
+    properties:
+      code:
+        description: Error code
+        type: string
+      message:
+        description: Error message
+        type: string
+  GisExternalAccessTokenOutputRepresentation:
+    description: Output representation for an External GIS authentication token
+    type: object
+    properties:
+      expiresIn:
+        description: The token expiration time
+        type: integer
+      token:
+        description: The access token used to authenticate against GIS services (e.g.,
+          'esri')
+        type: string
+      type:
+        description: The type of token (e.g., 'Bearer')
+        type: string
+  GisExternalAuthIdentityProviderCollectionRepresentation:
+    description: Represents collection of Gis ExternalProviders
+    type: object
+    properties:
+      count:
+        description: Gis ExternalProvider total count
+        type: integer
+      gisExternalAuthIdentityProviderOutputRepresentation:
+        description: Gis ExternalProviders list
+        type: array
+        items:
+          type: GisExternalAuthIdentityProviderOutputRepresentation
+  GisExternalAuthIdentityProviderInputRepresentation:
+    description: Input representation for creating a GIS External Auth Identity Provider
+    type: object
+    properties:
+      authType:
+        description: Selected authentication method
+        type: string
+      baseUrl:
+        description: Base URL for the map provider API
+        type: string
+      clientId:
+        description: Client ID for authentication
+        type: string
+      clientSecret:
+        description: Client secret for authentication
+        type: string
+      gisProvider:
+        description: Selected map provider
+        type: string
+      name:
+        description: Name of the GIS Authentication setup
+        type: string
+  GisExternalAuthIdentityProviderOutputRepresentation:
+    description: Output representation for External Auth Identity Provider
+    type: object
+    properties:
+      authType:
+        description: Selected map provider
+        type: string
+      baseUrl:
+        description: Identity provider base url
+        type: string
+      clientId:
+        description: Client ID for authentication
+        type: string
+      fullName:
+        description: External Auth Identity Provider full name
+        type: string
+      gisProvider:
+        description: Selected map provider
+        type: string
+      id:
+        description: External Auth Identity Provider ID
+        type: string
+      label:
+        description: Label for External Auth Identity Provider
+        type: string
+  GisExtlMapObjectConfigCollectionRepresentation:
+    description: Represents collection of GIS External Map Object Configurations
+    type: object
+    properties:
+      count:
+        description: Total count of GIS External Map Object Configurations
+        type: integer
+      gisExtlMapObjectConfigs:
+        description: List of GIS External Map Object Configurations
+        type: array
+        items:
+          type: GisExtlMapObjectConfigOutputRepresentation
+  GisExtlMapObjectConfigOutputRepresentation:
+    description: Output representation for GIS External Map Object Configuration
+    type: object
+    properties:
+      defaultMapId:
+        description: Default map ID for the object
+        type: string
+      id:
+        description: Entity ID
+        type: string
+      mapIdFieldName:
+        description: Field name for the map ID
+        type: string | nil
+      objectName:
+        description: Name of the object (e.g., "WorkOrder")
+        type: string
+      recordType:
+        description: Type of the record (e.g., "All")
+        type: string | nil
+  GisRelatedObjectConfigCollectionRepresentation:
+    description: Represents collection of Map Object Configurations
+    type: object
+    properties:
+      count:
+        description: Map Object Configurations total count
+        type: integer
+      gisRelatedObjectConfigOutputRepresentation:
+        description: Map Object Configurations list
+        type: array
+        items:
+          type: GisRelatedObjectConfigOutputRepresentation
+  GisRelatedObjectConfigOutputRepresentation:
+    description: Output representation for Map Object Configuration
+    type: object
+    properties:
+      defaultColor:
+        description: Default color for map objects
+        type: string
+      defaultIcon:
+        description: Default icon for map objects
+        type: string
+      fieldName:
+        description: Field name for location data
+        type: string
+      fieldType:
+        description: Type of location field (geographic data type)
+        type: string
+      id:
+        description: Entity ID
+        type: string
+      objectName:
+        description: Name of the object to be configured
+        type: string
+      recordTypeId:
+        description: Record type ID for the map object configuration
+        type: string
+      recordType:
+        description: Record type for the map object configuration
+        type: string
+      referenceObjectName:
+        description: Reference object name for location data
+        type: string
+/gis:
+  /auth:
+    /GisExternalAccessToken:
+      get:
+        displayName: getGisExternalAuthAccessToken
+        description: Get an authentication access token for GIS services (e.g., 'esri')
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GisExternalAccessTokenOutputRepresentation
+        queryParameters:
+          authSettingsId:
+            description: Authentication settings related
+            type: string
+    /GisExternalAuthIdentityProvider:
+      post:
+        displayName: createGisExternalAuthIdentityProvider
+        description: Create Gis ExternalAuthIdentityProviders.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GisExternalAuthIdentityProviderOutputRepresentation
+        body:
+          application/json:
+            type: GisExternalAuthIdentityProviderInputRepresentation
+            (oas-body-name): gisExternalAuthIdentityProviderInputRepresentation
+    /GisExternalAuthIdentityProviders:
+      get:
+        displayName: getGisExternalAuthIdentityProviders
+        description: Gets Gis ExternalAuthIdentityProviders.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GisExternalAuthIdentityProviderCollectionRepresentation
+        queryParameters:
+          limitByProfile:
+            description: Limits the settings for profile or not
+            type: boolean
+  /config:
+    /GisExtlMapObjectConfig:
+      get:
+        displayName: getGisExtlMapObjectConfig
+        description: Fetches the display mapping configuration for a specific object
+          and record type.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GisExtlMapObjectConfigCollectionRepresentation
+        queryParameters:
+          id:
+            description: Filter by object id
+            type: string
+            required: false
+          objectName:
+            description: The name of the object to get mapping configuration for (e.g.,
+              "WorkOrder")
+            type: string
+            required: false
+    /GisRelatedObjectConfig:
+      get:
+        displayName: getGisRelatedObjectConfig
+        description: Get a list of all map object configurations, optionally filtered
+          by objectName.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GisRelatedObjectConfigCollectionRepresentation
+        queryParameters:
+          id:
+            description: Filter by object id
+            type: string
+            required: false
+          objectName:
+            description: Filter by object name
+            type: string
+            required: false

package/src/raml/luvio.raml

@@ -0,0 +1,77 @@
+#%RAML 1.0 Overlay
+title: GIS Service API Overlay
+extends: ./api.raml
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'gis'
+(luvio.ttl): 1000
+
+# Type definitions with TTL
+types:
+  # GIS External Auth Identity Provider types
+  GisExternalAuthIdentityProviderCollectionRepresentation:
+    (luvio.ttl): 300
+
+  GisExternalAuthIdentityProviderOutputRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: id
+
+  GisExternalAuthIdentityProviderInputRepresentation:
+    (luvio.ttl): 300
+
+  GisExternalAuthIdentityProviderCredential:
+    (luvio.ttl): 300
+
+  GisExternalAuthIdentityProviderParameter:
+    (luvio.ttl): 300
+
+  GisExternalAccessTokenOutputRepresentation:
+    (luvio.ttl): 300
+
+  # GIS Config types
+  GisExtlMapObjectConfigOutputRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: id
+
+  GisExtlMapObjectConfigCollectionRepresentation:
+    (luvio.ttl): 300
+
+  GisRelatedObjectConfigOutputRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: id
+
+  GisRelatedObjectConfigCollectionRepresentation:
+    (luvio.ttl): 300
+
+# Endpoint configurations - Only include customizations that don't override base endpoints
+/gis/auth:
+  # GisExternalAuthIdentityProvider endpoints
+  /GisExternalAuthIdentityProvider:
+    post:
+      (luvio.adapter):
+        name: createGisExternalAuthIdentityProvider
+
+  /GisExternalAuthIdentityProviders:
+    get:
+      (luvio.adapter):
+        name: getGisExternalAuthIdentityProviders
+
+  /GisExternalAccessToken:
+    get:
+      (luvio.adapter):
+        name: getGisExternalAuthAccessToken
+
+/gis/config:
+  /GisExtlMapObjectConfig:
+    get:
+      (luvio.adapter):
+        name: getGisExtlMapObjectConfig
+
+  /GisRelatedObjectConfig:
+    get:
+      (luvio.adapter):
+        name: getGisRelatedObjectConfig