@osdk/generator 2.0.0-beta.7 → 2.0.0-beta.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.
- package/CHANGELOG.md +12 -0
- package/build/browser/index.js +7 -1
- package/build/browser/index.js.map +1 -1
- package/build/cjs/index.cjs +7 -1
- package/build/cjs/index.cjs.map +1 -1
- package/build/cjs/v2.0/generatePerActionDataFiles.d.ts.map +1 -1
- package/build/esm/index.js +7 -1
- package/build/esm/index.js.map +1 -1
- package/build/esm/v2.0/generatePerActionDataFiles.d.ts.map +1 -1
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @osdk/generator
|
|
2
2
|
|
|
3
|
+
## 2.0.0-beta.8
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 96ea876: Adding js docs for actions so you can hover and see params and description.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- @osdk/api@2.0.0-beta.8
|
|
12
|
+
- @osdk/internal.foundry.core@0.2.0-beta.5
|
|
13
|
+
- @osdk/generator-converters@2.0.0-beta.8
|
|
14
|
+
|
|
3
15
|
## 2.0.0-beta.7
|
|
4
16
|
|
|
5
17
|
### Minor Changes
|
package/build/browser/index.js
CHANGED
|
@@ -711,6 +711,10 @@ async function generatePerActionDataFiles({
|
|
|
711
711
|
}
|
|
712
712
|
function createV2Types() {
|
|
713
713
|
`${action.shortApiName}$Params`;
|
|
714
|
+
let jsDocBlock = ["/**"];
|
|
715
|
+
if (action.description != null) {
|
|
716
|
+
jsDocBlock.push(`* ${action.description}`);
|
|
717
|
+
}
|
|
714
718
|
return `
|
|
715
719
|
|
|
716
720
|
export namespace ${action.shortApiName}{
|
|
@@ -723,6 +727,7 @@ async function generatePerActionDataFiles({
|
|
|
723
727
|
const key = `${getDescriptionIfPresent(ogValue.description)}
|
|
724
728
|
readonly "${ogKey}"${ogValue.nullable ? "?" : ""}`;
|
|
725
729
|
const value = ogValue.multiplicity ? `ReadonlyArray<${getActionParamType(ogValue.type)}>` : `${getActionParamType(ogValue.type)}`;
|
|
730
|
+
jsDocBlock.push(`* @param {${getActionParamType(ogValue.type)}} ${ogValue.nullable ? `[${ogKey}]` : `${ogKey}`} ${ogValue.description ?? ""} `);
|
|
726
731
|
return [key, value];
|
|
727
732
|
}
|
|
728
733
|
})}
|
|
@@ -748,7 +753,8 @@ async function generatePerActionDataFiles({
|
|
|
748
753
|
|
|
749
754
|
}
|
|
750
755
|
|
|
751
|
-
|
|
756
|
+
${jsDocBlock.join("\n")}
|
|
757
|
+
*/
|
|
752
758
|
export type ${action.shortApiName} = ${action.shortApiName}.Signatures;
|
|
753
759
|
`;
|
|
754
760
|
}
|