@objectstack/spec 0.8.2 → 0.9.0

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.
Files changed (188) hide show
  1. package/dist/ai/devops-agent.zod.d.ts +1 -1
  2. package/dist/ai/feedback-loop.zod.d.ts +4293 -0
  3. package/dist/ai/feedback-loop.zod.d.ts.map +1 -0
  4. package/dist/ai/feedback-loop.zod.js +53 -0
  5. package/dist/ai/index.d.ts +1 -0
  6. package/dist/ai/index.d.ts.map +1 -1
  7. package/dist/ai/index.js +1 -0
  8. package/dist/api/documentation.zod.d.ts +1073 -0
  9. package/dist/api/documentation.zod.d.ts.map +1 -0
  10. package/dist/api/documentation.zod.js +487 -0
  11. package/dist/api/errors.zod.d.ts +6 -6
  12. package/dist/api/graphql.zod.d.ts +3 -3
  13. package/dist/api/hub.zod.d.ts +5239 -0
  14. package/dist/api/hub.zod.d.ts.map +1 -0
  15. package/dist/api/hub.zod.js +784 -0
  16. package/dist/api/index.d.ts +4 -0
  17. package/dist/api/index.d.ts.map +1 -1
  18. package/dist/api/index.js +4 -0
  19. package/dist/api/odata.zod.d.ts +1 -1
  20. package/dist/api/registry.example.d.ts +411 -0
  21. package/dist/api/registry.example.d.ts.map +1 -0
  22. package/dist/api/registry.example.js +470 -0
  23. package/dist/api/registry.zod.d.ts +2095 -0
  24. package/dist/api/registry.zod.d.ts.map +1 -0
  25. package/dist/api/registry.zod.js +755 -0
  26. package/dist/api/websocket.zod.d.ts +8 -8
  27. package/dist/auth/scim.zod.d.ts +3 -3
  28. package/dist/automation/flow.zod.d.ts +3 -3
  29. package/dist/contracts/index.d.ts +1 -0
  30. package/dist/contracts/index.d.ts.map +1 -1
  31. package/dist/contracts/index.js +1 -0
  32. package/dist/contracts/schema-driver.d.ts +21 -0
  33. package/dist/contracts/schema-driver.d.ts.map +1 -0
  34. package/dist/contracts/schema-driver.js +2 -0
  35. package/dist/hub/composer.zod.d.ts +226 -0
  36. package/dist/hub/composer.zod.d.ts.map +1 -1
  37. package/dist/hub/hub-federation.zod.d.ts +764 -0
  38. package/dist/hub/hub-federation.zod.d.ts.map +1 -0
  39. package/dist/hub/hub-federation.zod.js +441 -0
  40. package/dist/hub/index.d.ts +2 -0
  41. package/dist/hub/index.d.ts.map +1 -1
  42. package/dist/hub/index.js +3 -0
  43. package/dist/hub/plugin-security.zod.d.ts +1029 -0
  44. package/dist/hub/plugin-security.zod.d.ts.map +1 -0
  45. package/dist/hub/plugin-security.zod.js +637 -0
  46. package/dist/index.d.ts +1 -0
  47. package/dist/index.d.ts.map +1 -1
  48. package/dist/index.js +2 -1
  49. package/dist/integration/connector/vercel.zod.d.ts +2 -2
  50. package/dist/qa/index.d.ts +11 -0
  51. package/dist/qa/index.d.ts.map +1 -0
  52. package/dist/qa/index.js +26 -0
  53. package/dist/qa/testing.zod.d.ts +345 -0
  54. package/dist/qa/testing.zod.d.ts.map +1 -0
  55. package/dist/qa/testing.zod.js +69 -0
  56. package/dist/stack.zod.d.ts +576 -3
  57. package/dist/stack.zod.d.ts.map +1 -1
  58. package/dist/system/index.d.ts +2 -0
  59. package/dist/system/index.d.ts.map +1 -1
  60. package/dist/system/index.js +2 -0
  61. package/dist/system/manifest.zod.d.ts +226 -0
  62. package/dist/system/manifest.zod.d.ts.map +1 -1
  63. package/dist/system/manifest.zod.js +8 -0
  64. package/dist/system/message-queue.zod.d.ts +2 -2
  65. package/dist/system/metadata-loader.zod.d.ts +1 -1
  66. package/dist/system/migration.zod.d.ts +4205 -0
  67. package/dist/system/migration.zod.d.ts.map +1 -0
  68. package/dist/system/migration.zod.js +70 -0
  69. package/dist/system/plugin-loading.zod.d.ts +575 -0
  70. package/dist/system/plugin-loading.zod.d.ts.map +1 -0
  71. package/dist/system/plugin-loading.zod.js +612 -0
  72. package/json-schema/ai/FeedbackLoop.json +7 -0
  73. package/json-schema/ai/Issue.json +7 -0
  74. package/json-schema/ai/MetadataSource.json +7 -0
  75. package/json-schema/ai/Resolution.json +7 -0
  76. package/json-schema/api/ApiChangelogEntry.json +7 -0
  77. package/json-schema/api/ApiDiscoveryQuery.json +7 -0
  78. package/json-schema/api/ApiDiscoveryResponse.json +7 -0
  79. package/json-schema/api/ApiDocumentationConfig.json +7 -0
  80. package/json-schema/api/ApiEndpointRegistration.json +7 -0
  81. package/json-schema/api/ApiMetadata.json +7 -0
  82. package/json-schema/api/ApiParameter.json +7 -0
  83. package/json-schema/api/ApiProtocolType.json +7 -0
  84. package/json-schema/api/ApiRegistry.json +7 -0
  85. package/json-schema/api/ApiRegistryEntry.json +7 -0
  86. package/json-schema/api/ApiResponse.json +7 -0
  87. package/json-schema/api/ApiTestCollection.json +7 -0
  88. package/json-schema/api/ApiTestRequest.json +7 -0
  89. package/json-schema/api/ApiTestingUiConfig.json +7 -0
  90. package/json-schema/api/ApiTestingUiType.json +7 -0
  91. package/json-schema/api/BuildStatusResponse.json +7 -0
  92. package/json-schema/api/CodeGenerationTemplate.json +7 -0
  93. package/json-schema/api/CompileManifestRequest.json +7 -0
  94. package/json-schema/api/CompileManifestResponse.json +7 -0
  95. package/json-schema/api/ConflictResolutionStrategy.json +7 -0
  96. package/json-schema/api/CreateSpaceRequest.json +7 -0
  97. package/json-schema/api/CreateTenantRequest.json +7 -0
  98. package/json-schema/api/GeneratedApiDocumentation.json +7 -0
  99. package/json-schema/api/GetBuildStatusRequest.json +7 -0
  100. package/json-schema/api/GetMarketplacePluginRequest.json +7 -0
  101. package/json-schema/api/GetPluginVersionsRequest.json +7 -0
  102. package/json-schema/api/GetPluginVersionsResponse.json +7 -0
  103. package/json-schema/api/HttpStatusCode.json +7 -0
  104. package/json-schema/api/HubHealthResponse.json +7 -0
  105. package/json-schema/api/HubMetricsResponse.json +7 -0
  106. package/json-schema/api/IssueLicenseRequest.json +7 -0
  107. package/json-schema/api/LicenseResponse.json +7 -0
  108. package/json-schema/api/ListLicensesRequest.json +7 -0
  109. package/json-schema/api/ListLicensesResponse.json +7 -0
  110. package/json-schema/api/ListMarketplaceRequest.json +7 -0
  111. package/json-schema/api/ListMarketplaceResponse.json +7 -0
  112. package/json-schema/api/ListSpacesRequest.json +7 -0
  113. package/json-schema/api/ListSpacesResponse.json +7 -0
  114. package/json-schema/api/ListTenantsRequest.json +7 -0
  115. package/json-schema/api/ListTenantsResponse.json +7 -0
  116. package/json-schema/api/MarketplacePluginResponse.json +7 -0
  117. package/json-schema/api/ObjectQLReference.json +7 -0
  118. package/json-schema/api/OpenApiSecurityScheme.json +7 -0
  119. package/json-schema/api/OpenApiServer.json +7 -0
  120. package/json-schema/api/OpenApiSpec.json +7 -0
  121. package/json-schema/api/PaginationRequest.json +7 -0
  122. package/json-schema/api/PaginationResponse.json +7 -0
  123. package/json-schema/api/PluginResponse.json +7 -0
  124. package/json-schema/api/PluginVersionInfo.json +7 -0
  125. package/json-schema/api/PublishPluginRequest.json +7 -0
  126. package/json-schema/api/RevokeLicenseRequest.json +7 -0
  127. package/json-schema/api/SchemaDefinition.json +7 -0
  128. package/json-schema/api/SearchPluginsRequest.json +7 -0
  129. package/json-schema/api/SearchPluginsResponse.json +7 -0
  130. package/json-schema/api/SpaceResponse.json +7 -0
  131. package/json-schema/api/TenantResponse.json +7 -0
  132. package/json-schema/api/UpdatePluginRequest.json +7 -0
  133. package/json-schema/api/UpdateSpaceRequest.json +7 -0
  134. package/json-schema/api/UpdateTenantRequest.json +7 -0
  135. package/json-schema/api/ValidateLicenseRequest.json +7 -0
  136. package/json-schema/api/ValidateLicenseResponse.json +7 -0
  137. package/json-schema/hub/DependencyConflict.json +7 -0
  138. package/json-schema/hub/DependencyGraph.json +7 -0
  139. package/json-schema/hub/DependencyGraphNode.json +7 -0
  140. package/json-schema/hub/DependencyResolutionResult.json +7 -0
  141. package/json-schema/hub/EdgeLocation.json +7 -0
  142. package/json-schema/hub/FederationTopology.json +7 -0
  143. package/json-schema/hub/GlobalRegistryEntry.json +7 -0
  144. package/json-schema/hub/HubInstance.json +7 -0
  145. package/json-schema/hub/PackageDependency.json +7 -0
  146. package/json-schema/hub/PluginProvenance.json +7 -0
  147. package/json-schema/hub/PluginTrustScore.json +7 -0
  148. package/json-schema/hub/Region.json +7 -0
  149. package/json-schema/hub/ReplicationJob.json +7 -0
  150. package/json-schema/hub/SBOM.json +7 -0
  151. package/json-schema/hub/SBOMEntry.json +7 -0
  152. package/json-schema/hub/SecurityPolicy.json +7 -0
  153. package/json-schema/hub/SecurityScanResult.json +7 -0
  154. package/json-schema/hub/SecurityVulnerability.json +7 -0
  155. package/json-schema/hub/TenantPlacementPolicy.json +7 -0
  156. package/json-schema/hub/VulnerabilitySeverity.json +7 -0
  157. package/json-schema/qa/TestAction.json +7 -0
  158. package/json-schema/qa/TestActionType.json +7 -0
  159. package/json-schema/qa/TestAssertion.json +7 -0
  160. package/json-schema/qa/TestAssertionType.json +7 -0
  161. package/json-schema/qa/TestContext.json +7 -0
  162. package/json-schema/qa/TestScenario.json +7 -0
  163. package/json-schema/qa/TestStep.json +7 -0
  164. package/json-schema/qa/TestSuite.json +7 -0
  165. package/json-schema/system/AddFieldOperation.json +7 -0
  166. package/json-schema/system/ChangeSet.json +7 -0
  167. package/json-schema/system/CreateObjectOperation.json +7 -0
  168. package/json-schema/system/DeleteObjectOperation.json +7 -0
  169. package/json-schema/system/ExecuteSqlOperation.json +7 -0
  170. package/json-schema/system/MigrationDependency.json +7 -0
  171. package/json-schema/system/MigrationOperation.json +7 -0
  172. package/json-schema/system/ModifyFieldOperation.json +7 -0
  173. package/json-schema/system/PluginCaching.json +7 -0
  174. package/json-schema/system/PluginCodeSplitting.json +7 -0
  175. package/json-schema/system/PluginDependencyResolution.json +7 -0
  176. package/json-schema/system/PluginDynamicImport.json +7 -0
  177. package/json-schema/system/PluginHotReload.json +7 -0
  178. package/json-schema/system/PluginInitialization.json +7 -0
  179. package/json-schema/system/PluginLoadingConfig.json +7 -0
  180. package/json-schema/system/PluginLoadingEvent.json +7 -0
  181. package/json-schema/system/PluginLoadingState.json +7 -0
  182. package/json-schema/system/PluginLoadingStrategy.json +7 -0
  183. package/json-schema/system/PluginPerformanceMonitoring.json +7 -0
  184. package/json-schema/system/PluginPreloadConfig.json +7 -0
  185. package/json-schema/system/PluginSandboxing.json +7 -0
  186. package/json-schema/system/RemoveFieldOperation.json +7 -0
  187. package/json-schema/system/RenameObjectOperation.json +7 -0
  188. package/package.json +1 -1
@@ -0,0 +1,1073 @@
1
+ import { z } from 'zod';
2
+ /**
3
+ * API Documentation & Testing Interface Protocol
4
+ *
5
+ * Provides schemas for generating interactive API documentation and testing
6
+ * interfaces similar to Swagger UI, GraphQL Playground, Postman, etc.
7
+ *
8
+ * Features:
9
+ * - OpenAPI/Swagger specification generation
10
+ * - Interactive API testing playground
11
+ * - API versioning and changelog
12
+ * - Code generation templates
13
+ * - Mock server configuration
14
+ *
15
+ * Architecture Alignment:
16
+ * - Swagger UI: Interactive API documentation
17
+ * - Postman: API testing collections
18
+ * - GraphQL Playground: GraphQL-specific testing
19
+ * - Redoc: Documentation rendering
20
+ *
21
+ * @example Documentation Config
22
+ * ```typescript
23
+ * const docConfig: ApiDocumentationConfig = {
24
+ * enabled: true,
25
+ * title: 'ObjectStack API',
26
+ * version: '1.0.0',
27
+ * servers: [{ url: 'https://api.example.com', description: 'Production' }],
28
+ * ui: {
29
+ * type: 'swagger-ui',
30
+ * theme: 'light',
31
+ * enableTryItOut: true
32
+ * }
33
+ * }
34
+ * ```
35
+ */
36
+ /**
37
+ * OpenAPI Server Schema
38
+ *
39
+ * Server configuration for OpenAPI specification.
40
+ */
41
+ export declare const OpenApiServerSchema: z.ZodObject<{
42
+ url: z.ZodString;
43
+ description: z.ZodOptional<z.ZodString>;
44
+ variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
45
+ default: z.ZodString;
46
+ description: z.ZodOptional<z.ZodString>;
47
+ enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
48
+ }, z.core.$strip>>>;
49
+ }, z.core.$strip>;
50
+ export type OpenApiServer = z.infer<typeof OpenApiServerSchema>;
51
+ /**
52
+ * OpenAPI Security Scheme Schema
53
+ *
54
+ * Security scheme definition for OpenAPI.
55
+ */
56
+ export declare const OpenApiSecuritySchemeSchema: z.ZodObject<{
57
+ type: z.ZodEnum<{
58
+ oauth2: "oauth2";
59
+ apiKey: "apiKey";
60
+ http: "http";
61
+ openIdConnect: "openIdConnect";
62
+ }>;
63
+ scheme: z.ZodOptional<z.ZodString>;
64
+ bearerFormat: z.ZodOptional<z.ZodString>;
65
+ name: z.ZodOptional<z.ZodString>;
66
+ in: z.ZodOptional<z.ZodEnum<{
67
+ query: "query";
68
+ header: "header";
69
+ cookie: "cookie";
70
+ }>>;
71
+ flows: z.ZodOptional<z.ZodObject<{
72
+ implicit: z.ZodOptional<z.ZodAny>;
73
+ password: z.ZodOptional<z.ZodAny>;
74
+ clientCredentials: z.ZodOptional<z.ZodAny>;
75
+ authorizationCode: z.ZodOptional<z.ZodAny>;
76
+ }, z.core.$strip>>;
77
+ openIdConnectUrl: z.ZodOptional<z.ZodString>;
78
+ description: z.ZodOptional<z.ZodString>;
79
+ }, z.core.$strip>;
80
+ export type OpenApiSecurityScheme = z.infer<typeof OpenApiSecuritySchemeSchema>;
81
+ /**
82
+ * OpenAPI Specification Schema
83
+ *
84
+ * Complete OpenAPI 3.0 specification structure.
85
+ *
86
+ * @see https://swagger.io/specification/
87
+ *
88
+ * @example
89
+ * ```json
90
+ * {
91
+ * "openapi": "3.0.0",
92
+ * "info": {
93
+ * "title": "ObjectStack API",
94
+ * "version": "1.0.0",
95
+ * "description": "ObjectStack unified API"
96
+ * },
97
+ * "servers": [
98
+ * { "url": "https://api.example.com" }
99
+ * ],
100
+ * "paths": { ... },
101
+ * "components": { ... }
102
+ * }
103
+ * ```
104
+ */
105
+ export declare const OpenApiSpecSchema: z.ZodObject<{
106
+ openapi: z.ZodDefault<z.ZodString>;
107
+ info: z.ZodObject<{
108
+ title: z.ZodString;
109
+ version: z.ZodString;
110
+ description: z.ZodOptional<z.ZodString>;
111
+ termsOfService: z.ZodOptional<z.ZodString>;
112
+ contact: z.ZodOptional<z.ZodObject<{
113
+ name: z.ZodOptional<z.ZodString>;
114
+ url: z.ZodOptional<z.ZodString>;
115
+ email: z.ZodOptional<z.ZodString>;
116
+ }, z.core.$strip>>;
117
+ license: z.ZodOptional<z.ZodObject<{
118
+ name: z.ZodString;
119
+ url: z.ZodOptional<z.ZodString>;
120
+ }, z.core.$strip>>;
121
+ }, z.core.$strip>;
122
+ servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
123
+ url: z.ZodString;
124
+ description: z.ZodOptional<z.ZodString>;
125
+ variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
126
+ default: z.ZodString;
127
+ description: z.ZodOptional<z.ZodString>;
128
+ enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
129
+ }, z.core.$strip>>>;
130
+ }, z.core.$strip>>>>;
131
+ paths: z.ZodRecord<z.ZodString, z.ZodAny>;
132
+ components: z.ZodOptional<z.ZodObject<{
133
+ schemas: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
134
+ responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
135
+ parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
136
+ examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
137
+ requestBodies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
138
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
139
+ securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
140
+ type: z.ZodEnum<{
141
+ oauth2: "oauth2";
142
+ apiKey: "apiKey";
143
+ http: "http";
144
+ openIdConnect: "openIdConnect";
145
+ }>;
146
+ scheme: z.ZodOptional<z.ZodString>;
147
+ bearerFormat: z.ZodOptional<z.ZodString>;
148
+ name: z.ZodOptional<z.ZodString>;
149
+ in: z.ZodOptional<z.ZodEnum<{
150
+ query: "query";
151
+ header: "header";
152
+ cookie: "cookie";
153
+ }>>;
154
+ flows: z.ZodOptional<z.ZodObject<{
155
+ implicit: z.ZodOptional<z.ZodAny>;
156
+ password: z.ZodOptional<z.ZodAny>;
157
+ clientCredentials: z.ZodOptional<z.ZodAny>;
158
+ authorizationCode: z.ZodOptional<z.ZodAny>;
159
+ }, z.core.$strip>>;
160
+ openIdConnectUrl: z.ZodOptional<z.ZodString>;
161
+ description: z.ZodOptional<z.ZodString>;
162
+ }, z.core.$strip>>>;
163
+ links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
164
+ callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
165
+ }, z.core.$strip>>;
166
+ security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>>;
167
+ tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
168
+ name: z.ZodString;
169
+ description: z.ZodOptional<z.ZodString>;
170
+ externalDocs: z.ZodOptional<z.ZodObject<{
171
+ description: z.ZodOptional<z.ZodString>;
172
+ url: z.ZodString;
173
+ }, z.core.$strip>>;
174
+ }, z.core.$strip>>>;
175
+ externalDocs: z.ZodOptional<z.ZodObject<{
176
+ description: z.ZodOptional<z.ZodString>;
177
+ url: z.ZodString;
178
+ }, z.core.$strip>>;
179
+ }, z.core.$strip>;
180
+ export type OpenApiSpec = z.infer<typeof OpenApiSpecSchema>;
181
+ /**
182
+ * API Testing UI Type
183
+ */
184
+ export declare const ApiTestingUiType: z.ZodEnum<{
185
+ custom: "custom";
186
+ "swagger-ui": "swagger-ui";
187
+ redoc: "redoc";
188
+ rapidoc: "rapidoc";
189
+ stoplight: "stoplight";
190
+ scalar: "scalar";
191
+ "graphql-playground": "graphql-playground";
192
+ graphiql: "graphiql";
193
+ postman: "postman";
194
+ }>;
195
+ export type ApiTestingUiType = z.infer<typeof ApiTestingUiType>;
196
+ /**
197
+ * API Testing UI Configuration Schema
198
+ *
199
+ * Configuration for interactive API testing interface.
200
+ *
201
+ * @example Swagger UI Config
202
+ * ```json
203
+ * {
204
+ * "type": "swagger-ui",
205
+ * "path": "/api-docs",
206
+ * "theme": "light",
207
+ * "enableTryItOut": true,
208
+ * "enableFilter": true,
209
+ * "enableCors": true,
210
+ * "defaultModelsExpandDepth": 1
211
+ * }
212
+ * ```
213
+ */
214
+ export declare const ApiTestingUiConfigSchema: z.ZodObject<{
215
+ type: z.ZodEnum<{
216
+ custom: "custom";
217
+ "swagger-ui": "swagger-ui";
218
+ redoc: "redoc";
219
+ rapidoc: "rapidoc";
220
+ stoplight: "stoplight";
221
+ scalar: "scalar";
222
+ "graphql-playground": "graphql-playground";
223
+ graphiql: "graphiql";
224
+ postman: "postman";
225
+ }>;
226
+ path: z.ZodDefault<z.ZodString>;
227
+ theme: z.ZodDefault<z.ZodEnum<{
228
+ auto: "auto";
229
+ light: "light";
230
+ dark: "dark";
231
+ }>>;
232
+ enableTryItOut: z.ZodDefault<z.ZodBoolean>;
233
+ enableFilter: z.ZodDefault<z.ZodBoolean>;
234
+ enableCors: z.ZodDefault<z.ZodBoolean>;
235
+ defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
236
+ displayRequestDuration: z.ZodDefault<z.ZodBoolean>;
237
+ syntaxHighlighting: z.ZodDefault<z.ZodBoolean>;
238
+ customCssUrl: z.ZodOptional<z.ZodString>;
239
+ customJsUrl: z.ZodOptional<z.ZodString>;
240
+ layout: z.ZodOptional<z.ZodObject<{
241
+ showExtensions: z.ZodDefault<z.ZodBoolean>;
242
+ showCommonExtensions: z.ZodDefault<z.ZodBoolean>;
243
+ deepLinking: z.ZodDefault<z.ZodBoolean>;
244
+ displayOperationId: z.ZodDefault<z.ZodBoolean>;
245
+ defaultModelRendering: z.ZodDefault<z.ZodEnum<{
246
+ model: "model";
247
+ example: "example";
248
+ }>>;
249
+ defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
250
+ defaultModelExpandDepth: z.ZodDefault<z.ZodNumber>;
251
+ docExpansion: z.ZodDefault<z.ZodEnum<{
252
+ full: "full";
253
+ list: "list";
254
+ none: "none";
255
+ }>>;
256
+ }, z.core.$strip>>;
257
+ }, z.core.$strip>;
258
+ export type ApiTestingUiConfig = z.infer<typeof ApiTestingUiConfigSchema>;
259
+ /**
260
+ * API Test Request Schema
261
+ *
262
+ * Represents a saved/example API test request.
263
+ *
264
+ * @example
265
+ * ```json
266
+ * {
267
+ * "name": "Get Customer by ID",
268
+ * "description": "Retrieves a customer record",
269
+ * "method": "GET",
270
+ * "url": "/api/v1/data/customer/123",
271
+ * "headers": {
272
+ * "Authorization": "Bearer {{token}}"
273
+ * },
274
+ * "variables": {
275
+ * "token": "sample_token"
276
+ * }
277
+ * }
278
+ * ```
279
+ */
280
+ export declare const ApiTestRequestSchema: z.ZodObject<{
281
+ name: z.ZodString;
282
+ description: z.ZodOptional<z.ZodString>;
283
+ method: z.ZodEnum<{
284
+ GET: "GET";
285
+ POST: "POST";
286
+ PUT: "PUT";
287
+ DELETE: "DELETE";
288
+ PATCH: "PATCH";
289
+ HEAD: "HEAD";
290
+ OPTIONS: "OPTIONS";
291
+ }>;
292
+ url: z.ZodString;
293
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
294
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
295
+ body: z.ZodOptional<z.ZodAny>;
296
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
297
+ expectedResponse: z.ZodOptional<z.ZodObject<{
298
+ statusCode: z.ZodNumber;
299
+ body: z.ZodOptional<z.ZodAny>;
300
+ }, z.core.$strip>>;
301
+ }, z.core.$strip>;
302
+ export type ApiTestRequest = z.infer<typeof ApiTestRequestSchema>;
303
+ /**
304
+ * API Test Collection Schema
305
+ *
306
+ * Collection of test requests (similar to Postman collections).
307
+ *
308
+ * @example
309
+ * ```json
310
+ * {
311
+ * "name": "Customer API Tests",
312
+ * "description": "Test collection for customer endpoints",
313
+ * "variables": {
314
+ * "baseUrl": "https://api.example.com",
315
+ * "apiKey": "test_key"
316
+ * },
317
+ * "requests": [...]
318
+ * }
319
+ * ```
320
+ */
321
+ export declare const ApiTestCollectionSchema: z.ZodObject<{
322
+ name: z.ZodString;
323
+ description: z.ZodOptional<z.ZodString>;
324
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
325
+ requests: z.ZodArray<z.ZodObject<{
326
+ name: z.ZodString;
327
+ description: z.ZodOptional<z.ZodString>;
328
+ method: z.ZodEnum<{
329
+ GET: "GET";
330
+ POST: "POST";
331
+ PUT: "PUT";
332
+ DELETE: "DELETE";
333
+ PATCH: "PATCH";
334
+ HEAD: "HEAD";
335
+ OPTIONS: "OPTIONS";
336
+ }>;
337
+ url: z.ZodString;
338
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
339
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
340
+ body: z.ZodOptional<z.ZodAny>;
341
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
342
+ expectedResponse: z.ZodOptional<z.ZodObject<{
343
+ statusCode: z.ZodNumber;
344
+ body: z.ZodOptional<z.ZodAny>;
345
+ }, z.core.$strip>>;
346
+ }, z.core.$strip>>;
347
+ folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
348
+ name: z.ZodString;
349
+ description: z.ZodOptional<z.ZodString>;
350
+ requests: z.ZodArray<z.ZodObject<{
351
+ name: z.ZodString;
352
+ description: z.ZodOptional<z.ZodString>;
353
+ method: z.ZodEnum<{
354
+ GET: "GET";
355
+ POST: "POST";
356
+ PUT: "PUT";
357
+ DELETE: "DELETE";
358
+ PATCH: "PATCH";
359
+ HEAD: "HEAD";
360
+ OPTIONS: "OPTIONS";
361
+ }>;
362
+ url: z.ZodString;
363
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
364
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
365
+ body: z.ZodOptional<z.ZodAny>;
366
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
367
+ expectedResponse: z.ZodOptional<z.ZodObject<{
368
+ statusCode: z.ZodNumber;
369
+ body: z.ZodOptional<z.ZodAny>;
370
+ }, z.core.$strip>>;
371
+ }, z.core.$strip>>;
372
+ }, z.core.$strip>>>;
373
+ }, z.core.$strip>;
374
+ export type ApiTestCollection = z.infer<typeof ApiTestCollectionSchema>;
375
+ /**
376
+ * API Changelog Entry Schema
377
+ *
378
+ * Documents changes in API versions.
379
+ */
380
+ export declare const ApiChangelogEntrySchema: z.ZodObject<{
381
+ version: z.ZodString;
382
+ date: z.ZodString;
383
+ changes: z.ZodObject<{
384
+ added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
385
+ changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
386
+ deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
387
+ removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
388
+ fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
389
+ security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
390
+ }, z.core.$strip>;
391
+ migrationGuide: z.ZodOptional<z.ZodString>;
392
+ }, z.core.$strip>;
393
+ export type ApiChangelogEntry = z.infer<typeof ApiChangelogEntrySchema>;
394
+ /**
395
+ * Code Generation Template Schema
396
+ *
397
+ * Templates for generating client code.
398
+ */
399
+ export declare const CodeGenerationTemplateSchema: z.ZodObject<{
400
+ language: z.ZodString;
401
+ name: z.ZodString;
402
+ template: z.ZodString;
403
+ variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
404
+ }, z.core.$strip>;
405
+ export type CodeGenerationTemplate = z.infer<typeof CodeGenerationTemplateSchema>;
406
+ /**
407
+ * API Documentation Configuration Schema
408
+ *
409
+ * Complete configuration for API documentation and testing interface.
410
+ *
411
+ * @example
412
+ * ```json
413
+ * {
414
+ * "enabled": true,
415
+ * "title": "ObjectStack API Documentation",
416
+ * "version": "1.0.0",
417
+ * "description": "Unified API for ObjectStack platform",
418
+ * "servers": [
419
+ * { "url": "https://api.example.com", "description": "Production" }
420
+ * ],
421
+ * "ui": {
422
+ * "type": "swagger-ui",
423
+ * "theme": "light",
424
+ * "enableTryItOut": true
425
+ * },
426
+ * "generateOpenApi": true,
427
+ * "generateTestCollections": true
428
+ * }
429
+ * ```
430
+ */
431
+ export declare const ApiDocumentationConfigSchema: z.ZodObject<{
432
+ enabled: z.ZodDefault<z.ZodBoolean>;
433
+ title: z.ZodDefault<z.ZodString>;
434
+ version: z.ZodString;
435
+ description: z.ZodOptional<z.ZodString>;
436
+ servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
437
+ url: z.ZodString;
438
+ description: z.ZodOptional<z.ZodString>;
439
+ variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
440
+ default: z.ZodString;
441
+ description: z.ZodOptional<z.ZodString>;
442
+ enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
443
+ }, z.core.$strip>>>;
444
+ }, z.core.$strip>>>>;
445
+ ui: z.ZodOptional<z.ZodObject<{
446
+ type: z.ZodEnum<{
447
+ custom: "custom";
448
+ "swagger-ui": "swagger-ui";
449
+ redoc: "redoc";
450
+ rapidoc: "rapidoc";
451
+ stoplight: "stoplight";
452
+ scalar: "scalar";
453
+ "graphql-playground": "graphql-playground";
454
+ graphiql: "graphiql";
455
+ postman: "postman";
456
+ }>;
457
+ path: z.ZodDefault<z.ZodString>;
458
+ theme: z.ZodDefault<z.ZodEnum<{
459
+ auto: "auto";
460
+ light: "light";
461
+ dark: "dark";
462
+ }>>;
463
+ enableTryItOut: z.ZodDefault<z.ZodBoolean>;
464
+ enableFilter: z.ZodDefault<z.ZodBoolean>;
465
+ enableCors: z.ZodDefault<z.ZodBoolean>;
466
+ defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
467
+ displayRequestDuration: z.ZodDefault<z.ZodBoolean>;
468
+ syntaxHighlighting: z.ZodDefault<z.ZodBoolean>;
469
+ customCssUrl: z.ZodOptional<z.ZodString>;
470
+ customJsUrl: z.ZodOptional<z.ZodString>;
471
+ layout: z.ZodOptional<z.ZodObject<{
472
+ showExtensions: z.ZodDefault<z.ZodBoolean>;
473
+ showCommonExtensions: z.ZodDefault<z.ZodBoolean>;
474
+ deepLinking: z.ZodDefault<z.ZodBoolean>;
475
+ displayOperationId: z.ZodDefault<z.ZodBoolean>;
476
+ defaultModelRendering: z.ZodDefault<z.ZodEnum<{
477
+ model: "model";
478
+ example: "example";
479
+ }>>;
480
+ defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
481
+ defaultModelExpandDepth: z.ZodDefault<z.ZodNumber>;
482
+ docExpansion: z.ZodDefault<z.ZodEnum<{
483
+ full: "full";
484
+ list: "list";
485
+ none: "none";
486
+ }>>;
487
+ }, z.core.$strip>>;
488
+ }, z.core.$strip>>;
489
+ generateOpenApi: z.ZodDefault<z.ZodBoolean>;
490
+ generateTestCollections: z.ZodDefault<z.ZodBoolean>;
491
+ testCollections: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
492
+ name: z.ZodString;
493
+ description: z.ZodOptional<z.ZodString>;
494
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
495
+ requests: z.ZodArray<z.ZodObject<{
496
+ name: z.ZodString;
497
+ description: z.ZodOptional<z.ZodString>;
498
+ method: z.ZodEnum<{
499
+ GET: "GET";
500
+ POST: "POST";
501
+ PUT: "PUT";
502
+ DELETE: "DELETE";
503
+ PATCH: "PATCH";
504
+ HEAD: "HEAD";
505
+ OPTIONS: "OPTIONS";
506
+ }>;
507
+ url: z.ZodString;
508
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
509
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
510
+ body: z.ZodOptional<z.ZodAny>;
511
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
512
+ expectedResponse: z.ZodOptional<z.ZodObject<{
513
+ statusCode: z.ZodNumber;
514
+ body: z.ZodOptional<z.ZodAny>;
515
+ }, z.core.$strip>>;
516
+ }, z.core.$strip>>;
517
+ folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
518
+ name: z.ZodString;
519
+ description: z.ZodOptional<z.ZodString>;
520
+ requests: z.ZodArray<z.ZodObject<{
521
+ name: z.ZodString;
522
+ description: z.ZodOptional<z.ZodString>;
523
+ method: z.ZodEnum<{
524
+ GET: "GET";
525
+ POST: "POST";
526
+ PUT: "PUT";
527
+ DELETE: "DELETE";
528
+ PATCH: "PATCH";
529
+ HEAD: "HEAD";
530
+ OPTIONS: "OPTIONS";
531
+ }>;
532
+ url: z.ZodString;
533
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
534
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
535
+ body: z.ZodOptional<z.ZodAny>;
536
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
537
+ expectedResponse: z.ZodOptional<z.ZodObject<{
538
+ statusCode: z.ZodNumber;
539
+ body: z.ZodOptional<z.ZodAny>;
540
+ }, z.core.$strip>>;
541
+ }, z.core.$strip>>;
542
+ }, z.core.$strip>>>;
543
+ }, z.core.$strip>>>>;
544
+ changelog: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
545
+ version: z.ZodString;
546
+ date: z.ZodString;
547
+ changes: z.ZodObject<{
548
+ added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
549
+ changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
550
+ deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
551
+ removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
552
+ fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
553
+ security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
554
+ }, z.core.$strip>;
555
+ migrationGuide: z.ZodOptional<z.ZodString>;
556
+ }, z.core.$strip>>>>;
557
+ codeTemplates: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
558
+ language: z.ZodString;
559
+ name: z.ZodString;
560
+ template: z.ZodString;
561
+ variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
562
+ }, z.core.$strip>>>>;
563
+ termsOfService: z.ZodOptional<z.ZodString>;
564
+ contact: z.ZodOptional<z.ZodObject<{
565
+ name: z.ZodOptional<z.ZodString>;
566
+ url: z.ZodOptional<z.ZodString>;
567
+ email: z.ZodOptional<z.ZodString>;
568
+ }, z.core.$strip>>;
569
+ license: z.ZodOptional<z.ZodObject<{
570
+ name: z.ZodString;
571
+ url: z.ZodOptional<z.ZodString>;
572
+ }, z.core.$strip>>;
573
+ externalDocs: z.ZodOptional<z.ZodObject<{
574
+ description: z.ZodOptional<z.ZodString>;
575
+ url: z.ZodString;
576
+ }, z.core.$strip>>;
577
+ securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
578
+ type: z.ZodEnum<{
579
+ oauth2: "oauth2";
580
+ apiKey: "apiKey";
581
+ http: "http";
582
+ openIdConnect: "openIdConnect";
583
+ }>;
584
+ scheme: z.ZodOptional<z.ZodString>;
585
+ bearerFormat: z.ZodOptional<z.ZodString>;
586
+ name: z.ZodOptional<z.ZodString>;
587
+ in: z.ZodOptional<z.ZodEnum<{
588
+ query: "query";
589
+ header: "header";
590
+ cookie: "cookie";
591
+ }>>;
592
+ flows: z.ZodOptional<z.ZodObject<{
593
+ implicit: z.ZodOptional<z.ZodAny>;
594
+ password: z.ZodOptional<z.ZodAny>;
595
+ clientCredentials: z.ZodOptional<z.ZodAny>;
596
+ authorizationCode: z.ZodOptional<z.ZodAny>;
597
+ }, z.core.$strip>>;
598
+ openIdConnectUrl: z.ZodOptional<z.ZodString>;
599
+ description: z.ZodOptional<z.ZodString>;
600
+ }, z.core.$strip>>>;
601
+ tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
602
+ name: z.ZodString;
603
+ description: z.ZodOptional<z.ZodString>;
604
+ externalDocs: z.ZodOptional<z.ZodObject<{
605
+ description: z.ZodOptional<z.ZodString>;
606
+ url: z.ZodString;
607
+ }, z.core.$strip>>;
608
+ }, z.core.$strip>>>;
609
+ }, z.core.$strip>;
610
+ export type ApiDocumentationConfig = z.infer<typeof ApiDocumentationConfigSchema>;
611
+ /**
612
+ * Generated API Documentation Schema
613
+ *
614
+ * Output of documentation generation process.
615
+ */
616
+ export declare const GeneratedApiDocumentationSchema: z.ZodObject<{
617
+ openApiSpec: z.ZodOptional<z.ZodObject<{
618
+ openapi: z.ZodDefault<z.ZodString>;
619
+ info: z.ZodObject<{
620
+ title: z.ZodString;
621
+ version: z.ZodString;
622
+ description: z.ZodOptional<z.ZodString>;
623
+ termsOfService: z.ZodOptional<z.ZodString>;
624
+ contact: z.ZodOptional<z.ZodObject<{
625
+ name: z.ZodOptional<z.ZodString>;
626
+ url: z.ZodOptional<z.ZodString>;
627
+ email: z.ZodOptional<z.ZodString>;
628
+ }, z.core.$strip>>;
629
+ license: z.ZodOptional<z.ZodObject<{
630
+ name: z.ZodString;
631
+ url: z.ZodOptional<z.ZodString>;
632
+ }, z.core.$strip>>;
633
+ }, z.core.$strip>;
634
+ servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
635
+ url: z.ZodString;
636
+ description: z.ZodOptional<z.ZodString>;
637
+ variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
638
+ default: z.ZodString;
639
+ description: z.ZodOptional<z.ZodString>;
640
+ enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
641
+ }, z.core.$strip>>>;
642
+ }, z.core.$strip>>>>;
643
+ paths: z.ZodRecord<z.ZodString, z.ZodAny>;
644
+ components: z.ZodOptional<z.ZodObject<{
645
+ schemas: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
646
+ responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
647
+ parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
648
+ examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
649
+ requestBodies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
650
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
651
+ securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
652
+ type: z.ZodEnum<{
653
+ oauth2: "oauth2";
654
+ apiKey: "apiKey";
655
+ http: "http";
656
+ openIdConnect: "openIdConnect";
657
+ }>;
658
+ scheme: z.ZodOptional<z.ZodString>;
659
+ bearerFormat: z.ZodOptional<z.ZodString>;
660
+ name: z.ZodOptional<z.ZodString>;
661
+ in: z.ZodOptional<z.ZodEnum<{
662
+ query: "query";
663
+ header: "header";
664
+ cookie: "cookie";
665
+ }>>;
666
+ flows: z.ZodOptional<z.ZodObject<{
667
+ implicit: z.ZodOptional<z.ZodAny>;
668
+ password: z.ZodOptional<z.ZodAny>;
669
+ clientCredentials: z.ZodOptional<z.ZodAny>;
670
+ authorizationCode: z.ZodOptional<z.ZodAny>;
671
+ }, z.core.$strip>>;
672
+ openIdConnectUrl: z.ZodOptional<z.ZodString>;
673
+ description: z.ZodOptional<z.ZodString>;
674
+ }, z.core.$strip>>>;
675
+ links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
676
+ callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
677
+ }, z.core.$strip>>;
678
+ security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>>;
679
+ tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
680
+ name: z.ZodString;
681
+ description: z.ZodOptional<z.ZodString>;
682
+ externalDocs: z.ZodOptional<z.ZodObject<{
683
+ description: z.ZodOptional<z.ZodString>;
684
+ url: z.ZodString;
685
+ }, z.core.$strip>>;
686
+ }, z.core.$strip>>>;
687
+ externalDocs: z.ZodOptional<z.ZodObject<{
688
+ description: z.ZodOptional<z.ZodString>;
689
+ url: z.ZodString;
690
+ }, z.core.$strip>>;
691
+ }, z.core.$strip>>;
692
+ testCollections: z.ZodOptional<z.ZodArray<z.ZodObject<{
693
+ name: z.ZodString;
694
+ description: z.ZodOptional<z.ZodString>;
695
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
696
+ requests: z.ZodArray<z.ZodObject<{
697
+ name: z.ZodString;
698
+ description: z.ZodOptional<z.ZodString>;
699
+ method: z.ZodEnum<{
700
+ GET: "GET";
701
+ POST: "POST";
702
+ PUT: "PUT";
703
+ DELETE: "DELETE";
704
+ PATCH: "PATCH";
705
+ HEAD: "HEAD";
706
+ OPTIONS: "OPTIONS";
707
+ }>;
708
+ url: z.ZodString;
709
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
710
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
711
+ body: z.ZodOptional<z.ZodAny>;
712
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
713
+ expectedResponse: z.ZodOptional<z.ZodObject<{
714
+ statusCode: z.ZodNumber;
715
+ body: z.ZodOptional<z.ZodAny>;
716
+ }, z.core.$strip>>;
717
+ }, z.core.$strip>>;
718
+ folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
719
+ name: z.ZodString;
720
+ description: z.ZodOptional<z.ZodString>;
721
+ requests: z.ZodArray<z.ZodObject<{
722
+ name: z.ZodString;
723
+ description: z.ZodOptional<z.ZodString>;
724
+ method: z.ZodEnum<{
725
+ GET: "GET";
726
+ POST: "POST";
727
+ PUT: "PUT";
728
+ DELETE: "DELETE";
729
+ PATCH: "PATCH";
730
+ HEAD: "HEAD";
731
+ OPTIONS: "OPTIONS";
732
+ }>;
733
+ url: z.ZodString;
734
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
735
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
736
+ body: z.ZodOptional<z.ZodAny>;
737
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
738
+ expectedResponse: z.ZodOptional<z.ZodObject<{
739
+ statusCode: z.ZodNumber;
740
+ body: z.ZodOptional<z.ZodAny>;
741
+ }, z.core.$strip>>;
742
+ }, z.core.$strip>>;
743
+ }, z.core.$strip>>>;
744
+ }, z.core.$strip>>>;
745
+ markdown: z.ZodOptional<z.ZodString>;
746
+ html: z.ZodOptional<z.ZodString>;
747
+ generatedAt: z.ZodString;
748
+ sourceApis: z.ZodArray<z.ZodString>;
749
+ }, z.core.$strip>;
750
+ export type GeneratedApiDocumentation = z.infer<typeof GeneratedApiDocumentationSchema>;
751
+ /**
752
+ * Helper to create API documentation config
753
+ */
754
+ export declare const ApiDocumentationConfig: z.ZodObject<{
755
+ enabled: z.ZodDefault<z.ZodBoolean>;
756
+ title: z.ZodDefault<z.ZodString>;
757
+ version: z.ZodString;
758
+ description: z.ZodOptional<z.ZodString>;
759
+ servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
760
+ url: z.ZodString;
761
+ description: z.ZodOptional<z.ZodString>;
762
+ variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
763
+ default: z.ZodString;
764
+ description: z.ZodOptional<z.ZodString>;
765
+ enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
766
+ }, z.core.$strip>>>;
767
+ }, z.core.$strip>>>>;
768
+ ui: z.ZodOptional<z.ZodObject<{
769
+ type: z.ZodEnum<{
770
+ custom: "custom";
771
+ "swagger-ui": "swagger-ui";
772
+ redoc: "redoc";
773
+ rapidoc: "rapidoc";
774
+ stoplight: "stoplight";
775
+ scalar: "scalar";
776
+ "graphql-playground": "graphql-playground";
777
+ graphiql: "graphiql";
778
+ postman: "postman";
779
+ }>;
780
+ path: z.ZodDefault<z.ZodString>;
781
+ theme: z.ZodDefault<z.ZodEnum<{
782
+ auto: "auto";
783
+ light: "light";
784
+ dark: "dark";
785
+ }>>;
786
+ enableTryItOut: z.ZodDefault<z.ZodBoolean>;
787
+ enableFilter: z.ZodDefault<z.ZodBoolean>;
788
+ enableCors: z.ZodDefault<z.ZodBoolean>;
789
+ defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
790
+ displayRequestDuration: z.ZodDefault<z.ZodBoolean>;
791
+ syntaxHighlighting: z.ZodDefault<z.ZodBoolean>;
792
+ customCssUrl: z.ZodOptional<z.ZodString>;
793
+ customJsUrl: z.ZodOptional<z.ZodString>;
794
+ layout: z.ZodOptional<z.ZodObject<{
795
+ showExtensions: z.ZodDefault<z.ZodBoolean>;
796
+ showCommonExtensions: z.ZodDefault<z.ZodBoolean>;
797
+ deepLinking: z.ZodDefault<z.ZodBoolean>;
798
+ displayOperationId: z.ZodDefault<z.ZodBoolean>;
799
+ defaultModelRendering: z.ZodDefault<z.ZodEnum<{
800
+ model: "model";
801
+ example: "example";
802
+ }>>;
803
+ defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
804
+ defaultModelExpandDepth: z.ZodDefault<z.ZodNumber>;
805
+ docExpansion: z.ZodDefault<z.ZodEnum<{
806
+ full: "full";
807
+ list: "list";
808
+ none: "none";
809
+ }>>;
810
+ }, z.core.$strip>>;
811
+ }, z.core.$strip>>;
812
+ generateOpenApi: z.ZodDefault<z.ZodBoolean>;
813
+ generateTestCollections: z.ZodDefault<z.ZodBoolean>;
814
+ testCollections: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
815
+ name: z.ZodString;
816
+ description: z.ZodOptional<z.ZodString>;
817
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
818
+ requests: z.ZodArray<z.ZodObject<{
819
+ name: z.ZodString;
820
+ description: z.ZodOptional<z.ZodString>;
821
+ method: z.ZodEnum<{
822
+ GET: "GET";
823
+ POST: "POST";
824
+ PUT: "PUT";
825
+ DELETE: "DELETE";
826
+ PATCH: "PATCH";
827
+ HEAD: "HEAD";
828
+ OPTIONS: "OPTIONS";
829
+ }>;
830
+ url: z.ZodString;
831
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
832
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
833
+ body: z.ZodOptional<z.ZodAny>;
834
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
835
+ expectedResponse: z.ZodOptional<z.ZodObject<{
836
+ statusCode: z.ZodNumber;
837
+ body: z.ZodOptional<z.ZodAny>;
838
+ }, z.core.$strip>>;
839
+ }, z.core.$strip>>;
840
+ folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
841
+ name: z.ZodString;
842
+ description: z.ZodOptional<z.ZodString>;
843
+ requests: z.ZodArray<z.ZodObject<{
844
+ name: z.ZodString;
845
+ description: z.ZodOptional<z.ZodString>;
846
+ method: z.ZodEnum<{
847
+ GET: "GET";
848
+ POST: "POST";
849
+ PUT: "PUT";
850
+ DELETE: "DELETE";
851
+ PATCH: "PATCH";
852
+ HEAD: "HEAD";
853
+ OPTIONS: "OPTIONS";
854
+ }>;
855
+ url: z.ZodString;
856
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
857
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
858
+ body: z.ZodOptional<z.ZodAny>;
859
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
860
+ expectedResponse: z.ZodOptional<z.ZodObject<{
861
+ statusCode: z.ZodNumber;
862
+ body: z.ZodOptional<z.ZodAny>;
863
+ }, z.core.$strip>>;
864
+ }, z.core.$strip>>;
865
+ }, z.core.$strip>>>;
866
+ }, z.core.$strip>>>>;
867
+ changelog: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
868
+ version: z.ZodString;
869
+ date: z.ZodString;
870
+ changes: z.ZodObject<{
871
+ added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
872
+ changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
873
+ deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
874
+ removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
875
+ fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
876
+ security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
877
+ }, z.core.$strip>;
878
+ migrationGuide: z.ZodOptional<z.ZodString>;
879
+ }, z.core.$strip>>>>;
880
+ codeTemplates: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
881
+ language: z.ZodString;
882
+ name: z.ZodString;
883
+ template: z.ZodString;
884
+ variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
885
+ }, z.core.$strip>>>>;
886
+ termsOfService: z.ZodOptional<z.ZodString>;
887
+ contact: z.ZodOptional<z.ZodObject<{
888
+ name: z.ZodOptional<z.ZodString>;
889
+ url: z.ZodOptional<z.ZodString>;
890
+ email: z.ZodOptional<z.ZodString>;
891
+ }, z.core.$strip>>;
892
+ license: z.ZodOptional<z.ZodObject<{
893
+ name: z.ZodString;
894
+ url: z.ZodOptional<z.ZodString>;
895
+ }, z.core.$strip>>;
896
+ externalDocs: z.ZodOptional<z.ZodObject<{
897
+ description: z.ZodOptional<z.ZodString>;
898
+ url: z.ZodString;
899
+ }, z.core.$strip>>;
900
+ securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
901
+ type: z.ZodEnum<{
902
+ oauth2: "oauth2";
903
+ apiKey: "apiKey";
904
+ http: "http";
905
+ openIdConnect: "openIdConnect";
906
+ }>;
907
+ scheme: z.ZodOptional<z.ZodString>;
908
+ bearerFormat: z.ZodOptional<z.ZodString>;
909
+ name: z.ZodOptional<z.ZodString>;
910
+ in: z.ZodOptional<z.ZodEnum<{
911
+ query: "query";
912
+ header: "header";
913
+ cookie: "cookie";
914
+ }>>;
915
+ flows: z.ZodOptional<z.ZodObject<{
916
+ implicit: z.ZodOptional<z.ZodAny>;
917
+ password: z.ZodOptional<z.ZodAny>;
918
+ clientCredentials: z.ZodOptional<z.ZodAny>;
919
+ authorizationCode: z.ZodOptional<z.ZodAny>;
920
+ }, z.core.$strip>>;
921
+ openIdConnectUrl: z.ZodOptional<z.ZodString>;
922
+ description: z.ZodOptional<z.ZodString>;
923
+ }, z.core.$strip>>>;
924
+ tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
925
+ name: z.ZodString;
926
+ description: z.ZodOptional<z.ZodString>;
927
+ externalDocs: z.ZodOptional<z.ZodObject<{
928
+ description: z.ZodOptional<z.ZodString>;
929
+ url: z.ZodString;
930
+ }, z.core.$strip>>;
931
+ }, z.core.$strip>>>;
932
+ }, z.core.$strip> & {
933
+ create: <T extends z.input<typeof ApiDocumentationConfigSchema>>(config: T) => T;
934
+ };
935
+ /**
936
+ * Helper to create API test collection
937
+ */
938
+ export declare const ApiTestCollection: z.ZodObject<{
939
+ name: z.ZodString;
940
+ description: z.ZodOptional<z.ZodString>;
941
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
942
+ requests: z.ZodArray<z.ZodObject<{
943
+ name: z.ZodString;
944
+ description: z.ZodOptional<z.ZodString>;
945
+ method: z.ZodEnum<{
946
+ GET: "GET";
947
+ POST: "POST";
948
+ PUT: "PUT";
949
+ DELETE: "DELETE";
950
+ PATCH: "PATCH";
951
+ HEAD: "HEAD";
952
+ OPTIONS: "OPTIONS";
953
+ }>;
954
+ url: z.ZodString;
955
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
956
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
957
+ body: z.ZodOptional<z.ZodAny>;
958
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
959
+ expectedResponse: z.ZodOptional<z.ZodObject<{
960
+ statusCode: z.ZodNumber;
961
+ body: z.ZodOptional<z.ZodAny>;
962
+ }, z.core.$strip>>;
963
+ }, z.core.$strip>>;
964
+ folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
965
+ name: z.ZodString;
966
+ description: z.ZodOptional<z.ZodString>;
967
+ requests: z.ZodArray<z.ZodObject<{
968
+ name: z.ZodString;
969
+ description: z.ZodOptional<z.ZodString>;
970
+ method: z.ZodEnum<{
971
+ GET: "GET";
972
+ POST: "POST";
973
+ PUT: "PUT";
974
+ DELETE: "DELETE";
975
+ PATCH: "PATCH";
976
+ HEAD: "HEAD";
977
+ OPTIONS: "OPTIONS";
978
+ }>;
979
+ url: z.ZodString;
980
+ headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
981
+ queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
982
+ body: z.ZodOptional<z.ZodAny>;
983
+ variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
984
+ expectedResponse: z.ZodOptional<z.ZodObject<{
985
+ statusCode: z.ZodNumber;
986
+ body: z.ZodOptional<z.ZodAny>;
987
+ }, z.core.$strip>>;
988
+ }, z.core.$strip>>;
989
+ }, z.core.$strip>>>;
990
+ }, z.core.$strip> & {
991
+ create: <T extends z.input<typeof ApiTestCollectionSchema>>(config: T) => T;
992
+ };
993
+ /**
994
+ * Helper to create OpenAPI specification
995
+ */
996
+ export declare const OpenApiSpec: z.ZodObject<{
997
+ openapi: z.ZodDefault<z.ZodString>;
998
+ info: z.ZodObject<{
999
+ title: z.ZodString;
1000
+ version: z.ZodString;
1001
+ description: z.ZodOptional<z.ZodString>;
1002
+ termsOfService: z.ZodOptional<z.ZodString>;
1003
+ contact: z.ZodOptional<z.ZodObject<{
1004
+ name: z.ZodOptional<z.ZodString>;
1005
+ url: z.ZodOptional<z.ZodString>;
1006
+ email: z.ZodOptional<z.ZodString>;
1007
+ }, z.core.$strip>>;
1008
+ license: z.ZodOptional<z.ZodObject<{
1009
+ name: z.ZodString;
1010
+ url: z.ZodOptional<z.ZodString>;
1011
+ }, z.core.$strip>>;
1012
+ }, z.core.$strip>;
1013
+ servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
1014
+ url: z.ZodString;
1015
+ description: z.ZodOptional<z.ZodString>;
1016
+ variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
1017
+ default: z.ZodString;
1018
+ description: z.ZodOptional<z.ZodString>;
1019
+ enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
1020
+ }, z.core.$strip>>>;
1021
+ }, z.core.$strip>>>>;
1022
+ paths: z.ZodRecord<z.ZodString, z.ZodAny>;
1023
+ components: z.ZodOptional<z.ZodObject<{
1024
+ schemas: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1025
+ responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1026
+ parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1027
+ examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1028
+ requestBodies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1029
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1030
+ securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
1031
+ type: z.ZodEnum<{
1032
+ oauth2: "oauth2";
1033
+ apiKey: "apiKey";
1034
+ http: "http";
1035
+ openIdConnect: "openIdConnect";
1036
+ }>;
1037
+ scheme: z.ZodOptional<z.ZodString>;
1038
+ bearerFormat: z.ZodOptional<z.ZodString>;
1039
+ name: z.ZodOptional<z.ZodString>;
1040
+ in: z.ZodOptional<z.ZodEnum<{
1041
+ query: "query";
1042
+ header: "header";
1043
+ cookie: "cookie";
1044
+ }>>;
1045
+ flows: z.ZodOptional<z.ZodObject<{
1046
+ implicit: z.ZodOptional<z.ZodAny>;
1047
+ password: z.ZodOptional<z.ZodAny>;
1048
+ clientCredentials: z.ZodOptional<z.ZodAny>;
1049
+ authorizationCode: z.ZodOptional<z.ZodAny>;
1050
+ }, z.core.$strip>>;
1051
+ openIdConnectUrl: z.ZodOptional<z.ZodString>;
1052
+ description: z.ZodOptional<z.ZodString>;
1053
+ }, z.core.$strip>>>;
1054
+ links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1055
+ callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1056
+ }, z.core.$strip>>;
1057
+ security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>>;
1058
+ tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
1059
+ name: z.ZodString;
1060
+ description: z.ZodOptional<z.ZodString>;
1061
+ externalDocs: z.ZodOptional<z.ZodObject<{
1062
+ description: z.ZodOptional<z.ZodString>;
1063
+ url: z.ZodString;
1064
+ }, z.core.$strip>>;
1065
+ }, z.core.$strip>>>;
1066
+ externalDocs: z.ZodOptional<z.ZodObject<{
1067
+ description: z.ZodOptional<z.ZodString>;
1068
+ url: z.ZodString;
1069
+ }, z.core.$strip>>;
1070
+ }, z.core.$strip> & {
1071
+ create: <T extends z.input<typeof OpenApiSpecSchema>>(config: T) => T;
1072
+ };
1073
+ //# sourceMappingURL=documentation.zod.d.ts.map