@scalar/api-reference 0.5.6 → 0.6.1

package/dist/stores/template.d.ts

@@ -6,18 +6,23 @@ export declare enum NavState {
     Guide = "Guide",
     Reference = "Reference"
 }
+export type SelectedClient = {
+    targetKey: TargetId;
+    clientKey: string;
+};
 type TemplateState = {
     isDark: boolean;
     showSideBar: boolean;
     showSearch: boolean;
     activeNavState: NavState;
     collapsedSidebarItems: Partial<Record<string, boolean>>;
-    preferredLanguage: TargetId | 'axios' | 'laravel';
+    selectedClient: SelectedClient;
 };
 declare function resetState(): void;
 declare function toggleCollapsedSidebarItem(key: string): void;
 declare function setCollapsedSidebarItem(key: string, value: boolean): void;
-declare function getLanguageTitleByKey(language: TargetId | 'axios' | 'laravel'): string | undefined;
+declare function getTargetTitle(client: SelectedClient): string;
+declare function getClientTitle(client: SelectedClient): string;
 export declare const useTemplateStore: () => {
     state: {
         readonly isDark: boolean;
@@ -27,7 +32,10 @@ export declare const useTemplateStore: () => {
         readonly collapsedSidebarItems: {
             readonly [x: string]: boolean | undefined;
         };
-        readonly preferredLanguage: TargetId | 'axios' | 'laravel';
+        readonly selectedClient: {
+            readonly targetKey: TargetId;
+            readonly clientKey: string;
+        };
     };
     resetState: typeof resetState;
     setItem: <K extends keyof TemplateState>(key: K, value: {
@@ -36,12 +44,16 @@ export declare const useTemplateStore: () => {
         showSearch: boolean;
         activeNavState: NavState;
         collapsedSidebarItems: Partial<Record<string, boolean>>;
-        preferredLanguage: TargetId | 'axios' | 'laravel';
+        selectedClient: {
+            targetKey: TargetId;
+            clientKey: string;
+        };
     }[K]) => void;
     toggleItem: (key: "isDark" | "showSideBar" | "showSearch") => void;
     toggleCollapsedSidebarItem: typeof toggleCollapsedSidebarItem;
     setCollapsedSidebarItem: typeof setCollapsedSidebarItem;
-    getLanguageTitleByKey: typeof getLanguageTitleByKey;
+    getClientTitle: typeof getClientTitle;
+    getTargetTitle: typeof getTargetTitle;
 };
 export {};
 //# sourceMappingURL=template.d.ts.map

package/dist/stores/template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../src/stores/template.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,QAAQ,EAAoB,MAAM,kBAAkB,CAAA;AAMlE,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,SAAS,cAAc;CACxB;AAED,KAAK,aAAa,GAAG;IACnB,MAAM,EAAE,OAAO,CAAA;IACf,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,OAAO,CAAA;IACnB,cAAc,EAAE,QAAQ,CAAA;IACxB,qBAAqB,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACvD,iBAAiB,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAA;CAClD,CAAA;AAaD,iBAAS,UAAU,SAElB;AAED,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AAGD,iBAAS,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,sBAQtE;AAED,eAAO,MAAM,gBAAgB;;yBA1CnB,OAAO;8BACF,OAAO;6BACR,OAAO;iCACH,QAAQ;;;;oCAEL,QAAQ,GAAG,OAAO,GAAG,SAAS;;;;gBALzC,OAAO;qBACF,OAAO;oBACR,OAAO;wBACH,QAAQ;+BACD,QAAQ,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC;2BACpC,QAAQ,GAAG,OAAO,GAAG,SAAS;;;;;;CA6CjD,CAAA"}
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../src/stores/template.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,QAAQ,EAAoB,MAAM,kBAAkB,CAAA;AAMlE,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,cAAc,GAAG;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvE,KAAK,aAAa,GAAG;IACnB,MAAM,EAAE,OAAO,CAAA;IACf,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,OAAO,CAAA;IACnB,cAAc,EAAE,QAAQ,CAAA;IACxB,qBAAqB,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACvD,cAAc,EAAE,cAAc,CAAA;CAC/B,CAAA;AAgBD,iBAAS,UAAU,SAElB;AAED,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AAID,iBAAS,cAAc,CAAC,MAAM,EAAE,cAAc,UAK7C;AAID,iBAAS,cAAc,CAAC,MAAM,EAAE,cAAc,UAO7C;AAED,eAAO,MAAM,gBAAgB;;yBAtDnB,OAAO;8BACF,OAAO;6BACR,OAAO;iCACH,QAAQ;;;;;gCANgB,QAAQ;gCAAa,MAAM;;;;;gBAG3D,OAAO;qBACF,OAAO;oBACR,OAAO;wBACH,QAAQ;+BACD,QAAQ,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC;;uBAPf,QAAQ;uBAAa,MAAM;;;;;;;;CAkEnE,CAAA"}

package/dist/stories/Card.stories.d.ts

@@ -0,0 +1,8 @@
+import '@scalar/default-theme/theme.css';
+import type { Meta, StoryObj } from '@storybook/vue3';
+import { Card } from '../components/Card';
+declare const meta: Meta<typeof Card>;
+export default meta;
+type Story = StoryObj<typeof Card>;
+export declare const Primary: Story;
+//# sourceMappingURL=Card.stories.d.ts.map

package/dist/stories/Card.stories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Card.stories.d.ts","sourceRoot":"","sources":["../../src/stories/Card.stories.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAErD,OAAO,EAAE,IAAI,EAAuC,MAAM,oBAAoB,CAAA;AAE9E,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,IAAI,CAI3B,CAAA;AAED,eAAe,IAAI,CAAA;AAEnB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAA;AAElC,eAAO,MAAM,OAAO,EAAE,KAiCrB,CAAA"}

package/dist/stories/CardContent.stories.d.ts

@@ -0,0 +1,10 @@
+import '@scalar/default-theme/theme.css';
+import type { Meta, StoryObj } from '@storybook/vue3';
+import { CardContent } from '../components/Card';
+declare const meta: Meta<typeof CardContent>;
+export default meta;
+type Story = StoryObj<typeof CardContent>;
+export declare const Default: Story;
+export declare const Muted: Story;
+export declare const Frameless: Story;
+//# sourceMappingURL=CardContent.stories.d.ts.map

package/dist/stories/CardContent.stories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CardContent.stories.d.ts","sourceRoot":"","sources":["../../src/stories/CardContent.stories.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAErD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhD,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,WAAW,CAIlC,CAAA;AAED,eAAe,IAAI,CAAA;AAEnB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,WAAW,CAAC,CAAA;AAEzC,eAAO,MAAM,OAAO,EAAE,KAiBrB,CAAA;AAED,eAAO,MAAM,KAAK,EAAE,KAmBnB,CAAA;AAED,eAAO,MAAM,SAAS,EAAE,KAmBvB,CAAA"}

package/dist/stories/ExampleRequest.stories.d.ts

@@ -0,0 +1,7 @@
+import type { Meta, StoryObj } from '@storybook/vue3';
+import { default as ExampleRequest } from '../components/Content/ReferenceEndpoint/ExampleRequest.vue';
+declare const meta: Meta<typeof ExampleRequest>;
+export default meta;
+type Story = StoryObj<typeof ExampleRequest>;
+export declare const Primary: Story;
+//# sourceMappingURL=ExampleRequest.stories.d.ts.map

package/dist/stories/ExampleRequest.stories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleRequest.stories.d.ts","sourceRoot":"","sources":["../../src/stories/ExampleRequest.stories.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAErD,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,4DAA4D,CAAA;AAEtG,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,cAAc,CAIrC,CAAA;AAED,eAAe,IAAI,CAAA;AAEnB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,cAAc,CAAC,CAAA;AAO5C,eAAO,MAAM,OAAO,EAAE,KAwVrB,CAAA"}

package/package.json

@@ -1,99 +1,111 @@
 {
   "name": "@scalar/api-reference",
   "description": "generate beautiful API references from OpenAPI specs",
-  "keywords": [
-    "vue",
-    "vue3",
-    "swagger",
-    "openapi",
-    "spec",
-    "reference",
-    "documentation",
-    "component"
-  ],
-  "version": "0.5.6",
+  "version": "0.6.1",
   "author": "Scalar (https://github.com/scalar)",
-  "homepage": "https://github.com/scalar/scalar",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/scalar/scalar.git",
-    "directory": "packages/api-reference"
+  "browser": "./dist/browser/standalone.js",
+  "bugs": "https://github.com/scalar/scalar/issues/new",
+  "dependencies": {
+    "@headlessui/vue": "1.7.16",
+    "@vueuse/core": "10.4.1",
+    "fuse.js": "6.6.2",
+    "httpsnippet-lite": "3.0.5",
+    "js-yaml": "4.1.0",
+    "modern-normalize": "2.0.0",
+    "nanoid": "5.0.1",
+    "postcss-nested": "6.0.1",
+    "rehype-document": "7.0.1",
+    "rehype-format": "5.0.0",
+    "rehype-sanitize": "6.0.0",
+    "rehype-stringify": "10.0.0",
+    "remark-breaks": "3.0.3",
+    "remark-gfm": "4.0.0",
+    "remark-parse": "11.0.0",
+    "remark-rehype": "11.0.0",
+    "remark-textr": "6.0.0",
+    "typographic-base": "1.0.4",
+    "unified": "11.0.3",
+    "xmldom": "0.6.0",
+    "@scalar/api-client": "0.6.0",
+    "@scalar/default-theme": "0.3.0",
+    "@scalar/swagger-editor": "0.6.0",
+    "@scalar/swagger-parser": "0.5.0",
+    "@scalar/use-clipboard": "0.5.0",
+    "@scalar/use-codemirror": "0.6.0",
+    "@scalar/use-keyboard-event": "0.5.0",
+    "@scalar/use-toasts": "0.5.0",
+    "@scalar/use-tooltip": "0.5.0"
   },
-  "bugs": {
-    "url": "https://github.com/scalar/scalar/issues/new"
+  "devDependencies": {
+    "@storybook/addon-essentials": "7.4.3",
+    "@storybook/addon-interactions": "7.4.3",
+    "@storybook/addon-links": "7.4.3",
+    "@storybook/blocks": "7.4.3",
+    "@storybook/testing-library": "0.2.1",
+    "@storybook/vue3": "7.4.3",
+    "@storybook/vue3-vite": "7.4.3",
+    "@vitejs/plugin-vue": "4.3.4",
+    "@vitest/coverage-v8": "0.34.4",
+    "http-server": "14.1.1",
+    "postcss": "8.4.30",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "storybook": "7.4.3",
+    "tsc-alias": "1.8.8",
+    "vite": "4.4.9",
+    "vite-plugin-css-injected-by-js": "3.3.0",
+    "vite-plugin-node-polyfills": "0.14.1",
+    "vitest": "0.34.4",
+    "vue-tsc": "1.8.13"
   },
-  "license": "MIT",
   "engines": {
     "node": ">=18"
   },
-  "type": "module",
+  "exports": {
+    "import": "./dist/index.js"
+  },
   "files": [
     "dist"
   ],
+  "homepage": "https://github.com/scalar/scalar",
+  "keywords": [
+    "component",
+    "documentation",
+    "openapi",
+    "reference",
+    "spec",
+    "swagger",
+    "vue",
+    "vue3"
+  ],
+  "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
-  "exports": {
-    "import": "./dist/index.js"
-  },
-  "types": "dist/index.d.ts",
-  "dependencies": {
-    "@headlessui/vue": "1.7.14",
-    "@vueuse/core": "10.1.2",
-    "fuse.js": "^6.6.2",
-    "httpsnippet-lite": "3.0.5",
-    "js-yaml": "4.1.0",
-    "modern-normalize": "^2.0.0",
-    "nanoid": "4.0.2",
-    "postcss-nested": "^6.0.1",
-    "rehype-document": "6.1.0",
-    "rehype-format": "4.0.1",
-    "rehype-sanitize": "5.0.1",
-    "rehype-stringify": "9.0.3",
-    "remark-breaks": "^3.0.3",
-    "remark-gfm": "3.0.1",
-    "remark-parse": "10.0.2",
-    "remark-rehype": "10.1.0",
-    "remark-textr": "5.0.1",
-    "typographic-base": "1.0.4",
-    "unified": "10.1.2",
-    "xmldom": "0.6.0",
-    "@scalar/api-client": "0.5.5",
-    "@scalar/default-theme": "0.2.1",
-    "@scalar/swagger-editor": "0.5.6",
-    "@scalar/swagger-parser": "0.4.3",
-    "@scalar/use-clipboard": "0.4.2",
-    "@scalar/use-codemirror": "0.5.4",
-    "@scalar/use-keyboard-event": "0.4.2",
-    "@scalar/use-toasts": "0.4.1",
-    "@scalar/use-tooltip": "0.4.2"
-  },
-  "devDependencies": {
-    "@vitejs/plugin-vue": "4.2.3",
-    "http-server": "^14.1.1",
-    "postcss": "^8.4.28",
-    "tsc-alias": "1.8.6",
-    "vite": "4.4.8",
-    "vite-plugin-css-injected-by-js": "^3.3.0",
-    "vite-plugin-node-polyfills": "^0.11.2",
-    "vitest": "0.34.1",
-    "@vitest/coverage-v8": "^0.34.4",
-    "vue-tsc": "1.8.8"
-  },
   "peerDependencies": {
-    "vue": "3.3.4",
-    "@types/js-yaml": "4.0.5",
-    "@types/xmldom": "0.1.31"
+    "@types/js-yaml": "4.0.6",
+    "@types/xmldom": "0.1.31",
+    "vue": "3.3.4"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scalar/scalar.git",
+    "directory": "packages/api-reference"
+  },
+  "type": "module",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "build": "vite build && pnpm types:build && tsc-alias -p tsconfig.build.json",
+    "build": "pnpm build:default && pnpm build:cdn && pnpm types:build && tsc-alias -p tsconfig.build.json",
+    "build:default": "vite build",
+    "build:cdn": "vite build -c vite.cdn.config.ts",
+    "build:storybook": "storybook build",
     "dev": "vite",
     "lint:check": "eslint .",
     "lint:fix": "eslint .  --fix",
     "preview": "vite preview",
+    "preview:cdn": "http-server",
+    "storybook": "storybook dev -p 6006",
     "test": "vitest",
     "types:build": "vue-tsc -p tsconfig.build.json",
-    "types:check": "vue-tsc --noEmit --skipLibCheck",
-    "build:cdn": "vite build -c vite.cdn.config.ts",
-    "preview:cdn": "http-server"
+    "types:check": "vue-tsc --noEmit --skipLibCheck"
   }
 }

package/dist/components/Content/Introduction/LanguageSelector.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LanguageSelector.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/LanguageSelector.vue.ts"],"names":[],"mappings":";AAmXA,wBAAkD"}

package/dist/helpers/generateAxiosCodeFromRequest.d.ts

@@ -1,12 +0,0 @@
-type HarRequestHeader = {
-    name: string;
-    value: string;
-};
-type HarRequest = {
-    url: string;
-    method: string;
-    headers?: HarRequestHeader[];
-};
-export declare const generateAxiosCodeFromRequest: (request: HarRequest) => string;
-export {};
-//# sourceMappingURL=generateAxiosCodeFromRequest.d.ts.map

package/dist/helpers/generateAxiosCodeFromRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateAxiosCodeFromRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/generateAxiosCodeFromRequest.ts"],"names":[],"mappings":"AAAA,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,KAAK,UAAU,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAC7B,CAAA;AAED,eAAO,MAAM,4BAA4B,YAAa,UAAU,WA8B/D,CAAA"}

package/dist/helpers/generateLaravelCodeFromRequest.d.ts

@@ -1,7 +0,0 @@
-type HarRequest = {
-    url: string;
-    method: string;
-};
-export declare const generateLaravelCodeFromRequest: (request: HarRequest) => string;
-export {};
-//# sourceMappingURL=generateLaravelCodeFromRequest.d.ts.map

package/dist/helpers/generateLaravelCodeFromRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateLaravelCodeFromRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/generateLaravelCodeFromRequest.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,eAAO,MAAM,8BAA8B,YAAa,UAAU,WAcjE,CAAA"}