@scalar/types 0.1.1 → 0.1.2
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.
- package/CHANGELOG.md +7 -0
- package/dist/api-reference/api-reference-configuration.d.ts +18 -0
- package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
- package/dist/api-reference/api-reference-configuration.js +6 -1
- package/dist/api-reference/helpers/migrate-theme-variables.d.ts.map +1 -1
- package/dist/api-reference/helpers/migrate-theme-variables.js +2 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -394,6 +394,11 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
394
394
|
* @default false
|
|
395
395
|
*/
|
|
396
396
|
isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
397
|
+
/**
|
|
398
|
+
* Controls whether the references show a loading state in the intro
|
|
399
|
+
* @default false
|
|
400
|
+
*/
|
|
401
|
+
isLoading: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
397
402
|
/**
|
|
398
403
|
* Whether to show models in the sidebar, search, and content.
|
|
399
404
|
* @default false
|
|
@@ -593,6 +598,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
593
598
|
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
|
|
594
599
|
layout: "modern" | "classic";
|
|
595
600
|
isEditable: boolean;
|
|
601
|
+
isLoading: boolean;
|
|
596
602
|
hideModels: boolean;
|
|
597
603
|
hideDownloadButton: boolean;
|
|
598
604
|
hideTestRequestButton: boolean;
|
|
@@ -678,6 +684,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
678
684
|
layout?: unknown;
|
|
679
685
|
proxy?: string | undefined;
|
|
680
686
|
isEditable?: unknown;
|
|
687
|
+
isLoading?: unknown;
|
|
681
688
|
hideModels?: unknown;
|
|
682
689
|
hideDownloadButton?: unknown;
|
|
683
690
|
hideTestRequestButton?: unknown;
|
|
@@ -729,6 +736,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
729
736
|
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
|
|
730
737
|
layout: "modern" | "classic";
|
|
731
738
|
isEditable: boolean;
|
|
739
|
+
isLoading: boolean;
|
|
732
740
|
hideModels: boolean;
|
|
733
741
|
hideDownloadButton: boolean;
|
|
734
742
|
hideTestRequestButton: boolean;
|
|
@@ -814,6 +822,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
814
822
|
layout?: unknown;
|
|
815
823
|
proxy?: string | undefined;
|
|
816
824
|
isEditable?: unknown;
|
|
825
|
+
isLoading?: unknown;
|
|
817
826
|
hideModels?: unknown;
|
|
818
827
|
hideDownloadButton?: unknown;
|
|
819
828
|
hideTestRequestButton?: unknown;
|
|
@@ -1009,6 +1018,11 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
|
|
|
1009
1018
|
* @default false
|
|
1010
1019
|
*/
|
|
1011
1020
|
isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1021
|
+
/**
|
|
1022
|
+
* Controls whether the references show a loading state in the intro
|
|
1023
|
+
* @default false
|
|
1024
|
+
*/
|
|
1025
|
+
isLoading: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1012
1026
|
/**
|
|
1013
1027
|
* Whether to show models in the sidebar, search, and content.
|
|
1014
1028
|
* @default false
|
|
@@ -1282,6 +1296,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
|
|
|
1282
1296
|
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
|
|
1283
1297
|
layout: "modern" | "classic";
|
|
1284
1298
|
isEditable: boolean;
|
|
1299
|
+
isLoading: boolean;
|
|
1285
1300
|
hideModels: boolean;
|
|
1286
1301
|
hideDownloadButton: boolean;
|
|
1287
1302
|
hideTestRequestButton: boolean;
|
|
@@ -1379,6 +1394,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
|
|
|
1379
1394
|
layout?: unknown;
|
|
1380
1395
|
proxy?: string | undefined;
|
|
1381
1396
|
isEditable?: unknown;
|
|
1397
|
+
isLoading?: unknown;
|
|
1382
1398
|
hideModels?: unknown;
|
|
1383
1399
|
hideDownloadButton?: unknown;
|
|
1384
1400
|
hideTestRequestButton?: unknown;
|
|
@@ -1430,6 +1446,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
|
|
|
1430
1446
|
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
|
|
1431
1447
|
layout: "modern" | "classic";
|
|
1432
1448
|
isEditable: boolean;
|
|
1449
|
+
isLoading: boolean;
|
|
1433
1450
|
hideModels: boolean;
|
|
1434
1451
|
hideDownloadButton: boolean;
|
|
1435
1452
|
hideTestRequestButton: boolean;
|
|
@@ -1527,6 +1544,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
|
|
|
1527
1544
|
layout?: unknown;
|
|
1528
1545
|
proxy?: string | undefined;
|
|
1529
1546
|
isEditable?: unknown;
|
|
1547
|
+
isLoading?: unknown;
|
|
1530
1548
|
hideModels?: unknown;
|
|
1531
1549
|
hideDownloadButton?: unknown;
|
|
1532
1550
|
hideTestRequestButton?: unknown;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA8EvB,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;IAClC;;;;;;;;;;;;;;;;;QAiBI;;IAEJ;;;;;;;;;;;;;;;;;;;;QAoBI;;IAEJ;;;;;;OAMG;;IAEH;;;;;;;;;;OAUG;;;;;;;;;;;;EAEH,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAQvE,uCAAuC;AACvC,eAAO,MAAM,4BAA4B;IACvC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAElC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;
|
|
1
|
+
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA8EvB,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;IAClC;;;;;;;;;;;;;;;;;QAiBI;;IAEJ;;;;;;;;;;;;;;;;;;;;QAoBI;;IAEJ;;;;;;OAMG;;IAEH;;;;;;;;;;OAUG;;;;;;;;;;;;EAEH,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAQvE,uCAAuC;AACvC,eAAO,MAAM,4BAA4B;IACvC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAElC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAgRjF,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;IA5U1C;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;IAYhC;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD;;;;;OAKG;;QA9JL,sCAAsC;;;;;;;IAgKpC;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH,wDAAwD;;IAExD;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyEwG,CAAA;AAE/G,yDAAyD;AACzD,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,EAE/C,OAAO,GAAG,MAAM,CACjB,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,0CAA0C;IAtVrD;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;IAYhC;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD;;;;;OAKG;;QA9JL,sCAAsC;;;;;;;IAgKpC;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH,wDAAwD;;IAExD;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;QA3UL;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoWwE,CAAA;AAC7E,MAAM,MAAM,oCAAoC,GAAG,IAAI,CACrD,CAAC,CAAC,KAAK,CAAC,OAAO,0CAA0C,CAAC,EAE1D,OAAO,GAAG,MAAM,CACjB,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,2BAA2B,GACnC,OAAO,CAAC,yBAAyB,CAAC,GAClC,OAAO,CAAC,yBAAyB,CAAC,EAAE,GACpC,OAAO,CAAC,oCAAoC,CAAC,CAAA;AAEjD,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,WAC7B,2BAA2B,KAClC,MAAM,IAAI,OAAO,CAAC,oCAAoC,CAC0C,CAAA"}
|
|
@@ -202,7 +202,7 @@ const apiClientConfigurationSchema = z.object({
|
|
|
202
202
|
});
|
|
203
203
|
const OLD_PROXY_URL = 'https://api.scalar.com/request-proxy';
|
|
204
204
|
const NEW_PROXY_URL = 'https://proxy.scalar.com';
|
|
205
|
-
/** Configuration for the Api
|
|
205
|
+
/** Configuration for the Api Client without the transform since it cannot be merged */
|
|
206
206
|
const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.object({
|
|
207
207
|
/**
|
|
208
208
|
* The layout to use for the references
|
|
@@ -219,6 +219,11 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
|
|
|
219
219
|
* @default false
|
|
220
220
|
*/
|
|
221
221
|
isEditable: z.boolean().optional().default(false).catch(false),
|
|
222
|
+
/**
|
|
223
|
+
* Controls whether the references show a loading state in the intro
|
|
224
|
+
* @default false
|
|
225
|
+
*/
|
|
226
|
+
isLoading: z.boolean().optional().default(false).catch(false),
|
|
222
227
|
/**
|
|
223
228
|
* Whether to show models in the sidebar, search, and content.
|
|
224
229
|
* @default false
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"migrate-theme-variables.d.ts","sourceRoot":"","sources":["../../../src/api-reference/helpers/migrate-theme-variables.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,eAAO,MAAM,iBAAiB,6FAGpB,CAAA;AAEV,eAAO,MAAM,eAAe,+BAA8C,CAAA;AAE1E;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,
|
|
1
|
+
{"version":3,"file":"migrate-theme-variables.d.ts","sourceRoot":"","sources":["../../../src/api-reference/helpers/migrate-theme-variables.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,eAAO,MAAM,iBAAiB,6FAGpB,CAAA;AAEV,eAAO,MAAM,eAAe,+BAA8C,CAAA;AAE1E;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAY5D"}
|
|
@@ -11,8 +11,9 @@ const LEGACY_PREFIXES = PREFIX_MIGRATIONS.map(([legacy]) => legacy);
|
|
|
11
11
|
*/
|
|
12
12
|
function migrateThemeVariables(styles) {
|
|
13
13
|
const hasLegacyPrefixes = LEGACY_PREFIXES.some((p) => styles.includes(p));
|
|
14
|
-
if (!hasLegacyPrefixes)
|
|
14
|
+
if (!hasLegacyPrefixes) {
|
|
15
15
|
return styles;
|
|
16
|
+
}
|
|
16
17
|
console.warn(`DEPRECATION WARNING: It looks like you're using legacy CSS variables in your custom CSS string. Please migrate them to use the updated prefixes. See https://github.com/scalar/scalar/blob/main/documentation/themes.md#theme-prefix-changes`);
|
|
17
18
|
// Replaces each old variable in the prefix migrations
|
|
18
19
|
return PREFIX_MIGRATIONS.reduce((s, [o, n]) => s.replaceAll(o, n), styles);
|