@scalar/api-client 0.4.0 → 0.5.1

package/README.md

@@ -0,0 +1,62 @@
+# Scalar API Client
+
+![Version](https://img.shields.io/npm/v/%40scalar/api-client)
+![Downloads](https://img.shields.io/npm/dm/%40scalar/api-client)
+![License](https://img.shields.io/npm/l/%40scalar%2Fapi-client)
+[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/mw6FQRPh)
+
+## Installation
+
+```bash
+npm install @scalar/api-client
+```
+
+## Usage
+
+```vue
+<script setup>
+import { ApiClient } from '@scalar/api-client'
+</script>
+
+<template>
+  <ApiClient />
+</template>
+```
+
+## Props
+
+### proxyUrl?: string
+
+Pass an URL of [a request proxy](https://github.com/scalar/scalar/tree/main/packages/api-client-proxy) to avoid CORS issues.
+
+## Composable
+
+You can use `useApiClientRequestStore()` to interact with the API client.
+
+### readOnly
+
+```js
+const { readOnly } = useApiClientRequestStore()
+
+readOnly.value = false
+```
+
+### activeRequest
+
+```js
+const { activeRequest } = useApiClientRequestStore()
+
+console.log(activeRequest)
+```
+
+### setActiveRequest
+
+```js
+const { setActiveRequest } = useApiClientRequestStore()
+
+setActiveRequest({
+  url: 'https://echo.scalar.com'
+  type: 'GET,
+  path: '/foobar'
+})
+```

package/dist/components/ApiClient/Request/RequestBody.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestBody.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestBody.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAiIA,wBAAkD"}
+{"version":3,"file":"RequestBody.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestBody.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAkIA,wBAAkD"}

package/dist/components/ApiClient/Request/RequestHeaders.vue.d.ts

@@ -1,12 +1,10 @@
 declare const _default: import("vue").DefineComponent<{
     headers: {
         type: import("vue").PropType<any[]>;
-        required: true;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     headers: {
         type: import("vue").PropType<any[]>;
-        required: true;
     };
 }>>, {}, {}>;
 export default _default;

package/dist/components/ApiClient/Request/RequestHeaders.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestHeaders.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestHeaders.vue.ts"],"names":[],"mappings":";;;;;;;;;;;AAyFA,wBAAkD"}
+{"version":3,"file":"RequestHeaders.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestHeaders.vue.ts"],"names":[],"mappings":";;;;;;;;;AAyFA,wBAAkD"}

package/dist/components/ApiClient/Request/RequestQuery.vue.d.ts

@@ -1,12 +1,10 @@
 declare const _default: import("vue").DefineComponent<{
     queries: {
         type: import("vue").PropType<import("../../../types").BaseParameter[]>;
-        required: true;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     queries: {
         type: import("vue").PropType<import("../../../types").BaseParameter[]>;
-        required: true;
     };
 }>>, {}, {}>;
 export default _default;

package/dist/components/ApiClient/Request/RequestQuery.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestQuery.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestQuery.vue.ts"],"names":[],"mappings":";;;;;;;;;;;AA0FA,wBAAkD"}
+{"version":3,"file":"RequestQuery.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestQuery.vue.ts"],"names":[],"mappings":";;;;;;;;;AA0FA,wBAAkD"}

package/dist/components/ApiClient/Request/RequestVariables.vue.d.ts

@@ -1,13 +1,11 @@
 import type { BaseParameter } from '../../../types';
 declare const _default: import("vue").DefineComponent<{
-    paths: {
+    variables: {
         type: import("vue").PropType<BaseParameter[]>;
-        required: true;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    paths: {
+    variables: {
         type: import("vue").PropType<BaseParameter[]>;
-        required: true;
     };
 }>>, {}, {}>;
 export default _default;

package/dist/components/ApiClient/Request/RequestVariables.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestVariables.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestVariables.vue.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;AAwFnD,wBAAkD"}
+{"version":3,"file":"RequestVariables.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestVariables.vue.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;AAwFnD,wBAAkD"}

package/dist/components/ApiClient/Response/ResponseBody.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ResponseBody.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Response/ResponseBody.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA8FA,wBAAkD"}
+{"version":3,"file":"ResponseBody.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Response/ResponseBody.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA+FA,wBAAkD"}

package/dist/helpers/concatenateUrlAndPath.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Make sure the URL and path are concatenated correctly.
+ */
+export declare const concatenateUrlAndPath: (url: string, path?: string) => string;
+//# sourceMappingURL=concatenateUrlAndPath.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"concatenateUrlAndPath.d.ts","sourceRoot":"","sources":["../../src/helpers/concatenateUrlAndPath.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,qBAAqB,QAAS,MAAM,SAAS,MAAM,WAS/D,CAAA"}

package/dist/helpers/index.d.ts

@@ -1,6 +1,11 @@
+export { concatenateUrlAndPath } from './concatenateUrlAndPath';
 export { createPlaceholderRequest } from './createPlaceholderRequest';
-export { generateRequest } from './generateRequest';
 export { generateParameters } from './generateParameters';
+export { generateRequest } from './generateRequest';
 export { mapFromArray } from './mapFromArray';
+export { normalizePath } from './normalizePath';
+export { normalizeRequestMethod } from './normalizeRequestMethod';
+export { normalizeUrl } from './normalizeUrl';
+export { replaceVariables } from './replaceVariables';
 export { sendRequest } from './sendRequest';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA"}

package/dist/helpers/normalizePath.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Normalizes a path by removing leading slashes.
+ */
+export declare const normalizePath: (path?: string) => string;
+//# sourceMappingURL=normalizePath.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"normalizePath.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizePath.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,aAAa,UAAW,MAAM,WAY1C,CAAA"}

package/dist/helpers/normalizeRequestMethod.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get a normalized request method (e.g. GET, POST, etc.)
+ */
+export declare const normalizeRequestMethod: (method?: string) => string;
+//# sourceMappingURL=normalizeRequestMethod.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"normalizeRequestMethod.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeRequestMethod.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,eAAO,MAAM,sBAAsB,YAAa,MAAM,WAyBrD,CAAA"}

package/dist/helpers/normalizeUrl.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Normalizes a URL by trimming it and adding http:// as the default prefix.
+ */
+export declare const normalizeUrl: (url?: string) => string;
+//# sourceMappingURL=normalizeUrl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"normalizeUrl.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeUrl.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,YAAY,SAAU,MAAM,WAoBxC,CAAA"}

package/dist/helpers/replaceVariables.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Replaces variables in a url with the values provided.
+ */
+export declare const replaceVariables: (url: string, variables: Record<string, string | number>) => string;
+//# sourceMappingURL=replaceVariables.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"replaceVariables.d.ts","sourceRoot":"","sources":["../../src/helpers/replaceVariables.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,gBAAgB,QACtB,MAAM,aACA,OAAO,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,WAK3C,CAAA"}

package/dist/helpers/sendRequest.d.ts

@@ -1,6 +1,6 @@
-import type { ClientRequestConfig, RequestResult } from '../types';
+import type { RequestResult, SendRequestConfig } from '../types';
 /**
  * Send a request via the proxy
  */
-export declare function sendRequest(request: ClientRequestConfig, proxyUrl: string): Promise<RequestResult | null>;
+export declare function sendRequest(request: SendRequestConfig, proxyUrl?: string): Promise<RequestResult | null>;
 //# sourceMappingURL=sendRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sendRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/sendRequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,mBAAmB,EAEnB,aAAa,EACd,MAAM,UAAU,CAAA;AAcjB;;GAEG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,mBAAmB,EAC5B,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAiE/B"}
+{"version":3,"file":"sendRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/sendRequest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGV,aAAa,EACb,iBAAiB,EAClB,MAAM,UAAU,CAAA;AAcjB;;GAEG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CA4E/B"}

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 export { ApiClient } from './components/ApiClient';
-export { CodeMirror } from './components/CodeMirror';
 export * from './helpers';
 export * from './hooks';
 export * from './stores/apiClientStore';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAElD,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA"}