@osdk/generator 1.9.1-main-20240412164446 → 1.10.0-main-20240418183121

package/CHANGELOG.md

@@ -1,14 +1,19 @@
 # @osdk/generator
 
-## 1.9.1-main-20240412164446
+## 1.10.0-main-20240418183121
+
+### Minor Changes
+
+- 11434b95: Deprecated bulk actions with renamed batchActions functionality
+- 948c6340: Add pivot to functionality and deprecate searchAround calls
 
 ### Patch Changes
 
 - 9906a41e: Extract package generation
 - 9906a41e: Compatible version checks now use versions that are both embedded in the code and updated automatically as part of the release process.
 - f7287ae8: For 2.0, fixes codegen version matching in snapshot builds
-  - @osdk/api@1.6.1-main-20240412164446
-  - @osdk/generator-converters@0.4.1-main-20240412164446
+  - @osdk/api@1.6.1-main-20240418183121
+  - @osdk/generator-converters@0.4.1-main-20240418183121
 
 ## 1.1.1
 

package/build/js/index.cjs

@@ -84,7 +84,9 @@ ${Array.from(uniqueLinkTargets).map((linkTarget) => `import type { ${linkTarget}
   ${getDescriptionIfPresent(objectTypeWithLinks.objectType.description)}
   export interface ${objectTypeWithLinks.objectType.apiName} extends OntologyObject {
   /** @deprecated please migrate to $apiName instead */
-  readonly __apiName: "${objectTypeWithLinks.objectType.apiName}";
+  readonly __apiName: "${objectTypeWithLinks.objectType.apiName}" & {${objectTypeWithLinks.linkTypes.map((linkType) => {
+    return `/** @deprecated please migrate to pivotTo(${linkType.apiName}) instead */ searchAround${linkType.apiName.charAt(0).toUpperCase() + linkType.apiName.slice(1)}?: never`;
+  })}};
   /** @deprecated please migrate to $primaryKey instead */
   readonly __primaryKey: ${wirePropertyTypeV2ToTypeScriptType(objectTypeWithLinks.objectType.properties[objectTypeWithLinks.objectType.primaryKey].dataType)};
   readonly $apiName: "${objectTypeWithLinks.objectType.apiName}";
@@ -951,6 +953,54 @@ async function generateBackCompatDeprecatedExports(fs2, outDir, importExt = "")
   await generateOntologyRuntimeDistDir(outDir, fs2, importExt);
   await generateOAuthClientDistDir(outDir, fs2, importExt);
 }
+async function generateBatchActions(ontology, fs2, outDir, importExt = "") {
+  const importedObjects = /* @__PURE__ */ new Set();
+  let actionSignatures = [];
+  for (const action of Object.values(ontology.actionTypes)) {
+    const entries = Object.entries(action.parameters);
+    const modifiedEntityTypes = getModifiedEntityTypes(action);
+    const addedObjects = Array.from(modifiedEntityTypes.addedObjects);
+    const modifiedObjects = Array.from(modifiedEntityTypes.modifiedObjects);
+    addedObjects.forEach(importedObjects.add, importedObjects);
+    modifiedObjects.forEach(importedObjects.add, importedObjects);
+    let jsDocBlock = ["/**"];
+    if (action.description) {
+      jsDocBlock.push(`* ${action.description}`);
+    }
+    let parameterBlock = "";
+    if (entries.length > 0) {
+      parameterBlock = `params: { 
+`;
+      for (const [parameterName, parameterData] of entries) {
+        parameterBlock += `"${parameterName}"`;
+        parameterBlock += parameterData.required ? ": " : "?: ";
+        const typeScriptType = getTypeScriptTypeFromDataType(parameterData.dataType, importedObjects);
+        parameterBlock += `${typeScriptType};
+`;
+        jsDocBlock.push(`* @param {${typeScriptType}} params.${parameterName}`);
+      }
+      parameterBlock += "}[], ";
+    } else {
+      parameterBlock = `params: Record<string,never>[], `;
+    }
+    jsDocBlock.push(`*/`);
+    actionSignatures.push(`
+      ${jsDocBlock.join("\n")}
+      ${action.apiName}<O extends BatchActionExecutionOptions>(${parameterBlock}options?: O): 
+        Promise<Result<BatchActionResponseFromOptions<O, Edits<${addedObjects.length > 0 ? addedObjects.join(" | ") : "void"}, ${modifiedObjects.length > 0 ? modifiedObjects.join(" | ") : "void"}>>, ActionError>>;
+      `);
+  }
+  await fs2.mkdir(outDir, {
+    recursive: true
+  });
+  await fs2.writeFile(path16__namespace.default.join(outDir, "BatchActions.ts"), await formatTs(`
+    import type { ObjectSet, LocalDate, Timestamp, Attachment, Edits, ActionExecutionOptions, BatchActionExecutionOptions, ActionError, Result, ActionResponseFromOptions, BatchActionResponseFromOptions } from "@osdk/legacy-client";
+    ${Array.from(importedObjects).map((importedObject) => `import type { ${importedObject} } from "../objects/${importedObject}${importExt}";`).join("\n")}
+    export interface BatchActions {
+    ${actionSignatures.join("\n")}
+    }
+  `));
+}
 async function generateBulkActions(ontology, fs2, outDir, importExt = "") {
   const importedObjects = /* @__PURE__ */ new Set();
   let actionSignatures = [];
@@ -1076,6 +1126,7 @@ async function generateMetadataFile(ontology, userAgent, fs2, outDir, importExt
   import type { Objects } from "./ontology/objects/Objects${importExt}";
   import type { Actions } from "./ontology/actions/Actions${importExt}";
   import type { Queries } from "./ontology/queries/Queries${importExt}";
+  import type { BatchActions } from "./ontology/actions/BatchActions${importExt}";
   import type { BulkActions } from "./ontology/actions/BulkActions${importExt}";
   ${objectNames.map((name) => `import {${name}} from "./ontology/objects/${name}${importExt}";`).join("\n")}
   ${actionNames.map((name) => `import {${getImportClause(name, actionAltNames)}} from "./ontology/actions/${name}${importExt}";`).join("\n")}
@@ -1119,7 +1170,9 @@ async function generateMetadataFile(ontology, userAgent, fs2, outDir, importExt
 export interface Ontology extends ClientOntology<typeof Ontology> {
     objects: Objects;
     actions: Actions;
+    /** @deprecated use batchActions */
     bulkActions: BulkActions;
+    batchActions: BatchActions;
     queries: Queries;
 }`));
 }
@@ -1581,6 +1634,7 @@ async function generateClientSdkVersionOneDotOne(ontology, userAgent, fs2, outDi
   await generateObjectsInterfaceSupportFiles(sanitizedOntology, fs2, path16__namespace.join(objectsDir, "objects-api"), importExt);
   await generatePerObjectInterfaceAndDataFiles(sanitizedOntology, fs2, objectsDir, importExt);
   await generateActions(sanitizedOntology, fs2, actionsDir, importExt);
+  await generateBatchActions(sanitizedOntology, fs2, actionsDir, importExt);
   await generateBulkActions(sanitizedOntology, fs2, actionsDir, importExt);
   await generatePerActionDataFiles(sanitizedOntology, fs2, actionsDir, importExt, false);
   await generateQueries(sanitizedOntology, fs2, queriesDir, importExt);