@mintlify/common 1.0.1088 → 1.0.1089
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/dist/sdk/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export { parseSdkString, potentiallyParseSdkString, parseSdkTargetFromMetadata, resolveSdkTarget, } from './parseSdkString.js';
|
|
1
|
+
export { isSdkFrontmatterValue, parseSdkString, potentiallyParseSdkString, parseSdkTargetFromMetadata, resolveSdkTarget, } from './parseSdkString.js';
|
package/dist/sdk/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export { parseSdkString, potentiallyParseSdkString, parseSdkTargetFromMetadata, resolveSdkTarget, } from './parseSdkString.js';
|
|
1
|
+
export { isSdkFrontmatterValue, parseSdkString, potentiallyParseSdkString, parseSdkTargetFromMetadata, resolveSdkTarget, } from './parseSdkString.js';
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
import type { ResolvedSdkTarget, SdkFormat, SdkTarget } from '@mintlify/models';
|
|
2
2
|
export declare const potentiallyParseSdkString: (str: string) => SdkTarget | undefined;
|
|
3
3
|
export declare const parseSdkString: (str: string) => SdkTarget;
|
|
4
|
+
/**
|
|
5
|
+
* Whether a frontmatter `sdk:` value is a well-formed SDK target, in either
|
|
6
|
+
* the string form (`[source] kind name`) or the object form.
|
|
7
|
+
*/
|
|
8
|
+
export declare function isSdkFrontmatterValue(value: unknown): boolean;
|
|
4
9
|
export declare const parseSdkTargetFromMetadata: (metadata: {
|
|
5
10
|
sdk?: unknown;
|
|
6
11
|
}, inherited?: {
|
|
@@ -60,6 +60,29 @@ export const parseSdkString = (str) => {
|
|
|
60
60
|
function isRecord(value) {
|
|
61
61
|
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
|
62
62
|
}
|
|
63
|
+
/**
|
|
64
|
+
* Whether a frontmatter `sdk:` value is a well-formed SDK target, in either
|
|
65
|
+
* the string form (`[source] kind name`) or the object form.
|
|
66
|
+
*/
|
|
67
|
+
export function isSdkFrontmatterValue(value) {
|
|
68
|
+
if (typeof value === 'string')
|
|
69
|
+
return potentiallyParseSdkString(value) !== undefined;
|
|
70
|
+
if (!isRecord(value))
|
|
71
|
+
return false;
|
|
72
|
+
if (typeof value.kind !== 'string' || !isSdkSymbolKind(value.kind))
|
|
73
|
+
return false;
|
|
74
|
+
if (typeof value.name !== 'string' || value.name.length === 0)
|
|
75
|
+
return false;
|
|
76
|
+
if (value.format !== undefined &&
|
|
77
|
+
(typeof value.format !== 'string' || !isSdkFormat(value.format))) {
|
|
78
|
+
return false;
|
|
79
|
+
}
|
|
80
|
+
if (value.source !== undefined &&
|
|
81
|
+
(typeof value.source !== 'string' || value.source.length === 0)) {
|
|
82
|
+
return false;
|
|
83
|
+
}
|
|
84
|
+
return true;
|
|
85
|
+
}
|
|
63
86
|
export const parseSdkTargetFromMetadata = (metadata, inherited) => {
|
|
64
87
|
const raw = metadata.sdk;
|
|
65
88
|
if (raw === undefined || raw === null || raw === '')
|