@scalar/api-client 0.4.0 → 0.5.0

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/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/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"}