@epilot/app-client 0.7.1 → 0.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.d.ts CHANGED
@@ -233,7 +233,7 @@ declare namespace Components {
233
233
  surfaces?: {
234
234
  [key: string]: any;
235
235
  };
236
- } & (JourneyBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent);
236
+ } & (JourneyBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent);
237
237
  export interface BaseComponentCommon {
238
238
  /**
239
239
  * Unique identifier for the component
@@ -433,7 +433,7 @@ declare namespace Components {
433
433
  /**
434
434
  * Type of app component
435
435
  */
436
- export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT";
436
+ export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY";
437
437
  /**
438
438
  * Configuration of the published app
439
439
  */
@@ -772,6 +772,22 @@ declare namespace Components {
772
772
  versioned_by?: string;
773
773
  };
774
774
  }
775
+ export interface CustomCapabilityComponent {
776
+ component_type: "CUSTOM_CAPABILITY";
777
+ configuration: {
778
+ /**
779
+ * Define what type of capability this is
780
+ */
781
+ type?: "tab" | "group";
782
+ /**
783
+ * Which schemas are supported by the capability. If empty, all schemas are supported.
784
+ */
785
+ allowed_schemas?: string[];
786
+ };
787
+ surfaces?: {
788
+ capability_config?: AppBridgeSurfaceConfig;
789
+ };
790
+ }
775
791
  export interface CustomFlowActionComponent {
776
792
  component_type: "CUSTOM_FLOW_ACTION";
777
793
  configuration: CustomFlowConfig;
@@ -1421,6 +1437,16 @@ declare namespace Paths {
1421
1437
  appId: Parameters.AppId;
1422
1438
  }
1423
1439
  export interface RequestBody {
1440
+ /**
1441
+ * Version of the app configuration
1442
+ * example:
1443
+ * 1.0.0
1444
+ */
1445
+ version?: string;
1446
+ /**
1447
+ * ID of the journey block component
1448
+ */
1449
+ component_id?: string;
1424
1450
  /**
1425
1451
  * example:
1426
1452
  * dist.zip
@@ -1429,6 +1455,10 @@ declare namespace Paths {
1429
1455
  }
1430
1456
  namespace Responses {
1431
1457
  export interface $200 {
1458
+ /**
1459
+ * ID of the journye block component
1460
+ */
1461
+ component_id?: string;
1432
1462
  /**
1433
1463
  * Presigned S3 URL for uploading the bundle
1434
1464
  */
@@ -2408,6 +2438,7 @@ export type ComponentType = Components.Schemas.ComponentType;
2408
2438
  export type Configuration = Components.Schemas.Configuration;
2409
2439
  export type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
2410
2440
  export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
2441
+ export type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
2411
2442
  export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
2412
2443
  export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
2413
2444
  export type EnumArg = Components.Schemas.EnumArg;
package/dist/openapi.json CHANGED
@@ -452,6 +452,15 @@
452
452
  "type": "object",
453
453
  "additionalProperties": false,
454
454
  "properties": {
455
+ "version": {
456
+ "type": "string",
457
+ "description": "Version of the app configuration",
458
+ "example": "1.0.0"
459
+ },
460
+ "component_id": {
461
+ "type": "string",
462
+ "description": "ID of the journey block component"
463
+ },
455
464
  "filename": {
456
465
  "type": "string",
457
466
  "example": "dist.zip"
@@ -473,6 +482,10 @@
473
482
  "artifact_url"
474
483
  ],
475
484
  "properties": {
485
+ "component_id": {
486
+ "type": "string",
487
+ "description": "ID of the journye block component"
488
+ },
476
489
  "upload_url": {
477
490
  "type": "string",
478
491
  "description": "Presigned S3 URL for uploading the bundle"
@@ -1622,7 +1635,8 @@
1622
1635
  "CUSTOM_JOURNEY_BLOCK",
1623
1636
  "PORTAL_EXTENSION",
1624
1637
  "CUSTOM_FLOW_ACTION",
1625
- "ERP_INFORM_TOOLKIT"
1638
+ "ERP_INFORM_TOOLKIT",
1639
+ "CUSTOM_CAPABILITY"
1626
1640
  ],
1627
1641
  "description": "Type of app component"
1628
1642
  },
@@ -1730,7 +1744,8 @@
1730
1744
  "CUSTOM_JOURNEY_BLOCK": "#/components/schemas/JourneyBlockComponent",
1731
1745
  "PORTAL_EXTENSION": "#/components/schemas/PortalExtensionComponent",
1732
1746
  "CUSTOM_FLOW_ACTION": "#/components/schemas/CustomFlowActionComponent",
1733
- "ERP_INFORM_TOOLKIT": "#/components/schemas/ErpInformToolkitComponent"
1747
+ "ERP_INFORM_TOOLKIT": "#/components/schemas/ErpInformToolkitComponent",
1748
+ "CUSTOM_CAPABILITY": "#/components/schemas/CustomCapabilityComponent"
1734
1749
  }
1735
1750
  },
1736
1751
  "oneOf": [
@@ -1745,11 +1760,59 @@
1745
1760
  },
1746
1761
  {
1747
1762
  "$ref": "#/components/schemas/ErpInformToolkitComponent"
1763
+ },
1764
+ {
1765
+ "$ref": "#/components/schemas/CustomCapabilityComponent"
1748
1766
  }
1749
1767
  ]
1750
1768
  }
1751
1769
  ]
1752
1770
  },
1771
+ "CustomCapabilityComponent": {
1772
+ "type": "object",
1773
+ "required": [
1774
+ "component_type",
1775
+ "configuration"
1776
+ ],
1777
+ "properties": {
1778
+ "component_type": {
1779
+ "type": "string",
1780
+ "enum": [
1781
+ "CUSTOM_CAPABILITY"
1782
+ ]
1783
+ },
1784
+ "configuration": {
1785
+ "type": "object",
1786
+ "properties": {
1787
+ "type": {
1788
+ "description": "Define what type of capability this is",
1789
+ "type": "string",
1790
+ "enum": [
1791
+ "tab",
1792
+ "group"
1793
+ ]
1794
+ },
1795
+ "allowed_schemas": {
1796
+ "description": "Which schemas are supported by the capability. If empty, all schemas are supported.",
1797
+ "type": "array",
1798
+ "items": {
1799
+ "type": "string",
1800
+ "description": "Name of the schema",
1801
+ "example": "opportunity"
1802
+ }
1803
+ }
1804
+ }
1805
+ },
1806
+ "surfaces": {
1807
+ "type": "object",
1808
+ "properties": {
1809
+ "capability_config": {
1810
+ "$ref": "#/components/schemas/AppBridgeSurfaceConfig"
1811
+ }
1812
+ }
1813
+ }
1814
+ }
1815
+ },
1753
1816
  "JourneyBlockComponent": {
1754
1817
  "type": "object",
1755
1818
  "required": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.7.1",
3
+ "version": "0.7.3",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",