polyapi 0.20.5 → 0.21.2

package/index.d.ts

@@ -1,27 +1,48 @@
-export {default} from '.poly/lib';
+export { default } from '.poly/lib';
 export * from '.poly/lib';
 
-
 type Visibility = 'PUBLIC' | 'TENANT' | 'ENVIRONMENT';
 
-type PolyDeployable<
-  CustomConfig extends Record<string, any> = {}
-> = {
+type PolyDeployable<CustomConfig extends Record<string, any> = {}> = {
   context: string;
   name: string;
   disableAi?: boolean; // Disable use of AI for filling in missing descriptions
 } & CustomConfig;
 
-export type PolyServerFunction = PolyDeployable<{
-  logsEnabled?: boolean;
-  alwaysOn?: boolean;
-  visibility?: Visibility;
-}>;
-export type PolyClientFunction = PolyDeployable<{
-  logsEnabled?: boolean;
-  visibility?: Visibility;
-}>;
+type PolyFunction = PolyDeployable<{ logsEnabled?: boolean; visibility?: Visibility }>;
+
+export type PolyServerFunction = PolyFunction & { alwaysOn?: boolean };
+
+export type PolyClientFunction = PolyFunction;
+
+export type PolyWebhook = PolyDeployable<
+  {
+    environmentId?: string;
+    visibility?: Visibility;
+    eventPayload?: {};
+    eventPayloadTypeSchema?: Record<string, any>;
+    description?: string;
+    responseHeaders: Record<string, string | string[]>;
+    responsePayload?: {};
+    responseStatus?: number;
+    slug?: string | null;
+    subpath?: string;
+    method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    securityFunctions?: Array<{ path: string; message?: string } | { id: string; message?: string }>;
+    requirePolyApiKey?: boolean;
+    enabled?: boolean;
+    xmlParserOptions: {
+      enabled: boolean;
+      explicitArray: boolean;
+      trim: boolean;
+      normalizeTags: boolean;
+    };
+  } & (
+    | { eventPayload: {}; eventPayloadTypeSchema?: never } // If eventPayload is defined, eventPayloadTypeSchema is not allowed
+    | { eventPayload?: never; eventPayloadTypeSchema: Record<string, any> }
+  ) // If eventPayload is not defined, eventPayloadTypeSchema is required
+>;
+
 // export type PolyApiFunction = PolyDeployable<{}>;
 // export type PolyVariable = PolyDeployable<{}>;
-// export type PolyWebhook = PolyDeployable<{}>;
-// export type PolyTrigger = PolyDeployable<{}>;
+// export type PolyTrigger = PolyDeployable<{}>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polyapi",
-  "version": "0.20.5",
+  "version": "0.21.2",
   "description": "Poly is a CLI tool to help create and manage your Poly definitions.",
   "license": "MIT",
   "repository": {
@@ -42,6 +42,7 @@
   },
   "dependencies": {
     "@guanghechen/helper-string": "4.7.1",
+    "@inquirer/prompts": "^7.0.1",
     "adm-zip": "^0.5.16",
     "axios": "^1.7.4",
     "chalk": "4.1.2",
@@ -50,11 +51,10 @@
     "handlebars": "4.7.7",
     "http-proxy-agent": "^7.0.0",
     "https-proxy-agent": "^7.0.0",
-    "@inquirer/prompts": "^7.0.1",
     "json-schema-to-typescript": "^15.0.2",
     "jsonpath": "^1.1.1",
     "lodash": "4.17.21",
-    "prettier": "2.8.7",
+    "prettier": "^3.0.0",
     "semver": "^7.5.4",
     "shelljs": "0.8.5",
     "slugify": "^1.6.6",
@@ -66,6 +66,6 @@
     "yargs": "17.7.1"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=18.20.5"
   }
 }