@aloma.io/integration-sdk 3.3.9 → 3.3.10

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 (3) hide show
  1. package/build/builder/transform/index.mjs +12 -2
  2. package/package.json +1 -1
  3. package/src/builder/transform/index.mts +16 -4
package/build/builder/transform/index.mjs CHANGED
@@ -24,6 +24,14 @@ const transform = (meta) => {
24
24
  const docs = sig.getJSDoc().serialize() || [];
25
25
  const desc = docs.find((what) => what.kind === "description")
26
26
  ?.value;
27
+ const example = docs.find((what) => what.kind === "example")
28
+ ?.value;
29
+ let eg;
30
+ if (example) {
31
+ const parts = example.split(/```/);
32
+ const backticks = '```';
33
+ eg = `@example ${parts[0]}\n${backticks}${parts[1]}${backticks}`;
34
+ }
27
35
  const paramDocs = docs
28
36
  .filter((what) => what.kind === "param")
29
37
  .map((what) => {
@@ -43,9 +51,9 @@ const transform = (meta) => {
43
51
  return `${p.name}${defaultVal}`;
44
52
  })
45
53
  .join("; ");
46
- return `{${tmp}}: ${param.getType().text}`;
54
+ return `{${tmp}}: ${serialized.type.text}`;
47
55
  case false:
48
- return `${param.getName()}: ${param.getType().text}`;
56
+ return `${serialized.name}: ${serialized.type.text}`;
49
57
  }
50
58
  })
51
59
  .join(", ");
@@ -58,6 +66,8 @@ const transform = (meta) => {
58
66
  * ${desc || ""}
59
67
  *
60
68
  ${paramDocs}
69
+ *
70
+ * ${eg || ''}
61
71
  **/
62
72
  declare function ${member.getName()}(${params}): ${retVal};
63
73
  `;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aloma.io/integration-sdk",
3
- "version": "3.3.9",
3
+ "version": "3.3.10",
4
4
  "description": "",
5
5
  "author": "aloma.io",
6
6
  "license": "Apache-2.0",
package/src/builder/transform/index.mts CHANGED
@@ -31,7 +31,18 @@ const transform = (meta: any) => {
31
31
  const docs = sig.getJSDoc().serialize() || [];
32
32
  const desc = docs.find((what: any) => what.kind === "description")
33
33
  ?.value;
34
+
35
+ const example = docs.find((what: any) => what.kind === "example")
36
+ ?.value;
34
37
 
38
+ let eg;
39
+ if (example)
40
+ {
41
+ const parts = example.split(/```/);
42
+ const backticks = '```';
43
+ eg = `@example ${parts[0]}\n${backticks}${parts[1]}${backticks}`;
44
+ }
45
+
35
46
  const paramDocs =
36
47
  docs
37
48
  .filter((what: any) => what.kind === "param")
@@ -46,7 +57,7 @@ const transform = (meta: any) => {
46
57
  .getParameters()
47
58
  .map((param: any) => {
48
59
  const serialized = param.serialize();
49
-
60
+
50
61
  switch (!!param.isNamed()) {
51
62
  case true:
52
63
  const tmp = param
@@ -58,13 +69,12 @@ const transform = (meta: any) => {
58
69
  return `${p.name}${defaultVal}`;
59
70
  })
60
71
  .join("; ");
61
- return `{${tmp}}: ${param.getType().text}`;
72
+ return `{${tmp}}: ${serialized.type.text}`;
62
73
  case false:
63
- return `${param.getName()}: ${param.getType().text}`;
74
+ return `${serialized.name}: ${serialized.type.text}`;
64
75
  }
65
76
  })
66
77
  .join(", ");
67
-
68
78
  const retVal = sig
69
79
  .serialize()
70
80
  .return.type.text.replace(/^Promise</, "")
@@ -75,6 +85,8 @@ const transform = (meta: any) => {
75
85
  * ${desc || ""}
76
86
  *
77
87
  ${paramDocs}
88
+ *
89
+ * ${eg || ''}
78
90
  **/
79
91
  declare function ${member.getName()}(${params}): ${retVal};
80
92
  `;