@scalar/types 0.2.5 → 0.2.7

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scalar/types
 
+## 0.2.7
+
+### Patch Changes
+
+- ad2e3e6: feat: new onBeforeRequest hook to modify the request
+
+## 0.2.6
+
+### Patch Changes
+
+- 2d7f995: refactor: use more common straight apostrophe ' instead of the real apostrophe ’
+- Updated dependencies [2d7f995]
+  - @scalar/openapi-types@0.3.5
+
 ## 0.2.5
 
 ### Patch Changes

package/dist/api-client/api-client-plugin.d.ts

@@ -1,8 +1,43 @@
 import { z } from 'zod';
+export declare const HooksSchema: z.ZodObject<{
+    onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
+        request: z.ZodType<Request, z.ZodTypeDef, Request>;
+    }, "strip", z.ZodTypeAny, {
+        request: Request;
+    }, {
+        request: Request;
+    }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+    onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
+        response: z.ZodType<Response, z.ZodTypeDef, Response>;
+        operation: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        response: Response;
+        operation: Record<string, any>;
+    }, {
+        response: Response;
+        operation: Record<string, any>;
+    }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+}, "strip", z.ZodTypeAny, {
+    onBeforeRequest?: ((args_0: {
+        request: Request;
+    }, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onResponseReceived?: ((args_0: {
+        response: Response;
+        operation: Record<string, any>;
+    }, ...args: unknown[]) => void | Promise<void>) | undefined;
+}, {
+    onBeforeRequest?: ((args_0: {
+        request: Request;
+    }, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onResponseReceived?: ((args_0: {
+        response: Response;
+        operation: Record<string, any>;
+    }, ...args: unknown[]) => void | Promise<void>) | undefined;
+}>;
 export declare const ApiClientPluginSchema: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
     name: z.ZodString;
-    views: z.ZodObject<{
-        'request.section': z.ZodArray<z.ZodObject<{
+    views: z.ZodOptional<z.ZodObject<{
+        'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
             title: z.ZodOptional<z.ZodString>;
             component: z.ZodUnknown;
             props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
@@ -14,8 +49,8 @@ export declare const ApiClientPluginSchema: z.ZodFunction<z.ZodTuple<[], z.ZodUn
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }>, "many">;
-        'response.section': z.ZodArray<z.ZodObject<{
+        }>, "many">>;
+        'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
             title: z.ZodOptional<z.ZodString>;
             component: z.ZodUnknown;
             props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
@@ -27,33 +62,39 @@ export declare const ApiClientPluginSchema: z.ZodFunction<z.ZodTuple<[], z.ZodUn
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }>, "many">;
+        }>, "many">>;
     }, "strip", z.ZodTypeAny, {
-        'request.section': {
+        'request.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
-        'response.section': {
+        }[] | undefined;
+        'response.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
+        }[] | undefined;
     }, {
-        'request.section': {
+        'request.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
-        'response.section': {
+        }[] | undefined;
+        'response.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
-    }>;
-    hooks: z.ZodObject<{
-        onBeforeRequest: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
-        onResponseReceived: z.ZodFunction<z.ZodTuple<[z.ZodObject<{
+        }[] | undefined;
+    }>>;
+    hooks: z.ZodOptional<z.ZodObject<{
+        onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
+            request: z.ZodType<Request, z.ZodTypeDef, Request>;
+        }, "strip", z.ZodTypeAny, {
+            request: Request;
+        }, {
+            request: Request;
+        }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+        onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
             response: z.ZodType<Response, z.ZodTypeDef, Response>;
             operation: z.ZodRecord<z.ZodString, z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
@@ -62,62 +103,70 @@ export declare const ApiClientPluginSchema: z.ZodFunction<z.ZodTuple<[], z.ZodUn
         }, {
             response: Response;
             operation: Record<string, any>;
-        }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
+        }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
     }, "strip", z.ZodTypeAny, {
-        onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
-        onResponseReceived: (args_0: {
+        onBeforeRequest?: ((args_0: {
+            request: Request;
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
+        onResponseReceived?: ((args_0: {
             response: Response;
             operation: Record<string, any>;
-        }, ...args: unknown[]) => void | Promise<void>;
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
     }, {
-        onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
-        onResponseReceived: (args_0: {
+        onBeforeRequest?: ((args_0: {
+            request: Request;
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
+        onResponseReceived?: ((args_0: {
             response: Response;
             operation: Record<string, any>;
-        }, ...args: unknown[]) => void | Promise<void>;
-    }>;
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    views: {
-        'request.section': {
+    views?: {
+        'request.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
-        'response.section': {
+        }[] | undefined;
+        'response.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
-    };
-    hooks: {
-        onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
-        onResponseReceived: (args_0: {
+        }[] | undefined;
+    } | undefined;
+    hooks?: {
+        onBeforeRequest?: ((args_0: {
+            request: Request;
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
+        onResponseReceived?: ((args_0: {
             response: Response;
             operation: Record<string, any>;
-        }, ...args: unknown[]) => void | Promise<void>;
-    };
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
+    } | undefined;
 }, {
     name: string;
-    views: {
-        'request.section': {
+    views?: {
+        'request.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
-        'response.section': {
+        }[] | undefined;
+        'response.section'?: {
             title?: string | undefined;
             component?: unknown;
             props?: Record<string, any> | undefined;
-        }[];
-    };
-    hooks: {
-        onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
-        onResponseReceived: (args_0: {
+        }[] | undefined;
+    } | undefined;
+    hooks?: {
+        onBeforeRequest?: ((args_0: {
+            request: Request;
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
+        onResponseReceived?: ((args_0: {
             response: Response;
             operation: Record<string, any>;
-        }, ...args: unknown[]) => void | Promise<void>;
-    };
+        }, ...args: unknown[]) => void | Promise<void>) | undefined;
+    } | undefined;
 }>>;
 export type ApiClientPlugin = z.infer<typeof ApiClientPluginSchema>;
 //# sourceMappingURL=api-client-plugin.d.ts.map

package/dist/api-client/api-client-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-client-plugin.d.ts","sourceRoot":"","sources":["../../src/api-client/api-client-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA4BvB,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAMjC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}
+{"version":3,"file":"api-client-plugin.d.ts","sourceRoot":"","sources":["../../src/api-client/api-client-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAcvB,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBtB,CAAA;AAEF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAMjC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}

package/dist/api-client/api-client-plugin.js

@@ -6,27 +6,28 @@ const SectionViewSchema = z.object({
   props: z.record(z.any()).optional()
 });
 const ViewsSchema = z.object({
-  "request.section": z.array(SectionViewSchema),
-  "response.section": z.array(SectionViewSchema)
+  "request.section": z.array(SectionViewSchema).optional(),
+  "response.section": z.array(SectionViewSchema).optional()
 });
 const HooksSchema = z.object({
-  onBeforeRequest: z.function().returns(z.union([z.void(), z.promise(z.void())])),
+  onBeforeRequest: z.function().args(z.object({ request: z.instanceof(Request) })).returns(z.union([z.void(), z.promise(z.void())])).optional(),
   onResponseReceived: z.function().args(
     z.object({
       response: z.instanceof(Response),
       // Ideally, we'd have the Operation type here, but we don't.
       operation: z.record(z.any())
     })
-  ).returns(z.union([z.void(), z.promise(z.void())]))
+  ).returns(z.union([z.void(), z.promise(z.void())])).optional()
 });
 const ApiClientPluginSchema = z.function().returns(
   z.object({
     name: z.string(),
-    views: ViewsSchema,
-    hooks: HooksSchema
+    views: ViewsSchema.optional(),
+    hooks: HooksSchema.optional()
   })
 );
 export {
-  ApiClientPluginSchema
+  ApiClientPluginSchema,
+  HooksSchema
 };
 //# sourceMappingURL=api-client-plugin.js.map

package/dist/api-client/api-client-plugin.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/api-client/api-client-plugin.ts"],
-  "sourcesContent": ["import { z } from 'zod'\n\nconst SectionViewSchema = z.object({\n  title: z.string().optional(),\n  // Since this is meant to be a Vue component, we'll use unknown\n  component: z.unknown(),\n  props: z.record(z.any()).optional(),\n})\n\nconst ViewsSchema = z.object({\n  'request.section': z.array(SectionViewSchema),\n  'response.section': z.array(SectionViewSchema),\n})\n\nconst HooksSchema = z.object({\n  onBeforeRequest: z.function().returns(z.union([z.void(), z.promise(z.void())])),\n  onResponseReceived: z\n    .function()\n    .args(\n      z.object({\n        response: z.instanceof(Response),\n        // Ideally, we'd have the Operation type here, but we don't.\n        operation: z.record(z.any()),\n      }),\n    )\n    .returns(z.union([z.void(), z.promise(z.void())])),\n})\n\nexport const ApiClientPluginSchema = z.function().returns(\n  z.object({\n    name: z.string(),\n    views: ViewsSchema,\n    hooks: HooksSchema,\n  }),\n)\n\nexport type ApiClientPlugin = z.infer<typeof ApiClientPluginSchema>\n"],
-  "mappings": "AAAA,SAAS,SAAS;AAElB,MAAM,oBAAoB,EAAE,OAAO;AAAA,EACjC,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE3B,WAAW,EAAE,QAAQ;AAAA,EACrB,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,SAAS;AACpC,CAAC;AAED,MAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,mBAAmB,EAAE,MAAM,iBAAiB;AAAA,EAC5C,oBAAoB,EAAE,MAAM,iBAAiB;AAC/C,CAAC;AAED,MAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,iBAAiB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAAA,EAC9E,oBAAoB,EACjB,SAAS,EACT;AAAA,IACC,EAAE,OAAO;AAAA,MACP,UAAU,EAAE,WAAW,QAAQ;AAAA;AAAA,MAE/B,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,IAC7B,CAAC;AAAA,EACH,EACC,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AAEM,MAAM,wBAAwB,EAAE,SAAS,EAAE;AAAA,EAChD,EAAE,OAAO;AAAA,IACP,MAAM,EAAE,OAAO;AAAA,IACf,OAAO;AAAA,IACP,OAAO;AAAA,EACT,CAAC;AACH;",
+  "sourcesContent": ["import { z } from 'zod'\n\nconst SectionViewSchema = z.object({\n  title: z.string().optional(),\n  // Since this is meant to be a Vue component, we'll use unknown\n  component: z.unknown(),\n  props: z.record(z.any()).optional(),\n})\n\nconst ViewsSchema = z.object({\n  'request.section': z.array(SectionViewSchema).optional(),\n  'response.section': z.array(SectionViewSchema).optional(),\n})\n\nexport const HooksSchema = z.object({\n  onBeforeRequest: z\n    .function()\n    .args(z.object({ request: z.instanceof(Request) }))\n    .returns(z.union([z.void(), z.promise(z.void())]))\n    .optional(),\n  onResponseReceived: z\n    .function()\n    .args(\n      z.object({\n        response: z.instanceof(Response),\n        // Ideally, we'd have the Operation type here, but we don't.\n        operation: z.record(z.any()),\n      }),\n    )\n    .returns(z.union([z.void(), z.promise(z.void())]))\n    .optional(),\n})\n\nexport const ApiClientPluginSchema = z.function().returns(\n  z.object({\n    name: z.string(),\n    views: ViewsSchema.optional(),\n    hooks: HooksSchema.optional(),\n  }),\n)\n\nexport type ApiClientPlugin = z.infer<typeof ApiClientPluginSchema>\n"],
+  "mappings": "AAAA,SAAS,SAAS;AAElB,MAAM,oBAAoB,EAAE,OAAO;AAAA,EACjC,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE3B,WAAW,EAAE,QAAQ;AAAA,EACrB,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,SAAS;AACpC,CAAC;AAED,MAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,mBAAmB,EAAE,MAAM,iBAAiB,EAAE,SAAS;AAAA,EACvD,oBAAoB,EAAE,MAAM,iBAAiB,EAAE,SAAS;AAC1D,CAAC;AAEM,MAAM,cAAc,EAAE,OAAO;AAAA,EAClC,iBAAiB,EACd,SAAS,EACT,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,OAAO,EAAE,CAAC,CAAC,EACjD,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,SAAS;AAAA,EACZ,oBAAoB,EACjB,SAAS,EACT;AAAA,IACC,EAAE,OAAO;AAAA,MACP,UAAU,EAAE,WAAW,QAAQ;AAAA;AAAA,MAE/B,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,IAC7B,CAAC;AAAA,EACH,EACC,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,SAAS;AACd,CAAC;AAEM,MAAM,wBAAwB,EAAE,SAAS,EAAE;AAAA,EAChD,EAAE,OAAO;AAAA,IACP,MAAM,EAAE,OAAO;AAAA,IACf,OAAO,YAAY,SAAS;AAAA,IAC5B,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AACH;",
   "names": []
 }

package/dist/api-client/index.d.ts

@@ -1,2 +1,2 @@
-export { type ApiClientPlugin, ApiClientPluginSchema } from './api-client-plugin.js';
+export { type ApiClientPlugin, ApiClientPluginSchema, HooksSchema } from './api-client-plugin.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/api-client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA"}

package/dist/api-client/index.js

@@ -1,5 +1,6 @@
-import { ApiClientPluginSchema } from "./api-client-plugin.js";
+import { ApiClientPluginSchema, HooksSchema } from "./api-client-plugin.js";
 export {
-  ApiClientPluginSchema
+  ApiClientPluginSchema,
+  HooksSchema
 };
 //# sourceMappingURL=index.js.map

package/dist/api-client/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/api-client/index.ts"],
-  "sourcesContent": ["export { type ApiClientPlugin, ApiClientPluginSchema } from './api-client-plugin'\n"],
-  "mappings": "AAAA,SAA+B,6BAA6B;",
+  "sourcesContent": ["export { type ApiClientPlugin, ApiClientPluginSchema, HooksSchema } from './api-client-plugin'\n"],
+  "mappings": "AAAA,SAA+B,uBAAuB,mBAAmB;",
   "names": []
 }