@epilot/app-client 0.11.0 → 0.12.1

package/dist/client.d.ts

@@ -1,3 +1,3 @@
-import { Client } from './openapi';
+import type { Client } from './openapi';
 export declare const getClient: () => Client;
 export declare const createClient: () => Client;

package/dist/openapi.d.ts

@@ -1,5 +1,3 @@
-/* eslint-disable */
-
 import type {
   OpenAPIClient,
   Parameters,
@@ -247,7 +245,7 @@ declare namespace Components {
             surfaces?: {
                 [key: string]: any;
             };
-        } & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent);
+        } & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent | CustomPageComponent);
         export interface BaseComponentCommon {
             /**
              * Unique identifier for the component
@@ -451,7 +449,7 @@ declare namespace Components {
         /**
          * Type of app component
          */
-        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG";
+        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE";
         /**
          * Configuration of the published app
          */
@@ -822,6 +820,37 @@ declare namespace Components {
             };
         }
         export type CustomFlowConfig = ExternalIntegrationCustomActionConfig | SandboxCustomActionConfig;
+        export interface CustomPageComponent {
+            component_type: "CUSTOM_PAGE";
+            configuration: CustomPageConfig;
+            surfaces?: {
+                page?: AppBridgeSurfaceConfig;
+            };
+        }
+        export interface CustomPageConfig {
+            /**
+             * URL slug for the page route. Must be unique per organization.
+             * example:
+             * zapier
+             */
+            slug: string; // ^[a-z0-9][a-z0-9-]*[a-z0-9]$
+            /**
+             * Display label in the navigation sidebar.
+             * example:
+             * Zapier
+             */
+            nav_label?: string;
+            /**
+             * Icon identifier for the navigation item.
+             * example:
+             * zap
+             */
+            nav_icon?: string;
+            /**
+             * Optional tooltip or description for the navigation item.
+             */
+            nav_description?: string;
+        }
         export interface EnumArg {
             type?: "enum";
             /**
@@ -1510,6 +1539,7 @@ declare namespace Components {
              * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
              */
             use_static_ips?: boolean;
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
         }
         /**
          * Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
@@ -1591,6 +1621,7 @@ declare namespace Components {
              * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
              */
             use_static_ips?: boolean;
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
         }
         /**
          * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
@@ -1647,6 +1678,7 @@ declare namespace Components {
              * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
              */
             use_static_ips?: boolean;
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
         }
         /**
          * Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
@@ -1740,6 +1772,7 @@ declare namespace Components {
              * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
              */
             use_static_ips?: boolean;
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
         }
         /**
          * Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
@@ -1796,6 +1829,7 @@ declare namespace Components {
              * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
              */
             use_static_ips?: boolean;
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
         }
         /**
          * Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
@@ -1847,6 +1881,7 @@ declare namespace Components {
              * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
              */
             use_static_ips?: boolean;
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
         }
         export interface PortalExtensionSeamlessLink {
             /**
@@ -1876,6 +1911,19 @@ declare namespace Components {
                 };
             };
         }
+        /**
+         * If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.
+         */
+        export interface PortalExtensionSecureProxy {
+            /**
+             * Integration ID that owns the secure_proxy use case.
+             */
+            integration_id: string; // uuid
+            /**
+             * Use case slug for the secure proxy use case.
+             */
+            use_case_slug: string;
+        }
         export interface Pricing {
             pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
             billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
@@ -3292,6 +3340,8 @@ 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 CustomPageComponent = Components.Schemas.CustomPageComponent;
+export type CustomPageConfig = Components.Schemas.CustomPageConfig;
 export type EnumArg = Components.Schemas.EnumArg;
 export type ErpInformToolkitComponent = Components.Schemas.ErpInformToolkitComponent;
 export type EventsQuery = Components.Schemas.EventsQuery;
@@ -3326,6 +3376,7 @@ export type PortalExtensionHookMeterReadingPlausibilityCheck = Components.Schema
 export type PortalExtensionHookPriceDataRetrieval = Components.Schemas.PortalExtensionHookPriceDataRetrieval;
 export type PortalExtensionHookRegistrationIdentifiersCheck = Components.Schemas.PortalExtensionHookRegistrationIdentifiersCheck;
 export type PortalExtensionSeamlessLink = Components.Schemas.PortalExtensionSeamlessLink;
+export type PortalExtensionSecureProxy = Components.Schemas.PortalExtensionSecureProxy;
 export type Pricing = Components.Schemas.Pricing;
 export type PublicConfiguration = Components.Schemas.PublicConfiguration;
 export type RawEvents = Components.Schemas.RawEvents;

package/dist/openapi.json

@@ -1831,7 +1831,8 @@
           "CUSTOM_FLOW_ACTION",
           "ERP_INFORM_TOOLKIT",
           "CUSTOM_CAPABILITY",
-          "EXTERNAL_PRODUCT_CATALOG"
+          "EXTERNAL_PRODUCT_CATALOG",
+          "CUSTOM_PAGE"
         ],
         "description": "Type of app component"
       },
@@ -1942,7 +1943,8 @@
                 "CUSTOM_FLOW_ACTION": "#/components/schemas/CustomFlowActionComponent",
                 "ERP_INFORM_TOOLKIT": "#/components/schemas/ErpInformToolkitComponent",
                 "CUSTOM_CAPABILITY": "#/components/schemas/CustomCapabilityComponent",
-                "EXTERNAL_PRODUCT_CATALOG": "#/components/schemas/ExternalProductCatalogComponent"
+                "EXTERNAL_PRODUCT_CATALOG": "#/components/schemas/ExternalProductCatalogComponent",
+                "CUSTOM_PAGE": "#/components/schemas/CustomPageComponent"
               }
             },
             "oneOf": [
@@ -1966,6 +1968,9 @@
               },
               {
                 "$ref": "#/components/schemas/ExternalProductCatalogComponent"
+              },
+              {
+                "$ref": "#/components/schemas/CustomPageComponent"
               }
             ]
           }
@@ -2016,6 +2021,60 @@
           }
         }
       },
+      "CustomPageComponent": {
+        "type": "object",
+        "required": [
+          "component_type",
+          "configuration"
+        ],
+        "properties": {
+          "component_type": {
+            "type": "string",
+            "enum": [
+              "CUSTOM_PAGE"
+            ]
+          },
+          "configuration": {
+            "$ref": "#/components/schemas/CustomPageConfig"
+          },
+          "surfaces": {
+            "type": "object",
+            "properties": {
+              "page": {
+                "$ref": "#/components/schemas/AppBridgeSurfaceConfig"
+              }
+            }
+          }
+        }
+      },
+      "CustomPageConfig": {
+        "type": "object",
+        "required": [
+          "slug"
+        ],
+        "properties": {
+          "slug": {
+            "type": "string",
+            "description": "URL slug for the page route. Must be unique per organization.",
+            "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$",
+            "example": "zapier"
+          },
+          "nav_label": {
+            "type": "string",
+            "description": "Display label in the navigation sidebar.",
+            "example": "Zapier"
+          },
+          "nav_icon": {
+            "type": "string",
+            "description": "Icon identifier for the navigation item.",
+            "example": "zap"
+          },
+          "nav_description": {
+            "type": "string",
+            "description": "Optional tooltip or description for the navigation item."
+          }
+        }
+      },
       "JourneyBlockComponent": {
         "type": "object",
         "required": [
@@ -2537,6 +2596,9 @@
             "type": "boolean",
             "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
             "default": false
+          },
+          "secure_proxy": {
+            "$ref": "#/components/schemas/PortalExtensionSecureProxy"
           }
         },
         "required": [
@@ -2647,6 +2709,9 @@
             "type": "boolean",
             "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
             "default": false
+          },
+          "secure_proxy": {
+            "$ref": "#/components/schemas/PortalExtensionSecureProxy"
           }
         },
         "required": [
@@ -2755,6 +2820,9 @@
             "type": "boolean",
             "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
             "default": false
+          },
+          "secure_proxy": {
+            "$ref": "#/components/schemas/PortalExtensionSecureProxy"
           }
         },
         "required": [
@@ -2852,6 +2920,9 @@
             "type": "boolean",
             "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
             "default": false
+          },
+          "secure_proxy": {
+            "$ref": "#/components/schemas/PortalExtensionSecureProxy"
           }
         },
         "required": [
@@ -2948,6 +3019,9 @@
             "type": "boolean",
             "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
             "default": false
+          },
+          "secure_proxy": {
+            "$ref": "#/components/schemas/PortalExtensionSecureProxy"
           }
         },
         "required": [
@@ -3044,6 +3118,9 @@
             "type": "boolean",
             "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
             "default": false
+          },
+          "secure_proxy": {
+            "$ref": "#/components/schemas/PortalExtensionSecureProxy"
           }
         },
         "required": [
@@ -3167,6 +3244,26 @@
         ],
         "additionalProperties": false
       },
+      "PortalExtensionSecureProxy": {
+        "type": "object",
+        "description": "If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.",
+        "properties": {
+          "integration_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Integration ID that owns the secure_proxy use case."
+          },
+          "use_case_slug": {
+            "type": "string",
+            "description": "Use case slug for the secure proxy use case."
+          }
+        },
+        "required": [
+          "integration_id",
+          "use_case_slug"
+        ],
+        "additionalProperties": false
+      },
       "ExternalProductCatalogAuthBlock": {
         "type": "object",
         "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,18 +22,18 @@
     "app"
   ],
   "scripts": {
-    "test": "jest",
+    "test": "vitest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
     "openapi:local": "node ../../scripts/update-openapi.js ../../../app-api/openapi.yml",
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/app.yaml",
-    "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
+    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
     "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
     "build:watch": "npm run build && tsc -w",
     "release-alpha": "npm version prerelease --preid alpha",
     "prepublishOnly": "npm run typegen && npm run build",
-    "lint": "pnpm exec eslint src"
+    "lint": "biome check src"
   },
   "files": [
     "*.js",
@@ -61,13 +61,10 @@
     "util": "^0.12.3"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.20",
     "axios": "^1.11.0",
     "copy-webpack-plugin": "^7.0.0",
-    "jest": "^29.6.2",
     "json-loader": "^0.5.7",
     "openapicmd": "^2.7.0",
-    "ts-jest": "^29.4.1",
     "ts-loader": "^8.0.14",
     "ts-node": "^10.9.1",
     "typescript": "^4.1.3",