@scalar/api-client 0.7.18 → 0.7.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +1 -1
  3. package/dist/components/ApiClient/AddressBar.vue.d.ts.map +1 -1
  4. package/dist/components/ApiClient/Request/RequestHeaders.vue.d.ts.map +1 -1
  5. package/dist/components/ApiClient/Request/RequestQuery.vue.d.ts.map +1 -1
  6. package/dist/components/ApiClient/Request/RequestVariables.vue.d.ts.map +1 -1
  7. package/dist/components/ApiClient/RequestMethodSelect.vue.d.ts.map +1 -1
  8. package/dist/components/Grid/Grid.vue.d.ts.map +1 -1
  9. package/dist/fixtures/httpRequestMethods.d.ts +2 -0
  10. package/dist/fixtures/httpRequestMethods.d.ts.map +1 -0
  11. package/dist/fixtures/index.d.ts +3 -2
  12. package/dist/fixtures/index.d.ts.map +1 -1
  13. package/dist/helpers/generateRequest.d.ts.map +1 -1
  14. package/dist/helpers/generateRequestBody.d.ts +10 -0
  15. package/dist/helpers/generateRequestBody.d.ts.map +1 -0
  16. package/dist/helpers/normalizeRequestMethod.d.ts +0 -1
  17. package/dist/helpers/normalizeRequestMethod.d.ts.map +1 -1
  18. package/dist/index.js +4231 -4088
  19. package/dist/stores/apiClientStore.d.ts +6 -0
  20. package/dist/stores/apiClientStore.d.ts.map +1 -1
  21. package/dist/types.d.ts +6 -5
  22. package/dist/types.d.ts.map +1 -1
  23. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @scalar/api-client
2
2
 
3
+ ## 0.7.20
4
+
5
+ ### Patch Changes
6
+
7
+ - d87566fd: refactor: new section components, new sidebar
8
+ - 43628366: Fix overflow and scrolling issues for API client
9
+ - dd8df965: feat: add requestbody to api client if json schema available
10
+
11
+ ## 0.7.19
12
+
13
+ ### Patch Changes
14
+
15
+ - 28cce042: fix: externalize markdown plugins to not break SSG
16
+
3
17
  ## 0.7.18
4
18
 
5
19
  ### Patch Changes
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ![Version](https://img.shields.io/npm/v/%40scalar/api-client)
4
4
  ![Downloads](https://img.shields.io/npm/dm/%40scalar/api-client)
5
5
  ![License](https://img.shields.io/npm/l/%40scalar%2Fapi-client)
6
- [![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.com/invite/Ve683JXN)
6
+ [![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/8HeZcRGPFS)
7
7
 
8
8
  ## Installation
9
9
 
package/dist/components/ApiClient/AddressBar.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"AddressBar.vue.d.ts","sourceRoot":"","sources":["../../../src/components/ApiClient/AddressBar.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;AA8eA,wBAAkD"}
1
+ {"version":3,"file":"AddressBar.vue.d.ts","sourceRoot":"","sources":["../../../src/components/ApiClient/AddressBar.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAifA,wBAAkD"}
package/dist/components/ApiClient/Request/RequestHeaders.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RequestHeaders.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestHeaders.vue.ts"],"names":[],"mappings":";;;;;;;;;AAgIA,wBAAkD"}
1
+ {"version":3,"file":"RequestHeaders.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestHeaders.vue.ts"],"names":[],"mappings":";;;;;;;;;AAqJA,wBAAkD"}
package/dist/components/ApiClient/Request/RequestQuery.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RequestQuery.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestQuery.vue.ts"],"names":[],"mappings":";;;;;;;;;AAiIA,wBAAkD"}
1
+ {"version":3,"file":"RequestQuery.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestQuery.vue.ts"],"names":[],"mappings":";;;;;;;;;AAsJA,wBAAkD"}
package/dist/components/ApiClient/Request/RequestVariables.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RequestVariables.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestVariables.vue.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;AA8HnD,wBAAkD"}
1
+ {"version":3,"file":"RequestVariables.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/ApiClient/Request/RequestVariables.vue.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;AAmJnD,wBAAkD"}
package/dist/components/ApiClient/RequestMethodSelect.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RequestMethodSelect.vue.d.ts","sourceRoot":"","sources":["../../../src/components/ApiClient/RequestMethodSelect.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAgJA,wBAAkD"}
1
+ {"version":3,"file":"RequestMethodSelect.vue.d.ts","sourceRoot":"","sources":["../../../src/components/ApiClient/RequestMethodSelect.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA2JA,wBAAkD"}
package/dist/components/Grid/Grid.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Grid.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Grid/Grid.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA2XA,wBAAkD"}
1
+ {"version":3,"file":"Grid.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Grid/Grid.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA2WA,wBAAkD"}
package/dist/fixtures/httpRequestMethods.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export declare const validRequestMethods: string[];
2
+ //# sourceMappingURL=httpRequestMethods.d.ts.map
package/dist/fixtures/httpRequestMethods.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"httpRequestMethods.d.ts","sourceRoot":"","sources":["../../src/fixtures/httpRequestMethods.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,UAU/B,CAAA"}
package/dist/fixtures/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
- export { httpHeaders, type HttpHeader } from './httpHeaders';
2
- export { default as httpStatusCodes, type HttpStatusCode, type HttpStatusCodes, } from './httpStatusCodes';
1
+ export * from './httpHeaders';
2
+ export * from './httpRequestMethods';
3
+ export * from './httpStatusCodes';
3
4
  //# sourceMappingURL=index.d.ts.map
package/dist/fixtures/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAA;AAC5D,OAAO,EACL,OAAO,IAAI,eAAe,EAC1B,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,mBAAmB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA"}
package/dist/helpers/generateRequest.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"generateRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/generateRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGtE;;GAEG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,QAAQ,EACtB,MAAM,EAAE,MAAM,GACb,mBAAmB,CAcrB"}
1
+ {"version":3,"file":"generateRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/generateRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAItE;;GAEG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,QAAQ,EACtB,MAAM,EAAE,MAAM,GACb,mBAAmB,CAcrB"}
package/dist/helpers/generateRequestBody.d.ts ADDED
@@ -0,0 +1,10 @@
1
+ import type { RequestBody } from '../types';
2
+ /**
3
+ * This function takes a properties object and generates an example requestBody.
4
+ */
5
+ export declare function getRequestBody(requestBody?: RequestBody): string;
6
+ /**
7
+ * This function takes a properties object and generates an example requestBody.
8
+ */
9
+ export declare const generateRequestBody: (schema: Record<string, any>, level?: number, includeExample?: boolean) => any;
10
+ //# sourceMappingURL=generateRequestBody.d.ts.map
package/dist/helpers/generateRequestBody.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generateRequestBody.d.ts","sourceRoot":"","sources":["../../src/helpers/generateRequestBody.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAE3C;;GAEG;AACH,wBAAgB,cAAc,CAAC,WAAW,CAAC,EAAE,WAAW,UAUvD;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,WACtB,OAAO,MAAM,EAAE,GAAG,CAAC,UACpB,MAAM,mBACG,OAAO,QAuFxB,CAAA"}
package/dist/helpers/normalizeRequestMethod.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- export declare const validRequestMethods: string[];
2
1
  /**
3
2
  * Get a normalized request method (e.g. GET, POST, etc.)
4
3
  */
package/dist/helpers/normalizeRequestMethod.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"normalizeRequestMethod.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeRequestMethod.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB,UAU/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,YAAa,MAAM,WAyBrD,CAAA"}
1
+ {"version":3,"file":"normalizeRequestMethod.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeRequestMethod.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,sBAAsB,YAAa,MAAM,WAyBrD,CAAA"}