@epilot/app-client 0.7.0 → 0.7.2

package/dist/openapi.d.ts

@@ -55,6 +55,10 @@ declare namespace Components {
              * Configuration values for the app components
              */
             option_values?: Schemas.OptionsRef[];
+            /**
+             * Manifest ID used to create/update the entity
+             */
+            _manifest?: string /* uuid */[];
         }
         export interface PatchConfigMetadataRequest {
             /**
@@ -229,7 +233,7 @@ declare namespace Components {
             surfaces?: {
                 [key: string]: any;
             };
-        } & (JourneyBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent);
+        } & (JourneyBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent);
         export interface BaseComponentCommon {
             /**
              * Unique identifier for the component
@@ -429,7 +433,7 @@ declare namespace Components {
         /**
          * Type of app component
          */
-        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT";
+        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY";
         /**
          * Configuration of the published app
          */
@@ -768,6 +772,22 @@ declare namespace Components {
                 versioned_by?: string;
             };
         }
+        export interface CustomCapabilityComponent {
+            component_type: "CUSTOM_CAPABILITY";
+            configuration: {
+                /**
+                 * Define what type of capability this is
+                 */
+                type?: "tab" | "group";
+                /**
+                 * Which schemas are supported by the capability. If empty, all schemas are supported.
+                 */
+                allowed_schemas?: string[];
+            };
+            surfaces?: {
+                capability_config?: AppBridgeSurfaceConfig;
+            };
+        }
         export interface CustomFlowActionComponent {
             component_type: "CUSTOM_FLOW_ACTION";
             configuration: CustomFlowConfig;
@@ -1538,7 +1558,9 @@ declare namespace Paths {
     }
     namespace GetPublicFacingComponent {
         namespace Responses {
-            export type $200 = Components.Schemas.BaseComponent;
+            export interface $200 {
+                component?: Components.Schemas.BaseComponent;
+            }
             export interface $404 {
             }
         }
@@ -2402,6 +2424,7 @@ export type ComponentType = Components.Schemas.ComponentType;
 export type Configuration = Components.Schemas.Configuration;
 export type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
 export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
+export type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
 export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
 export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
 export type EnumArg = Components.Schemas.EnumArg;

package/dist/openapi.json

@@ -75,7 +75,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/BaseComponent"
+                  "type": "object",
+                  "properties": {
+                    "component": {
+                      "$ref": "#/components/schemas/BaseComponent"
+                    }
+                  }
                 }
               }
             }
@@ -1466,6 +1471,15 @@
                     "$ref": "#/components/schemas/OptionsRef"
                   },
                   "description": "Configuration values for the app components"
+                },
+                "_manifest": {
+                  "type": "array",
+                  "description": "Manifest ID used to create/update the entity",
+                  "items": {
+                    "type": "string",
+                    "format": "uuid",
+                    "example": "123e4567-e89b-12d3-a456-426614174000"
+                  }
                 }
               }
             }
@@ -1608,7 +1622,8 @@
           "CUSTOM_JOURNEY_BLOCK",
           "PORTAL_EXTENSION",
           "CUSTOM_FLOW_ACTION",
-          "ERP_INFORM_TOOLKIT"
+          "ERP_INFORM_TOOLKIT",
+          "CUSTOM_CAPABILITY"
         ],
         "description": "Type of app component"
       },
@@ -1716,7 +1731,8 @@
                 "CUSTOM_JOURNEY_BLOCK": "#/components/schemas/JourneyBlockComponent",
                 "PORTAL_EXTENSION": "#/components/schemas/PortalExtensionComponent",
                 "CUSTOM_FLOW_ACTION": "#/components/schemas/CustomFlowActionComponent",
-                "ERP_INFORM_TOOLKIT": "#/components/schemas/ErpInformToolkitComponent"
+                "ERP_INFORM_TOOLKIT": "#/components/schemas/ErpInformToolkitComponent",
+                "CUSTOM_CAPABILITY": "#/components/schemas/CustomCapabilityComponent"
               }
             },
             "oneOf": [
@@ -1731,11 +1747,59 @@
               },
               {
                 "$ref": "#/components/schemas/ErpInformToolkitComponent"
+              },
+              {
+                "$ref": "#/components/schemas/CustomCapabilityComponent"
               }
             ]
           }
         ]
       },
+      "CustomCapabilityComponent": {
+        "type": "object",
+        "required": [
+          "component_type",
+          "configuration"
+        ],
+        "properties": {
+          "component_type": {
+            "type": "string",
+            "enum": [
+              "CUSTOM_CAPABILITY"
+            ]
+          },
+          "configuration": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "description": "Define what type of capability this is",
+                "type": "string",
+                "enum": [
+                  "tab",
+                  "group"
+                ]
+              },
+              "allowed_schemas": {
+                "description": "Which schemas are supported by the capability. If empty, all schemas are supported.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "description": "Name of the schema",
+                  "example": "opportunity"
+                }
+              }
+            }
+          },
+          "surfaces": {
+            "type": "object",
+            "properties": {
+              "capability_config": {
+                "$ref": "#/components/schemas/AppBridgeSurfaceConfig"
+              }
+            }
+          }
+        }
+      },
       "JourneyBlockComponent": {
         "type": "object",
         "required": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",