@epilot/app-client 0.5.5 → 0.5.6-rc.2

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={187:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=n(t(466));r.default=o.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}},"delete":{"operationId":"deleteConfiguration","responses":{}}},"/v1/app-configurations/{appId}/bundle":{"post":{"operationId":"createBundleUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateBundlePresignedRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoPresignedRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/PatchVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components":{"post":{"operationId":"createComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components/{componentId}":{"patch":{"operationId":"patchComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}},"delete":{"operationId":"deleteComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstallations","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstallation","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"install","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"patch":{"operationId":"patchInstallation","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"delete":{"operationId":"uninstall","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoPresignedRequest":{"required":true,"content":{"application/json":{}}},"CreateBundlePresignedRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"PatchVersionRequest":{"required":true,"content":{"application/json":{}}},"UpsertComponentRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(187),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={187:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=n(t(466));r.default=o.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}},"delete":{"operationId":"deleteConfiguration","responses":{}}},"/v1/app-configurations/{appId}/bundle":{"post":{"operationId":"createBundleUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateBundlePresignedRequest"},"responses":{}}},"/v1/app-configurations/{appId}/zip":{"post":{"operationId":"createZipUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoPresignedRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/PatchVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components":{"post":{"operationId":"createComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components/{componentId}":{"patch":{"operationId":"patchComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}},"delete":{"operationId":"deleteComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstallations","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstallation","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"install","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"patch":{"operationId":"patchInstallation","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"delete":{"operationId":"uninstall","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoPresignedRequest":{"required":true,"content":{"application/json":{}}},"CreateBundlePresignedRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"PatchVersionRequest":{"required":true,"content":{"application/json":{}}},"UpsertComponentRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(187),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
@@ -100,6 +100,24 @@
100
100
  "responses": {}
101
101
  }
102
102
  },
103
+ "/v1/app-configurations/{appId}/zip": {
104
+ "post": {
105
+ "operationId": "createZipUploadUrl",
106
+ "parameters": [
107
+ {
108
+ "name": "appId",
109
+ "in": "path",
110
+ "required": true
111
+ }
112
+ ],
113
+ "requestBody": {
114
+ "content": {
115
+ "application/json": {}
116
+ }
117
+ },
118
+ "responses": {}
119
+ }
120
+ },
103
121
  "/v1/app-configurations/{appId}/logo": {
104
122
  "parameters": [
105
123
  {
package/dist/openapi.d.ts CHANGED
@@ -16,7 +16,7 @@ declare namespace Components {
16
16
  */
17
17
  version: string;
18
18
  /**
19
- * ID of the journye block component
19
+ * ID of the journey block component
20
20
  */
21
21
  component_id?: string;
22
22
  }
@@ -74,6 +74,10 @@ declare namespace Components {
74
74
  * Email address for support requests
75
75
  */
76
76
  support_email?: string;
77
+ /**
78
+ * Flag to indicate if the app is in dev mode. If true, the app takes the override properties of components into account.
79
+ */
80
+ dev_mode?: boolean;
77
81
  }
78
82
  export interface PatchVersionRequest {
79
83
  /**
@@ -85,6 +89,12 @@ declare namespace Components {
85
89
  export type UpsertComponentRequest = Schemas.BaseComponent;
86
90
  }
87
91
  namespace Schemas {
92
+ export interface AppBridgeSurfaceConfig {
93
+ /**
94
+ * URL of the uploaded App Bridge App
95
+ */
96
+ app_url: string;
97
+ }
88
98
  export interface Audit {
89
99
  /**
90
100
  * Timestamp of the creation
@@ -246,6 +256,10 @@ declare namespace Components {
246
256
  */
247
257
  name: string;
248
258
  author?: Author;
259
+ /**
260
+ * Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
261
+ */
262
+ dev_mode?: boolean;
249
263
  /**
250
264
  * List of available versions of the app
251
265
  */
@@ -405,6 +419,10 @@ declare namespace Components {
405
419
  */
406
420
  name: string;
407
421
  author?: Author;
422
+ /**
423
+ * Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
424
+ */
425
+ dev_mode?: boolean;
408
426
  /**
409
427
  * List of available versions of the app
410
428
  */
@@ -567,6 +585,9 @@ declare namespace Components {
567
585
  export interface CustomFlowActionComponent {
568
586
  component_type: "CUSTOM_FLOW_ACTION";
569
587
  configuration: CustomFlowConfig;
588
+ surfaces?: {
589
+ flow_action_config?: AppBridgeSurfaceConfig;
590
+ };
570
591
  }
571
592
  export type CustomFlowConfig = ExternalIntegrationCustomActionConfig;
572
593
  export interface EnumArg {
@@ -668,6 +689,10 @@ declare namespace Components {
668
689
  * Unique identifier for the organization the app is installed in
669
690
  */
670
691
  installer_org_id: string;
692
+ /**
693
+ * Organization ID of the app creator
694
+ */
695
+ owner_org_id?: string;
671
696
  /**
672
697
  * Flag to indicate if the app is enabled. Enabled is set to true when required option values are set.
673
698
  */
@@ -713,6 +738,10 @@ declare namespace Components {
713
738
  */
714
739
  updated_by?: string;
715
740
  };
741
+ /**
742
+ * Manifest ID used to create/update the entity
743
+ */
744
+ _manifest?: string /* uuid */[];
716
745
  }
717
746
  export interface JourneyBlockComponent {
718
747
  component_type: "CUSTOM_JOURNEY_BLOCK";
@@ -756,6 +785,7 @@ declare namespace Components {
756
785
  };
757
786
  } & (TextArg | BooleanArg | EnumArg);
758
787
  export interface JourneyBlockConfig {
788
+ override_dev_mode?: /* Override URL when app is in dev mode */ OverrideDevMode;
759
789
  /**
760
790
  * URL of the web component object
761
791
  * example:
@@ -837,6 +867,17 @@ declare namespace Components {
837
867
  component_id: string;
838
868
  options: Option[];
839
869
  }
870
+ /**
871
+ * Override URL when app is in dev mode
872
+ */
873
+ export interface OverrideDevMode {
874
+ /**
875
+ * URL of the web component object in dev mode
876
+ * example:
877
+ * http://localhost:3000/bundle.js
878
+ */
879
+ override_url?: string;
880
+ }
840
881
  export interface PortalAuth {
841
882
  type?: string;
842
883
  url?: string;
@@ -908,6 +949,10 @@ declare namespace Components {
908
949
  */
909
950
  name: string;
910
951
  author?: Author;
952
+ /**
953
+ * Flag to indicate if the app is in dev mode.
954
+ */
955
+ dev_mode?: boolean;
911
956
  /**
912
957
  * Category of the app.
913
958
  */
@@ -1104,6 +1149,35 @@ declare namespace Paths {
1104
1149
  }
1105
1150
  }
1106
1151
  }
1152
+ namespace CreateZipUploadUrl {
1153
+ namespace Parameters {
1154
+ export type AppId = string;
1155
+ }
1156
+ export interface PathParameters {
1157
+ appId: Parameters.AppId;
1158
+ }
1159
+ export interface RequestBody {
1160
+ }
1161
+ namespace Responses {
1162
+ export interface $200 {
1163
+ /**
1164
+ * Presigned S3 URL for uploading the bundle
1165
+ */
1166
+ upload_url: string;
1167
+ /**
1168
+ * Public CDN URL for the unpacked artifacts
1169
+ */
1170
+ artifact_url: string;
1171
+ s3ref?: Components.Schemas.S3Reference;
1172
+ /**
1173
+ * Timestamp when the upload URL expires
1174
+ */
1175
+ expires_at?: string; // date-time
1176
+ }
1177
+ export interface $404 {
1178
+ }
1179
+ }
1180
+ }
1107
1181
  namespace DeleteComponent {
1108
1182
  namespace Parameters {
1109
1183
  export type AppId = string;
@@ -1481,13 +1555,24 @@ export interface OperationMethods {
1481
1555
  /**
1482
1556
  * createBundleUploadUrl - createBundleUploadUrl
1483
1557
  *
1484
- * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path
1558
+ * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
1485
1559
  */
1486
1560
  'createBundleUploadUrl'(
1487
1561
  parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
1488
1562
  data?: Paths.CreateBundleUploadUrl.RequestBody,
1489
1563
  config?: AxiosRequestConfig
1490
1564
  ): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
1565
+ /**
1566
+ * createZipUploadUrl - createZipUploadUrl
1567
+ *
1568
+ * Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
1569
+ *
1570
+ */
1571
+ 'createZipUploadUrl'(
1572
+ parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
1573
+ data?: Paths.CreateZipUploadUrl.RequestBody,
1574
+ config?: AxiosRequestConfig
1575
+ ): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
1491
1576
  /**
1492
1577
  * createLogoUploadUrl - createLogoUploadUrl
1493
1578
  *
@@ -1721,7 +1806,7 @@ export interface PathsDictionary {
1721
1806
  /**
1722
1807
  * createBundleUploadUrl - createBundleUploadUrl
1723
1808
  *
1724
- * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path
1809
+ * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
1725
1810
  */
1726
1811
  'post'(
1727
1812
  parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
@@ -1729,6 +1814,19 @@ export interface PathsDictionary {
1729
1814
  config?: AxiosRequestConfig
1730
1815
  ): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
1731
1816
  }
1817
+ ['/v1/app-configurations/{appId}/zip']: {
1818
+ /**
1819
+ * createZipUploadUrl - createZipUploadUrl
1820
+ *
1821
+ * Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
1822
+ *
1823
+ */
1824
+ 'post'(
1825
+ parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
1826
+ data?: Paths.CreateZipUploadUrl.RequestBody,
1827
+ config?: AxiosRequestConfig
1828
+ ): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
1829
+ }
1732
1830
  ['/v1/app-configurations/{appId}/logo']: {
1733
1831
  /**
1734
1832
  * createLogoUploadUrl - createLogoUploadUrl
@@ -1911,6 +2009,7 @@ export interface PathsDictionary {
1911
2009
 
1912
2010
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1913
2011
 
2012
+ export type AppBridgeSurfaceConfig = Components.Schemas.AppBridgeSurfaceConfig;
1914
2013
  export type Audit = Components.Schemas.Audit;
1915
2014
  export type Author = Components.Schemas.Author;
1916
2015
  export type BaseComponent = Components.Schemas.BaseComponent;
@@ -1937,6 +2036,7 @@ export type NotificationEvent = Components.Schemas.NotificationEvent;
1937
2036
  export type Option = Components.Schemas.Option;
1938
2037
  export type Options = Components.Schemas.Options;
1939
2038
  export type OptionsRef = Components.Schemas.OptionsRef;
2039
+ export type OverrideDevMode = Components.Schemas.OverrideDevMode;
1940
2040
  export type PortalAuth = Components.Schemas.PortalAuth;
1941
2041
  export type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
1942
2042
  export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
package/dist/openapi.json CHANGED
@@ -257,7 +257,7 @@
257
257
  "/v1/app-configurations/{appId}/bundle": {
258
258
  "post": {
259
259
  "summary": "createBundleUploadUrl",
260
- "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path",
260
+ "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path",
261
261
  "operationId": "createBundleUploadUrl",
262
262
  "tags": [
263
263
  "App Configuration"
@@ -318,6 +318,74 @@
318
318
  }
319
319
  }
320
320
  },
321
+ "/v1/app-configurations/{appId}/zip": {
322
+ "post": {
323
+ "summary": "createZipUploadUrl",
324
+ "operationId": "createZipUploadUrl",
325
+ "description": "Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path\n",
326
+ "tags": [
327
+ "App Configuration"
328
+ ],
329
+ "parameters": [
330
+ {
331
+ "name": "appId",
332
+ "in": "path",
333
+ "required": true,
334
+ "schema": {
335
+ "type": "string"
336
+ },
337
+ "description": "ID of the app configuration"
338
+ }
339
+ ],
340
+ "requestBody": {
341
+ "content": {
342
+ "application/json": {
343
+ "schema": {
344
+ "type": "object",
345
+ "additionalProperties": false
346
+ }
347
+ }
348
+ }
349
+ },
350
+ "responses": {
351
+ "200": {
352
+ "description": "Upload URL generated successfully",
353
+ "content": {
354
+ "application/json": {
355
+ "schema": {
356
+ "type": "object",
357
+ "required": [
358
+ "upload_url",
359
+ "artifact_url"
360
+ ],
361
+ "properties": {
362
+ "upload_url": {
363
+ "type": "string",
364
+ "description": "Presigned S3 URL for uploading the bundle"
365
+ },
366
+ "artifact_url": {
367
+ "type": "string",
368
+ "description": "Public CDN URL for the unpacked artifacts"
369
+ },
370
+ "s3ref": {
371
+ "$ref": "#/components/schemas/S3Reference"
372
+ },
373
+ "expires_at": {
374
+ "type": "string",
375
+ "format": "date-time",
376
+ "description": "Timestamp when the upload URL expires"
377
+ }
378
+ }
379
+ }
380
+ }
381
+ }
382
+ },
383
+ "404": {
384
+ "description": "App configuration not found"
385
+ }
386
+ }
387
+ }
388
+ },
321
389
  "/v1/app-configurations/{appId}/logo": {
322
390
  "parameters": [
323
391
  {
@@ -1112,7 +1180,7 @@
1112
1180
  },
1113
1181
  "component_id": {
1114
1182
  "type": "string",
1115
- "description": "ID of the journye block component"
1183
+ "description": "ID of the journey block component"
1116
1184
  }
1117
1185
  }
1118
1186
  }
@@ -1152,6 +1220,10 @@
1152
1220
  "support_email": {
1153
1221
  "type": "string",
1154
1222
  "description": "Email address for support requests"
1223
+ },
1224
+ "dev_mode": {
1225
+ "type": "boolean",
1226
+ "description": "Flag to indicate if the app is in dev mode. If true, the app takes the override properties of components into account."
1155
1227
  }
1156
1228
  }
1157
1229
  }
@@ -1521,6 +1593,14 @@
1521
1593
  },
1522
1594
  "configuration": {
1523
1595
  "$ref": "#/components/schemas/CustomFlowConfig"
1596
+ },
1597
+ "surfaces": {
1598
+ "type": "object",
1599
+ "properties": {
1600
+ "flow_action_config": {
1601
+ "$ref": "#/components/schemas/AppBridgeSurfaceConfig"
1602
+ }
1603
+ }
1524
1604
  }
1525
1605
  }
1526
1606
  },
@@ -1728,6 +1808,17 @@
1728
1808
  }
1729
1809
  }
1730
1810
  },
1811
+ "OverrideDevMode": {
1812
+ "type": "object",
1813
+ "description": "Override URL when app is in dev mode",
1814
+ "properties": {
1815
+ "override_url": {
1816
+ "type": "string",
1817
+ "description": "URL of the web component object in dev mode",
1818
+ "example": "http://localhost:3000/bundle.js"
1819
+ }
1820
+ }
1821
+ },
1731
1822
  "JourneyBlockConfig": {
1732
1823
  "type": "object",
1733
1824
  "required": [
@@ -1735,6 +1826,9 @@
1735
1826
  "component_tag"
1736
1827
  ],
1737
1828
  "properties": {
1829
+ "override_dev_mode": {
1830
+ "$ref": "#/components/schemas/OverrideDevMode"
1831
+ },
1738
1832
  "component_url": {
1739
1833
  "type": "string",
1740
1834
  "description": "URL of the web component object",
@@ -1774,6 +1868,18 @@
1774
1868
  }
1775
1869
  }
1776
1870
  },
1871
+ "AppBridgeSurfaceConfig": {
1872
+ "type": "object",
1873
+ "properties": {
1874
+ "app_url": {
1875
+ "type": "string",
1876
+ "description": "URL of the uploaded App Bridge App"
1877
+ }
1878
+ },
1879
+ "required": [
1880
+ "app_url"
1881
+ ]
1882
+ },
1777
1883
  "JourneyBlockComponentArgs": {
1778
1884
  "allOf": [
1779
1885
  {
@@ -1993,6 +2099,10 @@
1993
2099
  "author": {
1994
2100
  "$ref": "#/components/schemas/Author"
1995
2101
  },
2102
+ "dev_mode": {
2103
+ "type": "boolean",
2104
+ "description": "Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account."
2105
+ },
1996
2106
  "versions": {
1997
2107
  "type": "array",
1998
2108
  "items": {
@@ -2222,6 +2332,11 @@
2222
2332
  "description": "Unique identifier for the organization the app is installed in",
2223
2333
  "readOnly": true
2224
2334
  },
2335
+ "owner_org_id": {
2336
+ "type": "string",
2337
+ "description": "Organization ID of the app creator",
2338
+ "readOnly": true
2339
+ },
2225
2340
  "enabled": {
2226
2341
  "readOnly": true,
2227
2342
  "type": "boolean",
@@ -2268,6 +2383,15 @@
2268
2383
  "$ref": "#/components/schemas/Audit"
2269
2384
  }
2270
2385
  ]
2386
+ },
2387
+ "_manifest": {
2388
+ "type": "array",
2389
+ "description": "Manifest ID used to create/update the entity",
2390
+ "items": {
2391
+ "type": "string",
2392
+ "format": "uuid",
2393
+ "example": "123e4567-e89b-12d3-a456-426614174000"
2394
+ }
2271
2395
  }
2272
2396
  }
2273
2397
  },
@@ -2301,6 +2425,10 @@
2301
2425
  "author": {
2302
2426
  "$ref": "#/components/schemas/Author"
2303
2427
  },
2428
+ "dev_mode": {
2429
+ "type": "boolean",
2430
+ "description": "Flag to indicate if the app is in dev mode."
2431
+ },
2304
2432
  "category": {
2305
2433
  "type": "string",
2306
2434
  "description": "Category of the app."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.5.5",
3
+ "version": "0.5.6-rc.2",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
25
25
  "test": "jest",
26
26
  "typescript": "tsc",
27
27
  "bundle-definition": "webpack",
28
- "openapi": "node ../../scripts/update-openapi.js ../../../backend/app-api/packages/functions/src/api/openapi.yml",
28
+ "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/app.yaml",
29
29
  "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
30
30
  "build": "tsc && npm run build:patch && npm run bundle-definition",
31
31
  "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",