@scalar/types 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/types
 
+## 0.3.1
+
+### Patch Changes
+
+- 1e01464: Adds a new ApiReferenceConfigWithSource type and make the base ApiReferenceConfig type agnostic of any document sources.
+- Updated dependencies [15c4240]
+  - @scalar/openapi-types@0.4.1
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/api-reference/api-client-configuration.d.ts

@@ -0,0 +1,122 @@
+import type z from 'zod';
+export declare const apiClientConfigurationSchema: z.ZodObject<{
+    authentication: z.ZodOptional<z.ZodAny>;
+    baseServerURL: z.ZodOptional<z.ZodString>;
+    hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    proxyUrl: z.ZodOptional<z.ZodString>;
+    searchHotKey: z.ZodOptional<z.ZodEnum<{
+        a: "a";
+        b: "b";
+        c: "c";
+        d: "d";
+        e: "e";
+        f: "f";
+        g: "g";
+        h: "h";
+        i: "i";
+        j: "j";
+        k: "k";
+        l: "l";
+        m: "m";
+        n: "n";
+        o: "o";
+        p: "p";
+        q: "q";
+        r: "r";
+        s: "s";
+        t: "t";
+        u: "u";
+        v: "v";
+        w: "w";
+        x: "x";
+        y: "y";
+        z: "z";
+    }>>;
+    servers: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    showToolbar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        never: "never";
+        always: "always";
+        localhost: "localhost";
+    }>>>>;
+    operationTitleSource: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        summary: "summary";
+        path: "path";
+    }>>>>;
+    theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        default: "default";
+        alternate: "alternate";
+        moon: "moon";
+        purple: "purple";
+        solarized: "solarized";
+        bluePlanet: "bluePlanet";
+        deepSpace: "deepSpace";
+        saturn: "saturn";
+        kepler: "kepler";
+        elysiajs: "elysiajs";
+        fastify: "fastify";
+        mars: "mars";
+        laserwave: "laserwave";
+        none: "none";
+    }>>>>;
+    _integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        elysiajs: "elysiajs";
+        fastify: "fastify";
+        adonisjs: "adonisjs";
+        docusaurus: "docusaurus";
+        dotnet: "dotnet";
+        express: "express";
+        fastapi: "fastapi";
+        go: "go";
+        hono: "hono";
+        html: "html";
+        laravel: "laravel";
+        litestar: "litestar";
+        nestjs: "nestjs";
+        nextjs: "nextjs";
+        nitro: "nitro";
+        nuxt: "nuxt";
+        platformatic: "platformatic";
+        react: "react";
+        rust: "rust";
+        svelte: "svelte";
+        vue: "vue";
+    }>>>;
+    onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>;
+    persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
+        name: z.ZodString;
+        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>>;
+            }, z.core.$strip>>>;
+            '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>>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>;
+        hooks: z.ZodOptional<z.ZodObject<{
+            onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
+                request: z.ZodCustom<Request, Request>;
+            }, z.core.$strip>], null>, z.ZodUnion<readonly [z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+            onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
+                response: z.ZodCustom<Response, Response>;
+                operation: z.ZodRecord<z.ZodString, z.ZodAny>;
+            }, z.core.$strip>], null>, z.ZodUnion<readonly [z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>>;
+    telemetry: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    url: z.ZodOptional<z.ZodString>;
+    content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
+    title: z.ZodOptional<z.ZodString>;
+    slug: z.ZodOptional<z.ZodString>;
+    spec: z.ZodOptional<z.ZodObject<{
+        url: z.ZodOptional<z.ZodString>;
+        content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>;
+//# sourceMappingURL=api-client-configuration.d.ts.map

package/dist/api-reference/api-client-configuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-client-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-client-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAKxB,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAkE,CAAA;AAE3G,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA"}

package/dist/api-reference/api-client-configuration.js

@@ -0,0 +1,7 @@
+import { baseConfigurationSchema } from "./base-configuration.js";
+import { sourceConfigurationSchema } from "./source-configuration.js";
+const apiClientConfigurationSchema = baseConfigurationSchema.extend(sourceConfigurationSchema.shape);
+export {
+  apiClientConfigurationSchema
+};
+//# sourceMappingURL=api-client-configuration.js.map

package/dist/api-reference/api-client-configuration.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/api-reference/api-client-configuration.ts"],
+  "sourcesContent": ["import type z from 'zod'\n\nimport { baseConfigurationSchema } from './base-configuration'\nimport { sourceConfigurationSchema } from './source-configuration'\n\nexport const apiClientConfigurationSchema = baseConfigurationSchema.extend(sourceConfigurationSchema.shape)\n\nexport type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>\n"],
+  "mappings": "AAEA,SAAS,+BAA+B;AACxC,SAAS,iCAAiC;AAEnC,MAAM,+BAA+B,wBAAwB,OAAO,0BAA0B,KAAK;",
+  "names": []
+}

package/dist/{api-client → api-reference}/api-client-plugin.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export declare const HooksSchema: z.ZodObject<{
+export declare const hooksSchema: z.ZodObject<{
     onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
         request: z.ZodCustom<Request, Request>;
     }, z.core.$strip>], null>, z.ZodUnion<readonly [z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
@@ -8,7 +8,10 @@ export declare const HooksSchema: z.ZodObject<{
         operation: z.ZodRecord<z.ZodString, z.ZodAny>;
     }, z.core.$strip>], null>, z.ZodUnion<readonly [z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
 }, z.core.$strip>;
-export declare const ApiClientPluginSchema: z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
+/**
+ * An API client plugin that can connect into request and response hooks
+ */
+export declare const apiClientPluginSchema: z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
     name: z.ZodString;
     views: z.ZodOptional<z.ZodObject<{
         'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -32,5 +35,5 @@ export declare const ApiClientPluginSchema: z.ZodFunction<z.ZodTuple<readonly []
         }, z.core.$strip>], null>, z.ZodUnion<readonly [z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>>;
-export type ApiClientPlugin = z.infer<typeof ApiClientPluginSchema>;
+export type ApiClientPlugin = z.infer<typeof apiClientPluginSchema>;
 //# sourceMappingURL=api-client-plugin.d.ts.map

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

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

package/dist/{api-client → api-reference}/api-client-plugin.js

@@ -1,15 +1,15 @@
 import { z } from "zod";
-const SectionViewSchema = z.object({
+const sectionViewSchema = z.object({
   title: z.string().optional(),
   // Since this is meant to be a Vue component, we'll use unknown
   component: z.unknown(),
   props: z.record(z.string(), z.any()).optional()
 });
-const ViewsSchema = z.object({
-  "request.section": z.array(SectionViewSchema).optional(),
-  "response.section": z.array(SectionViewSchema).optional()
+const viewsSchema = z.object({
+  "request.section": z.array(sectionViewSchema).optional(),
+  "response.section": z.array(sectionViewSchema).optional()
 });
-const HooksSchema = z.object({
+const hooksSchema = z.object({
   onBeforeRequest: z.function({
     input: [z.object({ request: z.instanceof(Request) })],
     output: z.union([z.void(), z.promise(z.void())])
@@ -19,16 +19,16 @@ const HooksSchema = z.object({
     output: z.union([z.void(), z.promise(z.void())])
   }).optional()
 });
-const ApiClientPluginSchema = z.function({
+const apiClientPluginSchema = z.function({
   input: [],
   output: z.object({
     name: z.string(),
-    views: ViewsSchema.optional(),
-    hooks: HooksSchema.optional()
+    views: viewsSchema.optional(),
+    hooks: hooksSchema.optional()
   })
 });
 export {
-  ApiClientPluginSchema,
-  HooksSchema
+  apiClientPluginSchema,
+  hooksSchema
 };
 //# sourceMappingURL=api-client-plugin.js.map

package/dist/{api-client → api-reference}/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.string(), 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      input: [z.object({ request: z.instanceof(Request) })],\n      output: z.union([z.void(), z.promise(z.void())]),\n    })\n    .optional(),\n  onResponseReceived: z\n    .function({\n      input: [z.object({ response: z.instanceof(Response), operation: z.record(z.string(), z.any()) })],\n      output: z.union([z.void(), z.promise(z.void())]),\n    })\n    .optional(),\n})\n\nexport const ApiClientPluginSchema = z.function({\n  input: [],\n  output: 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,OAAO,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS;AAChD,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;AAAA,IACR,OAAO,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,OAAO,EAAE,CAAC,CAAC;AAAA,IACpD,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAAA,EACjD,CAAC,EACA,SAAS;AAAA,EACZ,oBAAoB,EACjB,SAAS;AAAA,IACR,OAAO,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,QAAQ,GAAG,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;AAAA,IAChG,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAAA,EACjD,CAAC,EACA,SAAS;AACd,CAAC;AAEM,MAAM,wBAAwB,EAAE,SAAS;AAAA,EAC9C,OAAO,CAAC;AAAA,EACR,QAAQ,EAAE,OAAO;AAAA,IACf,MAAM,EAAE,OAAO;AAAA,IACf,OAAO,YAAY,SAAS;AAAA,IAC5B,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AACH,CAAC;",
+  "sources": ["../../src/api-reference/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.string(), 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      input: [z.object({ request: z.instanceof(Request) })],\n      output: z.union([z.void(), z.promise(z.void())]),\n    })\n    .optional(),\n  onResponseReceived: z\n    .function({\n      input: [z.object({ response: z.instanceof(Response), operation: z.record(z.string(), z.any()) })],\n      output: z.union([z.void(), z.promise(z.void())]),\n    })\n    .optional(),\n})\n\n/**\n * An API client plugin that can connect into request and response hooks\n */\nexport const apiClientPluginSchema = z.function({\n  input: [],\n  output: 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,OAAO,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS;AAChD,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;AAAA,IACR,OAAO,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,OAAO,EAAE,CAAC,CAAC;AAAA,IACpD,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAAA,EACjD,CAAC,EACA,SAAS;AAAA,EACZ,oBAAoB,EACjB,SAAS;AAAA,IACR,OAAO,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,QAAQ,GAAG,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;AAAA,IAChG,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAAA,EACjD,CAAC,EACA,SAAS;AACd,CAAC;AAKM,MAAM,wBAAwB,EAAE,SAAS;AAAA,EAC9C,OAAO,CAAC;AAAA,EACR,QAAQ,EAAE,OAAO;AAAA,IACf,MAAM,EAAE,OAAO;AAAA,IACf,OAAO,YAAY,SAAS;AAAA,IAC5B,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AACH,CAAC;",
   "names": []
 }