@apify/docusaurus-plugin-typedoc-api 4.4.6 → 4.4.8
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.
|
@@ -157,6 +157,7 @@ function ApiItem({
|
|
|
157
157
|
|
|
158
158
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
159
159
|
const apiItem = deepCopy(item);
|
|
160
|
+
const shortenedDescription = Comment.displayPartsToMarkdown(item.comment?.summary ?? []).split('\n')[0];
|
|
160
161
|
|
|
161
162
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
162
163
|
resolveGithubUrls(apiItem, siteConfig, gitRefName);
|
|
@@ -176,7 +177,7 @@ function ApiItem({
|
|
|
176
177
|
})]
|
|
177
178
|
}),
|
|
178
179
|
pageMetadata: /*#__PURE__*/jsxRuntime.jsx(themeCommon.PageMetadata, {
|
|
179
|
-
description:
|
|
180
|
+
description: shortenedDescription,
|
|
180
181
|
title: `${item.name} | API`
|
|
181
182
|
}),
|
|
182
183
|
pagingMetadata: pagingMetadata,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiItem.js","sources":["../../src/components/ApiItem.tsx"],"sourcesContent":null,"names":["getKindIconHtml","escapeMdx","resolveGithubUrl","useState","useMemo","useRequiredReflection","useReflectionMap","useReflection","useDocusaurusContext","useGitRefName","_jsx","ApiOptionsContext","_jsxs","_Fragment","Flags","TypeParametersGeneric","PageMetadata","
|
|
1
|
+
{"version":3,"file":"ApiItem.js","sources":["../../src/components/ApiItem.tsx"],"sourcesContent":null,"names":["getKindIconHtml","escapeMdx","resolveGithubUrl","useState","useMemo","useRequiredReflection","useReflectionMap","useReflection","useDocusaurusContext","useGitRefName","displayPartsToMarkdown","_jsx","ApiOptionsContext","_jsxs","_Fragment","Flags","TypeParametersGeneric","PageMetadata","Reflection"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAiBA,SAAS,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE;AAC9C,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;AACjB,EAAE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;AAC3B,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;AAChC,IAAI,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI;AACvC,MAAM,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;AACjC,MAAM,MAAM,UAAU,GAAG,KAAK,EAAE,aAAa,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;AACtE,MAAM,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;AAC3D,QAAQ,OAAO;AACf,OAAO;AACP,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AAC7D,QAAQ,MAAM,QAAQ,GAAGA,qBAAe,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;AACjE,QAAQ,MAAM,KAAK,GAAGC,iBAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;AAClD,QAAQ,GAAG,CAAC,IAAI,CAAC;AACjB;AACA,UAAU,QAAQ,EAAE,EAAE;AACtB,UAAU,EAAE,EAAE,KAAK,CAAC,IAAI;AACxB,UAAU,KAAK,EAAE,QAAQ,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,KAAK;AAC1D,UAAU,KAAK,EAAE,CAAC;AAClB,SAAS,CAAC,CAAC;AACX,QAAQ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC/B,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL,EAAE,OAAO,GAAG,CAAC;AACb,CAAC;AACD;AACA,SAAS,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE;AACxD,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO;AACnB,EAAE,IAAI,GAAG,CAAC,OAAO,EAAE;AACnB,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI;AAClC,MAAM,MAAM,CAAC,GAAG,GAAGC,2BAAgB,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AACpE,KAAK,CAAC,CAAC;AACP,GAAG;AACH,EAAE,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;AACzB,IAAI,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;AACtC,MAAM,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAC1D,KAAK;AACL,GAAG;AACH,CAAC;AACD,SAAS,qBAAqB,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE;AAC5D,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO;AACnB,EAAE,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,EAAE;AAChC,IAAI,MAAM,oBAAoB,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,EAAE,CAAC;AACtD,IAAI,MAAM,GAAG,GAAG,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,GAAG,IAAI,CAAC;AAC1F,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;AAC7C,IAAI,MAAM;AACV,MAAM,EAAE;AACR,MAAM,OAAO;AACb,MAAM,IAAI;AACV,MAAM,SAAS;AACf,KAAK,GAAG,GAAG,IAAI,EAAE,CAAC;AAClB;AACA,IAAI,GAAG,CAAC,GAAG,GAAG;AACd,MAAM,EAAE;AACR,MAAM,OAAO;AACb,MAAM,IAAI;AACV,MAAM,SAAS;AACf,KAAK,CAAC;AACN,IAAI,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,SAAS,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC9F,GAAG;AACH,EAAE,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;AACzB,IAAI,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;AACtC,MAAM,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;AAC9D,KAAK;AACL,GAAG;AACH,CAAC;AACD,SAAS,gBAAgB,CAAC,UAAU,EAAE,WAAW,EAAE;AACnD,EAAE,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAClD,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AACjC,IAAI,QAAQ;AACZ,GAAG,KAAK,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAChD,IAAI,KAAK;AACT,GAAG,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AACD,SAAS,QAAQ,CAAC,GAAG,EAAE;AACvB,EAAE,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,OAAO,GAAG,CAAC;AAC1C,EAAE,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;AAC5C;AACA,EAAE,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;AACzB;AACA,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AACnC,GAAG;AACH,EAAE,OAAO,IAAI,CAAC;AACd,CAAC;AACD,SAAS,YAAY,CAAC,OAAO,EAAE;AAC/B,EAAE,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAClD,EAAE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnF,EAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC;AACzB,CAAC;AACc,SAAS,OAAO,CAAC;AAChC,EAAE,MAAM,EAAE,MAAM;AAChB,EAAE,KAAK;AACP,CAAC,EAAE;AACH,EAAE,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAGC,cAAQ,CAAC,KAAK,CAAC,CAAC;AAC5D,EAAE,MAAM,UAAU,GAAGC,aAAO,CAAC,OAAO;AACpC,IAAI,aAAa;AACjB,IAAI,gBAAgB;AACpB,GAAG,CAAC,EAAE,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACzC,EAAE,MAAM,IAAI,GAAGC,mCAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC/C,EAAE,MAAM,WAAW,GAAGC,iCAAgB,EAAE,CAAC;AACzC,EAAE,MAAM,GAAG,GAAGF,aAAO,CAAC,MAAM,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC;AAC9G;AACA;AACA,EAAE,MAAM,QAAQ,GAAGG,2BAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAClD,EAAE,MAAM,QAAQ,GAAGA,2BAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC9C,EAAE,MAAM,cAAc,GAAGH,aAAO,CAAC,OAAO;AACxC,IAAI,IAAI,EAAE,QAAQ,GAAG;AACrB,MAAM,SAAS,EAAE,QAAQ,CAAC,SAAS;AACnC,MAAM,KAAK,EAAEH,iBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;AAC3C,KAAK,GAAG,SAAS;AACjB,IAAI,QAAQ,EAAE,QAAQ,GAAG;AACzB,MAAM,SAAS,EAAE,QAAQ,CAAC,SAAS;AACnC,MAAM,KAAK,EAAEA,iBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;AAC3C,KAAK,GAAG,SAAS;AACjB,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC5B,EAAE,MAAM;AACR,IAAI,UAAU;AACd,GAAG,GAAGO,qCAAoB,EAAE,CAAC;AAC7B,EAAE,MAAM,UAAU,GAAGC,2BAAa,EAAE,CAAC;AACrC;AACA;AACA,EAAE,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACjC,EAAE,MAAM,oBAAoB,GAAGC,8BAAsB,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAClG;AACA;AACA,EAAE,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AACrD;AACA,EAAE,qBAAqB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;AAChG,EAAE,oBAAoBC,cAAI,CAACC,mCAAiB,CAAC,QAAQ,EAAE;AACvD,IAAI,KAAK,EAAE,UAAU;AACrB,IAAI,QAAQ,eAAeC,eAAK,CAAC,aAAa,EAAE;AAChD,MAAM,OAAO,eAAeA,eAAK,CAACC,mBAAS,EAAE;AAC7C,QAAQ,QAAQ,EAAE,cAAcH,cAAI,CAAC,MAAM,EAAE;AAC7C,UAAU,SAAS,EAAE,kBAAkB;AACvC,UAAU,QAAQ,eAAeA,cAAI,CAACI,WAAK,EAAE;AAC7C,YAAY,KAAK,EAAE,IAAI,CAAC,KAAK;AAC7B,WAAW,CAAC;AACZ,SAAS,CAAC,EAAEd,iBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,eAAeU,cAAI,CAACK,2CAAqB,EAAE;AAChF,UAAU,MAAM,EAAE,IAAI,CAAC,cAAc;AACrC,SAAS,CAAC,CAAC;AACX,OAAO,CAAC;AACR,MAAM,YAAY,eAAeL,cAAI,CAACM,wBAAY,EAAE;AACpD,QAAQ,WAAW,EAAE,oBAAoB;AACzC,QAAQ,KAAK,EAAE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;AACnC,OAAO,CAAC;AACR,MAAM,cAAc,EAAE,cAAc;AACpC,MAAM,KAAK,EAAE,KAAK;AAClB,MAAM,GAAG,EAAE,GAAG;AACd,MAAM,QAAQ,EAAE,CAAC,MAAM,iBAAiBN,cAAI,CAAC,SAAS,EAAE;AACxD,QAAQ,SAAS,EAAE,YAAY;AAC/B,QAAQ,QAAQ,eAAeA,cAAI,CAAC,MAAM,EAAE,EAAE,CAAC;AAC/C,OAAO,CAAC,eAAeA,cAAI,CAACO,qBAAU,EAAE;AACxC,QAAQ,UAAU,EAAE,IAAI;AACxB,OAAO,CAAC,eAAeP,cAAI,CAAC,QAAQ,EAAE;AACtC;AACA,QAAQ,uBAAuB,EAAE;AACjC,UAAU,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC;AAC9C;AACA,YAAY,IAAI,EAAE;AAClB,cAAc,GAAG,OAAO;AACxB,cAAc,MAAM,EAAE,SAAS;AAC/B,cAAc,UAAU,EAAE,SAAS;AACnC,cAAc,QAAQ,EAAE,SAAS;AACjC,aAAa;AACb,YAAY,MAAM,EAAE,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC;AACvD,WAAW,CAAC,CAAC;AACb,SAAS;AACT,QAAQ,IAAI,EAAE,iCAAiC;AAC/C,OAAO,CAAC,CAAC;AACT,KAAK,CAAC;AACN,GAAG,CAAC,CAAC;AACL;;;;"}
|
|
@@ -32,7 +32,7 @@ class InheritanceGraph {
|
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
34
|
* Resolves the inheritance relationships between the objects.
|
|
35
|
-
*
|
|
35
|
+
*
|
|
36
36
|
* Adds the inherited symbols to the descendants, and sets the `extendedTypes` / `extendedBy` properties.
|
|
37
37
|
* The symbol inheritance works transitively, so if `A` inherits from `B` and `B` inherits from `C`, then `A` inherits from `C`.
|
|
38
38
|
*
|
|
@@ -55,8 +55,8 @@ class InheritanceGraph {
|
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
57
|
* Given two TypeDoc objects, resolves the inherited symbols between them.
|
|
58
|
-
* This method injects the ancestors' symbols into the descendants.
|
|
59
|
-
*
|
|
58
|
+
* This method injects the ancestors' symbols into the descendants.
|
|
59
|
+
*
|
|
60
60
|
* In case the descendant already has a symbol with the same name, the symbol is not injected.
|
|
61
61
|
* @param ancestor The ancestor object.
|
|
62
62
|
* @param descendant The descendant object.
|
|
@@ -97,14 +97,14 @@ class InheritanceGraph {
|
|
|
97
97
|
title: groupName
|
|
98
98
|
});
|
|
99
99
|
}
|
|
100
|
-
ownChild = _objectSpread(_objectSpread({}, inheritedChild), {}, {
|
|
100
|
+
ownChild = JSON.parse(JSON.stringify(_objectSpread(_objectSpread({}, inheritedChild), {}, {
|
|
101
101
|
id: childId,
|
|
102
102
|
inheritedFrom: inheritedChild.inheritedFrom ?? {
|
|
103
103
|
name: `${ancestor.name}.${inheritedChild.name}`,
|
|
104
104
|
target: inheritedChild.id,
|
|
105
105
|
type: 'reference'
|
|
106
106
|
}
|
|
107
|
-
});
|
|
107
|
+
})));
|
|
108
108
|
descendant.children.push(ownChild);
|
|
109
109
|
}
|
|
110
110
|
if (!ownChild.comment?.summary?.[0]?.text) {
|
|
@@ -128,10 +128,10 @@ class InheritanceGraph {
|
|
|
128
128
|
|
|
129
129
|
/**
|
|
130
130
|
* Returns the topological order of the inheritance graph.
|
|
131
|
-
*
|
|
131
|
+
*
|
|
132
132
|
* The topological order puts the ancestors before their descendants.
|
|
133
133
|
* This ensures that all the ancestors are processed before the descendants.
|
|
134
|
-
* @returns
|
|
134
|
+
* @returns
|
|
135
135
|
*/
|
|
136
136
|
getTopologicalOrder() {
|
|
137
137
|
const visited = new Set();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inheritance.js","sources":["../../../src/plugin/python/inheritance.ts"],"sourcesContent":null,"names":["getGroupName","sortChildren"],"mappings":";;;;AACO,MAAM,gBAAgB,CAAC;AAC9B,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;AACpB,EAAE,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;AACvB,EAAE,gBAAgB,CAAC;AACnB,EAAE,WAAW,CAAC,gBAAgB,EAAE;AAChC,IAAI,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AAC7C,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,eAAe,CAAC,UAAU,EAAE,KAAK,EAAE;AACrC,IAAI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;AACzD,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC9B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAC5C,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtC,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AAC7B,GAAG;AACH,EAAE,YAAY,CAAC,IAAI,EAAE;AACrB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACpC,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,kBAAkB,GAAG;AACvB,IAAI,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;AAC/C,IAAI,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAClC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACtD,MAAM,IAAI,QAAQ,EAAE;AACpB,QAAQ,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;AACxC,UAAU,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAChD,UAAU,IAAI,KAAK,EAAE;AACrB,YAAY,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACxD,WAAW;AACX,SAAS;AACT,OAAO;AACP,KAAK;AACL,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,uBAAuB,CAAC,QAAQ,EAAE,UAAU,EAAE;AAChD,IAAI,UAAU,CAAC,QAAQ,KAAK,EAAE,CAAC;AAC/B,IAAI,UAAU,CAAC,aAAa,GAAG,CAAC,IAAI,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE;AACrE,MAAM,IAAI,EAAE,QAAQ,CAAC,IAAI;AACzB,MAAM,MAAM,EAAE,QAAQ,CAAC,EAAE;AACzB,MAAM,IAAI,EAAE,WAAW;AACvB,KAAK,CAAC,CAAC;AACP,IAAI,QAAQ,CAAC,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE;AAC3D,MAAM,IAAI,EAAE,UAAU,CAAC,IAAI;AAC3B,MAAM,MAAM,EAAE,UAAU,CAAC,EAAE;AAC3B,MAAM,IAAI,EAAE,WAAW;AACvB,KAAK,CAAC,CAAC;AACP,IAAI,KAAK,MAAM,cAAc,IAAI,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE;AAC1D,MAAM,IAAI,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC;AACpF,MAAM,IAAI,QAAQ,EAAE;AACpB,QAAQ,QAAQ,CAAC,UAAU,GAAG;AAC9B,UAAU,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;AACzD,UAAU,MAAM,EAAE,cAAc,CAAC,EAAE;AACnC,UAAU,IAAI,EAAE,WAAW;AAC3B,SAAS,CAAC;AACV,OAAO,MAAM;AACb,QAAQ,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;AACzD,QAAQ,MAAM;AACd,UAAU,SAAS;AACnB,SAAS,GAAGA,kBAAY,CAAC,cAAc,CAAC,CAAC;AACzC,QAAQ,IAAI,CAAC,SAAS,EAAE;AACxB,UAAU,MAAM,IAAI,KAAK,CAAC,CAAC,oCAAoC,EAAE,cAAc,CAAC,IAAI,CAAC,qBAAqB,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9H,SAAS;AACT,QAAQ,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;AAC1E,QAAQ,IAAI,KAAK,EAAE;AACnB,UAAU,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACvC,SAAS,MAAM;AACf,UAAU,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC;AAClC,YAAY,QAAQ,EAAE,CAAC,OAAO,CAAC;AAC/B,YAAY,KAAK,EAAE,SAAS;AAC5B,WAAW,CAAC,CAAC;AACb,SAAS;AACT,QAAQ,QAAQ,GAAG;
|
|
1
|
+
{"version":3,"file":"inheritance.js","sources":["../../../src/plugin/python/inheritance.ts"],"sourcesContent":null,"names":["getGroupName","sortChildren"],"mappings":";;;;AACO,MAAM,gBAAgB,CAAC;AAC9B,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;AACpB,EAAE,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;AACvB,EAAE,gBAAgB,CAAC;AACnB,EAAE,WAAW,CAAC,gBAAgB,EAAE;AAChC,IAAI,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AAC7C,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,eAAe,CAAC,UAAU,EAAE,KAAK,EAAE;AACrC,IAAI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;AACzD,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC9B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAC5C,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtC,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AAC7B,GAAG;AACH,EAAE,YAAY,CAAC,IAAI,EAAE;AACrB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACpC,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,kBAAkB,GAAG;AACvB,IAAI,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;AAC/C,IAAI,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAClC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACtD,MAAM,IAAI,QAAQ,EAAE;AACpB,QAAQ,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;AACxC,UAAU,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAChD,UAAU,IAAI,KAAK,EAAE;AACrB,YAAY,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACxD,WAAW;AACX,SAAS;AACT,OAAO;AACP,KAAK;AACL,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,uBAAuB,CAAC,QAAQ,EAAE,UAAU,EAAE;AAChD,IAAI,UAAU,CAAC,QAAQ,KAAK,EAAE,CAAC;AAC/B,IAAI,UAAU,CAAC,aAAa,GAAG,CAAC,IAAI,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE;AACrE,MAAM,IAAI,EAAE,QAAQ,CAAC,IAAI;AACzB,MAAM,MAAM,EAAE,QAAQ,CAAC,EAAE;AACzB,MAAM,IAAI,EAAE,WAAW;AACvB,KAAK,CAAC,CAAC;AACP,IAAI,QAAQ,CAAC,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE;AAC3D,MAAM,IAAI,EAAE,UAAU,CAAC,IAAI;AAC3B,MAAM,MAAM,EAAE,UAAU,CAAC,EAAE;AAC3B,MAAM,IAAI,EAAE,WAAW;AACvB,KAAK,CAAC,CAAC;AACP,IAAI,KAAK,MAAM,cAAc,IAAI,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE;AAC1D,MAAM,IAAI,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC;AACpF,MAAM,IAAI,QAAQ,EAAE;AACpB,QAAQ,QAAQ,CAAC,UAAU,GAAG;AAC9B,UAAU,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;AACzD,UAAU,MAAM,EAAE,cAAc,CAAC,EAAE;AACnC,UAAU,IAAI,EAAE,WAAW;AAC3B,SAAS,CAAC;AACV,OAAO,MAAM;AACb,QAAQ,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;AACzD,QAAQ,MAAM;AACd,UAAU,SAAS;AACnB,SAAS,GAAGA,kBAAY,CAAC,cAAc,CAAC,CAAC;AACzC,QAAQ,IAAI,CAAC,SAAS,EAAE;AACxB,UAAU,MAAM,IAAI,KAAK,CAAC,CAAC,oCAAoC,EAAE,cAAc,CAAC,IAAI,CAAC,qBAAqB,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9H,SAAS;AACT,QAAQ,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;AAC1E,QAAQ,IAAI,KAAK,EAAE;AACnB,UAAU,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACvC,SAAS,MAAM;AACf,UAAU,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC;AAClC,YAAY,QAAQ,EAAE,CAAC,OAAO,CAAC;AAC/B,YAAY,KAAK,EAAE,SAAS;AAC5B,WAAW,CAAC,CAAC;AACb,SAAS;AACT,QAAQ,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;AAC7C,UAAU,GAAG,cAAc;AAC3B,UAAU,EAAE,EAAE,OAAO;AACrB,UAAU,aAAa,EAAE,cAAc,CAAC,aAAa,IAAI;AACzD,YAAY,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;AAC3D,YAAY,MAAM,EAAE,cAAc,CAAC,EAAE;AACrC,YAAY,IAAI,EAAE,WAAW;AAC7B,WAAW;AACX,SAAS,CAAC,CAAC,CAAC;AACZ,QAAQ,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3C,OAAO;AACP,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE;AACjD,QAAQ,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;AACvD,UAAU,IAAI,CAAC,CAAC,IAAI,EAAE,eAAe,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AAC/E;AACA,YAAY,QAAQ,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;AAChD,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM,IAAI,QAAQ,CAAC,UAAU,KAAK,QAAQ,EAAE;AAC5C,QAAQ,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE;AACrD,UAAU,GAAG,CAAC,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;AACrD,UAAU,GAAG,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;AAC/C,SAAS;AACT,OAAO;AACP,MAAM,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;AACtD,KAAK;AACL,IAAIC,kBAAY,CAAC,UAAU,CAAC,CAAC;AAC7B,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,mBAAmB,GAAG;AACxB,IAAI,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;AAC9B,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;AACrB,IAAI,MAAM,KAAK,GAAG,QAAQ,IAAI;AAC9B,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,OAAO;AACxC,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC5C,MAAM,IAAI,CAAC,IAAI,EAAE;AACjB;AACA,QAAQ,OAAO;AACf,OAAO;AACP,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC5B,MAAM,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE;AAC7D,QAAQ,KAAK,CAAC,KAAK,CAAC,CAAC;AACrB,OAAO;AACP,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvB,KAAK,CAAC;AACN,IAAI,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE;AAC7C,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;AAC3B,GAAG;AACH;;;;"}
|
package/package.json
CHANGED
|
@@ -172,6 +172,8 @@ export default function ApiItem({ readme: Readme, route }: ApiItemProps) {
|
|
|
172
172
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
173
173
|
const apiItem = deepCopy(item);
|
|
174
174
|
|
|
175
|
+
const shortenedDescription = displayPartsToMarkdown(item.comment?.summary ?? []).split('\n')[0]
|
|
176
|
+
|
|
175
177
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
176
178
|
resolveGithubUrls(apiItem, siteConfig as never, gitRefName);
|
|
177
179
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
@@ -190,7 +192,7 @@ export default function ApiItem({ readme: Readme, route }: ApiItemProps) {
|
|
|
190
192
|
}
|
|
191
193
|
pageMetadata={
|
|
192
194
|
<PageMetadata
|
|
193
|
-
description={
|
|
195
|
+
description={shortenedDescription}
|
|
194
196
|
title={`${item.name} | API`}
|
|
195
197
|
/>
|
|
196
198
|
}
|
|
@@ -35,7 +35,7 @@ export class InheritanceGraph {
|
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
37
|
* Resolves the inheritance relationships between the objects.
|
|
38
|
-
*
|
|
38
|
+
*
|
|
39
39
|
* Adds the inherited symbols to the descendants, and sets the `extendedTypes` / `extendedBy` properties.
|
|
40
40
|
* The symbol inheritance works transitively, so if `A` inherits from `B` and `B` inherits from `C`, then `A` inherits from `C`.
|
|
41
41
|
*
|
|
@@ -61,15 +61,15 @@ export class InheritanceGraph {
|
|
|
61
61
|
|
|
62
62
|
/**
|
|
63
63
|
* Given two TypeDoc objects, resolves the inherited symbols between them.
|
|
64
|
-
* This method injects the ancestors' symbols into the descendants.
|
|
65
|
-
*
|
|
64
|
+
* This method injects the ancestors' symbols into the descendants.
|
|
65
|
+
*
|
|
66
66
|
* In case the descendant already has a symbol with the same name, the symbol is not injected.
|
|
67
67
|
* @param ancestor The ancestor object.
|
|
68
68
|
* @param descendant The descendant object.
|
|
69
69
|
*/
|
|
70
70
|
protected resolveInheritedSymbols(ancestor: TypeDocObject, descendant: TypeDocObject) {
|
|
71
71
|
descendant.children ??= [];
|
|
72
|
-
|
|
72
|
+
|
|
73
73
|
descendant.extendedTypes = [
|
|
74
74
|
...(descendant.extendedTypes ?? []),
|
|
75
75
|
{
|
|
@@ -78,7 +78,7 @@ export class InheritanceGraph {
|
|
|
78
78
|
type: 'reference',
|
|
79
79
|
},
|
|
80
80
|
];
|
|
81
|
-
|
|
81
|
+
|
|
82
82
|
ancestor.extendedBy = [
|
|
83
83
|
...(ancestor.extendedBy ?? []),
|
|
84
84
|
{
|
|
@@ -87,10 +87,10 @@ export class InheritanceGraph {
|
|
|
87
87
|
type: 'reference',
|
|
88
88
|
},
|
|
89
89
|
];
|
|
90
|
-
|
|
90
|
+
|
|
91
91
|
for (const inheritedChild of ancestor.children ?? []) {
|
|
92
92
|
let ownChild = descendant.children?.find((x) => x.name === inheritedChild.name);
|
|
93
|
-
|
|
93
|
+
|
|
94
94
|
if (ownChild) {
|
|
95
95
|
ownChild.overwrites = {
|
|
96
96
|
name: `${ancestor.name}.${inheritedChild.name}`,
|
|
@@ -99,16 +99,16 @@ export class InheritanceGraph {
|
|
|
99
99
|
};
|
|
100
100
|
} else {
|
|
101
101
|
const childId = this.symbolIdResolver.getNewId();
|
|
102
|
-
|
|
102
|
+
|
|
103
103
|
const { groupName } = getGroupName(inheritedChild);
|
|
104
104
|
if (!groupName) {
|
|
105
105
|
throw new Error(
|
|
106
106
|
`Couldn't resolve the group name for ${inheritedChild.name} (inherited child of ${ancestor.name})`,
|
|
107
107
|
);
|
|
108
108
|
}
|
|
109
|
-
|
|
109
|
+
|
|
110
110
|
const group = descendant.groups?.find((g) => g.title === groupName);
|
|
111
|
-
|
|
111
|
+
|
|
112
112
|
if (group) {
|
|
113
113
|
group.children.push(childId);
|
|
114
114
|
} else {
|
|
@@ -117,8 +117,8 @@ export class InheritanceGraph {
|
|
|
117
117
|
title: groupName,
|
|
118
118
|
});
|
|
119
119
|
}
|
|
120
|
-
|
|
121
|
-
ownChild = {
|
|
120
|
+
|
|
121
|
+
ownChild = JSON.parse(JSON.stringify({
|
|
122
122
|
...inheritedChild,
|
|
123
123
|
id: childId,
|
|
124
124
|
inheritedFrom: inheritedChild.inheritedFrom ?? {
|
|
@@ -126,12 +126,12 @@ export class InheritanceGraph {
|
|
|
126
126
|
target: inheritedChild.id,
|
|
127
127
|
type: 'reference',
|
|
128
128
|
},
|
|
129
|
-
};
|
|
129
|
+
})) as TypeDocObject;
|
|
130
130
|
|
|
131
131
|
descendant.children.push(ownChild);
|
|
132
132
|
}
|
|
133
133
|
|
|
134
|
-
|
|
134
|
+
|
|
135
135
|
if (!ownChild.comment?.summary?.[0]?.text) {
|
|
136
136
|
for (const key of Object.keys(inheritedChild)) {
|
|
137
137
|
if (!['id','inheritedFrom','overwrites','sources'].includes(key)) {
|
|
@@ -156,10 +156,10 @@ export class InheritanceGraph {
|
|
|
156
156
|
|
|
157
157
|
/**
|
|
158
158
|
* Returns the topological order of the inheritance graph.
|
|
159
|
-
*
|
|
159
|
+
*
|
|
160
160
|
* The topological order puts the ancestors before their descendants.
|
|
161
161
|
* This ensures that all the ancestors are processed before the descendants.
|
|
162
|
-
* @returns
|
|
162
|
+
* @returns
|
|
163
163
|
*/
|
|
164
164
|
protected getTopologicalOrder(): TypeDocObject[] {
|
|
165
165
|
const visited = new Set<TypeDocObject['name']>();
|