@azure-tools/rlc-common 0.11.0

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 (232) hide show
  1. package/.eslintrc.json +23 -0
  2. package/.prettierignore +1 -0
  3. package/.prettierrc +7 -0
  4. package/.rush/temp/package-deps_build.json +53 -0
  5. package/.rush/temp/shrinkwrap-deps.json +147 -0
  6. package/CHANGELOG.md +61 -0
  7. package/CONTRIBUTING.md +30 -0
  8. package/README.md +3 -0
  9. package/dist/buildClient.js +268 -0
  10. package/dist/buildClient.js.map +1 -0
  11. package/dist/buildClientDefinitions.js +160 -0
  12. package/dist/buildClientDefinitions.js.map +1 -0
  13. package/dist/buildIndexFile.js +170 -0
  14. package/dist/buildIndexFile.js.map +1 -0
  15. package/dist/buildIsUnexpectedHelper.js +220 -0
  16. package/dist/buildIsUnexpectedHelper.js.map +1 -0
  17. package/dist/buildMethodShortcuts.js +50 -0
  18. package/dist/buildMethodShortcuts.js.map +1 -0
  19. package/dist/buildObjectTypes.js +286 -0
  20. package/dist/buildObjectTypes.js.map +1 -0
  21. package/dist/buildPaginateHelper.js +30 -0
  22. package/dist/buildPaginateHelper.js.map +1 -0
  23. package/dist/buildParameterTypes.js +315 -0
  24. package/dist/buildParameterTypes.js.map +1 -0
  25. package/dist/buildPollingHelper.js +21 -0
  26. package/dist/buildPollingHelper.js.map +1 -0
  27. package/dist/buildResponseTypes.js +135 -0
  28. package/dist/buildResponseTypes.js.map +1 -0
  29. package/dist/buildSchemaType.js +65 -0
  30. package/dist/buildSchemaType.js.map +1 -0
  31. package/dist/buildSerializeHelper.js +35 -0
  32. package/dist/buildSerializeHelper.js.map +1 -0
  33. package/dist/buildTopLevelIndexFile.js +48 -0
  34. package/dist/buildTopLevelIndexFile.js.map +1 -0
  35. package/dist/helpers/nameConstructors.js +41 -0
  36. package/dist/helpers/nameConstructors.js.map +1 -0
  37. package/dist/helpers/nameUtils.js +196 -0
  38. package/dist/helpers/nameUtils.js.map +1 -0
  39. package/dist/helpers/operationHelpers.js +103 -0
  40. package/dist/helpers/operationHelpers.js.map +1 -0
  41. package/dist/helpers/pathUtils.js +13 -0
  42. package/dist/helpers/pathUtils.js.map +1 -0
  43. package/dist/helpers/schemaHelpers.js +27 -0
  44. package/dist/helpers/schemaHelpers.js.map +1 -0
  45. package/dist/helpers/shortcutMethods.js +46 -0
  46. package/dist/helpers/shortcutMethods.js.map +1 -0
  47. package/dist/index.js +45 -0
  48. package/dist/index.js.map +1 -0
  49. package/dist/interfaces.js +18 -0
  50. package/dist/interfaces.js.map +1 -0
  51. package/dist/metadata/buildApiExtractorConfig.js +56 -0
  52. package/dist/metadata/buildApiExtractorConfig.js.map +1 -0
  53. package/dist/metadata/buildESLintConfig.js +33 -0
  54. package/dist/metadata/buildESLintConfig.js.map +1 -0
  55. package/dist/metadata/buildLicenseFile.js +41 -0
  56. package/dist/metadata/buildLicenseFile.js.map +1 -0
  57. package/dist/metadata/buildPackageFile.js +274 -0
  58. package/dist/metadata/buildPackageFile.js.map +1 -0
  59. package/dist/metadata/buildReadmeFile.js +170 -0
  60. package/dist/metadata/buildReadmeFile.js.map +1 -0
  61. package/dist/metadata/buildRollupConfig.js +144 -0
  62. package/dist/metadata/buildRollupConfig.js.map +1 -0
  63. package/dist/metadata/buildTsConfig.js +72 -0
  64. package/dist/metadata/buildTsConfig.js.map +1 -0
  65. package/dist/package.json +1 -0
  66. package/dist/static/paginateContent.js +214 -0
  67. package/dist/static/paginateContent.js.map +1 -0
  68. package/dist/static/pollingContent.js +98 -0
  69. package/dist/static/pollingContent.js.map +1 -0
  70. package/dist/static/serializeHelper.js +30 -0
  71. package/dist/static/serializeHelper.js.map +1 -0
  72. package/dist/test/buildEnvFile.js +31 -0
  73. package/dist/test/buildEnvFile.js.map +1 -0
  74. package/dist/test/buildKarmaConfig.js +19 -0
  75. package/dist/test/buildKarmaConfig.js.map +1 -0
  76. package/dist/test/buildRecordedClient.js +22 -0
  77. package/dist/test/buildRecordedClient.js.map +1 -0
  78. package/dist/test/buildSampleTest.js +19 -0
  79. package/dist/test/buildSampleTest.js.map +1 -0
  80. package/dist/test/template.js +191 -0
  81. package/dist/test/template.js.map +1 -0
  82. package/dist-esm/buildClient.js +261 -0
  83. package/dist-esm/buildClient.js.map +1 -0
  84. package/dist-esm/buildClientDefinitions.js +155 -0
  85. package/dist-esm/buildClientDefinitions.js.map +1 -0
  86. package/dist-esm/buildIndexFile.js +165 -0
  87. package/dist-esm/buildIndexFile.js.map +1 -0
  88. package/dist-esm/buildIsUnexpectedHelper.js +216 -0
  89. package/dist-esm/buildIsUnexpectedHelper.js.map +1 -0
  90. package/dist-esm/buildMethodShortcuts.js +46 -0
  91. package/dist-esm/buildMethodShortcuts.js.map +1 -0
  92. package/dist-esm/buildObjectTypes.js +288 -0
  93. package/dist-esm/buildObjectTypes.js.map +1 -0
  94. package/dist-esm/buildPaginateHelper.js +26 -0
  95. package/dist-esm/buildPaginateHelper.js.map +1 -0
  96. package/dist-esm/buildParameterTypes.js +321 -0
  97. package/dist-esm/buildParameterTypes.js.map +1 -0
  98. package/dist-esm/buildPollingHelper.js +17 -0
  99. package/dist-esm/buildPollingHelper.js.map +1 -0
  100. package/dist-esm/buildResponseTypes.js +140 -0
  101. package/dist-esm/buildResponseTypes.js.map +1 -0
  102. package/dist-esm/buildSchemaType.js +60 -0
  103. package/dist-esm/buildSchemaType.js.map +1 -0
  104. package/dist-esm/buildSerializeHelper.js +31 -0
  105. package/dist-esm/buildSerializeHelper.js.map +1 -0
  106. package/dist-esm/buildTopLevelIndexFile.js +44 -0
  107. package/dist-esm/buildTopLevelIndexFile.js.map +1 -0
  108. package/dist-esm/helpers/nameConstructors.js +34 -0
  109. package/dist-esm/helpers/nameConstructors.js.map +1 -0
  110. package/dist-esm/helpers/nameUtils.js +187 -0
  111. package/dist-esm/helpers/nameUtils.js.map +1 -0
  112. package/dist-esm/helpers/operationHelpers.js +84 -0
  113. package/dist-esm/helpers/operationHelpers.js.map +1 -0
  114. package/dist-esm/helpers/pathUtils.js +9 -0
  115. package/dist-esm/helpers/pathUtils.js.map +1 -0
  116. package/dist-esm/helpers/schemaHelpers.js +21 -0
  117. package/dist-esm/helpers/schemaHelpers.js.map +1 -0
  118. package/dist-esm/helpers/shortcutMethods.js +42 -0
  119. package/dist-esm/helpers/shortcutMethods.js.map +1 -0
  120. package/dist-esm/index.js +29 -0
  121. package/dist-esm/index.js.map +1 -0
  122. package/dist-esm/interfaces.js +15 -0
  123. package/dist-esm/interfaces.js.map +1 -0
  124. package/dist-esm/metadata/buildApiExtractorConfig.js +51 -0
  125. package/dist-esm/metadata/buildApiExtractorConfig.js.map +1 -0
  126. package/dist-esm/metadata/buildESLintConfig.js +28 -0
  127. package/dist-esm/metadata/buildESLintConfig.js.map +1 -0
  128. package/dist-esm/metadata/buildLicenseFile.js +36 -0
  129. package/dist-esm/metadata/buildLicenseFile.js.map +1 -0
  130. package/dist-esm/metadata/buildPackageFile.js +276 -0
  131. package/dist-esm/metadata/buildPackageFile.js.map +1 -0
  132. package/dist-esm/metadata/buildReadmeFile.js +167 -0
  133. package/dist-esm/metadata/buildReadmeFile.js.map +1 -0
  134. package/dist-esm/metadata/buildRollupConfig.js +139 -0
  135. package/dist-esm/metadata/buildRollupConfig.js.map +1 -0
  136. package/dist-esm/metadata/buildTsConfig.js +67 -0
  137. package/dist-esm/metadata/buildTsConfig.js.map +1 -0
  138. package/dist-esm/package.json +1 -0
  139. package/dist-esm/static/paginateContent.js +211 -0
  140. package/dist-esm/static/paginateContent.js.map +1 -0
  141. package/dist-esm/static/pollingContent.js +95 -0
  142. package/dist-esm/static/pollingContent.js.map +1 -0
  143. package/dist-esm/static/serializeHelper.js +27 -0
  144. package/dist-esm/static/serializeHelper.js.map +1 -0
  145. package/dist-esm/test/buildEnvFile.js +24 -0
  146. package/dist-esm/test/buildEnvFile.js.map +1 -0
  147. package/dist-esm/test/buildKarmaConfig.js +14 -0
  148. package/dist-esm/test/buildKarmaConfig.js.map +1 -0
  149. package/dist-esm/test/buildRecordedClient.js +17 -0
  150. package/dist-esm/test/buildRecordedClient.js.map +1 -0
  151. package/dist-esm/test/buildSampleTest.js +14 -0
  152. package/dist-esm/test/buildSampleTest.js.map +1 -0
  153. package/dist-esm/test/template.js +188 -0
  154. package/dist-esm/test/template.js.map +1 -0
  155. package/package.json +46 -0
  156. package/publishPackage.js +11 -0
  157. package/rlc-common.build.log +2 -0
  158. package/src/buildClient.ts +353 -0
  159. package/src/buildClientDefinitions.ts +235 -0
  160. package/src/buildIndexFile.ts +202 -0
  161. package/src/buildIsUnexpectedHelper.ts +240 -0
  162. package/src/buildMethodShortcuts.ts +75 -0
  163. package/src/buildObjectTypes.ts +449 -0
  164. package/src/buildPaginateHelper.ts +33 -0
  165. package/src/buildParameterTypes.ts +477 -0
  166. package/src/buildPollingHelper.ts +18 -0
  167. package/src/buildResponseTypes.ts +186 -0
  168. package/src/buildSchemaType.ts +85 -0
  169. package/src/buildSerializeHelper.ts +42 -0
  170. package/src/buildTopLevelIndexFile.ts +52 -0
  171. package/src/helpers/nameConstructors.ts +93 -0
  172. package/src/helpers/nameUtils.ts +227 -0
  173. package/src/helpers/operationHelpers.ts +119 -0
  174. package/src/helpers/pathUtils.ts +9 -0
  175. package/src/helpers/schemaHelpers.ts +25 -0
  176. package/src/helpers/shortcutMethods.ts +60 -0
  177. package/src/index.ts +29 -0
  178. package/src/interfaces.ts +227 -0
  179. package/src/metadata/buildApiExtractorConfig.ts +59 -0
  180. package/src/metadata/buildESLintConfig.ts +34 -0
  181. package/src/metadata/buildLicenseFile.ts +39 -0
  182. package/src/metadata/buildPackageFile.ts +334 -0
  183. package/src/metadata/buildReadmeFile.ts +231 -0
  184. package/src/metadata/buildRollupConfig.ts +147 -0
  185. package/src/metadata/buildTsConfig.ts +79 -0
  186. package/src/static/paginateContent.ts +210 -0
  187. package/src/static/pollingContent.ts +94 -0
  188. package/src/static/serializeHelper.ts +29 -0
  189. package/src/test/buildEnvFile.ts +26 -0
  190. package/src/test/buildKarmaConfig.ts +15 -0
  191. package/src/test/buildRecordedClient.ts +18 -0
  192. package/src/test/buildSampleTest.ts +15 -0
  193. package/src/test/template.ts +191 -0
  194. package/tsconfig-cjs.json +9 -0
  195. package/tsconfig-common.json +13 -0
  196. package/tsconfig.json +13 -0
  197. package/types/buildClient.d.ts +2 -0
  198. package/types/buildClientDefinitions.d.ts +5 -0
  199. package/types/buildIndexFile.d.ts +5 -0
  200. package/types/buildIsUnexpectedHelper.d.ts +5 -0
  201. package/types/buildMethodShortcuts.d.ts +4 -0
  202. package/types/buildObjectTypes.d.ts +15 -0
  203. package/types/buildPaginateHelper.d.ts +5 -0
  204. package/types/buildParameterTypes.d.ts +13 -0
  205. package/types/buildPollingHelper.d.ts +5 -0
  206. package/types/buildResponseTypes.d.ts +5 -0
  207. package/types/buildSchemaType.d.ts +19 -0
  208. package/types/buildSerializeHelper.d.ts +5 -0
  209. package/types/buildTopLevelIndexFile.d.ts +5 -0
  210. package/types/helpers/nameConstructors.d.ts +28 -0
  211. package/types/helpers/nameUtils.d.ts +25 -0
  212. package/types/helpers/operationHelpers.d.ts +13 -0
  213. package/types/helpers/pathUtils.d.ts +1 -0
  214. package/types/helpers/schemaHelpers.d.ts +4 -0
  215. package/types/helpers/shortcutMethods.d.ts +3 -0
  216. package/types/index.d.ts +26 -0
  217. package/types/interfaces.d.ts +200 -0
  218. package/types/metadata/buildApiExtractorConfig.d.ts +5 -0
  219. package/types/metadata/buildESLintConfig.d.ts +5 -0
  220. package/types/metadata/buildLicenseFile.d.ts +5 -0
  221. package/types/metadata/buildPackageFile.d.ts +5 -0
  222. package/types/metadata/buildReadmeFile.d.ts +5 -0
  223. package/types/metadata/buildRollupConfig.d.ts +5 -0
  224. package/types/metadata/buildTsConfig.d.ts +5 -0
  225. package/types/static/paginateContent.d.ts +1 -0
  226. package/types/static/pollingContent.d.ts +1 -0
  227. package/types/static/serializeHelper.d.ts +4 -0
  228. package/types/test/buildEnvFile.d.ts +9 -0
  229. package/types/test/buildKarmaConfig.d.ts +5 -0
  230. package/types/test/buildRecordedClient.d.ts +5 -0
  231. package/types/test/buildSampleTest.d.ts +5 -0
  232. package/types/test/template.d.ts +5 -0
@@ -0,0 +1,288 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ import { StructureKind } from "ts-morph";
4
+ import { NameType, normalizeName } from "./helpers/nameUtils.js";
5
+ import { isDictionarySchema, isObjectSchema } from "./helpers/schemaHelpers.js";
6
+ import { SchemaContext } from "./interfaces.js";
7
+ /**
8
+ * Generates interfaces for ObjectSchemas
9
+ */
10
+ export function buildObjectInterfaces(model, importedModels, schemaUsage) {
11
+ const objectSchemas = (model.schemas ?? []).filter((o) => isObjectSchema(o) &&
12
+ o.usage?.some((u) => schemaUsage.includes(u)));
13
+ const objectInterfaces = [];
14
+ for (const objectSchema of objectSchemas) {
15
+ if (objectSchema.alias || objectSchema.outputAlias) {
16
+ continue;
17
+ }
18
+ const baseName = getObjectBaseName(objectSchema, schemaUsage);
19
+ const interfaceDeclaration = getObjectInterfaceDeclaration(baseName, objectSchema, schemaUsage, importedModels);
20
+ objectInterfaces.push(interfaceDeclaration);
21
+ }
22
+ return objectInterfaces;
23
+ }
24
+ export function buildObjectAliases(model, importedModels, schemaUsage) {
25
+ const objectSchemas = (model.schemas ?? []).filter((o) => isObjectSchema(o) &&
26
+ o.usage?.some((u) => schemaUsage.includes(u)));
27
+ const objectAliases = [];
28
+ for (const objectSchema of objectSchemas) {
29
+ if (objectSchema.alias || objectSchema.outputAlias) {
30
+ const description = objectSchema.description;
31
+ objectAliases.push({
32
+ kind: StructureKind.TypeAlias,
33
+ ...(description && { docs: [{ description }] }),
34
+ name: schemaUsage.includes(SchemaContext.Input)
35
+ ? `${objectSchema.typeName}`
36
+ : `${objectSchema.outputTypeName}`,
37
+ type: schemaUsage.includes(SchemaContext.Input)
38
+ ? `${objectSchema.alias}`
39
+ : `${objectSchema.outputAlias}`,
40
+ isExported: true
41
+ });
42
+ if (objectSchema.alias?.startsWith("Paged<")) {
43
+ importedModels.add("Paged");
44
+ }
45
+ }
46
+ }
47
+ return objectAliases;
48
+ }
49
+ export function buildPolymorphicAliases(model, schemaUsage) {
50
+ // We'll add aliases for polymorphic objects
51
+ const objectAliases = [];
52
+ const objectSchemas = (model.schemas ?? []).filter((o) => isObjectSchema(o) &&
53
+ o.usage?.some((u) => schemaUsage.includes(u)));
54
+ for (const objectSchema of objectSchemas) {
55
+ const baseName = getObjectBaseName(objectSchema, schemaUsage);
56
+ const typeAlias = getPolymorphicTypeAlias(baseName, objectSchema, schemaUsage);
57
+ if (typeAlias) {
58
+ objectAliases.push(typeAlias);
59
+ }
60
+ }
61
+ return objectAliases;
62
+ }
63
+ /**
64
+ * Gets a base name for an object schema this is tipically used with suffixes when building interface or type names
65
+ */
66
+ function getObjectBaseName(objectSchema, schemaUsage) {
67
+ const nameSuffix = schemaUsage.includes(SchemaContext.Output) ? "Output" : "";
68
+ const name = normalizeName(objectSchema.name, NameType.Interface, true /** guard name */);
69
+ return `${name}${nameSuffix}`;
70
+ }
71
+ /**
72
+ * If the current object is a Polymorphic parent, we need to create
73
+ * a type alias with the union of its children to enable polymorphism
74
+ */
75
+ function getPolymorphicTypeAlias(baseName, objectSchema, schemaUsage) {
76
+ if (!isPolymorphicParent(objectSchema)) {
77
+ return undefined;
78
+ }
79
+ const unionTypes = [];
80
+ // If the object itself has a discriminatorValue add its base to the union
81
+ if (objectSchema.discriminatorValue) {
82
+ unionTypes.push(`${baseName}Parent`);
83
+ }
84
+ for (const child of objectSchema.children?.all ?? []) {
85
+ const nameSuffix = schemaUsage.includes(SchemaContext.Output)
86
+ ? "Output"
87
+ : "";
88
+ const name = normalizeName(child.name, NameType.Interface, true /** shouldGuard */);
89
+ unionTypes.push(`${name}${nameSuffix}`);
90
+ }
91
+ const description = objectSchema.description;
92
+ return {
93
+ kind: StructureKind.TypeAlias,
94
+ ...(description && { docs: [{ description }] }),
95
+ name: `${baseName}`,
96
+ type: unionTypes.join(" | "),
97
+ isExported: true
98
+ };
99
+ }
100
+ /**
101
+ * Builds the interface for the current object schema. If it is a polymorphic
102
+ * root node it will suffix it with Base.
103
+ */
104
+ function getObjectInterfaceDeclaration(baseName, objectSchema, schemaUsage, importedModels) {
105
+ let interfaceName = `${baseName}`;
106
+ if (isPolymorphicParent(objectSchema)) {
107
+ interfaceName = `${baseName}Parent`;
108
+ }
109
+ const properties = objectSchema.properties ?? {};
110
+ let propertySignatures = getPropertySignatures(properties, schemaUsage, importedModels);
111
+ // Add the polymorphic property if exists
112
+ propertySignatures = addDiscriminatorProperty(objectSchema, propertySignatures);
113
+ // Calculate the parents of the current object
114
+ const extendFrom = getImmediateParentsNames(objectSchema, schemaUsage);
115
+ const description = objectSchema.description;
116
+ return {
117
+ kind: StructureKind.Interface,
118
+ ...(description && { docs: [{ description }] }),
119
+ name: interfaceName,
120
+ isExported: true,
121
+ properties: propertySignatures,
122
+ ...(extendFrom && { extends: extendFrom })
123
+ };
124
+ }
125
+ function isPolymorphicParent(objectSchema) {
126
+ return objectSchema.isPolyParent ? true : false;
127
+ }
128
+ function addDiscriminatorProperty(objectSchema, properties) {
129
+ const polymorphicProperty = getDiscriminatorProperty(objectSchema);
130
+ if (polymorphicProperty) {
131
+ // It is possible that the polymorphic property needs to override an existing property.
132
+ // This is usually the case on the top level parent where the property already has a type of string
133
+ // we need to replace it with the polymorphic values of its children
134
+ const filteredProperties = properties.filter((p) => p.name !== polymorphicProperty.name);
135
+ return [...filteredProperties, polymorphicProperty];
136
+ }
137
+ return properties;
138
+ }
139
+ /**
140
+ * Finds the name of the property used as discriminator and the discriminator value.
141
+ */
142
+ function getDiscriminatorProperty(objectSchema) {
143
+ const discriminatorValue = objectSchema.discriminatorValue;
144
+ if (!discriminatorValue && !objectSchema.discriminator) {
145
+ return undefined;
146
+ }
147
+ const discriminators = getDiscriminatorValue(objectSchema);
148
+ const discriminatorPropertyName = getDiscriminatorPropertyName(objectSchema);
149
+ if (discriminators) {
150
+ if (discriminatorPropertyName === undefined) {
151
+ throw new Error(`getDiscriminatorProperty: Expected object ${objectSchema.name} to have a discriminator in its hierarchy but found none`);
152
+ }
153
+ return {
154
+ kind: StructureKind.PropertySignature,
155
+ name: `"${discriminatorPropertyName}"`,
156
+ type: discriminators
157
+ };
158
+ }
159
+ return undefined;
160
+ }
161
+ /**
162
+ * Finds the closest discriminator property
163
+ */
164
+ function getDiscriminatorPropertyName(objectSchema) {
165
+ if (objectSchema.discriminator !== undefined) {
166
+ return objectSchema.discriminator.name;
167
+ }
168
+ const allParents = objectSchema.parents?.all ?? [];
169
+ for (const parent of allParents) {
170
+ if (isObjectSchema(parent) && parent.discriminator) {
171
+ return parent.discriminator.name;
172
+ }
173
+ }
174
+ return undefined;
175
+ }
176
+ /**
177
+ * Calculates the discriminator values that a given object needs
178
+ */
179
+ function getDiscriminatorValue(objectSchema) {
180
+ const discriminatorValue = objectSchema.discriminatorValue
181
+ ? objectSchema.discriminatorValue
182
+ : objectSchema.discriminator
183
+ ? objectSchema.name
184
+ : undefined;
185
+ const children = objectSchema.children?.immediate ?? [];
186
+ // If the current object has a discriminatorValue but doesn't have any children
187
+ // it is a leaf node and the only discriminator value needed is itself
188
+ if (discriminatorValue && !children.length) {
189
+ return `"${discriminatorValue}"`;
190
+ }
191
+ // when the current object has both discriminator and discriminatorValue
192
+ if (children) {
193
+ const discriminatorProperty = objectSchema.discriminator;
194
+ // Even when there are children, if no discriminatorProperty is present this is a leaf in the polymorphism tree
195
+ if (!discriminatorProperty) {
196
+ return `"${discriminatorValue}"`;
197
+ }
198
+ // the current object has discriminated children we need to find all the discriminatorValues for each of its children
199
+ const allChildren = objectSchema.children?.all ?? [];
200
+ // Top level parents may not have a discriminator of their own.
201
+ const selfDiscriminator = discriminatorValue
202
+ ? [`"${discriminatorValue}"`]
203
+ : [];
204
+ const childValues = getChildDiscriminatorValues(allChildren).map((v) => `"${v}"`);
205
+ return [...selfDiscriminator, ...childValues].join(" | ");
206
+ }
207
+ return undefined;
208
+ }
209
+ /**
210
+ * Looks into the children and grabs all possible discriminatorValues
211
+ */
212
+ function getChildDiscriminatorValues(children) {
213
+ const discriminatorValues = new Set();
214
+ for (const child of children) {
215
+ if (isObjectSchema(child) && child.discriminatorValue) {
216
+ discriminatorValues.add(child.discriminatorValue);
217
+ }
218
+ }
219
+ return [...discriminatorValues];
220
+ }
221
+ /**
222
+ * Gets a list of types a given object may extend from
223
+ */
224
+ function getImmediateParentsNames(objectSchema, schemaUsage) {
225
+ if (!objectSchema.parents?.immediate) {
226
+ return [];
227
+ }
228
+ const extendFrom = [];
229
+ // If an immediate parent is a DictionarySchema, that means that the object has been marked
230
+ // with additional properties. We need to add Record<string, unknown> to the extend list and
231
+ if (objectSchema.parents.immediate.find(isDictionarySchema)) {
232
+ extendFrom.push("Record<string, unknown>");
233
+ }
234
+ // Get the rest of the parents excluding any DictionarySchemas
235
+ const parents = objectSchema.parents.immediate
236
+ .filter((p) => !isDictionarySchema(p))
237
+ .map((parent) => {
238
+ const nameSuffix = schemaUsage.includes(SchemaContext.Output)
239
+ ? "Output"
240
+ : "";
241
+ const name = `${normalizeName(parent.name, NameType.Interface, true /** shouldGuard */)}${nameSuffix}`;
242
+ return isObjectSchema(parent) && isPolymorphicParent(parent)
243
+ ? `${name}Parent`
244
+ : name;
245
+ });
246
+ return [...parents, ...extendFrom];
247
+ }
248
+ function getPropertySignatures(properties, schemaUsage, importedModels) {
249
+ let validProperties = Object.keys(properties);
250
+ const readOnlyFilter = (name) => !(schemaUsage.includes(SchemaContext.Input) && properties[name].readOnly);
251
+ const neverFilter = (name) => properties[name].type !== "never";
252
+ validProperties = validProperties.filter(readOnlyFilter).filter(neverFilter);
253
+ return validProperties.map((p) => getPropertySignature({ ...properties[p], name: p }, schemaUsage, importedModels));
254
+ }
255
+ /**
256
+ * Builds a Typescript property or parameter signature
257
+ * @param property - Property or parameter to get the Typescript signature for
258
+ * @param importedModels - Set to track the models that need to be imported
259
+ * @returns a PropertySignatureStructure for the property.
260
+ */
261
+ export function getPropertySignature(property, schemaUsage, importedModels) {
262
+ const propertyName = property.name;
263
+ const description = property.description;
264
+ let type = generateForOutput(schemaUsage, property.usage) && property.outputTypeName
265
+ ? property.outputTypeName
266
+ : property.typeName
267
+ ? property.typeName
268
+ : property.type;
269
+ if (property.typeName && property.fromCore) {
270
+ importedModels.add(property.typeName);
271
+ type = property.typeName;
272
+ }
273
+ return {
274
+ name: propertyName,
275
+ ...(description && { docs: [{ description }] }),
276
+ hasQuestionToken: !property.required,
277
+ isReadonly: generateForOutput(schemaUsage, property.usage) && property.readOnly,
278
+ type,
279
+ kind: StructureKind.PropertySignature
280
+ };
281
+ }
282
+ function generateForOutput(schemaUsage, propertyUsage) {
283
+ return ((schemaUsage.includes(SchemaContext.Output) &&
284
+ propertyUsage?.includes(SchemaContext.Output)) ||
285
+ (schemaUsage.includes(SchemaContext.Exception) &&
286
+ propertyUsage?.includes(SchemaContext.Exception)));
287
+ }
288
+ //# sourceMappingURL=buildObjectTypes.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"buildObjectTypes.js","sourceRoot":"","sources":["../src/buildObjectTypes.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAGL,aAAa,EAEd,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAKL,aAAa,EACd,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAAe,EACf,cAA2B,EAC3B,WAA4B;IAE5B,MAAM,aAAa,GAAmB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAChE,CAAC,CAAC,EAAE,EAAE,CACJ,cAAc,CAAC,CAAC,CAAC;QAChB,CAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC;IACF,MAAM,gBAAgB,GAAoC,EAAE,CAAC;IAE7D,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;QACxC,IAAI,YAAY,CAAC,KAAK,IAAI,YAAY,CAAC,WAAW,EAAE;YAClD,SAAS;SACV;QACD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QAC9D,MAAM,oBAAoB,GAAG,6BAA6B,CACxD,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,cAAc,CACf,CAAC;QAEF,gBAAgB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;KAC7C;IACD,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,KAAe,EACf,cAA2B,EAC3B,WAA4B;IAE5B,MAAM,aAAa,GAAmB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAChE,CAAC,CAAC,EAAE,EAAE,CACJ,cAAc,CAAC,CAAC,CAAC;QAChB,CAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC;IACF,MAAM,aAAa,GAAoC,EAAE,CAAC;IAE1D,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;QACxC,IAAI,YAAY,CAAC,KAAK,IAAI,YAAY,CAAC,WAAW,EAAE;YAClD,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;YAC7C,aAAa,CAAC,IAAI,CAAC;gBACjB,IAAI,EAAE,aAAa,CAAC,SAAS;gBAC7B,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;gBAC/C,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;oBAC7C,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,EAAE;oBAC5B,CAAC,CAAC,GAAG,YAAY,CAAC,cAAc,EAAE;gBACpC,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;oBAC7C,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE;oBACzB,CAAC,CAAC,GAAG,YAAY,CAAC,WAAW,EAAE;gBACjC,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;YACH,IAAI,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC5C,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aAC7B;SACF;KACF;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,KAAe,EACf,WAA4B;IAE5B,4CAA4C;IAC5C,MAAM,aAAa,GAAoC,EAAE,CAAC;IAC1D,MAAM,aAAa,GAAmB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAChE,CAAC,CAAC,EAAE,EAAE,CACJ,cAAc,CAAC,CAAC,CAAC;QAChB,CAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC;IACF,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;QACxC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QAC9D,MAAM,SAAS,GAAG,uBAAuB,CACvC,QAAQ,EACR,YAAY,EACZ,WAAW,CACZ,CAAC;QACF,IAAI,SAAS,EAAE;YACb,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC/B;KACF;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CACxB,YAA0B,EAC1B,WAA4B;IAE5B,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,MAAM,IAAI,GAAG,aAAa,CACxB,YAAY,CAAC,IAAI,EACjB,QAAQ,CAAC,SAAS,EAClB,IAAI,CAAC,iBAAiB,CACvB,CAAC;IAEF,OAAO,GAAG,IAAI,GAAG,UAAU,EAAE,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,SAAS,uBAAuB,CAC9B,QAAgB,EAChB,YAA0B,EAC1B,WAA4B;IAE5B,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE;QACtC,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,UAAU,GAAa,EAAE,CAAC;IAEhC,0EAA0E;IAC1E,IAAI,YAAY,CAAC,kBAAkB,EAAE;QACnC,UAAU,CAAC,IAAI,CAAC,GAAG,QAAQ,QAAQ,CAAC,CAAC;KACtC;IAED,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE;QACpD,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC;YAC3D,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,IAAI,GAAG,aAAa,CACxB,KAAK,CAAC,IAAI,EACV,QAAQ,CAAC,SAAS,EAClB,IAAI,CAAC,kBAAkB,CACxB,CAAC;QAEF,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,UAAU,EAAE,CAAC,CAAC;KACzC;IAED,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;IAE7C,OAAO;QACL,IAAI,EAAE,aAAa,CAAC,SAAS;QAC7B,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;QAC/C,IAAI,EAAE,GAAG,QAAQ,EAAE;QACnB,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5B,UAAU,EAAE,IAAI;KACjB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,6BAA6B,CACpC,QAAgB,EAChB,YAA0B,EAC1B,WAA4B,EAC5B,cAA2B;IAE3B,IAAI,aAAa,GAAG,GAAG,QAAQ,EAAE,CAAC;IAClC,IAAI,mBAAmB,CAAC,YAAY,CAAC,EAAE;QACrC,aAAa,GAAG,GAAG,QAAQ,QAAQ,CAAC;KACrC;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,IAAI,EAAE,CAAC;IAEjD,IAAI,kBAAkB,GAAG,qBAAqB,CAC5C,UAAU,EACV,WAAW,EACX,cAAc,CACf,CAAC;IAEF,yCAAyC;IACzC,kBAAkB,GAAG,wBAAwB,CAC3C,YAAY,EACZ,kBAAkB,CACnB,CAAC;IAEF,8CAA8C;IAC9C,MAAM,UAAU,GAAG,wBAAwB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAEvE,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;IAC7C,OAAO;QACL,IAAI,EAAE,aAAa,CAAC,SAAS;QAC7B,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;QAC/C,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,IAAI;QAChB,UAAU,EAAE,kBAAkB;QAC9B,GAAG,CAAC,UAAU,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC3C,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,YAA0B;IACrD,OAAO,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AAClD,CAAC;AAED,SAAS,wBAAwB,CAC/B,YAA0B,EAC1B,UAAwC;IAExC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAAC;IAEnE,IAAI,mBAAmB,EAAE;QACvB,uFAAuF;QACvF,mGAAmG;QACnG,oEAAoE;QACpE,MAAM,kBAAkB,GAAG,UAAU,CAAC,MAAM,CAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,IAAI,CAC3C,CAAC;QACF,OAAO,CAAC,GAAG,kBAAkB,EAAE,mBAAmB,CAAC,CAAC;KACrD;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,SAAS,wBAAwB,CAC/B,YAA0B;IAE1B,MAAM,kBAAkB,GAAG,YAAY,CAAC,kBAAkB,CAAC;IAC3D,IAAI,CAAC,kBAAkB,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE;QACtD,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,cAAc,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC3D,MAAM,yBAAyB,GAAG,4BAA4B,CAAC,YAAY,CAAC,CAAC;IAE7E,IAAI,cAAc,EAAE;QAClB,IAAI,yBAAyB,KAAK,SAAS,EAAE;YAC3C,MAAM,IAAI,KAAK,CACb,6CAA6C,YAAY,CAAC,IAAI,0DAA0D,CACzH,CAAC;SACH;QAED,OAAO;YACL,IAAI,EAAE,aAAa,CAAC,iBAAiB;YACrC,IAAI,EAAE,IAAI,yBAAyB,GAAG;YACtC,IAAI,EAAE,cAAc;SACrB,CAAC;KACH;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,SAAS,4BAA4B,CAAC,YAA0B;IAC9D,IAAI,YAAY,CAAC,aAAa,KAAK,SAAS,EAAE;QAC5C,OAAO,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC;KACxC;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IAEnD,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;QAC/B,IAAI,cAAc,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,aAAa,EAAE;YAClD,OAAO,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC;SAClC;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAAC,YAA0B;IACvD,MAAM,kBAAkB,GAAG,YAAY,CAAC,kBAAkB;QACxD,CAAC,CAAC,YAAY,CAAC,kBAAkB;QACjC,CAAC,CAAC,YAAY,CAAC,aAAa;YAC5B,CAAC,CAAC,YAAY,CAAC,IAAI;YACnB,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,SAAS,IAAI,EAAE,CAAC;IAExD,+EAA+E;IAC/E,sEAAsE;IACtE,IAAI,kBAAkB,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC1C,OAAO,IAAI,kBAAkB,GAAG,CAAC;KAClC;IAED,wEAAwE;IACxE,IAAI,QAAQ,EAAE;QACZ,MAAM,qBAAqB,GAAG,YAAY,CAAC,aAAa,CAAC;QACzD,+GAA+G;QAC/G,IAAI,CAAC,qBAAqB,EAAE;YAC1B,OAAO,IAAI,kBAAkB,GAAG,CAAC;SAClC;QAED,qHAAqH;QACrH,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAC;QAErD,+DAA+D;QAC/D,MAAM,iBAAiB,GAAG,kBAAkB;YAC1C,CAAC,CAAC,CAAC,IAAI,kBAAkB,GAAG,CAAC;YAC7B,CAAC,CAAC,EAAE,CAAC;QAEP,MAAM,WAAW,GAAG,2BAA2B,CAAC,WAAW,CAAC,CAAC,GAAG,CAC9D,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAChB,CAAC;QAEF,OAAO,CAAC,GAAG,iBAAiB,EAAE,GAAG,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC3D;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,SAAS,2BAA2B,CAAC,QAAwB;IAC3D,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9C,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;QAC5B,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,kBAAkB,EAAE;YACrD,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACnD;KACF;IAED,OAAO,CAAC,GAAG,mBAAmB,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,SAAS,wBAAwB,CAC/B,YAA0B,EAC1B,WAA4B;IAE5B,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,EAAE;QACpC,OAAO,EAAE,CAAC;KACX;IAED,MAAM,UAAU,GAAa,EAAE,CAAC;IAEhC,2FAA2F;IAC3F,4FAA4F;IAC5F,IAAI,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE;QAC3D,UAAU,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,8DAA8D;IAC9D,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS;SAC3C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;SACrC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACd,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC;YAC3D,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,IAAI,GAAG,GAAG,aAAa,CAC3B,MAAM,CAAC,IAAI,EACX,QAAQ,CAAC,SAAS,EAClB,IAAI,CAAC,kBAAkB,CACxB,GAAG,UAAU,EAAE,CAAC;QAEjB,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC;YAC1D,CAAC,CAAC,GAAG,IAAI,QAAQ;YACjB,CAAC,CAAC,IAAI,CAAC;IACX,CAAC,CAAC,CAAC;IAEL,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,qBAAqB,CAC5B,UAAuC,EACvC,WAA4B,EAC5B,cAA2B;IAE3B,IAAI,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9C,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,EAAE,CACtC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC5E,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC;IACxE,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7E,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC/B,oBAAoB,CAClB,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAC7B,WAAW,EACX,cAAc,CACf,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAA8B,EAC9B,WAA4B,EAC5B,cAA2B;IAE3B,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC;IAEnC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;IACzC,IAAI,IAAI,GACN,iBAAiB,CAAC,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,cAAc;QACvE,CAAC,CAAC,QAAQ,CAAC,cAAc;QACzB,CAAC,CAAC,QAAQ,CAAC,QAAQ;YACnB,CAAC,CAAC,QAAQ,CAAC,QAAQ;YACnB,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IACpB,IAAI,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE;QAC1C,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC;KAC1B;IACD,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,GAAG,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;QAC/C,gBAAgB,EAAE,CAAC,QAAQ,CAAC,QAAQ;QACpC,UAAU,EACR,iBAAiB,CAAC,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ;QACrE,IAAI;QACJ,IAAI,EAAE,aAAa,CAAC,iBAAiB;KACtC,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,WAA4B,EAC5B,aAA+B;IAE/B,OAAO,CACL,CAAC,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC;QACzC,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC;YAC5C,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CACpD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,26 @@
1
+ import * as path from "path";
2
+ // @ts-ignore: to fix the handlebars issue
3
+ import hbs from "handlebars";
4
+ import { paginateContent } from "./static/paginateContent.js";
5
+ export function buildPaginateHelper(model) {
6
+ const pagingInfo = model.annotations;
7
+ // return directly if no paging info
8
+ if (!pagingInfo || pagingInfo.hasPaging !== true || !pagingInfo.pageDetails) {
9
+ return;
10
+ }
11
+ hbs.registerHelper("quoteWrap", function (value) {
12
+ if (Array.isArray(value)) {
13
+ return value.map((element) => `"${element}"`).join();
14
+ }
15
+ return `"${value}"`;
16
+ });
17
+ const { srcPath } = model;
18
+ const paginateHelperContents = hbs.compile(paginateContent, {
19
+ noEscape: true
20
+ });
21
+ return {
22
+ path: path.join(srcPath, "paginateHelper.ts"),
23
+ content: paginateHelperContents(pagingInfo.pageDetails)
24
+ };
25
+ }
26
+ //# sourceMappingURL=buildPaginateHelper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"buildPaginateHelper.js","sourceRoot":"","sources":["../src/buildPaginateHelper.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,0CAA0C;AAC1C,OAAO,GAAG,MAAM,YAAY,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,MAAM,UAAU,mBAAmB,CAAC,KAAe;IACjD,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC;IACrC,oCAAoC;IACpC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE;QAC3E,OAAO;KACR;IAED,GAAG,CAAC,cAAc,CAChB,WAAW,EACX,UAAU,KAA2C;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;SACtD;QAED,OAAO,IAAI,KAAK,GAAG,CAAC;IACtB,CAAC,CACF,CAAC;IAEF,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAC1B,MAAM,sBAAsB,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE;QAC1D,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IACH,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,mBAAmB,CAAC;QAC7C,OAAO,EAAE,sBAAsB,CAAC,UAAU,CAAC,WAAW,CAAC;KACxD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,321 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ import { Project, StructureKind } from "ts-morph";
4
+ import * as path from "path";
5
+ import { ImportKind } from "./interfaces.js";
6
+ import { getParameterBaseName, getParameterTypeName } from "./helpers/nameConstructors.js";
7
+ export function buildParameterTypes(model) {
8
+ const project = new Project();
9
+ const srcPath = model.srcPath;
10
+ const filePath = path.join(srcPath, `parameters.ts`);
11
+ const parametersFile = project.createSourceFile(filePath, undefined, {
12
+ overwrite: true
13
+ });
14
+ let hasHeaders = false;
15
+ if (!model.parameters) {
16
+ return;
17
+ }
18
+ for (const requestParameter of model.parameters) {
19
+ const baseParameterName = getParameterBaseName(requestParameter.operationGroup, requestParameter.operationName);
20
+ const requestCount = requestParameter?.parameters?.length ?? 0;
21
+ const topParamName = getParameterTypeName(baseParameterName);
22
+ const subParamNames = [];
23
+ // We need to loop the requests. An operation with multiple requests means that
24
+ // the operation can get different values for content-type and each value may
25
+ // have a different type associated to it.
26
+ for (let i = 0; i < requestCount; i++) {
27
+ const parameter = requestParameter.parameters[i];
28
+ const internalReferences = new Set();
29
+ // In case we have more than one request to model we need to add a suffix to differentiate
30
+ const nameSuffix = i > 0 ? `${i}` : "";
31
+ const parameterInterfaceName = requestCount > 1
32
+ ? `${baseParameterName}RequestParameters${nameSuffix}`
33
+ : topParamName;
34
+ const queryParameterDefinitions = buildQueryParameterDefinition(parameter, baseParameterName, internalReferences, i);
35
+ const pathParameterDefinitions = buildPathParameterDefinitions(parameter, baseParameterName, parametersFile, internalReferences, i);
36
+ const headerParameterDefinitions = buildHeaderParameterDefinitions(parameter, baseParameterName, parametersFile, internalReferences, i);
37
+ const contentTypeParameterDefinition = buildContentTypeParametersDefinition(parameter, baseParameterName, internalReferences, i);
38
+ const bodyParameterDefinition = buildBodyParametersDefinition(parameter, baseParameterName, internalReferences, i);
39
+ const bodyTypeAlias = buildBodyTypeAlias(parameter);
40
+ if (bodyTypeAlias) {
41
+ parametersFile.addTypeAlias(bodyTypeAlias);
42
+ }
43
+ // Add interfaces for body and query parameters
44
+ parametersFile.addInterfaces([
45
+ ...(bodyParameterDefinition ?? []),
46
+ ...(queryParameterDefinitions ?? []),
47
+ ...(pathParameterDefinitions ? [pathParameterDefinitions] : []),
48
+ ...(headerParameterDefinitions ? [headerParameterDefinitions] : []),
49
+ ...(contentTypeParameterDefinition
50
+ ? [contentTypeParameterDefinition]
51
+ : [])
52
+ ]);
53
+ // Add Operation parameters type alias which is composed of the types we generated above
54
+ // plus the common type RequestParameters
55
+ parametersFile.addTypeAlias({
56
+ name: parameterInterfaceName,
57
+ isExported: true,
58
+ type: [...internalReferences, "RequestParameters"].join(" & ")
59
+ });
60
+ subParamNames.push(parameterInterfaceName);
61
+ if (headerParameterDefinitions !== undefined) {
62
+ hasHeaders = true;
63
+ }
64
+ }
65
+ // Add Operation parameters type alias which is composed of the types we generated above
66
+ // plus the common type RequestParameters
67
+ if (requestCount > 1) {
68
+ parametersFile.addTypeAlias({
69
+ name: topParamName,
70
+ isExported: true,
71
+ type: [...subParamNames].join(" | ")
72
+ });
73
+ }
74
+ }
75
+ if (hasHeaders) {
76
+ parametersFile.addImportDeclarations([
77
+ {
78
+ namedImports: ["RawHttpHeadersInput"],
79
+ moduleSpecifier: "@azure/core-rest-pipeline"
80
+ }
81
+ ]);
82
+ }
83
+ parametersFile.addImportDeclarations([
84
+ {
85
+ namedImports: ["RequestParameters"],
86
+ moduleSpecifier: "@azure-rest/core-client"
87
+ }
88
+ ]);
89
+ if (model.importSet?.has(ImportKind.ParameterInput)) {
90
+ parametersFile.addImportDeclarations([
91
+ {
92
+ namedImports: [
93
+ ...Array.from(model.importSet?.get(ImportKind.ParameterInput) || [])
94
+ ],
95
+ moduleSpecifier: "./models"
96
+ }
97
+ ]);
98
+ }
99
+ return { path: filePath, content: parametersFile.getFullText() };
100
+ }
101
+ function buildQueryParameterDefinition(parameters, baseName, internalReferences, requestIndex) {
102
+ const queryParameters = (parameters?.parameters || []).filter((p) => p.type === "query");
103
+ if (!queryParameters.length) {
104
+ return undefined;
105
+ }
106
+ const nameSuffix = requestIndex > 0 ? `${requestIndex}` : "";
107
+ const queryParameterInterfaceName = `${baseName}QueryParam${nameSuffix}`;
108
+ const queryParameterPropertiesName = `${baseName}QueryParamProperties`;
109
+ // Get the property signature for each query parameter
110
+ const propertiesDefinition = queryParameters.map((qp) => getPropertyFromSchema(qp.param));
111
+ const hasRequiredParameters = propertiesDefinition.some((p) => !p.hasQuestionToken);
112
+ const propertiesInterface = {
113
+ kind: StructureKind.Interface,
114
+ isExported: true,
115
+ name: queryParameterPropertiesName,
116
+ properties: propertiesDefinition
117
+ };
118
+ const parameterInterface = {
119
+ kind: StructureKind.Interface,
120
+ isExported: true,
121
+ name: queryParameterInterfaceName,
122
+ properties: [
123
+ {
124
+ name: "queryParameters",
125
+ type: queryParameterPropertiesName,
126
+ // Mark as optional if there are no required parameters
127
+ hasQuestionToken: !hasRequiredParameters
128
+ }
129
+ ]
130
+ };
131
+ // Mark the queryParameter interface for importing
132
+ internalReferences.add(queryParameterInterfaceName);
133
+ return [propertiesInterface, parameterInterface];
134
+ }
135
+ function getPropertyFromSchema(schema) {
136
+ const description = schema.description;
137
+ return {
138
+ name: schema.name,
139
+ ...(description && { docs: [{ description }] }),
140
+ type: schema.type,
141
+ hasQuestionToken: !schema.required,
142
+ kind: StructureKind.PropertySignature
143
+ };
144
+ }
145
+ function buildPathParameterDefinitions(parameters, baseName, parametersFile, internalReferences, requestIndex) {
146
+ const pathParameters = (parameters.parameters || []).filter((p) => p.type === "path");
147
+ if (!pathParameters.length) {
148
+ return undefined;
149
+ }
150
+ const nameSuffix = requestIndex > 0 ? `${requestIndex}` : "";
151
+ const pathParameterInterfaceName = `${baseName}PathParam${nameSuffix}`;
152
+ const pathInterface = getPathInterfaceDefinition(pathParameters, baseName);
153
+ if (pathInterface) {
154
+ parametersFile.addInterface(pathInterface);
155
+ }
156
+ internalReferences.add(pathParameterInterfaceName);
157
+ return {
158
+ isExported: true,
159
+ kind: StructureKind.Interface,
160
+ name: pathParameterInterfaceName,
161
+ properties: [
162
+ {
163
+ name: "pathParameters",
164
+ type: `${baseName}PathParameters`,
165
+ kind: StructureKind.PropertySignature
166
+ }
167
+ ]
168
+ };
169
+ }
170
+ function getPathInterfaceDefinition(pathParameters, baseName) {
171
+ const pathInterfaceName = `${baseName}PathParameters`;
172
+ return {
173
+ kind: StructureKind.Interface,
174
+ isExported: true,
175
+ name: pathInterfaceName,
176
+ properties: pathParameters.map((p) => getPropertyFromSchema(p.param))
177
+ };
178
+ }
179
+ function buildHeaderParameterDefinitions(parameters, baseName, parametersFile, internalReferences, requestIndex) {
180
+ const headerParameters = (parameters.parameters || []).filter((p) => p.type === "header" && p.name !== "contentType");
181
+ if (!headerParameters.length) {
182
+ return undefined;
183
+ }
184
+ const nameSuffix = requestIndex > 0 ? `${requestIndex}` : "";
185
+ const headerParameterInterfaceName = `${baseName}HeaderParam${nameSuffix}`;
186
+ const headersInterface = getRequestHeaderInterfaceDefinition(headerParameters, baseName);
187
+ let isOptional = true;
188
+ if (headersInterface) {
189
+ parametersFile.addInterface(headersInterface);
190
+ isOptional = !(headersInterface.properties || []).some((prop) => prop.hasQuestionToken === false);
191
+ }
192
+ internalReferences.add(headerParameterInterfaceName);
193
+ return {
194
+ isExported: true,
195
+ kind: StructureKind.Interface,
196
+ name: headerParameterInterfaceName,
197
+ properties: [
198
+ {
199
+ name: "headers",
200
+ type: `RawHttpHeadersInput & ${baseName}Headers`,
201
+ kind: StructureKind.PropertySignature,
202
+ hasQuestionToken: isOptional
203
+ }
204
+ ]
205
+ };
206
+ }
207
+ function getRequestHeaderInterfaceDefinition(headerParameters, baseName) {
208
+ const headersInterfaceName = `${baseName}Headers`;
209
+ return {
210
+ kind: StructureKind.Interface,
211
+ isExported: true,
212
+ name: headersInterfaceName,
213
+ properties: headerParameters.map((h) => getPropertyFromSchema(h.param))
214
+ };
215
+ }
216
+ function buildContentTypeParametersDefinition(parameters, baseName, internalReferences, requestIndex) {
217
+ const mediaTypeParameters = (parameters.parameters || []).filter((p) => p.type === "header" && p.name === "contentType");
218
+ if (!mediaTypeParameters.length) {
219
+ return undefined;
220
+ }
221
+ const nameSuffix = requestIndex > 0 ? `${requestIndex}` : "";
222
+ const mediaTypesParameterInterfaceName = `${baseName}MediaTypesParam${nameSuffix}`;
223
+ // Mark the queryParameter interface for importing
224
+ internalReferences.add(mediaTypesParameterInterfaceName);
225
+ const mediaParam = mediaTypeParameters[0].param;
226
+ return {
227
+ isExported: true,
228
+ kind: StructureKind.Interface,
229
+ name: mediaTypesParameterInterfaceName,
230
+ properties: [getPropertyFromSchema(mediaParam)]
231
+ };
232
+ }
233
+ function buildBodyParametersDefinition(parameters, baseName, internalReferences, requestIndex) {
234
+ const bodyParameters = parameters.body;
235
+ if (!bodyParameters ||
236
+ !bodyParameters?.body ||
237
+ !bodyParameters?.body.length) {
238
+ return [];
239
+ }
240
+ const nameSuffix = requestIndex > 0 ? `${requestIndex}` : "";
241
+ const bodyParameterInterfaceName = `${baseName}BodyParam${nameSuffix}`;
242
+ internalReferences.add(bodyParameterInterfaceName);
243
+ // In case of formData we'd get multiple properties in body marked as partialBody
244
+ if (bodyParameters.isPartialBody) {
245
+ let allOptionalParts = true;
246
+ const propertiesDefinitions = [];
247
+ for (const param of bodyParameters.body) {
248
+ if (param.required) {
249
+ allOptionalParts = false;
250
+ }
251
+ propertiesDefinitions.push(getPropertyFromSchema(param));
252
+ }
253
+ const formBodyName = `${baseName}FormBody`;
254
+ const formBodyInterface = {
255
+ isExported: true,
256
+ kind: StructureKind.Interface,
257
+ name: formBodyName,
258
+ properties: propertiesDefinitions
259
+ };
260
+ return [
261
+ {
262
+ isExported: true,
263
+ kind: StructureKind.Interface,
264
+ name: bodyParameterInterfaceName,
265
+ properties: [
266
+ {
267
+ name: "body",
268
+ type: formBodyName,
269
+ hasQuestionToken: allOptionalParts
270
+ }
271
+ ]
272
+ },
273
+ formBodyInterface
274
+ ];
275
+ }
276
+ else {
277
+ const bodySignature = getPropertyFromSchema(bodyParameters.body[0]);
278
+ return [
279
+ {
280
+ isExported: true,
281
+ kind: StructureKind.Interface,
282
+ name: bodyParameterInterfaceName,
283
+ properties: [
284
+ {
285
+ docs: bodySignature.docs,
286
+ name: "body",
287
+ type: bodySignature.type,
288
+ hasQuestionToken: bodySignature.hasQuestionToken
289
+ }
290
+ ]
291
+ }
292
+ ];
293
+ }
294
+ }
295
+ export function buildBodyTypeAlias(parameters) {
296
+ const bodyParameters = parameters.body;
297
+ if (!bodyParameters ||
298
+ !bodyParameters?.body ||
299
+ !bodyParameters?.body.length) {
300
+ return undefined;
301
+ }
302
+ const schema = bodyParameters.body[0];
303
+ const headerParameters = (parameters.parameters || []).filter((p) => p.type === "header" && p.name === "contentType");
304
+ if (!headerParameters.length || headerParameters.length > 1) {
305
+ return undefined;
306
+ }
307
+ const contentType = headerParameters[0].param.type;
308
+ const description = `${schema.description}`;
309
+ const typeName = `${schema.typeName}ResourceMergeAndPatch`;
310
+ if (contentType.includes("application/merge-patch+json")) {
311
+ const type = `Partial<${schema.typeName}>`;
312
+ return {
313
+ // kind: StructureKind.TypeAlias,
314
+ ...(description && { docs: [{ description }] }),
315
+ name: `${typeName}`,
316
+ type,
317
+ isExported: true
318
+ };
319
+ }
320
+ }
321
+ //# sourceMappingURL=buildParameterTypes.js.map