@osdk/generator 1.11.1-main-20240521212111 → 1.12.0-beta.1

package/build/cjs/generateClientSdkPackage.d.cts

@@ -7,47 +7,66 @@ export interface DependencyVersions {
     areTheTypesWrongVersion: string;
     osdkApiVersion: string;
     osdkClientVersion: string;
+    osdkClientApiVersion: string;
     osdkLegacyClientVersion: string;
 }
-export declare function getPackageJsonContents(name: string, version: string, sdkVersion: "2.0" | "1.1", { typescriptVersion, tslibVersion, areTheTypesWrongVersion, osdkApiVersion, osdkClientVersion, osdkLegacyClientVersion, }: DependencyVersions): {
-    name: string;
-    version: string;
-    main: string;
-    module: string;
-    exports: {
-        ".": {
-            import: string;
-            require: string;
-        };
-        "./ontology/objects": {
-            import: string;
-            require: string;
-        };
+export declare function getExpectedDependencies(sdkVersion: "2.0" | "1.1", { osdkApiVersion, osdkClientVersion, osdkClientApiVersion, osdkLegacyClientVersion, }: DependencyVersions): {
+    devDependencies: {
+        "@osdk/client.api": string;
+        "@osdk/api": string;
+    } | {
+        "@osdk/legacy-client": string;
+        "@osdk/api": string;
     };
-    scripts: {
-        prepack: string;
-        check: string;
+    peerDependencies: {
+        "@osdk/client.api": string;
+        "@osdk/client": string;
+        "@osdk/api": string;
+    } | {
+        "@osdk/legacy-client": string;
+        "@osdk/api": string;
     };
+};
+export declare function getPackageJsonContents(name: string, version: string, sdkVersion: "2.0" | "1.1", dependencyVersions: DependencyVersions): {
+    files: string[];
     devDependencies: {
-        "@osdk/client": string;
         typescript: string;
         tslib: string;
         "@arethetypeswrong/cli": string;
+        "@osdk/client.api": string;
         "@osdk/api": string;
     } | {
-        "@osdk/legacy-client": string;
         typescript: string;
         tslib: string;
         "@arethetypeswrong/cli": string;
+        "@osdk/legacy-client": string;
         "@osdk/api": string;
     };
     peerDependencies: {
+        "@osdk/client.api": string;
         "@osdk/client": string;
         "@osdk/api": string;
     } | {
         "@osdk/legacy-client": string;
         "@osdk/api": string;
     };
-    files: string[];
+    name: string;
+    version: string;
+    main: string;
+    module: string;
+    exports: {
+        ".": {
+            import: string;
+            require: string;
+        };
+        "./ontology/objects": {
+            import: string;
+            require: string;
+        };
+    };
+    scripts: {
+        prepack: string;
+        check: string;
+    };
 };
 //# sourceMappingURL=generateClientSdkPackage.d.ts.map

package/build/cjs/generateClientSdkPackage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateClientSdkPackage.d.ts","sourceRoot":"","sources":["../../src/generateClientSdkPackage.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAE1E,wBAAsB,wBAAwB,CAC5C,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,KAAK,GAAG,KAAK,EACzB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,sBAAsB,EAChC,SAAS,EAAE,SAAS,EACpB,kBAAkB,EAAE,kBAAkB,EACtC,UAAU,EAAE,MAAM,iBA0DnB;AA+BD,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,KAAK,GAAG,KAAK,EACzB,EACE,iBAAiB,EACjB,YAAY,EACZ,uBAAuB,EACvB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,GACxB,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkDtB"}
+{"version":3,"file":"generateClientSdkPackage.d.ts","sourceRoot":"","sources":["../../src/generateClientSdkPackage.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAE1E,wBAAsB,wBAAwB,CAC5C,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,KAAK,GAAG,KAAK,EACzB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,sBAAsB,EAChC,SAAS,EAAE,SAAS,EACpB,kBAAkB,EAAE,kBAAkB,EACtC,UAAU,EAAE,MAAM,iBA0DnB;AA+BD,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,KAAK,GAAG,KAAK,EACzB,EACE,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,GACxB,EAAE,kBAAkB;;;;;;;;;;;;;;;;EAoBtB;AA2BD,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,KAAK,GAAG,KAAK,EACzB,kBAAkB,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmCvC"}

package/build/cjs/index.cjs

@@ -356,13 +356,13 @@ async function generatePerActionDataFiles(ontology, fs2, outDir, importExt, v2)
           
 
           // Represents the runtime arguments for the action
-          export type ${paramsIdentifier} = NOOP<OsdkActionParameters<${paramsDefIdentifier}>>;
+          export type ${paramsIdentifier} = NOOP<OsdkActionParameters<${paramsDefIdentifier}>> | NOOP<OsdkActionParameters<${paramsDefIdentifier}>>[];
 
           
           // Represents a fqn of the action
           export interface ${action.apiName} {
             ${getDescriptionIfPresent(action.description)}
-             <OP extends ApplyActionOptions>(args: ${paramsIdentifier}, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+             <P extends ${paramsIdentifier}, OP extends P extends NOOP<OsdkActionParameters<${paramsDefIdentifier}>>[]? ApplyBatchActionOptions: ApplyActionOptions>(args: P, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
           }
 
           
@@ -400,7 +400,7 @@ async function generatePerActionDataFiles(ontology, fs2, outDir, importExt, v2)
     const importObjects = referencedObjectDefs.size > 0 ? `import type {${[...referencedObjectDefs].join(",")}} from "../objects${importExt}";` : "";
     await fs2.writeFile(path16__namespace.default.join(outDir, `${action.apiName}.ts`), await formatTs(`
           import type { ActionDefinition, ObjectActionDataType, ObjectSetActionDataType } from "@osdk/api";
-          import type { ActionSignature, ApplyActionOptions, OsdkActionParameters,ActionReturnTypeForOptions, NOOP } from '@osdk/client';
+          import type { ActionSignature, ApplyActionOptions, ApplyBatchActionOptions, OsdkActionParameters,ActionReturnTypeForOptions, NOOP } from '@osdk/client.api';
           import { $osdkMetadata} from "../../OntologyMetadata${importExt}";
           ${importObjects}
 
@@ -628,8 +628,7 @@ function reexportTypes(typesToExport, genericArgsLeft = "", genericArgsRight = c
 var captureInBracketsRegex = /<(.*?)>/;
 var captureGenericParamNameRegex = /^\s?(.+?)( extends .*?)?( = .*?)?\s?$/;
 function cleanup(s) {
-  if (s.length === 0)
-    return "";
+  if (s.length === 0) return "";
   const genericParameterNames = captureInBracketsRegex.exec(s)?.[1]?.split(",")?.map((a) => {
     return captureGenericParamNameRegex.exec(a)?.[1] ?? a;
   });
@@ -1681,7 +1680,7 @@ function __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(interfaceDef, v2 = false
       
     };`;
 }
-var ExpectedOsdkVersion = "0.19.1";
+var ExpectedOsdkVersion = "0.20.0";
 async function generateOntologyMetadataFile(ontology, userAgent, fs2, outDir) {
   fs2.writeFile(path16__namespace.default.join(outDir, "OntologyMetadata.ts"), await formatTs(`
       import { OntologyMetadata as OM } from "@osdk/api";
@@ -1726,7 +1725,29 @@ async function generateClientSdkVersionTwoPointZero(ontology, userAgent, fs2, ou
       import * as Interfaces from "./ontology/interfaces${importExt}";
       import { OntologyMetadata } from "./OntologyMetadata${importExt}";
       
-      const _Ontology = {
+      export interface Ontology extends OntologyDefinition<${stringUnionFrom2(objectNames)}> {
+        metadata: OntologyMetadata,
+        objects: {
+          ${objectNames.map((objectName) => {
+    return `${objectName}: Objects.${objectName}`;
+  }).join(",\n")}
+        },
+        actions: {
+          ${actionNames.map((actionName) => {
+    return `${actionName}: typeof Actions.${actionName}`;
+  }).join(",\n")}
+        },
+        queries: {
+          // TODO
+        },
+        interfaces: {
+          ${interfaceNames.map((objectName) => {
+    return `${objectName}: Interfaces.${objectName}`;
+  }).join(",\n")}
+      }
+    }
+
+      export const Ontology: Ontology = {
         metadata: OntologyMetadata,
         objects: {
           ${objectNames.map((objectName) => {
@@ -1748,11 +1769,8 @@ async function generateClientSdkVersionTwoPointZero(ontology, userAgent, fs2, ou
   }).join(",\n")}
               
         }
-      } satisfies OntologyDefinition<${stringUnionFrom2(objectNames)}>;
+      };
 
-      type _Ontology = typeof _Ontology;
-      export interface Ontology extends _Ontology {}
-      export const Ontology = _Ontology as Ontology;
     `));
   await fs2.mkdir(path16__namespace.default.join(outDir, "ontology", "objects"), {
     recursive: true
@@ -1761,7 +1779,7 @@ async function generateClientSdkVersionTwoPointZero(ontology, userAgent, fs2, ou
     const obj = ontology.objectTypes[name];
     await fs2.writeFile(path16__namespace.default.join(outDir, "ontology", `objects`, `${name}.ts`), await formatTs(`
         import type { ObjectTypeDefinition, VersionBound, ObjectTypeLinkDefinition, PropertyDef } from "@osdk/api";
-        import { Osdk } from "@osdk/client";
+        import { Osdk } from "@osdk/client.api";
         import { $osdkMetadata } from "../../OntologyMetadata${importExt}";
         import type { $ExpectedClientVersion } from "../../OntologyMetadata${importExt}";
 
@@ -1810,8 +1828,7 @@ async function generateOntologyInterfaces(fs2, outDir, interfaceNames, ontology,
 
 // src/generateClientSdkPackage.ts
 async function generateClientSdkPackage(packageName, packageVersion, sdkVersion, baseOutDir, ontology, minimalFs, dependencyVersions, cliVersion) {
-  if (!packageName)
-    throw new Error("Package name is require");
+  if (!packageName) throw new Error("Package name is require");
   for (const packageType of ["module", "commonjs"]) {
     const outDir = path16__namespace.join(baseOutDir, "dist", packageType);
     await (sdkVersion === "1.1" ? generateClientSdkVersionOneDotOne : sdkVersion === "2.0" ? generateClientSdkVersionTwoPointZero : void 0)(ontology, `typescript-sdk/${packageVersion} osdk-cli/${cliVersion}`, minimalFs, outDir, packageType);
@@ -1853,14 +1870,52 @@ function getTsCompilerOptions(packageType) {
   };
   return compilerOptions;
 }
-function getPackageJsonContents(name, version, sdkVersion, {
-  typescriptVersion,
-  tslibVersion,
-  areTheTypesWrongVersion,
+function getExpectedDependencies(sdkVersion, {
   osdkApiVersion,
   osdkClientVersion,
+  osdkClientApiVersion,
   osdkLegacyClientVersion
 }) {
+  return {
+    devDependencies: {
+      "@osdk/api": osdkApiVersion,
+      ...sdkVersion === "2.0" ? {
+        "@osdk/client.api": osdkClientApiVersion
+      } : {
+        "@osdk/legacy-client": osdkLegacyClientVersion
+      }
+    },
+    peerDependencies: {
+      "@osdk/api": osdkApiVersion,
+      ...sdkVersion === "2.0" ? {
+        "@osdk/client.api": osdkClientApiVersion,
+        "@osdk/client": osdkClientVersion
+      } : {
+        "@osdk/legacy-client": osdkLegacyClientVersion
+      }
+    }
+  };
+}
+function getExpectedDependenciesFull(sdkVersion, dependencyVersions) {
+  const {
+    typescriptVersion,
+    tslibVersion,
+    areTheTypesWrongVersion
+  } = dependencyVersions;
+  const base = getExpectedDependencies(sdkVersion, dependencyVersions);
+  return {
+    devDependencies: {
+      ...base.devDependencies,
+      "typescript": typescriptVersion,
+      "tslib": tslibVersion,
+      "@arethetypeswrong/cli": areTheTypesWrongVersion
+    },
+    peerDependencies: {
+      ...base.peerDependencies
+    }
+  };
+}
+function getPackageJsonContents(name, version, sdkVersion, dependencyVersions) {
   const esmPrefix = "./dist/module";
   const commonjsPrefix = "./dist/commonjs";
   return {
@@ -1882,25 +1937,7 @@ function getPackageJsonContents(name, version, sdkVersion, {
       prepack: `tsc -p ${esmPrefix}/tsconfig.json && tsc -p ${commonjsPrefix}/tsconfig.json`,
       check: "npm exec attw $(npm pack)"
     },
-    devDependencies: {
-      "typescript": typescriptVersion,
-      "tslib": tslibVersion,
-      "@arethetypeswrong/cli": areTheTypesWrongVersion,
-      "@osdk/api": osdkApiVersion,
-      ...sdkVersion === "2.0" ? {
-        "@osdk/client": osdkClientVersion
-      } : {
-        "@osdk/legacy-client": osdkLegacyClientVersion
-      }
-    },
-    peerDependencies: {
-      "@osdk/api": osdkApiVersion,
-      ...sdkVersion === "2.0" ? {
-        "@osdk/client": osdkClientVersion
-      } : {
-        "@osdk/legacy-client": osdkLegacyClientVersion
-      }
-    },
+    ...getExpectedDependenciesFull(sdkVersion, dependencyVersions),
     files: ["**/*.js", "**/*.d.ts", "dist/**/package.json"]
   };
 }
@@ -1911,5 +1948,6 @@ async function writeJson(minimalFs, filePath, body) {
 exports.__UNSTABLE_generateClientSdkPackage = generateClientSdkPackage;
 exports.generateClientSdkVersionOneDotOne = generateClientSdkVersionOneDotOne;
 exports.generateClientSdkVersionTwoPointZero = generateClientSdkVersionTwoPointZero;
+exports.getExpectedDependencies = getExpectedDependencies;
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.cjs.map