@zapier/zapier-sdk-core 0.3.0 → 0.4.0

package/dist/v0/common/responses.d.cts

@@ -0,0 +1,157 @@
+/**
+ * Common response definitions for v0 API routes
+ *
+ * This module provides reusable response definitions for error responses
+ * and common headers to reduce duplication across route definitions.
+ */
+/**
+ * Rate limit headers included in 429 responses
+ */
+declare const rateLimitHeaders: {
+    readonly "X-RateLimit-Limit": {
+        readonly schema: {
+            readonly type: "integer";
+        };
+        readonly description: "The number of requests remaining in the current rate limit window.";
+    };
+    readonly "X-RateLimit-Remaining": {
+        readonly schema: {
+            readonly type: "integer";
+        };
+        readonly description: "The number of requests remaining in the current rate limit window.";
+    };
+    readonly "X-RateLimit-Reset": {
+        readonly schema: {
+            readonly type: "string";
+        };
+        readonly description: "The timestamp when the rate limit will be reset.";
+    };
+    readonly "Retry-After": {
+        readonly schema: {
+            readonly type: "string";
+        };
+        readonly description: "The number of seconds to wait before retrying.";
+    };
+};
+/**
+ * Retry-After header included in 503 responses
+ */
+declare const retryAfterHeader: {
+    readonly "Retry-After": {
+        readonly schema: {
+            readonly type: "string";
+        };
+        readonly description: "The number of seconds to wait before retrying.";
+    };
+};
+/**
+ * Common error response definitions for all v0 API routes
+ *
+ * These responses follow the JSON:API error response format and are
+ * consistent across all endpoints.
+ */
+declare const commonErrorResponses: {
+    /**
+     * 400 Bad Request - Invalid request parameters or body
+     */
+    readonly 400: {
+        readonly description: "Bad Request";
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 401 Unauthorized - Missing or invalid authentication
+     */
+    readonly 401: {
+        readonly description: "Unauthorized";
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 429 Too Many Requests - Rate limit exceeded
+     * Includes rate limit headers
+     */
+    readonly 429: {
+        readonly description: "Too Many Requests";
+        readonly headers: {
+            readonly "X-RateLimit-Limit": {
+                readonly schema: {
+                    readonly type: "integer";
+                };
+                readonly description: "The number of requests remaining in the current rate limit window.";
+            };
+            readonly "X-RateLimit-Remaining": {
+                readonly schema: {
+                    readonly type: "integer";
+                };
+                readonly description: "The number of requests remaining in the current rate limit window.";
+            };
+            readonly "X-RateLimit-Reset": {
+                readonly schema: {
+                    readonly type: "string";
+                };
+                readonly description: "The timestamp when the rate limit will be reset.";
+            };
+            readonly "Retry-After": {
+                readonly schema: {
+                    readonly type: "string";
+                };
+                readonly description: "The number of seconds to wait before retrying.";
+            };
+        };
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 500 Server Error - Internal server error
+     */
+    readonly 500: {
+        readonly description: "Server Error";
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 503 Service Unavailable - Service temporarily unavailable
+     * Includes Retry-After header
+     */
+    readonly 503: {
+        readonly description: "Service Unavailable";
+        readonly headers: {
+            readonly "Retry-After": {
+                readonly schema: {
+                    readonly type: "string";
+                };
+                readonly description: "The number of seconds to wait before retrying.";
+            };
+        };
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+};
+
+export { commonErrorResponses, rateLimitHeaders, retryAfterHeader };

package/dist/v0/common/responses.d.ts

@@ -0,0 +1,157 @@
+/**
+ * Common response definitions for v0 API routes
+ *
+ * This module provides reusable response definitions for error responses
+ * and common headers to reduce duplication across route definitions.
+ */
+/**
+ * Rate limit headers included in 429 responses
+ */
+declare const rateLimitHeaders: {
+    readonly "X-RateLimit-Limit": {
+        readonly schema: {
+            readonly type: "integer";
+        };
+        readonly description: "The number of requests remaining in the current rate limit window.";
+    };
+    readonly "X-RateLimit-Remaining": {
+        readonly schema: {
+            readonly type: "integer";
+        };
+        readonly description: "The number of requests remaining in the current rate limit window.";
+    };
+    readonly "X-RateLimit-Reset": {
+        readonly schema: {
+            readonly type: "string";
+        };
+        readonly description: "The timestamp when the rate limit will be reset.";
+    };
+    readonly "Retry-After": {
+        readonly schema: {
+            readonly type: "string";
+        };
+        readonly description: "The number of seconds to wait before retrying.";
+    };
+};
+/**
+ * Retry-After header included in 503 responses
+ */
+declare const retryAfterHeader: {
+    readonly "Retry-After": {
+        readonly schema: {
+            readonly type: "string";
+        };
+        readonly description: "The number of seconds to wait before retrying.";
+    };
+};
+/**
+ * Common error response definitions for all v0 API routes
+ *
+ * These responses follow the JSON:API error response format and are
+ * consistent across all endpoints.
+ */
+declare const commonErrorResponses: {
+    /**
+     * 400 Bad Request - Invalid request parameters or body
+     */
+    readonly 400: {
+        readonly description: "Bad Request";
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 401 Unauthorized - Missing or invalid authentication
+     */
+    readonly 401: {
+        readonly description: "Unauthorized";
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 429 Too Many Requests - Rate limit exceeded
+     * Includes rate limit headers
+     */
+    readonly 429: {
+        readonly description: "Too Many Requests";
+        readonly headers: {
+            readonly "X-RateLimit-Limit": {
+                readonly schema: {
+                    readonly type: "integer";
+                };
+                readonly description: "The number of requests remaining in the current rate limit window.";
+            };
+            readonly "X-RateLimit-Remaining": {
+                readonly schema: {
+                    readonly type: "integer";
+                };
+                readonly description: "The number of requests remaining in the current rate limit window.";
+            };
+            readonly "X-RateLimit-Reset": {
+                readonly schema: {
+                    readonly type: "string";
+                };
+                readonly description: "The timestamp when the rate limit will be reset.";
+            };
+            readonly "Retry-After": {
+                readonly schema: {
+                    readonly type: "string";
+                };
+                readonly description: "The number of seconds to wait before retrying.";
+            };
+        };
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 500 Server Error - Internal server error
+     */
+    readonly 500: {
+        readonly description: "Server Error";
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+    /**
+     * 503 Service Unavailable - Service temporarily unavailable
+     * Includes Retry-After header
+     */
+    readonly 503: {
+        readonly description: "Service Unavailable";
+        readonly headers: {
+            readonly "Retry-After": {
+                readonly schema: {
+                    readonly type: "string";
+                };
+                readonly description: "The number of seconds to wait before retrying.";
+            };
+        };
+        readonly content: {
+            readonly "application/json": {
+                readonly schema: {
+                    readonly $ref: "#/components/schemas/ErrorsResponse";
+                };
+            };
+        };
+    };
+};
+
+export { commonErrorResponses, rateLimitHeaders, retryAfterHeader };

package/dist/v0/common/responses.js

@@ -0,0 +1,112 @@
+// src/v0/common/responses.ts
+var rateLimitHeaders = {
+  "X-RateLimit-Limit": {
+    schema: {
+      type: "integer"
+    },
+    description: "The number of requests remaining in the current rate limit window."
+  },
+  "X-RateLimit-Remaining": {
+    schema: {
+      type: "integer"
+    },
+    description: "The number of requests remaining in the current rate limit window."
+  },
+  "X-RateLimit-Reset": {
+    schema: {
+      type: "string"
+    },
+    description: "The timestamp when the rate limit will be reset."
+  },
+  "Retry-After": {
+    schema: {
+      type: "string"
+    },
+    description: "The number of seconds to wait before retrying."
+  }
+};
+var retryAfterHeader = {
+  "Retry-After": {
+    schema: {
+      type: "string"
+    },
+    description: "The number of seconds to wait before retrying."
+  }
+};
+var commonErrorResponses = {
+  /**
+   * 400 Bad Request - Invalid request parameters or body
+   */
+  400: {
+    description: "Bad Request",
+    content: {
+      "application/json": {
+        schema: {
+          $ref: "#/components/schemas/ErrorsResponse"
+        }
+      }
+    }
+  },
+  /**
+   * 401 Unauthorized - Missing or invalid authentication
+   */
+  401: {
+    description: "Unauthorized",
+    content: {
+      "application/json": {
+        schema: {
+          $ref: "#/components/schemas/ErrorsResponse"
+        }
+      }
+    }
+  },
+  /**
+   * 429 Too Many Requests - Rate limit exceeded
+   * Includes rate limit headers
+   */
+  429: {
+    description: "Too Many Requests",
+    headers: rateLimitHeaders,
+    content: {
+      "application/json": {
+        schema: {
+          $ref: "#/components/schemas/ErrorsResponse"
+        }
+      }
+    }
+  },
+  /**
+   * 500 Server Error - Internal server error
+   */
+  500: {
+    description: "Server Error",
+    content: {
+      "application/json": {
+        schema: {
+          $ref: "#/components/schemas/ErrorsResponse"
+        }
+      }
+    }
+  },
+  /**
+   * 503 Service Unavailable - Service temporarily unavailable
+   * Includes Retry-After header
+   */
+  503: {
+    description: "Service Unavailable",
+    headers: retryAfterHeader,
+    content: {
+      "application/json": {
+        schema: {
+          $ref: "#/components/schemas/ErrorsResponse"
+        }
+      }
+    }
+  }
+};
+export {
+  commonErrorResponses,
+  rateLimitHeaders,
+  retryAfterHeader
+};
+//# sourceMappingURL=responses.js.map

package/dist/v0/common/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/v0/common/responses.ts"],"sourcesContent":["/**\n * Common response definitions for v0 API routes\n *\n * This module provides reusable response definitions for error responses\n * and common headers to reduce duplication across route definitions.\n */\n\n/**\n * Rate limit headers included in 429 responses\n */\nexport const rateLimitHeaders = {\n  \"X-RateLimit-Limit\": {\n    schema: {\n      type: \"integer\" as const,\n    },\n    description:\n      \"The number of requests remaining in the current rate limit window.\",\n  },\n  \"X-RateLimit-Remaining\": {\n    schema: {\n      type: \"integer\" as const,\n    },\n    description:\n      \"The number of requests remaining in the current rate limit window.\",\n  },\n  \"X-RateLimit-Reset\": {\n    schema: {\n      type: \"string\" as const,\n    },\n    description: \"The timestamp when the rate limit will be reset.\",\n  },\n  \"Retry-After\": {\n    schema: {\n      type: \"string\" as const,\n    },\n    description: \"The number of seconds to wait before retrying.\",\n  },\n} as const;\n\n/**\n * Retry-After header included in 503 responses\n */\nexport const retryAfterHeader = {\n  \"Retry-After\": {\n    schema: {\n      type: \"string\" as const,\n    },\n    description: \"The number of seconds to wait before retrying.\",\n  },\n} as const;\n\n/**\n * Common error response definitions for all v0 API routes\n *\n * These responses follow the JSON:API error response format and are\n * consistent across all endpoints.\n */\nexport const commonErrorResponses = {\n  /**\n   * 400 Bad Request - Invalid request parameters or body\n   */\n  400: {\n    description: \"Bad Request\",\n    content: {\n      \"application/json\": {\n        schema: {\n          $ref: \"#/components/schemas/ErrorsResponse\",\n        },\n      },\n    },\n  },\n  /**\n   * 401 Unauthorized - Missing or invalid authentication\n   */\n  401: {\n    description: \"Unauthorized\",\n    content: {\n      \"application/json\": {\n        schema: {\n          $ref: \"#/components/schemas/ErrorsResponse\",\n        },\n      },\n    },\n  },\n  /**\n   * 429 Too Many Requests - Rate limit exceeded\n   * Includes rate limit headers\n   */\n  429: {\n    description: \"Too Many Requests\",\n    headers: rateLimitHeaders,\n    content: {\n      \"application/json\": {\n        schema: {\n          $ref: \"#/components/schemas/ErrorsResponse\",\n        },\n      },\n    },\n  },\n  /**\n   * 500 Server Error - Internal server error\n   */\n  500: {\n    description: \"Server Error\",\n    content: {\n      \"application/json\": {\n        schema: {\n          $ref: \"#/components/schemas/ErrorsResponse\",\n        },\n      },\n    },\n  },\n  /**\n   * 503 Service Unavailable - Service temporarily unavailable\n   * Includes Retry-After header\n   */\n  503: {\n    description: \"Service Unavailable\",\n    headers: retryAfterHeader,\n    content: {\n      \"application/json\": {\n        schema: {\n          $ref: \"#/components/schemas/ErrorsResponse\",\n        },\n      },\n    },\n  },\n} as const;\n"],"mappings":";AAUO,IAAM,mBAAmB;AAAA,EAC9B,qBAAqB;AAAA,IACnB,QAAQ;AAAA,MACN,MAAM;AAAA,IACR;AAAA,IACA,aACE;AAAA,EACJ;AAAA,EACA,yBAAyB;AAAA,IACvB,QAAQ;AAAA,MACN,MAAM;AAAA,IACR;AAAA,IACA,aACE;AAAA,EACJ;AAAA,EACA,qBAAqB;AAAA,IACnB,QAAQ;AAAA,MACN,MAAM;AAAA,IACR;AAAA,IACA,aAAa;AAAA,EACf;AAAA,EACA,eAAe;AAAA,IACb,QAAQ;AAAA,MACN,MAAM;AAAA,IACR;AAAA,IACA,aAAa;AAAA,EACf;AACF;AAKO,IAAM,mBAAmB;AAAA,EAC9B,eAAe;AAAA,IACb,QAAQ;AAAA,MACN,MAAM;AAAA,IACR;AAAA,IACA,aAAa;AAAA,EACf;AACF;AAQO,IAAM,uBAAuB;AAAA;AAAA;AAAA;AAAA,EAIlC,KAAK;AAAA,IACH,aAAa;AAAA,IACb,SAAS;AAAA,MACP,oBAAoB;AAAA,QAClB,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,KAAK;AAAA,IACH,aAAa;AAAA,IACb,SAAS;AAAA,MACP,oBAAoB;AAAA,QAClB,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,KAAK;AAAA,IACH,aAAa;AAAA,IACb,SAAS;AAAA,IACT,SAAS;AAAA,MACP,oBAAoB;AAAA,QAClB,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,KAAK;AAAA,IACH,aAAa;AAAA,IACb,SAAS;AAAA,MACP,oBAAoB;AAAA,QAClB,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,KAAK;AAAA,IACH,aAAa;AAAA,IACb,SAAS;AAAA,IACT,SAAS;AAAA,MACP,oBAAoB;AAAA,QAClB,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/dist/v0/config/metadata.cjs

@@ -0,0 +1,75 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/v0/config/metadata.ts
+var metadata_exports = {};
+__export(metadata_exports, {
+  apiInfo: () => apiInfo,
+  openApiMetadata: () => openApiMetadata,
+  securitySchemes: () => securitySchemes,
+  servers: () => servers,
+  tags: () => tags
+});
+module.exports = __toCommonJS(metadata_exports);
+var apiInfo = {
+  title: "Zapier SDK API",
+  version: "1.0.0",
+  contact: {
+    email: "engineering@zapier.com"
+  },
+  description: "The Zapier SDK API serves as a backend for the Zapier SDK."
+};
+var servers = [];
+var tags = [
+  {
+    name: "Apps",
+    description: "App-related routes"
+  },
+  {
+    name: "Authentications",
+    description: "Authentication-related routes"
+  },
+  {
+    name: "Documentation",
+    description: "Documentation-related routes"
+  }
+];
+var securitySchemes = {
+  userJwt: {
+    type: "apiKey",
+    in: "header",
+    name: "Authorization",
+    description: "Format should be `JWT <your-jwt>` (you must ensure that the JWT prefix is included in your requests).\\n\\nExample:  `Authorization: JWT your.jwt.value.here`"
+  }
+};
+var openApiMetadata = {
+  openapi: "3.1.0",
+  info: apiInfo,
+  servers,
+  tags
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  apiInfo,
+  openApiMetadata,
+  securitySchemes,
+  servers,
+  tags
+});
+//# sourceMappingURL=metadata.cjs.map

package/dist/v0/config/metadata.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/v0/config/metadata.ts"],"sourcesContent":["/**\n * OpenAPI specification metadata\n *\n * This file contains all the base metadata for the OpenAPI specification\n * that was previously stored in openapi-base.yaml.\n *\n * Note on 'as const' usage:\n * - We use 'as const' on literal values that should be treated as enums\n *   (e.g., \"apiKey\", \"header\", \"3.1.0\") to get precise literal types\n * - We avoid 'as const' on top-level configuration objects to prevent\n *   deep readonly types that can cause compatibility issues with libraries\n *   expecting mutable types (like zod-to-openapi)\n * - If you encounter readonly type errors, check whether the consuming\n *   library expects mutable types and remove 'as const' accordingly\n */\n\nexport const apiInfo = {\n  title: \"Zapier SDK API\",\n  version: \"1.0.0\",\n  contact: {\n    email: \"engineering@zapier.com\",\n  },\n  description: \"The Zapier SDK API serves as a backend for the Zapier SDK.\",\n};\n\nexport const servers: Array<{ url: string; description: string }> = [];\n\nexport const tags = [\n  {\n    name: \"Apps\",\n    description: \"App-related routes\",\n  },\n  {\n    name: \"Authentications\",\n    description: \"Authentication-related routes\",\n  },\n  {\n    name: \"Documentation\",\n    description: \"Documentation-related routes\",\n  },\n];\n\n/**\n * Security schemes for OpenAPI specification\n *\n * Note: 'as const' is used on enum-like literal values (\"apiKey\", \"header\")\n * to ensure TypeScript treats them as literal types rather than generic strings.\n * This provides better type safety when the OpenAPI generator validates these values.\n */\nexport const securitySchemes = {\n  userJwt: {\n    type: \"apiKey\" as const,\n    in: \"header\" as const,\n    name: \"Authorization\",\n    description:\n      \"Format should be `JWT <your-jwt>` (you must ensure that the JWT prefix \" +\n      \"is included in your requests).\\\\n\\\\n\" +\n      \"Example:  `Authorization: JWT your.jwt.value.here`\",\n  },\n} as const;\n\n/**\n * Complete OpenAPI metadata for document generation\n */\nexport const openApiMetadata = {\n  openapi: \"3.1.0\" as const,\n  info: apiInfo,\n  servers,\n  tags,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBO,IAAM,UAAU;AAAA,EACrB,OAAO;AAAA,EACP,SAAS;AAAA,EACT,SAAS;AAAA,IACP,OAAO;AAAA,EACT;AAAA,EACA,aAAa;AACf;AAEO,IAAM,UAAuD,CAAC;AAE9D,IAAM,OAAO;AAAA,EAClB;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AACF;AASO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,IACP,MAAM;AAAA,IACN,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aACE;AAAA,EAGJ;AACF;AAKO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,EACT,MAAM;AAAA,EACN;AAAA,EACA;AACF;","names":[]}

package/dist/v0/config/metadata.d.cts

@@ -0,0 +1,70 @@
+/**
+ * OpenAPI specification metadata
+ *
+ * This file contains all the base metadata for the OpenAPI specification
+ * that was previously stored in openapi-base.yaml.
+ *
+ * Note on 'as const' usage:
+ * - We use 'as const' on literal values that should be treated as enums
+ *   (e.g., "apiKey", "header", "3.1.0") to get precise literal types
+ * - We avoid 'as const' on top-level configuration objects to prevent
+ *   deep readonly types that can cause compatibility issues with libraries
+ *   expecting mutable types (like zod-to-openapi)
+ * - If you encounter readonly type errors, check whether the consuming
+ *   library expects mutable types and remove 'as const' accordingly
+ */
+declare const apiInfo: {
+    title: string;
+    version: string;
+    contact: {
+        email: string;
+    };
+    description: string;
+};
+declare const servers: Array<{
+    url: string;
+    description: string;
+}>;
+declare const tags: {
+    name: string;
+    description: string;
+}[];
+/**
+ * Security schemes for OpenAPI specification
+ *
+ * Note: 'as const' is used on enum-like literal values ("apiKey", "header")
+ * to ensure TypeScript treats them as literal types rather than generic strings.
+ * This provides better type safety when the OpenAPI generator validates these values.
+ */
+declare const securitySchemes: {
+    readonly userJwt: {
+        readonly type: "apiKey";
+        readonly in: "header";
+        readonly name: "Authorization";
+        readonly description: string;
+    };
+};
+/**
+ * Complete OpenAPI metadata for document generation
+ */
+declare const openApiMetadata: {
+    openapi: "3.1.0";
+    info: {
+        title: string;
+        version: string;
+        contact: {
+            email: string;
+        };
+        description: string;
+    };
+    servers: {
+        url: string;
+        description: string;
+    }[];
+    tags: {
+        name: string;
+        description: string;
+    }[];
+};
+
+export { apiInfo, openApiMetadata, securitySchemes, servers, tags };

package/dist/v0/config/metadata.d.ts

@@ -0,0 +1,70 @@
+/**
+ * OpenAPI specification metadata
+ *
+ * This file contains all the base metadata for the OpenAPI specification
+ * that was previously stored in openapi-base.yaml.
+ *
+ * Note on 'as const' usage:
+ * - We use 'as const' on literal values that should be treated as enums
+ *   (e.g., "apiKey", "header", "3.1.0") to get precise literal types
+ * - We avoid 'as const' on top-level configuration objects to prevent
+ *   deep readonly types that can cause compatibility issues with libraries
+ *   expecting mutable types (like zod-to-openapi)
+ * - If you encounter readonly type errors, check whether the consuming
+ *   library expects mutable types and remove 'as const' accordingly
+ */
+declare const apiInfo: {
+    title: string;
+    version: string;
+    contact: {
+        email: string;
+    };
+    description: string;
+};
+declare const servers: Array<{
+    url: string;
+    description: string;
+}>;
+declare const tags: {
+    name: string;
+    description: string;
+}[];
+/**
+ * Security schemes for OpenAPI specification
+ *
+ * Note: 'as const' is used on enum-like literal values ("apiKey", "header")
+ * to ensure TypeScript treats them as literal types rather than generic strings.
+ * This provides better type safety when the OpenAPI generator validates these values.
+ */
+declare const securitySchemes: {
+    readonly userJwt: {
+        readonly type: "apiKey";
+        readonly in: "header";
+        readonly name: "Authorization";
+        readonly description: string;
+    };
+};
+/**
+ * Complete OpenAPI metadata for document generation
+ */
+declare const openApiMetadata: {
+    openapi: "3.1.0";
+    info: {
+        title: string;
+        version: string;
+        contact: {
+            email: string;
+        };
+        description: string;
+    };
+    servers: {
+        url: string;
+        description: string;
+    }[];
+    tags: {
+        name: string;
+        description: string;
+    }[];
+};
+
+export { apiInfo, openApiMetadata, securitySchemes, servers, tags };