@osdk/generator 2.8.0-beta.2 → 2.8.0-beta.21

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 (66) hide show
  1. package/CHANGELOG.md +153 -0
  2. package/build/browser/shared/getInterfaceTypesFromQueryDataType.js +3 -0
  3. package/build/browser/shared/getInterfaceTypesFromQueryDataType.js.map +1 -1
  4. package/build/browser/shared/getObjectTypesFromQueryDataType.js +3 -0
  5. package/build/browser/shared/getObjectTypesFromQueryDataType.js.map +1 -1
  6. package/build/browser/util/test/TodoWireOntology.js +20 -10
  7. package/build/browser/util/test/TodoWireOntology.js.map +1 -1
  8. package/build/browser/v2.0/generatePerQueryDataFiles.js +10 -3
  9. package/build/browser/v2.0/generatePerQueryDataFiles.js.map +1 -1
  10. package/build/browser/v2.0/getDescriptionIfPresent.js +4 -1
  11. package/build/browser/v2.0/getDescriptionIfPresent.js.map +1 -1
  12. package/build/cjs/index.cjs +19 -4
  13. package/build/cjs/index.cjs.map +1 -1
  14. package/build/esm/shared/getInterfaceTypesFromQueryDataType.js +3 -0
  15. package/build/esm/shared/getInterfaceTypesFromQueryDataType.js.map +1 -1
  16. package/build/esm/shared/getObjectTypesFromQueryDataType.js +3 -0
  17. package/build/esm/shared/getObjectTypesFromQueryDataType.js.map +1 -1
  18. package/build/esm/util/test/TodoWireOntology.js +20 -10
  19. package/build/esm/util/test/TodoWireOntology.js.map +1 -1
  20. package/build/esm/v2.0/generatePerQueryDataFiles.js +10 -3
  21. package/build/esm/v2.0/generatePerQueryDataFiles.js.map +1 -1
  22. package/build/esm/v2.0/getDescriptionIfPresent.js +4 -1
  23. package/build/esm/v2.0/getDescriptionIfPresent.js.map +1 -1
  24. package/package.json +4 -4
  25. package/build/browser/generateClientSdkPackage.test.js +0 -68
  26. package/build/browser/generateClientSdkPackage.test.js.map +0 -1
  27. package/build/browser/shared/apiNamespaces/startsWithApiNamespace.test.js +0 -47
  28. package/build/browser/shared/apiNamespaces/startsWithApiNamespace.test.js.map +0 -1
  29. package/build/browser/shared/sanitizeMetadata.test.js +0 -46
  30. package/build/browser/shared/sanitizeMetadata.test.js.map +0 -1
  31. package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js +0 -472
  32. package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js.map +0 -1
  33. package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js +0 -2603
  34. package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js.map +0 -1
  35. package/build/browser/v2.0/generatePerActionDataFiles.test.js +0 -64
  36. package/build/browser/v2.0/generatePerActionDataFiles.test.js.map +0 -1
  37. package/build/browser/v2.0/generatePerQueryDataFiles.test.js +0 -519
  38. package/build/browser/v2.0/generatePerQueryDataFiles.test.js.map +0 -1
  39. package/build/esm/generateClientSdkPackage.test.js +0 -68
  40. package/build/esm/generateClientSdkPackage.test.js.map +0 -1
  41. package/build/esm/shared/apiNamespaces/startsWithApiNamespace.test.js +0 -47
  42. package/build/esm/shared/apiNamespaces/startsWithApiNamespace.test.js.map +0 -1
  43. package/build/esm/shared/sanitizeMetadata.test.js +0 -46
  44. package/build/esm/shared/sanitizeMetadata.test.js.map +0 -1
  45. package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js +0 -472
  46. package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js.map +0 -1
  47. package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js +0 -2603
  48. package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js.map +0 -1
  49. package/build/esm/v2.0/generatePerActionDataFiles.test.js +0 -64
  50. package/build/esm/v2.0/generatePerActionDataFiles.test.js.map +0 -1
  51. package/build/esm/v2.0/generatePerQueryDataFiles.test.js +0 -519
  52. package/build/esm/v2.0/generatePerQueryDataFiles.test.js.map +0 -1
  53. package/build/types/generateClientSdkPackage.test.d.ts +0 -1
  54. package/build/types/generateClientSdkPackage.test.d.ts.map +0 -1
  55. package/build/types/shared/apiNamespaces/startsWithApiNamespace.test.d.ts +0 -1
  56. package/build/types/shared/apiNamespaces/startsWithApiNamespace.test.d.ts.map +0 -1
  57. package/build/types/shared/sanitizeMetadata.test.d.ts +0 -1
  58. package/build/types/shared/sanitizeMetadata.test.d.ts.map +0 -1
  59. package/build/types/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.d.ts +0 -1
  60. package/build/types/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.d.ts.map +0 -1
  61. package/build/types/v2.0/generateClientSdkVersionTwoPointZero.test.d.ts +0 -1
  62. package/build/types/v2.0/generateClientSdkVersionTwoPointZero.test.d.ts.map +0 -1
  63. package/build/types/v2.0/generatePerActionDataFiles.test.d.ts +0 -1
  64. package/build/types/v2.0/generatePerActionDataFiles.test.d.ts.map +0 -1
  65. package/build/types/v2.0/generatePerQueryDataFiles.test.d.ts +0 -1
  66. package/build/types/v2.0/generatePerQueryDataFiles.test.d.ts.map +0 -1
@@ -357,8 +357,10 @@ function stringUnionFrom(values) {
357
357
  // src/v2.0/getDescriptionIfPresent.ts
358
358
  function getDescriptionIfPresent(description, includeNewline) {
359
359
  if (description) {
360
+ const lines = description.split("\n");
361
+ const formattedLines = lines.map((line) => ` * ${line}`).join("\n");
360
362
  return `/**
361
- * ${description}
363
+ ${formattedLines}
362
364
  */${""}`;
363
365
  }
364
366
  return "";
@@ -1112,6 +1114,7 @@ function getInterfaceTypesFromQueryDataType(dataType, types) {
1112
1114
  case "float":
1113
1115
  case "integer":
1114
1116
  case "long":
1117
+ case "mediaReference":
1115
1118
  case "null":
1116
1119
  case "string":
1117
1120
  case "threeDimensionalAggregation":
@@ -1121,6 +1124,8 @@ function getInterfaceTypesFromQueryDataType(dataType, types) {
1121
1124
  case "unsupported":
1122
1125
  case "object":
1123
1126
  case "objectSet":
1127
+ case "mediaReference":
1128
+ case "void":
1124
1129
  return;
1125
1130
  default:
1126
1131
  throw new Error(`Unknown query data type ${dataType.type}`);
@@ -1173,6 +1178,7 @@ function getObjectTypesFromQueryDataType(dataType, types) {
1173
1178
  case "float":
1174
1179
  case "integer":
1175
1180
  case "long":
1181
+ case "mediaReference":
1176
1182
  case "null":
1177
1183
  case "string":
1178
1184
  case "threeDimensionalAggregation":
@@ -1182,6 +1188,8 @@ function getObjectTypesFromQueryDataType(dataType, types) {
1182
1188
  case "unsupported":
1183
1189
  case "interfaceObject":
1184
1190
  case "interfaceObjectSet":
1191
+ case "mediaReference":
1192
+ case "void":
1185
1193
  return;
1186
1194
  default:
1187
1195
  throw new Error(`Unknown query data type ${dataType.type}`);
@@ -1268,8 +1276,8 @@ async function generateV2QueryFile(fs2, outDir, relOutDir, query, importExt, ont
1268
1276
  }), "Result")}
1269
1277
  `}
1270
1278
  }
1271
-
1272
-
1279
+
1280
+ ${getDescriptionIfPresent(query.description)}
1273
1281
  export interface ${query.shortApiName} extends QueryDefinition<
1274
1282
  ${query.shortApiName}.Signature
1275
1283
  >, VersionBound<$ExpectedClientVersion>{
@@ -1293,7 +1301,7 @@ async function generateV2QueryFile(fs2, outDir, relOutDir, query, importExt, ont
1293
1301
  osdkMetadata: typeof $osdkMetadata;
1294
1302
  }
1295
1303
 
1296
-
1304
+ ${getDescriptionIfPresent(query.description)}
1297
1305
  export const ${query.shortApiName}: ${query.definitionIdentifier} = {
1298
1306
  ${stringify(baseProps, {
1299
1307
  "description": () => void 0,
@@ -1358,6 +1366,13 @@ function getQueryParamType(enhancedOntology, input, type, isMapKey = false) {
1358
1366
  case "timestamp":
1359
1367
  paramType = `Query${type}.PrimitiveType<${JSON.stringify(input.type)}>`;
1360
1368
  break;
1369
+ case "mediaReference":
1370
+ if (type === "Param") {
1371
+ paramType = `Query${type}.PrimitiveType<${JSON.stringify(input.type)}>`;
1372
+ } else {
1373
+ paramType = `Query${type}.MediaType`;
1374
+ }
1375
+ break;
1361
1376
  case "struct":
1362
1377
  paramType = `{
1363
1378
  ${stringify(input.struct, {