@osdk/maker 0.14.0-beta.1 → 0.14.0-beta.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 (223) hide show
  1. package/CHANGELOG.md +83 -0
  2. package/README.md +86 -22
  3. package/build/browser/api/action/DefaultFormat.js +2 -0
  4. package/build/browser/api/action/DefaultFormat.js.map +1 -0
  5. package/build/browser/api/action/TableConfiguration.js +2 -0
  6. package/build/browser/api/action/TableConfiguration.js.map +1 -0
  7. package/build/browser/api/code-snippets/createCodeSnippets.js +91 -0
  8. package/build/browser/api/code-snippets/createCodeSnippets.js.map +1 -0
  9. package/build/browser/api/code-snippets/snippetTypes.js +60 -0
  10. package/build/browser/api/code-snippets/snippetTypes.js.map +1 -0
  11. package/build/browser/api/defineAction.js +131 -414
  12. package/build/browser/api/defineAction.js.map +1 -1
  13. package/build/browser/api/defineCreateInterfaceObjectAction.js +85 -0
  14. package/build/browser/api/defineCreateInterfaceObjectAction.js.map +1 -0
  15. package/build/browser/api/defineCreateObjectAction.js +80 -0
  16. package/build/browser/api/defineCreateObjectAction.js.map +1 -0
  17. package/build/browser/api/defineCreateOrModifyObjectAction.js +95 -0
  18. package/build/browser/api/defineCreateOrModifyObjectAction.js.map +1 -0
  19. package/build/browser/api/defineDeleteInterfaceObjectAction.js +53 -0
  20. package/build/browser/api/defineDeleteInterfaceObjectAction.js.map +1 -0
  21. package/build/browser/api/defineDeleteObjectAction.js +56 -0
  22. package/build/browser/api/defineDeleteObjectAction.js.map +1 -0
  23. package/build/browser/api/defineLink.js +5 -13
  24. package/build/browser/api/defineLink.js.map +1 -1
  25. package/build/browser/api/defineModifyInterfaceObjectAction.js +84 -0
  26. package/build/browser/api/defineModifyInterfaceObjectAction.js.map +1 -0
  27. package/build/browser/api/defineModifyObjectAction.js +93 -0
  28. package/build/browser/api/defineModifyObjectAction.js.map +1 -0
  29. package/build/browser/api/defineObject.js +94 -3
  30. package/build/browser/api/defineObject.js.map +1 -1
  31. package/build/browser/api/defineOntology.js +5 -1
  32. package/build/browser/api/defineOntology.js.map +1 -1
  33. package/build/browser/api/links/LinkType.js.map +1 -1
  34. package/build/browser/api/object/ObjectType.js.map +1 -1
  35. package/build/browser/api/object/ObjectTypeDatasourceDefinition.js.map +1 -1
  36. package/build/browser/api/object/ObjectTypeDefinition.js.map +1 -1
  37. package/build/browser/api/test/actions.test.js +12034 -0
  38. package/build/browser/api/test/actions.test.js.map +1 -0
  39. package/build/browser/api/test/interfaces.test.js +924 -0
  40. package/build/browser/api/test/interfaces.test.js.map +1 -0
  41. package/build/browser/api/test/links.test.js +1974 -0
  42. package/build/browser/api/test/links.test.js.map +1 -0
  43. package/build/browser/api/{markingconstraint.test.js → test/markingconstraint.test.js} +28 -2
  44. package/build/browser/api/test/markingconstraint.test.js.map +1 -0
  45. package/build/browser/api/test/misc.test.js +1058 -0
  46. package/build/browser/api/test/misc.test.js.map +1 -0
  47. package/build/browser/api/{objectStatus.test.js → test/objectStatus.test.js} +2 -2
  48. package/build/browser/api/test/objectStatus.test.js.map +1 -0
  49. package/build/browser/api/test/objects.test.js +2591 -0
  50. package/build/browser/api/test/objects.test.js.map +1 -0
  51. package/build/browser/api/test/spt.test.js +387 -0
  52. package/build/browser/api/test/spt.test.js.map +1 -0
  53. package/build/browser/api/test/valueTypes.test.js +156 -0
  54. package/build/browser/api/test/valueTypes.test.js.map +1 -0
  55. package/build/browser/cli/main.js +23 -4
  56. package/build/browser/cli/main.js.map +1 -1
  57. package/build/browser/conversion/toMarketplace/convertActionParameterConditionalOverride.js +2 -2
  58. package/build/browser/conversion/toMarketplace/convertActionParameterConditionalOverride.js.map +1 -1
  59. package/build/browser/conversion/toMarketplace/convertActionValidation.js +2 -16
  60. package/build/browser/conversion/toMarketplace/convertActionValidation.js.map +1 -1
  61. package/build/browser/conversion/toMarketplace/convertConditionDefinition.js +4 -4
  62. package/build/browser/conversion/toMarketplace/convertConditionDefinition.js.map +1 -1
  63. package/build/browser/conversion/toMarketplace/convertDatasourceDefinition.js +3 -2
  64. package/build/browser/conversion/toMarketplace/convertDatasourceDefinition.js.map +1 -1
  65. package/build/browser/conversion/toMarketplace/convertLink.js +109 -24
  66. package/build/browser/conversion/toMarketplace/convertLink.js.map +1 -1
  67. package/build/browser/conversion/toMarketplace/convertObject.js +81 -4
  68. package/build/browser/conversion/toMarketplace/convertObject.js.map +1 -1
  69. package/build/browser/conversion/toMarketplace/convertSectionConditionalOverride.js +2 -2
  70. package/build/browser/conversion/toMarketplace/convertSectionConditionalOverride.js.map +1 -1
  71. package/build/browser/index.js +8 -1
  72. package/build/browser/index.js.map +1 -1
  73. package/build/cjs/index.cjs +1711 -806
  74. package/build/cjs/index.cjs.map +1 -1
  75. package/build/cjs/index.d.cts +184 -115
  76. package/build/esm/api/action/DefaultFormat.js +2 -0
  77. package/build/esm/api/action/DefaultFormat.js.map +1 -0
  78. package/build/esm/api/action/TableConfiguration.js +2 -0
  79. package/build/esm/api/action/TableConfiguration.js.map +1 -0
  80. package/build/esm/api/code-snippets/createCodeSnippets.js +91 -0
  81. package/build/esm/api/code-snippets/createCodeSnippets.js.map +1 -0
  82. package/build/esm/api/code-snippets/snippetTypes.js +60 -0
  83. package/build/esm/api/code-snippets/snippetTypes.js.map +1 -0
  84. package/build/esm/api/defineAction.js +131 -414
  85. package/build/esm/api/defineAction.js.map +1 -1
  86. package/build/esm/api/defineCreateInterfaceObjectAction.js +85 -0
  87. package/build/esm/api/defineCreateInterfaceObjectAction.js.map +1 -0
  88. package/build/esm/api/defineCreateObjectAction.js +80 -0
  89. package/build/esm/api/defineCreateObjectAction.js.map +1 -0
  90. package/build/esm/api/defineCreateOrModifyObjectAction.js +95 -0
  91. package/build/esm/api/defineCreateOrModifyObjectAction.js.map +1 -0
  92. package/build/esm/api/defineDeleteInterfaceObjectAction.js +53 -0
  93. package/build/esm/api/defineDeleteInterfaceObjectAction.js.map +1 -0
  94. package/build/esm/api/defineDeleteObjectAction.js +56 -0
  95. package/build/esm/api/defineDeleteObjectAction.js.map +1 -0
  96. package/build/esm/api/defineLink.js +5 -13
  97. package/build/esm/api/defineLink.js.map +1 -1
  98. package/build/esm/api/defineModifyInterfaceObjectAction.js +84 -0
  99. package/build/esm/api/defineModifyInterfaceObjectAction.js.map +1 -0
  100. package/build/esm/api/defineModifyObjectAction.js +93 -0
  101. package/build/esm/api/defineModifyObjectAction.js.map +1 -0
  102. package/build/esm/api/defineObject.js +94 -3
  103. package/build/esm/api/defineObject.js.map +1 -1
  104. package/build/esm/api/defineOntology.js +5 -1
  105. package/build/esm/api/defineOntology.js.map +1 -1
  106. package/build/esm/api/links/LinkType.js.map +1 -1
  107. package/build/esm/api/object/ObjectType.js.map +1 -1
  108. package/build/esm/api/object/ObjectTypeDatasourceDefinition.js.map +1 -1
  109. package/build/esm/api/object/ObjectTypeDefinition.js.map +1 -1
  110. package/build/esm/api/test/actions.test.js +12034 -0
  111. package/build/esm/api/test/actions.test.js.map +1 -0
  112. package/build/esm/api/test/interfaces.test.js +924 -0
  113. package/build/esm/api/test/interfaces.test.js.map +1 -0
  114. package/build/esm/api/test/links.test.js +1974 -0
  115. package/build/esm/api/test/links.test.js.map +1 -0
  116. package/build/esm/api/{markingconstraint.test.js → test/markingconstraint.test.js} +28 -2
  117. package/build/esm/api/test/markingconstraint.test.js.map +1 -0
  118. package/build/esm/api/test/misc.test.js +1058 -0
  119. package/build/esm/api/test/misc.test.js.map +1 -0
  120. package/build/esm/api/{objectStatus.test.js → test/objectStatus.test.js} +2 -2
  121. package/build/esm/api/test/objectStatus.test.js.map +1 -0
  122. package/build/esm/api/test/objects.test.js +2591 -0
  123. package/build/esm/api/test/objects.test.js.map +1 -0
  124. package/build/esm/api/test/spt.test.js +387 -0
  125. package/build/esm/api/test/spt.test.js.map +1 -0
  126. package/build/esm/api/test/valueTypes.test.js +156 -0
  127. package/build/esm/api/test/valueTypes.test.js.map +1 -0
  128. package/build/esm/cli/main.js +23 -4
  129. package/build/esm/cli/main.js.map +1 -1
  130. package/build/esm/conversion/toMarketplace/convertActionParameterConditionalOverride.js +2 -2
  131. package/build/esm/conversion/toMarketplace/convertActionParameterConditionalOverride.js.map +1 -1
  132. package/build/esm/conversion/toMarketplace/convertActionValidation.js +2 -16
  133. package/build/esm/conversion/toMarketplace/convertActionValidation.js.map +1 -1
  134. package/build/esm/conversion/toMarketplace/convertConditionDefinition.js +4 -4
  135. package/build/esm/conversion/toMarketplace/convertConditionDefinition.js.map +1 -1
  136. package/build/esm/conversion/toMarketplace/convertDatasourceDefinition.js +3 -2
  137. package/build/esm/conversion/toMarketplace/convertDatasourceDefinition.js.map +1 -1
  138. package/build/esm/conversion/toMarketplace/convertLink.js +109 -24
  139. package/build/esm/conversion/toMarketplace/convertLink.js.map +1 -1
  140. package/build/esm/conversion/toMarketplace/convertObject.js +81 -4
  141. package/build/esm/conversion/toMarketplace/convertObject.js.map +1 -1
  142. package/build/esm/conversion/toMarketplace/convertSectionConditionalOverride.js +2 -2
  143. package/build/esm/conversion/toMarketplace/convertSectionConditionalOverride.js.map +1 -1
  144. package/build/esm/index.js +8 -1
  145. package/build/esm/index.js.map +1 -1
  146. package/build/types/api/action/DefaultFormat.d.ts +1 -0
  147. package/build/types/api/action/DefaultFormat.d.ts.map +1 -0
  148. package/build/types/api/action/TableConfiguration.d.ts +8 -0
  149. package/build/types/api/action/TableConfiguration.d.ts.map +1 -0
  150. package/build/types/api/code-snippets/createCodeSnippets.d.ts +2 -0
  151. package/build/types/api/code-snippets/createCodeSnippets.d.ts.map +1 -0
  152. package/build/types/api/code-snippets/snippetTypes.d.ts +23 -0
  153. package/build/types/api/code-snippets/snippetTypes.d.ts.map +1 -0
  154. package/build/types/api/defineAction.d.ts +34 -10
  155. package/build/types/api/defineAction.d.ts.map +1 -1
  156. package/build/types/api/defineCreateInterfaceObjectAction.d.ts +3 -0
  157. package/build/types/api/defineCreateInterfaceObjectAction.d.ts.map +1 -0
  158. package/build/types/api/defineCreateObjectAction.d.ts +3 -0
  159. package/build/types/api/defineCreateObjectAction.d.ts.map +1 -0
  160. package/build/types/api/defineCreateOrModifyObjectAction.d.ts +3 -0
  161. package/build/types/api/defineCreateOrModifyObjectAction.d.ts.map +1 -0
  162. package/build/types/api/defineDeleteInterfaceObjectAction.d.ts +3 -0
  163. package/build/types/api/defineDeleteInterfaceObjectAction.d.ts.map +1 -0
  164. package/build/types/api/defineDeleteObjectAction.d.ts +3 -0
  165. package/build/types/api/defineDeleteObjectAction.d.ts.map +1 -0
  166. package/build/types/api/defineLink.d.ts.map +1 -1
  167. package/build/types/api/defineModifyInterfaceObjectAction.d.ts +3 -0
  168. package/build/types/api/defineModifyInterfaceObjectAction.d.ts.map +1 -0
  169. package/build/types/api/defineModifyObjectAction.d.ts +3 -0
  170. package/build/types/api/defineModifyObjectAction.d.ts.map +1 -0
  171. package/build/types/api/defineObject.d.ts.map +1 -1
  172. package/build/types/api/defineOntology.d.ts +1 -1
  173. package/build/types/api/defineOntology.d.ts.map +1 -1
  174. package/build/types/api/links/LinkType.d.ts +7 -7
  175. package/build/types/api/object/ObjectType.d.ts +1 -1
  176. package/build/types/api/object/ObjectType.d.ts.map +1 -1
  177. package/build/types/api/object/ObjectTypeDatasourceDefinition.d.ts +41 -1
  178. package/build/types/api/object/ObjectTypeDatasourceDefinition.d.ts.map +1 -1
  179. package/build/types/api/object/ObjectTypeDefinition.d.ts +1 -1
  180. package/build/types/api/object/ObjectTypeDefinition.d.ts.map +1 -1
  181. package/build/types/api/test/actions.test.d.ts.map +1 -0
  182. package/build/types/api/test/interfaces.test.d.ts.map +1 -0
  183. package/build/types/api/test/links.test.d.ts.map +1 -0
  184. package/build/types/api/test/markingconstraint.test.d.ts +1 -0
  185. package/build/types/api/test/markingconstraint.test.d.ts.map +1 -0
  186. package/build/types/api/test/misc.test.d.ts +1 -0
  187. package/build/types/api/test/misc.test.d.ts.map +1 -0
  188. package/build/types/api/test/objectStatus.test.d.ts +1 -0
  189. package/build/types/api/test/objectStatus.test.d.ts.map +1 -0
  190. package/build/types/api/test/objects.test.d.ts +1 -0
  191. package/build/types/api/test/objects.test.d.ts.map +1 -0
  192. package/build/types/api/test/spt.test.d.ts +1 -0
  193. package/build/types/api/test/spt.test.d.ts.map +1 -0
  194. package/build/types/api/test/valueTypes.test.d.ts +1 -0
  195. package/build/types/api/test/valueTypes.test.d.ts.map +1 -0
  196. package/build/types/conversion/toMarketplace/convertActionParameterConditionalOverride.d.ts +2 -2
  197. package/build/types/conversion/toMarketplace/convertActionParameterConditionalOverride.d.ts.map +1 -1
  198. package/build/types/conversion/toMarketplace/convertActionValidation.d.ts +0 -1
  199. package/build/types/conversion/toMarketplace/convertActionValidation.d.ts.map +1 -1
  200. package/build/types/conversion/toMarketplace/convertConditionDefinition.d.ts +2 -1
  201. package/build/types/conversion/toMarketplace/convertConditionDefinition.d.ts.map +1 -1
  202. package/build/types/conversion/toMarketplace/convertLink.d.ts +6 -0
  203. package/build/types/conversion/toMarketplace/convertLink.d.ts.map +1 -1
  204. package/build/types/conversion/toMarketplace/convertObject.d.ts.map +1 -1
  205. package/build/types/conversion/toMarketplace/convertSectionConditionalOverride.d.ts +2 -1
  206. package/build/types/conversion/toMarketplace/convertSectionConditionalOverride.d.ts.map +1 -1
  207. package/build/types/index.d.ts +8 -1
  208. package/build/types/index.d.ts.map +1 -1
  209. package/package.json +4 -3
  210. package/build/browser/api/markingconstraint.test.js.map +0 -1
  211. package/build/browser/api/objectStatus.test.js.map +0 -1
  212. package/build/browser/api/overall.test.js +0 -14002
  213. package/build/browser/api/overall.test.js.map +0 -1
  214. package/build/esm/api/markingconstraint.test.js.map +0 -1
  215. package/build/esm/api/objectStatus.test.js.map +0 -1
  216. package/build/esm/api/overall.test.js +0 -14002
  217. package/build/esm/api/overall.test.js.map +0 -1
  218. package/build/types/api/markingconstraint.test.d.ts.map +0 -1
  219. package/build/types/api/objectStatus.test.d.ts.map +0 -1
  220. package/build/types/api/overall.test.d.ts.map +0 -1
  221. /package/build/types/api/{markingconstraint.test.d.ts → test/actions.test.d.ts} +0 -0
  222. /package/build/types/api/{objectStatus.test.d.ts → test/interfaces.test.d.ts} +0 -0
  223. /package/build/types/api/{overall.test.d.ts → test/links.test.d.ts} +0 -0
@@ -1,4 +1,4 @@
1
- import { OntologyIrLabelledValue, OntologyIrConditionValue, OntologyIrParameterDateRangeValue, InterfaceTypeApiName, OntologyIrCondition, OntologyIrParameterPrefill, OntologyIrBaseParameterType_decimal, OntologyIrBaseParameterType_decimalList, OntologyIrBaseParameterType_timestamp, OntologyIrBaseParameterType_timestampList, OntologyIrBaseParameterType_objectReference, OntologyIrBaseParameterType_objectReferenceList, OntologyIrBaseParameterType_objectSetRid, OntologyIrBaseParameterType_objectTypeReference, OntologyIrBaseParameterType_interfaceReference, OntologyIrBaseParameterType_interfaceReferenceList, OntologyIrBaseParameterType_struct, OntologyIrBaseParameterType_structList, ParameterId, ActionTypeStatus_deprecated, ButtonDisplayMetadata, ActionTypeApiName, OntologyIrLogicRule, SectionId, OntologyIrActionTypeEntities, OntologyIrFormContent, OntologyIrValidationRule, DisplayMetadataConfigurationDefaultLayout, DisplayMetadataConfigurationDisplayAndFormat, OntologyIrLogicRuleValue_parameterId, OntologyIrLogicRuleValue_staticValue, OntologyIrLogicRuleValue_objectParameterPropertyValue, OntologyIrLogicRuleValue_interfaceParameterPropertyValue, OntologyIrLogicRuleValue_synchronousWebhookOutput, ValidationRuleDisplayMetadata, StructFieldType, OntologyIrValueTypeReferenceWithMetadata, Visibility, SharedPropertyTypeGothamMapping, OntologyIrMarketplaceInterfaceType, InterfaceTypeStatus, ValueTypeApiName, ValueTypeDisplayMetadata, ValueTypeStatus, ValueTypeVersion, BaseType, ValueTypeDataConstraint, ExampleValue, OntologyIrBaseFormatter, LinkTypeMetadata, OntologyIrLinkTypeStatus, OntologyIrObjectType, OntologyIr, DataConstraint, FailureMessage, OntologyIrType } from '@osdk/client.unstable';
1
+ import { OntologyIrLabelledValue, OntologyIrConditionValue, OntologyIrParameterDateRangeValue, InterfaceTypeApiName, OntologyIrCondition, OntologyIrParameterPrefill, OntologyIrBaseParameterType_decimal, OntologyIrBaseParameterType_decimalList, OntologyIrBaseParameterType_timestamp, OntologyIrBaseParameterType_timestampList, OntologyIrBaseParameterType_objectReference, OntologyIrBaseParameterType_objectReferenceList, OntologyIrBaseParameterType_objectSetRid, OntologyIrBaseParameterType_objectTypeReference, OntologyIrBaseParameterType_interfaceReference, OntologyIrBaseParameterType_interfaceReferenceList, OntologyIrBaseParameterType_struct, OntologyIrBaseParameterType_structList, ParameterId, ActionTypeStatus_deprecated, ButtonDisplayMetadata, ActionTypeApiName, OntologyIrLogicRule, SectionId, OntologyIrActionTypeEntities, OntologyIrFormContent, OntologyIrValidationRule, DisplayMetadataConfigurationDefaultLayout, DisplayMetadataConfigurationDisplayAndFormat, OntologyIrLogicRuleValue_parameterId, OntologyIrLogicRuleValue_staticValue, OntologyIrLogicRuleValue_objectParameterPropertyValue, OntologyIrLogicRuleValue_interfaceParameterPropertyValue, OntologyIrLogicRuleValue_synchronousWebhookOutput, ValidationRuleDisplayMetadata, ParameterRid, StructFieldType, OntologyIrValueTypeReferenceWithMetadata, Visibility, SharedPropertyTypeGothamMapping, OntologyIrMarketplaceInterfaceType, InterfaceTypeStatus, ValueTypeApiName, ValueTypeDisplayMetadata, ValueTypeStatus, ValueTypeVersion, BaseType, ValueTypeDataConstraint, ExampleValue, OntologyIrBaseFormatter, LinkTypeMetadata, OntologyIrLinkTypeStatus, DerivedPropertyLinkTypeSide, ObjectTypeFieldApiName, OntologyIrObjectType, OntologyIr, DataConstraint, FailureMessage, OntologyIrType } from '@osdk/client.unstable';
2
2
 
3
3
  declare function main(args?: string[]): Promise<void>;
4
4
 
@@ -216,6 +216,16 @@ type ActionLevelValidationRule = {
216
216
  displayMetadata?: ValidationRuleDisplayMetadata;
217
217
  };
218
218
 
219
+ type DefaultFormat = "FORM" | "TABLE";
220
+
221
+ type TableConfiguration = {
222
+ columnWidthByParameterRid: Record<ParameterRid, number>;
223
+ enableFileImport: boolean;
224
+ fitHorizontally: boolean;
225
+ frozenColumnCount: number;
226
+ rowHeightInLines: number;
227
+ };
228
+
219
229
  interface Nullability {
220
230
  noEmptyCollections: boolean;
221
231
  noNulls: boolean;
@@ -276,14 +286,6 @@ interface InterfaceType extends OntologyEntityBase, Omit<OntologyIrMarketplaceIn
276
286
  __type: OntologyEntityTypeEnum.INTERFACE_TYPE;
277
287
  }
278
288
 
279
- type InterfaceImplementation = {
280
- implements: InterfaceType;
281
- propertyMapping: {
282
- interfaceProperty: string;
283
- mapsTo: string;
284
- }[];
285
- };
286
-
287
289
  type ValueTypeDefinitionVersion = OntologyEntityBase & {
288
290
  apiName: ValueTypeApiName;
289
291
  packageNamespace: string;
@@ -325,7 +327,109 @@ interface ObjectPropertyTypeInner {
325
327
 
326
328
  type ObjectPropertyTypeUserDefinition = RequiredFields<Partial<ObjectPropertyTypeInner>, "type">;
327
329
 
328
- type ObjectTypeDatasourceDefinition = ObjectTypeDatasourceDefinition_stream | ObjectTypeDatasourceDefinition_dataset | ObjectTypeDatasourceDefinition_restrictedView;
330
+ type InterfaceImplementation = {
331
+ implements: InterfaceType;
332
+ propertyMapping: {
333
+ interfaceProperty: string;
334
+ mapsTo: string;
335
+ }[];
336
+ };
337
+
338
+ type LinkType = (OntologyEntityBase & OneToManyLinkTypeDefinition & {
339
+ __type: OntologyEntityTypeEnum.LINK_TYPE;
340
+ }) | (OntologyEntityBase & ManyToManyLinkTypeDefinition & {
341
+ __type: OntologyEntityTypeEnum.LINK_TYPE;
342
+ }) | (OntologyEntityBase & IntermediaryLinkTypeDefinition & {
343
+ __type: OntologyEntityTypeEnum.LINK_TYPE;
344
+ });
345
+ type LinkTypeDefinition = Omit<OntologyEntityBase & OneToManyLinkTypeUserDefinition & {
346
+ __type: OntologyEntityTypeEnum.LINK_TYPE;
347
+ }, "__type"> | Omit<OntologyEntityBase & ManyToManyLinkTypeUserDefinition & {
348
+ __type: OntologyEntityTypeEnum.LINK_TYPE;
349
+ }, "__type"> | Omit<OntologyEntityBase & IntermediaryLinkTypeUserDefinition & {
350
+ __type: OntologyEntityTypeEnum.LINK_TYPE;
351
+ }, "__type">;
352
+ type ObjectTypePropertyApiName = string;
353
+ interface OneToManyLinkTypeDefinition {
354
+ apiName: string;
355
+ one: OneToManyObjectLinkReference;
356
+ toMany: OneToManyObjectLinkReference;
357
+ manyForeignKeyProperty: ObjectTypePropertyApiName;
358
+ cardinality: "OneToMany" | "OneToOne" | undefined;
359
+ editsEnabled?: boolean;
360
+ status?: OntologyIrLinkTypeStatus;
361
+ redacted?: boolean;
362
+ }
363
+ interface OneToManyObjectLinkReference {
364
+ object: ObjectTypeDefinition | string;
365
+ metadata: LinkTypeMetadata;
366
+ }
367
+ interface OneToManyLinkTypeUserDefinition {
368
+ apiName: string;
369
+ one: OneToManyObjectLinkReferenceUserDefinition;
370
+ toMany: OneToManyObjectLinkReferenceUserDefinition;
371
+ manyForeignKeyProperty: ObjectTypePropertyApiName;
372
+ cardinality?: "OneToMany" | "OneToOne" | undefined;
373
+ }
374
+ interface OneToManyObjectLinkReferenceUserDefinition {
375
+ object: ObjectTypeDefinition | string;
376
+ metadata: LinkTypeMetadataUserDefinition;
377
+ }
378
+ interface ManyToManyLinkTypeDefinition {
379
+ apiName: string;
380
+ many: ManyToManyObjectLinkReference;
381
+ toMany: ManyToManyObjectLinkReference;
382
+ editsEnabled?: boolean;
383
+ status?: OntologyIrLinkTypeStatus;
384
+ redacted?: boolean;
385
+ }
386
+ interface ManyToManyObjectLinkReference {
387
+ object: ObjectTypeDefinition | string;
388
+ metadata: LinkTypeMetadata;
389
+ }
390
+ interface ManyToManyLinkTypeUserDefinition {
391
+ apiName: string;
392
+ many: ManyToManyObjectLinkReferenceUserDefinition;
393
+ toMany: ManyToManyObjectLinkReferenceUserDefinition;
394
+ }
395
+ interface ManyToManyObjectLinkReferenceUserDefinition {
396
+ object: ObjectTypeDefinition | string;
397
+ metadata: LinkTypeMetadataUserDefinition;
398
+ }
399
+ interface IntermediaryLinkTypeDefinition {
400
+ apiName: string;
401
+ many: IntermediaryObjectLinkReference;
402
+ toMany: IntermediaryObjectLinkReference;
403
+ intermediaryObjectType: ObjectTypeDefinition;
404
+ editsEnabled?: boolean;
405
+ status?: OntologyIrLinkTypeStatus;
406
+ redacted?: boolean;
407
+ }
408
+ interface IntermediaryObjectLinkReference {
409
+ object: ObjectTypeDefinition | string;
410
+ metadata: LinkTypeMetadata;
411
+ linkToIntermediary: LinkType;
412
+ }
413
+ interface IntermediaryLinkTypeUserDefinition {
414
+ apiName: string;
415
+ many: IntermediaryObjectLinkReferenceUserDefinition;
416
+ toMany: IntermediaryObjectLinkReferenceUserDefinition;
417
+ intermediaryObjectType: ObjectTypeDefinition | string;
418
+ }
419
+ interface IntermediaryObjectLinkReferenceUserDefinition {
420
+ object: ObjectTypeDefinition | string;
421
+ metadata: LinkTypeMetadataUserDefinition;
422
+ linkToIntermediary: LinkType;
423
+ }
424
+ interface LinkTypeMetadataUserDefinition {
425
+ apiName: string;
426
+ displayName?: string;
427
+ pluralDisplayName?: string;
428
+ visibility?: Visibility;
429
+ groupDisplayName?: string;
430
+ }
431
+
432
+ type ObjectTypeDatasourceDefinition = ObjectTypeDatasourceDefinition_stream | ObjectTypeDatasourceDefinition_dataset | ObjectTypeDatasourceDefinition_restrictedView | ObjectTypeDatasourceDefinition_derived;
329
433
  interface ObjectTypeDatasourceDefinition_dataset {
330
434
  type: "dataset";
331
435
  }
@@ -336,6 +440,44 @@ interface ObjectTypeDatasourceDefinition_stream {
336
440
  interface ObjectTypeDatasourceDefinition_restrictedView {
337
441
  type: "restrictedView";
338
442
  }
443
+ interface ObjectTypeDatasourceDefinition_derived {
444
+ type: "derived";
445
+ linkDefinition: Array<DerivedPropertiesLinkDefinition>;
446
+ propertyMapping: Record<ObjectTypeFieldApiName, ObjectTypeFieldApiName> | Record<ObjectTypeFieldApiName, DerivedPropertyAggregation>;
447
+ }
448
+ interface DerivedPropertiesLinkDefinition {
449
+ linkType: LinkType;
450
+ side?: DerivedPropertyLinkTypeSide;
451
+ }
452
+ type DerivedPropertyAggregation = {
453
+ type: "count";
454
+ } | {
455
+ type: "avg";
456
+ property: ObjectTypeFieldApiName;
457
+ } | {
458
+ type: "sum";
459
+ property: ObjectTypeFieldApiName;
460
+ } | {
461
+ type: "min";
462
+ property: ObjectTypeFieldApiName;
463
+ } | {
464
+ type: "max";
465
+ property: ObjectTypeFieldApiName;
466
+ } | {
467
+ type: "approximateCardinality";
468
+ property: ObjectTypeFieldApiName;
469
+ } | {
470
+ type: "exactCardinality";
471
+ property: ObjectTypeFieldApiName;
472
+ } | {
473
+ type: "collectList";
474
+ property: ObjectTypeFieldApiName;
475
+ limit: number;
476
+ } | {
477
+ type: "collectSet";
478
+ property: ObjectTypeFieldApiName;
479
+ limit: number;
480
+ };
339
481
 
340
482
  type ObjectTypeDefinition = {
341
483
  apiName: string;
@@ -355,11 +497,13 @@ type ObjectTypeDefinition = {
355
497
  visibility?: Visibility;
356
498
  editsEnabled?: boolean;
357
499
  status?: ObjectTypeStatus;
358
- datasource?: ObjectTypeDatasourceDefinition;
500
+ datasources?: Array<ObjectTypeDatasourceDefinition>;
359
501
  };
360
502
 
361
503
  declare const MODIFY_OBJECT_PARAMETER: string;
362
504
  declare const CREATE_OR_MODIFY_OBJECT_PARAMETER: string;
505
+ declare const CREATE_INTERFACE_OBJECT_PARAMETER: string;
506
+ declare const MODIFY_INTERFACE_OBJECT_PARAMETER: string;
363
507
  type ActionTypeDefinition = Omit<ActionType, "__type">;
364
508
  type ActionTypeUserDefinition = {
365
509
  objectType: ObjectTypeDefinition;
@@ -371,9 +515,9 @@ type ActionTypeUserDefinition = {
371
515
  actionLevelValidation?: ActionLevelValidationDefinition;
372
516
  excludedProperties?: Array<ParameterId>;
373
517
  sections?: Array<ActionSection>;
374
- defaultFormat?: DisplayMetadataConfigurationDefaultLayout;
518
+ defaultFormat?: DefaultFormat;
375
519
  enableLayoutSwitch?: boolean;
376
- displayAndFormat?: DisplayMetadataConfigurationDisplayAndFormat;
520
+ tableConfiguration?: TableConfiguration;
377
521
  parameterOrdering?: Array<string>;
378
522
  submissionMetadata?: SubmissionMetadata;
379
523
  primaryKeyOption?: "autoGenerated" | "userInput";
@@ -381,16 +525,31 @@ type ActionTypeUserDefinition = {
381
525
  type InterfaceActionTypeUserDefinition = {
382
526
  interfaceType: InterfaceType;
383
527
  objectType?: ObjectTypeDefinition;
384
- validation?: ActionLevelValidationDefinition;
528
+ apiName?: string;
529
+ displayName?: string;
530
+ status?: ActionStatus;
531
+ parameterConfiguration?: Record<string, ActionParameterConfiguration>;
532
+ nonParameterMappings?: Record<string, MappingValue>;
533
+ actionLevelValidation?: ActionLevelValidationDefinition;
385
534
  excludedProperties?: Array<string>;
535
+ sections?: Array<ActionSection>;
536
+ defaultFormat?: DefaultFormat;
537
+ enableLayoutSwitch?: boolean;
538
+ tableConfiguration?: TableConfiguration;
539
+ parameterOrdering?: Array<string>;
540
+ submissionMetadata?: SubmissionMetadata;
386
541
  };
542
+ declare function defineAction(actionDef: ActionTypeDefinition): ActionType;
543
+
387
544
  declare function defineCreateInterfaceObjectAction(def: InterfaceActionTypeUserDefinition): ActionType;
545
+
388
546
  declare function defineCreateObjectAction(def: ActionTypeUserDefinition): ActionType;
389
- declare function defineModifyInterfaceObjectAction(def: InterfaceActionTypeUserDefinition): ActionType;
390
- declare function defineModifyObjectAction(def: ActionTypeUserDefinition): ActionType;
391
- declare function defineDeleteObjectAction(def: ActionTypeUserDefinition): ActionType;
547
+
392
548
  declare function defineCreateOrModifyObjectAction(def: ActionTypeUserDefinition): ActionType;
393
- declare function defineAction(actionDef: ActionTypeDefinition): ActionType;
549
+
550
+ declare function defineDeleteInterfaceObjectAction(def: InterfaceActionTypeUserDefinition): ActionType;
551
+
552
+ declare function defineDeleteObjectAction(def: ActionTypeUserDefinition): ActionType;
394
553
 
395
554
  type SimplifiedInterfaceTypeStatus = {
396
555
  type: "deprecated";
@@ -442,108 +601,18 @@ type One = {
442
601
  };
443
602
  declare function defineInterfaceLinkConstraint(linkDef: One | Many): void;
444
603
 
445
- type LinkType = (OntologyEntityBase & OneToManyLinkTypeDefinition & {
446
- __type: OntologyEntityTypeEnum.LINK_TYPE;
447
- }) | (OntologyEntityBase & ManyToManyLinkTypeDefinition & {
448
- __type: OntologyEntityTypeEnum.LINK_TYPE;
449
- }) | (OntologyEntityBase & IntermediaryLinkTypeDefinition & {
450
- __type: OntologyEntityTypeEnum.LINK_TYPE;
451
- });
452
- type LinkTypeDefinition = Omit<OntologyEntityBase & OneToManyLinkTypeUserDefinition & {
453
- __type: OntologyEntityTypeEnum.LINK_TYPE;
454
- }, "__type"> | Omit<OntologyEntityBase & ManyToManyLinkTypeUserDefinition & {
455
- __type: OntologyEntityTypeEnum.LINK_TYPE;
456
- }, "__type"> | Omit<OntologyEntityBase & IntermediaryLinkTypeUserDefinition & {
457
- __type: OntologyEntityTypeEnum.LINK_TYPE;
458
- }, "__type">;
459
- type ObjectTypePropertyApiName = string;
460
- interface OneToManyLinkTypeDefinition {
461
- apiName: string;
462
- one: OneToManyObjectLinkReference;
463
- toMany: OneToManyObjectLinkReference;
464
- manyForeignKeyProperty: ObjectTypePropertyApiName;
465
- cardinality: "OneToMany" | "OneToOne" | undefined;
466
- editsEnabled?: boolean;
467
- status?: OntologyIrLinkTypeStatus;
468
- redacted?: boolean;
469
- }
470
- interface OneToManyObjectLinkReference {
471
- object: ObjectTypeDefinition;
472
- metadata: LinkTypeMetadata;
473
- }
474
- interface OneToManyLinkTypeUserDefinition {
475
- apiName: string;
476
- one: OneToManyObjectLinkReferenceUserDefinition;
477
- toMany: OneToManyObjectLinkReferenceUserDefinition;
478
- manyForeignKeyProperty: ObjectTypePropertyApiName;
479
- cardinality?: "OneToMany" | "OneToOne" | undefined;
480
- }
481
- interface OneToManyObjectLinkReferenceUserDefinition {
482
- object: ObjectTypeDefinition;
483
- metadata: LinkTypeMetadataUserDefinition;
484
- }
485
- interface ManyToManyLinkTypeDefinition {
486
- apiName: string;
487
- many: ManyToManyObjectLinkReference;
488
- toMany: ManyToManyObjectLinkReference;
489
- editsEnabled?: boolean;
490
- status?: OntologyIrLinkTypeStatus;
491
- redacted?: boolean;
492
- }
493
- interface ManyToManyObjectLinkReference {
494
- object: ObjectTypeDefinition;
495
- metadata: LinkTypeMetadata;
496
- }
497
- interface ManyToManyLinkTypeUserDefinition {
498
- apiName: string;
499
- many: ManyToManyObjectLinkReferenceUserDefinition;
500
- toMany: ManyToManyObjectLinkReferenceUserDefinition;
501
- }
502
- interface ManyToManyObjectLinkReferenceUserDefinition {
503
- object: ObjectTypeDefinition;
504
- metadata: LinkTypeMetadataUserDefinition;
505
- }
506
- interface IntermediaryLinkTypeDefinition {
507
- apiName: string;
508
- many: IntermediaryObjectLinkReference;
509
- toMany: IntermediaryObjectLinkReference;
510
- intermediaryObjectType: ObjectTypeDefinition;
511
- editsEnabled?: boolean;
512
- status?: OntologyIrLinkTypeStatus;
513
- redacted?: boolean;
514
- }
515
- interface IntermediaryObjectLinkReference {
516
- object: ObjectTypeDefinition;
517
- metadata: LinkTypeMetadata;
518
- linkToIntermediary: LinkType;
519
- }
520
- interface IntermediaryLinkTypeUserDefinition {
521
- apiName: string;
522
- many: IntermediaryObjectLinkReferenceUserDefinition;
523
- toMany: IntermediaryObjectLinkReferenceUserDefinition;
524
- intermediaryObjectType: ObjectTypeDefinition;
525
- }
526
- interface IntermediaryObjectLinkReferenceUserDefinition {
527
- object: ObjectTypeDefinition;
528
- metadata: LinkTypeMetadataUserDefinition;
529
- linkToIntermediary: LinkType;
530
- }
531
- interface LinkTypeMetadataUserDefinition {
532
- apiName: string;
533
- displayName?: string;
534
- pluralDisplayName?: string;
535
- visibility?: Visibility;
536
- groupDisplayName?: string;
537
- }
538
-
539
604
  declare function defineLink(linkDefinition: LinkTypeDefinition): LinkType;
540
605
 
606
+ declare function defineModifyInterfaceObjectAction(def: InterfaceActionTypeUserDefinition): ActionType;
607
+
608
+ declare function defineModifyObjectAction(def: ActionTypeUserDefinition): ActionType;
609
+
541
610
  declare function defineObject(objectDef: ObjectTypeDefinition): ObjectTypeDefinition;
542
611
  declare function uppercaseFirstLetter(s: string | undefined | null): string;
543
612
  declare function convertToPluralDisplayName(s: string | undefined | null): string;
544
613
 
545
614
  type ObjectType = OntologyEntityBase & RequiredFields<Partial<ObjectTypeInner>, "apiName" | "primaryKeyPropertyApiName" | "displayName" | "pluralDisplayName" | "titlePropertyApiName"> & {
546
- datasource?: ObjectTypeDatasourceDefinition;
615
+ datasources?: Array<ObjectTypeDatasourceDefinition>;
547
616
  __type: OntologyEntityTypeEnum.OBJECT_TYPE;
548
617
  };
549
618
  interface ObjectTypeInner extends Omit<OntologyIrObjectType, "titlePropertyTypeRid" | "propertyTypes" | "allImplementsInterfaces" | "implementsInterfaces2" | "displayMetadata" | "primaryKeys" | "status"> {
@@ -563,7 +632,7 @@ interface ObjectTypeInner extends Omit<OntologyIrObjectType, "titlePropertyTypeR
563
632
  status?: ObjectTypeStatus;
564
633
  }
565
634
 
566
- declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string, randomnessKey?: string): Promise<OntologyIr>;
635
+ declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string, codeSnippetFiles?: boolean, snippetPackageName?: string, snippetFileOutputDir?: string, randomnessKey?: string): Promise<OntologyIr>;
567
636
  declare function dumpOntologyFullMetadata(): OntologyIr;
568
637
  declare function addNamespaceIfNone(apiName: string): string;
569
638
 
@@ -796,4 +865,4 @@ declare function wrapWithProxy<T extends OntologyEntityBase>(entity: T): T;
796
865
 
797
866
  declare function propertyTypeTypeToOntologyIrType(type: PropertyTypeType): OntologyIrType;
798
867
 
799
- export { type ActionParameterAllowedValues, type ActionParameterConditionalOverride, type ActionParameterConfiguration, type ActionParameterValidation, type ActionSection, type ActionType, CREATE_OR_MODIFY_OBJECT_PARAMETER, type ConditionDefinition, type CurrentTimeMappingValue, type CurrentUserMappingValue, type CustomMapping, type InterfaceType, type LinkType, MODIFY_OBJECT_PARAMETER, type MappingValue, type ObjectPropertyType, type ObjectType, OntologyEntityTypeEnum, type PropertyTypeType, type SectionConditionalOverride, type SharedPropertyType, type SubmissionMetadata, type UuidMappingValue, type ValueTypeDefinitionVersion, addDependency, addNamespaceIfNone, uppercaseFirstLetter as convertToDisplayName, convertToPluralDisplayName, propertyTypeTypeToOntologyIrType as convertType, main as default, defineAction, defineCreateInterfaceObjectAction, defineCreateObjectAction, defineCreateOrModifyObjectAction, defineDeleteObjectAction, defineInterface, defineInterfaceLinkConstraint, defineLink, defineModifyInterfaceObjectAction, defineModifyObjectAction, defineObject, defineOntology, defineSharedPropertyType, defineValueType, dumpOntologyFullMetadata, importOntologyEntity, importSharedPropertyType, wrapWithProxy };
868
+ export { type ActionParameterAllowedValues, type ActionParameterConditionalOverride, type ActionParameterConfiguration, type ActionParameterValidation, type ActionSection, type ActionType, CREATE_INTERFACE_OBJECT_PARAMETER, CREATE_OR_MODIFY_OBJECT_PARAMETER, type ConditionDefinition, type CurrentTimeMappingValue, type CurrentUserMappingValue, type CustomMapping, type InterfaceType, type LinkType, MODIFY_INTERFACE_OBJECT_PARAMETER, MODIFY_OBJECT_PARAMETER, type MappingValue, type ObjectPropertyType, type ObjectType, OntologyEntityTypeEnum, type PropertyTypeType, type SectionConditionalOverride, type SharedPropertyType, type SubmissionMetadata, type UuidMappingValue, type ValueTypeDefinitionVersion, addDependency, addNamespaceIfNone, uppercaseFirstLetter as convertToDisplayName, convertToPluralDisplayName, propertyTypeTypeToOntologyIrType as convertType, main as default, defineAction, defineCreateInterfaceObjectAction, defineCreateObjectAction, defineCreateOrModifyObjectAction, defineDeleteInterfaceObjectAction, defineDeleteObjectAction, defineInterface, defineInterfaceLinkConstraint, defineLink, defineModifyInterfaceObjectAction, defineModifyObjectAction, defineObject, defineOntology, defineSharedPropertyType, defineValueType, dumpOntologyFullMetadata, importOntologyEntity, importSharedPropertyType, wrapWithProxy };
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=DefaultFormat.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DefaultFormat.js","names":[],"sources":["DefaultFormat.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type DefaultFormat = \"FORM\" | \"TABLE\";\n"],"mappings":"","ignoreList":[]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=TableConfiguration.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TableConfiguration.js","names":[],"sources":["TableConfiguration.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { ParameterRid } from \"@osdk/client.unstable\";\nexport type TableConfiguration = {\n columnWidthByParameterRid: Record<ParameterRid, number>;\n enableFileImport: boolean;\n fitHorizontally: boolean;\n frozenColumnCount: number;\n rowHeightInLines: number;\n};\n"],"mappings":"","ignoreList":[]}
@@ -0,0 +1,91 @@
1
+ /*
2
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+
17
+ import { TYPESCRIPT_OSDK_SNIPPETS } from "@osdk/typescript-sdk-docs";
18
+ import { consola } from "consola";
19
+ import * as fs from "fs";
20
+ import Mustache from "mustache";
21
+ import * as path from "path";
22
+ import { OntologyEntityTypeEnum } from "../common/OntologyEntityTypeEnum.js";
23
+ import { actionSnippets, interfaceSnippets, objectSnippets } from "./snippetTypes.js";
24
+ export function createCodeSnippets(ontology, packageName, outputDir) {
25
+ if (outputDir === undefined) {
26
+ outputDir = "./code-snippets";
27
+ }
28
+ if (!fs.existsSync(outputDir)) {
29
+ fs.mkdirSync(outputDir, {
30
+ recursive: true
31
+ });
32
+ }
33
+ if (packageName === undefined) {
34
+ packageName = "";
35
+ }
36
+ consola.info("Generating code snippets to ", outputDir);
37
+ for (const type of Object.values(OntologyEntityTypeEnum)) {
38
+ for (const object of Object.values(ontology[type])) {
39
+ let snippet = {};
40
+ switch (type) {
41
+ case OntologyEntityTypeEnum.OBJECT_TYPE:
42
+ snippet = generateObjectSnippet(object, packageName);
43
+ break;
44
+ case OntologyEntityTypeEnum.ACTION_TYPE:
45
+ snippet = generateActionSnippet(object, packageName);
46
+ break;
47
+ case OntologyEntityTypeEnum.INTERFACE_TYPE:
48
+ snippet = generateInterfaceSnippet(object, packageName);
49
+ break;
50
+ default:
51
+ continue;
52
+ }
53
+ fs.writeFileSync(path.join(outputDir, object.apiName), JSON.stringify(snippet));
54
+ }
55
+ }
56
+ consola.info("Finished Code Snippet Generation");
57
+ }
58
+ function generateInterfaceSnippet(interfaceType, packageName) {
59
+ const interfaceContext = {
60
+ "interfaceApiName": interfaceType.apiName,
61
+ "packageName": packageName,
62
+ "objectOrInterfaceApiName": interfaceType.apiName,
63
+ "propertyNames": Object.keys(interfaceType.propertiesV2)
64
+ };
65
+ return getSnippets(interfaceSnippets, interfaceContext);
66
+ }
67
+ function generateObjectSnippet(objectType, packageName) {
68
+ const objectContext = {
69
+ "objectType": objectType.apiName,
70
+ "packageName": packageName,
71
+ "objectOrInterfaceApiName": objectType.apiName
72
+ };
73
+ return getSnippets(objectSnippets, objectContext);
74
+ }
75
+ function generateActionSnippet(actionType, packageName) {
76
+ const actionContext = {
77
+ "actionApiName": actionType.apiName,
78
+ "packageName": packageName
79
+ };
80
+ return getSnippets(actionSnippets, actionContext);
81
+ }
82
+ function getSnippets(snippetType, context) {
83
+ const allSnippets = {};
84
+ for (const templateName of Object.keys(snippetType).filter(key => isNaN(Number(key)))) {
85
+ const latestTemplate = Object.values(TYPESCRIPT_OSDK_SNIPPETS.versions).find(v => v.snippets[templateName])?.snippets[templateName][0].template ?? "";
86
+ const renderedTemplate = Mustache.render(latestTemplate, context);
87
+ allSnippets[templateName] = renderedTemplate;
88
+ }
89
+ return allSnippets;
90
+ }
91
+ //# sourceMappingURL=createCodeSnippets.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createCodeSnippets.js","names":["TYPESCRIPT_OSDK_SNIPPETS","consola","fs","Mustache","path","OntologyEntityTypeEnum","actionSnippets","interfaceSnippets","objectSnippets","createCodeSnippets","ontology","packageName","outputDir","undefined","existsSync","mkdirSync","recursive","info","type","Object","values","object","snippet","OBJECT_TYPE","generateObjectSnippet","ACTION_TYPE","generateActionSnippet","INTERFACE_TYPE","generateInterfaceSnippet","writeFileSync","join","apiName","JSON","stringify","interfaceType","interfaceContext","keys","propertiesV2","getSnippets","objectType","objectContext","actionType","actionContext","snippetType","context","allSnippets","templateName","filter","key","isNaN","Number","latestTemplate","versions","find","v","snippets","template","renderedTemplate","render"],"sources":["createCodeSnippets.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TYPESCRIPT_OSDK_SNIPPETS } from \"@osdk/typescript-sdk-docs\";\nimport { consola } from \"consola\";\nimport * as fs from \"fs\";\nimport Mustache from \"mustache\";\nimport * as path from \"path\";\nimport type { ActionType } from \"../action/ActionType.js\";\nimport type { OntologyDefinition } from \"../common/OntologyDefinition.js\";\nimport { OntologyEntityTypeEnum } from \"../common/OntologyEntityTypeEnum.js\";\nimport type { InterfaceType } from \"../interface/InterfaceType.js\";\nimport type { ObjectType } from \"../object/ObjectType.js\";\nimport {\n actionSnippets,\n interfaceSnippets,\n objectSnippets,\n} from \"./snippetTypes.js\";\n\nexport function createCodeSnippets(\n ontology: OntologyDefinition,\n packageName: string | undefined,\n outputDir: string | undefined,\n): void {\n if (outputDir === undefined) {\n outputDir = \"./code-snippets\";\n }\n if (!fs.existsSync(outputDir)) {\n fs.mkdirSync(outputDir, { recursive: true });\n }\n if (packageName === undefined) {\n packageName = \"\";\n }\n consola.info(\"Generating code snippets to \", outputDir);\n for (const type of Object.values(OntologyEntityTypeEnum)) {\n for (const object of Object.values(ontology[type])) {\n let snippet = {};\n switch (type) {\n case OntologyEntityTypeEnum.OBJECT_TYPE:\n snippet = generateObjectSnippet(object, packageName);\n break;\n case OntologyEntityTypeEnum.ACTION_TYPE:\n snippet = generateActionSnippet(object, packageName);\n break;\n case OntologyEntityTypeEnum.INTERFACE_TYPE:\n snippet = generateInterfaceSnippet(object, packageName);\n break;\n default:\n continue;\n }\n fs.writeFileSync(\n path.join(outputDir, object.apiName),\n JSON.stringify(snippet),\n );\n }\n }\n consola.info(\"Finished Code Snippet Generation\");\n}\n\nfunction generateInterfaceSnippet(\n interfaceType: InterfaceType,\n packageName: string,\n) {\n const interfaceContext = {\n \"interfaceApiName\": interfaceType.apiName,\n \"packageName\": packageName,\n \"objectOrInterfaceApiName\": interfaceType.apiName,\n \"propertyNames\": Object.keys(interfaceType.propertiesV2),\n };\n\n return getSnippets(interfaceSnippets, interfaceContext);\n}\n\nfunction generateObjectSnippet(objectType: ObjectType, packageName: string) {\n const objectContext = {\n \"objectType\": objectType.apiName,\n \"packageName\": packageName,\n \"objectOrInterfaceApiName\": objectType.apiName,\n };\n return getSnippets(objectSnippets, objectContext);\n}\n\nfunction generateActionSnippet(actionType: ActionType, packageName: string) {\n const actionContext = {\n \"actionApiName\": actionType.apiName,\n \"packageName\": packageName,\n };\n return getSnippets(actionSnippets, actionContext);\n}\n\nfunction getSnippets(\n snippetType:\n | typeof interfaceSnippets\n | typeof actionSnippets\n | typeof objectSnippets,\n context: {},\n) {\n const allSnippets = {};\n for (\n const templateName of Object.keys(snippetType).filter(key =>\n isNaN(Number(key))\n )\n ) {\n const latestTemplate =\n Object.values(TYPESCRIPT_OSDK_SNIPPETS.versions).find(v =>\n v.snippets[templateName]\n )?.snippets[templateName][0].template ?? \"\";\n const renderedTemplate = Mustache.render(latestTemplate, context);\n (allSnippets as any)[templateName] = renderedTemplate;\n }\n return allSnippets;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,wBAAwB,QAAQ,2BAA2B;AACpE,SAASC,OAAO,QAAQ,SAAS;AACjC,OAAO,KAAKC,EAAE,MAAM,IAAI;AACxB,OAAOC,QAAQ,MAAM,UAAU;AAC/B,OAAO,KAAKC,IAAI,MAAM,MAAM;AAG5B,SAASC,sBAAsB,QAAQ,qCAAqC;AAG5E,SACEC,cAAc,EACdC,iBAAiB,EACjBC,cAAc,QACT,mBAAmB;AAE1B,OAAO,SAASC,kBAAkBA,CAChCC,QAA4B,EAC5BC,WAA+B,EAC/BC,SAA6B,EACvB;EACN,IAAIA,SAAS,KAAKC,SAAS,EAAE;IAC3BD,SAAS,GAAG,iBAAiB;EAC/B;EACA,IAAI,CAACV,EAAE,CAACY,UAAU,CAACF,SAAS,CAAC,EAAE;IAC7BV,EAAE,CAACa,SAAS,CAACH,SAAS,EAAE;MAAEI,SAAS,EAAE;IAAK,CAAC,CAAC;EAC9C;EACA,IAAIL,WAAW,KAAKE,SAAS,EAAE;IAC7BF,WAAW,GAAG,EAAE;EAClB;EACAV,OAAO,CAACgB,IAAI,CAAC,8BAA8B,EAAEL,SAAS,CAAC;EACvD,KAAK,MAAMM,IAAI,IAAIC,MAAM,CAACC,MAAM,CAACf,sBAAsB,CAAC,EAAE;IACxD,KAAK,MAAMgB,MAAM,IAAIF,MAAM,CAACC,MAAM,CAACV,QAAQ,CAACQ,IAAI,CAAC,CAAC,EAAE;MAClD,IAAII,OAAO,GAAG,CAAC,CAAC;MAChB,QAAQJ,IAAI;QACV,KAAKb,sBAAsB,CAACkB,WAAW;UACrCD,OAAO,GAAGE,qBAAqB,CAACH,MAAM,EAAEV,WAAW,CAAC;UACpD;QACF,KAAKN,sBAAsB,CAACoB,WAAW;UACrCH,OAAO,GAAGI,qBAAqB,CAACL,MAAM,EAAEV,WAAW,CAAC;UACpD;QACF,KAAKN,sBAAsB,CAACsB,cAAc;UACxCL,OAAO,GAAGM,wBAAwB,CAACP,MAAM,EAAEV,WAAW,CAAC;UACvD;QACF;UACE;MACJ;MACAT,EAAE,CAAC2B,aAAa,CACdzB,IAAI,CAAC0B,IAAI,CAAClB,SAAS,EAAES,MAAM,CAACU,OAAO,CAAC,EACpCC,IAAI,CAACC,SAAS,CAACX,OAAO,CACxB,CAAC;IACH;EACF;EACArB,OAAO,CAACgB,IAAI,CAAC,kCAAkC,CAAC;AAClD;AAEA,SAASW,wBAAwBA,CAC/BM,aAA4B,EAC5BvB,WAAmB,EACnB;EACA,MAAMwB,gBAAgB,GAAG;IACvB,kBAAkB,EAAED,aAAa,CAACH,OAAO;IACzC,aAAa,EAAEpB,WAAW;IAC1B,0BAA0B,EAAEuB,aAAa,CAACH,OAAO;IACjD,eAAe,EAAEZ,MAAM,CAACiB,IAAI,CAACF,aAAa,CAACG,YAAY;EACzD,CAAC;EAED,OAAOC,WAAW,CAAC/B,iBAAiB,EAAE4B,gBAAgB,CAAC;AACzD;AAEA,SAASX,qBAAqBA,CAACe,UAAsB,EAAE5B,WAAmB,EAAE;EAC1E,MAAM6B,aAAa,GAAG;IACpB,YAAY,EAAED,UAAU,CAACR,OAAO;IAChC,aAAa,EAAEpB,WAAW;IAC1B,0BAA0B,EAAE4B,UAAU,CAACR;EACzC,CAAC;EACD,OAAOO,WAAW,CAAC9B,cAAc,EAAEgC,aAAa,CAAC;AACnD;AAEA,SAASd,qBAAqBA,CAACe,UAAsB,EAAE9B,WAAmB,EAAE;EAC1E,MAAM+B,aAAa,GAAG;IACpB,eAAe,EAAED,UAAU,CAACV,OAAO;IACnC,aAAa,EAAEpB;EACjB,CAAC;EACD,OAAO2B,WAAW,CAAChC,cAAc,EAAEoC,aAAa,CAAC;AACnD;AAEA,SAASJ,WAAWA,CAClBK,WAGyB,EACzBC,OAAW,EACX;EACA,MAAMC,WAAW,GAAG,CAAC,CAAC;EACtB,KACE,MAAMC,YAAY,IAAI3B,MAAM,CAACiB,IAAI,CAACO,WAAW,CAAC,CAACI,MAAM,CAACC,GAAG,IACvDC,KAAK,CAACC,MAAM,CAACF,GAAG,CAAC,CACnB,CAAC,EACD;IACA,MAAMG,cAAc,GAClBhC,MAAM,CAACC,MAAM,CAACpB,wBAAwB,CAACoD,QAAQ,CAAC,CAACC,IAAI,CAACC,CAAC,IACrDA,CAAC,CAACC,QAAQ,CAACT,YAAY,CACzB,CAAC,EAAES,QAAQ,CAACT,YAAY,CAAC,CAAC,CAAC,CAAC,CAACU,QAAQ,IAAI,EAAE;IAC7C,MAAMC,gBAAgB,GAAGtD,QAAQ,CAACuD,MAAM,CAACP,cAAc,EAAEP,OAAO,CAAC;IAChEC,WAAW,CAASC,YAAY,CAAC,GAAGW,gBAAgB;EACvD;EACA,OAAOZ,WAAW;AACpB","ignoreList":[]}
@@ -0,0 +1,60 @@
1
+ /*
2
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+
17
+ export let interfaceSnippets = /*#__PURE__*/function (interfaceSnippets) {
18
+ interfaceSnippets[interfaceSnippets["loadInterfacesReference"] = 0] = "loadInterfacesReference";
19
+ interfaceSnippets[interfaceSnippets["loadAllInterfacesReference"] = 1] = "loadAllInterfacesReference";
20
+ interfaceSnippets[interfaceSnippets["loadOrderedInterfacesReference"] = 2] = "loadOrderedInterfacesReference";
21
+ interfaceSnippets[interfaceSnippets["searchInterfacesReference"] = 3] = "searchInterfacesReference";
22
+ interfaceSnippets[interfaceSnippets["loadInterfaceMetadataSnippet"] = 4] = "loadInterfaceMetadataSnippet";
23
+ interfaceSnippets[interfaceSnippets["subscribeToObjectSetInstructions"] = 5] = "subscribeToObjectSetInstructions";
24
+ return interfaceSnippets;
25
+ }({});
26
+ export let actionSnippets = /*#__PURE__*/function (actionSnippets) {
27
+ actionSnippets[actionSnippets["applyAction"] = 0] = "applyAction";
28
+ actionSnippets[actionSnippets["batchApplyAction"] = 1] = "batchApplyAction";
29
+ return actionSnippets;
30
+ }({});
31
+ export let objectSnippets = /*#__PURE__*/function (objectSnippets) {
32
+ objectSnippets[objectSnippets["loadSingleObjectGuide"] = 0] = "loadSingleObjectGuide";
33
+ objectSnippets[objectSnippets["loadObjectsReference"] = 1] = "loadObjectsReference";
34
+ objectSnippets[objectSnippets["loadAllObjectsReference"] = 2] = "loadAllObjectsReference";
35
+ objectSnippets[objectSnippets["loadOrderedInterfacesReference"] = 3] = "loadOrderedInterfacesReference";
36
+ // what
37
+ objectSnippets[objectSnippets["searchObjectsGuide"] = 4] = "searchObjectsGuide";
38
+ // There's specific search queries under this one too, but a little verbose
39
+ objectSnippets[objectSnippets["aggregationTemplate"] = 5] = "aggregationTemplate";
40
+ /* Types of aggregation + group bys
41
+ approximateDistinctAggregationTemplate,
42
+ exactDistinctAggregationTemplate,
43
+ numericAggregationTemplate,
44
+ countAggregationTemplate,
45
+ fixedWidthGroupByTemplate,
46
+ durationGroupByTemplate,
47
+ exactGroupByTemplate,
48
+ rangeGroupByTemplate,
49
+ */
50
+ objectSnippets[objectSnippets["objectSetOperationsGuide"] = 6] = "objectSetOperationsGuide";
51
+ /* Types of set operations
52
+ objectSetOperationsUnion,
53
+ objectSetOperationsSubtract,
54
+ objectSetOperationsIntersect,
55
+ */
56
+ objectSnippets[objectSnippets["loadObjectMetadataSnippet"] = 7] = "loadObjectMetadataSnippet";
57
+ objectSnippets[objectSnippets["subscribeToObjectSetInstructions"] = 8] = "subscribeToObjectSetInstructions";
58
+ return objectSnippets;
59
+ }({});
60
+ //# sourceMappingURL=snippetTypes.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"snippetTypes.js","names":["interfaceSnippets","actionSnippets","objectSnippets"],"sources":["snippetTypes.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport enum interfaceSnippets {\n loadInterfacesReference,\n loadAllInterfacesReference,\n loadOrderedInterfacesReference,\n searchInterfacesReference,\n loadInterfaceMetadataSnippet,\n subscribeToObjectSetInstructions,\n}\n\nexport enum actionSnippets {\n applyAction,\n batchApplyAction,\n}\n\nexport enum objectSnippets {\n loadSingleObjectGuide,\n loadObjectsReference,\n loadAllObjectsReference,\n loadOrderedInterfacesReference, // what\n searchObjectsGuide, // There's specific search queries under this one too, but a little verbose\n aggregationTemplate,\n /* Types of aggregation + group bys\n approximateDistinctAggregationTemplate,\n exactDistinctAggregationTemplate,\n numericAggregationTemplate,\n countAggregationTemplate,\n fixedWidthGroupByTemplate,\n durationGroupByTemplate,\n exactGroupByTemplate,\n rangeGroupByTemplate,\n */\n objectSetOperationsGuide,\n /* Types of set operations\n objectSetOperationsUnion,\n objectSetOperationsSubtract,\n objectSetOperationsIntersect,\n */\n loadObjectMetadataSnippet,\n subscribeToObjectSetInstructions,\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,WAAYA,iBAAiB,0BAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;AAS7B,WAAYC,cAAc,0BAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAK1B,WAAYC,cAAc,0BAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAIQ;EAJtBA,cAAc,CAAdA,cAAc;EAKJ;EALVA,cAAc,CAAdA,cAAc;EAOxB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAhBYA,cAAc,CAAdA,cAAc;EAkBxB;AACF;AACA;AACA;AACA;EAtBYA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}