@scalar/api-client 2.8.0 → 2.8.1

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 (25) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +4 -4
  3. package/dist/components/HttpMethod/HttpMethod.vue.d.ts +2 -2
  4. package/dist/hooks/useClientConfig.d.ts +6 -6
  5. package/dist/layouts/App/create-api-client-app.d.ts +20 -20
  6. package/dist/layouts/Modal/create-api-client-modal.d.ts +40 -40
  7. package/dist/layouts/Web/create-api-client-web.d.ts +20 -20
  8. package/dist/libs/create-client.d.ts +23 -23
  9. package/dist/libs/create-client.d.ts.map +1 -1
  10. package/dist/libs/create-client.js +23 -23
  11. package/dist/libs/find-request.d.ts +2 -2
  12. package/dist/libs/send-request/create-request-operation.js +8 -8
  13. package/dist/libs/send-request/create-request-operation.test.d.ts +2 -2
  14. package/dist/plugins/plugin-manager.d.ts +1 -1
  15. package/dist/store/active-entities.d.ts +2 -2
  16. package/dist/store/requests.d.ts +22 -22
  17. package/dist/store/store.d.ts +20 -20
  18. package/dist/style.css +1 -1
  19. package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.js +2 -2
  20. package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue2.js +1 -1
  21. package/dist/v2/blocks/operation-code-sample/index.d.ts +1 -0
  22. package/dist/v2/blocks/operation-code-sample/index.d.ts.map +1 -1
  23. package/dist/v2/blocks/operation-code-sample/index.js +8 -6
  24. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
  25. package/package.json +37 -17
package/CHANGELOG.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # @scalar/api-client
2
2
 
3
+ ## 2.8.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 577150c: fix(api-client): create-request-operation - await from pluginManager onResponseReceived executeHook
8
+ - f3e17d8: fix(api-client): create-request-operation - await Promise from pluginManager.executeHook
9
+ - 8e4c8c0: feat: export all blocks
10
+ - f8efecd: feat: use new schema example generation in the response
11
+ - Updated dependencies [f8efecd]
12
+ - Updated dependencies [3f6d0b9]
13
+ - Updated dependencies [2089748]
14
+ - Updated dependencies [f3e17d8]
15
+ - Updated dependencies [f8efecd]
16
+ - Updated dependencies [8a7fb2a]
17
+ - Updated dependencies [1335923]
18
+ - Updated dependencies [07397c8]
19
+ - Updated dependencies [f69e7cc]
20
+ - @scalar/components@0.15.1
21
+ - @scalar/helpers@0.0.12
22
+ - @scalar/json-magic@0.6.1
23
+ - @scalar/types@0.3.2
24
+ - @scalar/oas-utils@0.5.2
25
+ - @scalar/workspace-store@0.17.1
26
+ - @scalar/openapi-types@0.5.0
27
+ - @scalar/use-codemirror@0.12.43
28
+ - @scalar/import@0.4.31
29
+ - @scalar/object-utils@1.2.8
30
+ - @scalar/postman-to-openapi@0.3.40
31
+ - @scalar/openapi-parser@0.22.3
32
+ - @scalar/snippetz@0.5.1
33
+ - @scalar/themes@0.13.22
34
+
3
35
  ## 2.8.0
4
36
 
5
37
  ### Minor Changes
package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts CHANGED
@@ -91,7 +91,7 @@ export declare const PaletteComponents: {
91
91
  deprecated?: boolean | undefined;
92
92
  schema?: unknown;
93
93
  content?: unknown;
94
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
94
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
95
95
  explode?: boolean | undefined;
96
96
  example?: unknown;
97
97
  examples?: Record<string, {
@@ -121,7 +121,7 @@ export declare const PaletteComponents: {
121
121
  type?: "request" | undefined;
122
122
  uid?: string | undefined;
123
123
  path?: string | undefined;
124
- method?: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace" | undefined;
124
+ method?: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace" | undefined;
125
125
  servers?: string[] | undefined;
126
126
  selectedServerUid?: string | null | undefined;
127
127
  examples?: string[] | undefined;
@@ -159,7 +159,7 @@ export declare const PaletteComponents: {
159
159
  deprecated?: boolean | undefined;
160
160
  schema?: unknown;
161
161
  content?: unknown;
162
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
162
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
163
163
  explode?: boolean | undefined;
164
164
  example?: unknown;
165
165
  examples?: Record<string, {
@@ -189,7 +189,7 @@ export declare const PaletteComponents: {
189
189
  type?: "request" | undefined;
190
190
  uid?: string | undefined;
191
191
  path?: string | undefined;
192
- method?: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace" | undefined;
192
+ method?: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace" | undefined;
193
193
  servers?: string[] | undefined;
194
194
  selectedServerUid?: string | null | undefined;
195
195
  examples?: string[] | undefined;
package/dist/components/HttpMethod/HttpMethod.vue.d.ts CHANGED
@@ -4,9 +4,9 @@ type __VLS_Props = {
4
4
  isEditable?: boolean;
5
5
  };
6
6
  declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
7
- change: (value: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace") => any;
7
+ change: (value: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace") => any;
8
8
  }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
9
- onChange?: ((value: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace") => any) | undefined;
9
+ onChange?: ((value: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace") => any) | undefined;
10
10
  }>, {
11
11
  isEditable: boolean;
12
12
  isSquare: boolean;
package/dist/hooks/useClientConfig.d.ts CHANGED
@@ -34,11 +34,11 @@ export declare const useClientConfig: () => Ref<{
34
34
  hooks: import("zod").ZodOptional<import("zod").ZodObject<{
35
35
  onBeforeRequest: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
36
36
  request: import("zod").ZodCustom<Request, Request>;
37
- }, import("zod/v4/core").$strip>], null>, import("zod").ZodUnion<readonly [import("zod").ZodVoid, import("zod").ZodPromise<import("zod").ZodVoid>]>>>;
37
+ }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
38
38
  onResponseReceived: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
39
39
  response: import("zod").ZodCustom<Response, Response>;
40
40
  operation: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
41
- }, import("zod/v4/core").$strip>], null>, import("zod").ZodUnion<readonly [import("zod").ZodVoid, import("zod").ZodPromise<import("zod").ZodVoid>]>>>;
41
+ }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
42
42
  }, import("zod/v4/core").$strip>>;
43
43
  }, import("zod/v4/core").$strip>>[] | undefined;
44
44
  url?: string | undefined;
@@ -81,11 +81,11 @@ export declare const useClientConfig: () => Ref<{
81
81
  hooks: import("zod").ZodOptional<import("zod").ZodObject<{
82
82
  onBeforeRequest: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
83
83
  request: import("zod").ZodCustom<Request, Request>;
84
- }, import("zod/v4/core").$strip>], null>, import("zod").ZodUnion<readonly [import("zod").ZodVoid, import("zod").ZodPromise<import("zod").ZodVoid>]>>>;
84
+ }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
85
85
  onResponseReceived: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
86
86
  response: import("zod").ZodCustom<Response, Response>;
87
87
  operation: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
88
- }, import("zod/v4/core").$strip>], null>, import("zod").ZodUnion<readonly [import("zod").ZodVoid, import("zod").ZodPromise<import("zod").ZodVoid>]>>>;
88
+ }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
89
89
  }, import("zod/v4/core").$strip>>;
90
90
  }, import("zod/v4/core").$strip>>[] | undefined;
91
91
  url?: string | undefined;
@@ -128,11 +128,11 @@ export declare const useClientConfig: () => Ref<{
128
128
  hooks: import("zod").ZodOptional<import("zod").ZodObject<{
129
129
  onBeforeRequest: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
130
130
  request: import("zod").ZodCustom<Request, Request>;
131
- }, import("zod/v4/core").$strip>], null>, import("zod").ZodUnion<readonly [import("zod").ZodVoid, import("zod").ZodPromise<import("zod").ZodVoid>]>>>;
131
+ }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
132
132
  onResponseReceived: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
133
133
  response: import("zod").ZodCustom<Response, Response>;
134
134
  operation: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
135
- }, import("zod/v4/core").$strip>], null>, import("zod").ZodUnion<readonly [import("zod").ZodVoid, import("zod").ZodPromise<import("zod").ZodVoid>]>>>;
135
+ }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
136
136
  }, import("zod/v4/core").$strip>>;
137
137
  }, import("zod/v4/core").$strip>>[] | undefined;
138
138
  url?: string | undefined;
package/dist/layouts/App/create-api-client-app.d.ts CHANGED
@@ -251,7 +251,7 @@ router?: import("vue-router").Router) => Promise<{
251
251
  type: "request";
252
252
  uid: string & import("zod").$brand<"operation">;
253
253
  path: string;
254
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
254
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
255
255
  servers: (string & import("zod").$brand<"server">)[];
256
256
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
257
257
  examples: (string & import("zod").$brand<"example">)[];
@@ -277,7 +277,7 @@ router?: import("vue-router").Router) => Promise<{
277
277
  description?: string | undefined;
278
278
  schema?: unknown;
279
279
  content?: unknown;
280
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
280
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
281
281
  explode?: boolean | undefined;
282
282
  example?: unknown;
283
283
  examples?: Record<string, {
@@ -1323,7 +1323,7 @@ router?: import("vue-router").Router) => Promise<{
1323
1323
  type: "request";
1324
1324
  uid: string & import("zod").$brand<"operation">;
1325
1325
  path: string;
1326
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1326
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1327
1327
  servers: (string & import("zod").$brand<"server">)[];
1328
1328
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1329
1329
  examples: (string & import("zod").$brand<"example">)[];
@@ -1349,7 +1349,7 @@ router?: import("vue-router").Router) => Promise<{
1349
1349
  description?: string | undefined;
1350
1350
  schema?: unknown;
1351
1351
  content?: unknown;
1352
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1352
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1353
1353
  explode?: boolean | undefined;
1354
1354
  example?: unknown;
1355
1355
  examples?: Record<string, {
@@ -1382,7 +1382,7 @@ router?: import("vue-router").Router) => Promise<{
1382
1382
  type: "request";
1383
1383
  uid: string & import("zod").$brand<"operation">;
1384
1384
  path: string;
1385
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1385
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1386
1386
  servers: (string & import("zod").$brand<"server">)[];
1387
1387
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1388
1388
  examples: (string & import("zod").$brand<"example">)[];
@@ -1408,7 +1408,7 @@ router?: import("vue-router").Router) => Promise<{
1408
1408
  description?: string | undefined;
1409
1409
  schema?: unknown;
1410
1410
  content?: unknown;
1411
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1411
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1412
1412
  explode?: boolean | undefined;
1413
1413
  example?: unknown;
1414
1414
  examples?: Record<string, {
@@ -1442,7 +1442,7 @@ router?: import("vue-router").Router) => Promise<{
1442
1442
  type: "request";
1443
1443
  uid: string & import("zod").$brand<"operation">;
1444
1444
  path: string;
1445
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1445
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1446
1446
  servers: (string & import("zod").$brand<"server">)[];
1447
1447
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1448
1448
  examples: (string & import("zod").$brand<"example">)[];
@@ -1468,7 +1468,7 @@ router?: import("vue-router").Router) => Promise<{
1468
1468
  description?: string | undefined;
1469
1469
  schema?: unknown;
1470
1470
  content?: unknown;
1471
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1471
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1472
1472
  explode?: boolean | undefined;
1473
1473
  example?: unknown;
1474
1474
  examples?: Record<string, {
@@ -1501,7 +1501,7 @@ router?: import("vue-router").Router) => Promise<{
1501
1501
  type: "request";
1502
1502
  uid: string & import("zod").$brand<"operation">;
1503
1503
  path: string;
1504
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1504
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1505
1505
  servers: (string & import("zod").$brand<"server">)[];
1506
1506
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1507
1507
  examples: (string & import("zod").$brand<"example">)[];
@@ -1527,7 +1527,7 @@ router?: import("vue-router").Router) => Promise<{
1527
1527
  description?: string | undefined;
1528
1528
  schema?: unknown;
1529
1529
  content?: unknown;
1530
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1530
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1531
1531
  explode?: boolean | undefined;
1532
1532
  example?: unknown;
1533
1533
  examples?: Record<string, {
@@ -1559,7 +1559,7 @@ router?: import("vue-router").Router) => Promise<{
1559
1559
  type: "request";
1560
1560
  uid: string & import("zod").$brand<"operation">;
1561
1561
  path: string;
1562
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1562
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1563
1563
  servers: (string & import("zod").$brand<"server">)[];
1564
1564
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1565
1565
  examples: (string & import("zod").$brand<"example">)[];
@@ -1585,7 +1585,7 @@ router?: import("vue-router").Router) => Promise<{
1585
1585
  description?: string | undefined;
1586
1586
  schema?: unknown;
1587
1587
  content?: unknown;
1588
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1588
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1589
1589
  explode?: boolean | undefined;
1590
1590
  example?: unknown;
1591
1591
  examples?: Record<string, {
@@ -1617,7 +1617,7 @@ router?: import("vue-router").Router) => Promise<{
1617
1617
  type: "request";
1618
1618
  uid: string & import("zod").$brand<"operation">;
1619
1619
  path: string;
1620
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1620
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1621
1621
  servers: (string & import("zod").$brand<"server">)[];
1622
1622
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1623
1623
  examples: (string & import("zod").$brand<"example">)[];
@@ -1643,7 +1643,7 @@ router?: import("vue-router").Router) => Promise<{
1643
1643
  description?: string | undefined;
1644
1644
  schema?: unknown;
1645
1645
  content?: unknown;
1646
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1646
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1647
1647
  explode?: boolean | undefined;
1648
1648
  example?: unknown;
1649
1649
  examples?: Record<string, {
@@ -1676,7 +1676,7 @@ router?: import("vue-router").Router) => Promise<{
1676
1676
  type: "request";
1677
1677
  uid: string & import("zod").$brand<"operation">;
1678
1678
  path: string;
1679
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1679
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1680
1680
  servers: (string & import("zod").$brand<"server">)[];
1681
1681
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1682
1682
  examples: (string & import("zod").$brand<"example">)[];
@@ -1702,7 +1702,7 @@ router?: import("vue-router").Router) => Promise<{
1702
1702
  description?: string | undefined;
1703
1703
  schema?: unknown;
1704
1704
  content?: unknown;
1705
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1705
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1706
1706
  explode?: boolean | undefined;
1707
1707
  example?: unknown;
1708
1708
  examples?: Record<string, {
@@ -1734,7 +1734,7 @@ router?: import("vue-router").Router) => Promise<{
1734
1734
  type: "request";
1735
1735
  uid: string & import("zod").$brand<"operation">;
1736
1736
  path: string;
1737
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1737
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1738
1738
  servers: (string & import("zod").$brand<"server">)[];
1739
1739
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1740
1740
  examples: (string & import("zod").$brand<"example">)[];
@@ -1760,7 +1760,7 @@ router?: import("vue-router").Router) => Promise<{
1760
1760
  description?: string | undefined;
1761
1761
  schema?: unknown;
1762
1762
  content?: unknown;
1763
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1763
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1764
1764
  explode?: boolean | undefined;
1765
1765
  example?: unknown;
1766
1766
  examples?: Record<string, {
@@ -1792,7 +1792,7 @@ router?: import("vue-router").Router) => Promise<{
1792
1792
  type: "request";
1793
1793
  uid: string & import("zod").$brand<"operation">;
1794
1794
  path: string;
1795
- method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
1795
+ method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
1796
1796
  servers: (string & import("zod").$brand<"server">)[];
1797
1797
  selectedServerUid: (string & import("zod").$brand<"server">) | null;
1798
1798
  examples: (string & import("zod").$brand<"example">)[];
@@ -1818,7 +1818,7 @@ router?: import("vue-router").Router) => Promise<{
1818
1818
  description?: string | undefined;
1819
1819
  schema?: unknown;
1820
1820
  content?: unknown;
1821
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1821
+ style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1822
1822
  explode?: boolean | undefined;
1823
1823
  example?: unknown;
1824
1824
  examples?: Record<string, {