@osdk/generator 2.0.0-beta.12 → 2.0.0-beta.13

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @osdk/generator
 
+## 2.0.0-beta.13
+
+### Minor Changes
+
+- 1488144: Renamed definition types to metadata
+- bbfebfd: Fix generation of actions with full api names
+- f6e2880: Fixes query type generation
+- c28792e: Modified return type of fetchMetadata to return Object/Interface Definitions
+- 26ee3bd: Updates return types of fetchMetadata to be Action and Query Definitions
+- 6ab5d2e: Renamed Min_Definition to \_Definition
+- 885c8e4: Fixing bug for codegen on windows machines, where we would use backslashes instead of forward slashes for import paths, which should be OS agnostic.
+
+### Patch Changes
+
+- Updated dependencies [1488144]
+- Updated dependencies [c28792e]
+- Updated dependencies [26ee3bd]
+- Updated dependencies [6ab5d2e]
+  - @osdk/generator-converters@2.0.0-beta.13
+  - @osdk/api@2.0.0-beta.13
+  - @osdk/internal.foundry.core@0.2.0-beta.8
+
 ## 2.0.0-beta.12
 
 ### Patch Changes

package/build/browser/index.js

@@ -1,7 +1,7 @@
 import * as fs from 'fs';
 import * as path5 from 'path';
 import path5__default from 'path';
-import { wireActionTypeV2ToSdkActionDefinition, wireQueryTypeV2ToSdkQueryDefinitionNoParams, wireQueryDataTypeToQueryDataTypeDefinition, wireQueryParameterV2ToQueryParameterDefinition, __UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition, wireObjectTypeFullMetadataToSdkObjectTypeDefinition } from '@osdk/generator-converters';
+import { wireActionTypeV2ToSdkActionMetadata, wireQueryTypeV2ToSdkQueryDefinitionNoParams, wireQueryDataTypeToQueryDataTypeDefinition, wireQueryParameterV2ToQueryParameterDefinition, __UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition, wireObjectTypeFullMetadataToSdkObjectMetadata } from '@osdk/generator-converters';
 import { format } from 'prettier';
 import fastDeepEqual from 'fast-deep-equal';
 import invariant from 'tiny-invariant';
@@ -28,7 +28,7 @@ var AbstractImportable = class {
   }
   getImportPathRelTo = (filePath) => {
     if (this.importPath.startsWith(".")) {
-      const result = path5.relative(path5.dirname(filePath), this.importPath);
+      const result = path5.relative(path5.dirname(filePath), this.importPath).split(path5.sep).join("/");
       if (result.startsWith(".")) {
         return result;
       } else {
@@ -116,7 +116,7 @@ var EnhancedObjectType = class extends EnhancedBase {
     return this.getDefinitionIdentifier(v2);
   }
   getCleanedUpDefinition(v2) {
-    return deleteUndefineds(wireObjectTypeFullMetadataToSdkObjectTypeDefinition(this.raw, v2));
+    return deleteUndefineds(wireObjectTypeFullMetadataToSdkObjectMetadata(this.raw, v2));
   }
 };
 
@@ -139,7 +139,7 @@ var EnhancedQuery = class extends EnhancedBase {
     return `${this.shortApiName}.Parameters`;
   }
   get definitionIdentifier() {
-    return `${this.shortApiName}.Definition`;
+    return `${this.shortApiName}`;
   }
   get definitionParamsIdentifier() {
     return `${this.definitionIdentifier}$Params`;
@@ -376,7 +376,7 @@ function wireObjectTypeV2ToSdkObjectConstV2(wireObject, {
 }, currentFilePath) {
   const object = ontology.requireObjectType(wireObject.objectType.apiName, true);
   const uniqueLinkTargetTypes = new Set(wireObject.linkTypes.map((a) => ontology.requireObjectType(a.objectTypeApiName, false)));
-  const definition = deleteUndefineds(wireObjectTypeFullMetadataToSdkObjectTypeDefinition(object.raw, true));
+  const definition = deleteUndefineds(wireObjectTypeFullMetadataToSdkObjectMetadata(object.raw, true));
   const objectDefIdentifier = object.getDefinitionIdentifier(true);
   const objectSetIdentifier = `${object.shortApiName}.ObjectSet`;
   const propertyKeysIdentifier = `${object.shortApiName}.PropertyKeys`;
@@ -396,7 +396,7 @@ function wireObjectTypeV2ToSdkObjectConstV2(wireObject, {
   function getV2Types() {
     return `import type {
       ObjectOrInterfacePropertyKeysFrom2 as $ObjectOrInterfacePropertyKeysFrom2,  
-      MinObjectDef as $ObjectTypeDefinition,
+      ObjectTypeDefinition as $ObjectTypeDefinition,
       ObjectTypeLinkDefinition as $ObjectTypeLinkDefinition,
     } from "@osdk/api";
      import type {
@@ -514,8 +514,6 @@ function createDefinition(object, ontology, identifier, {
       linksType: ${osdkObjectLinksIdentifier};
       strictProps: ${osdkObjectStrictPropsIdentifier};
       ${stringify(definition, {
-    osdkMetadata: () => void 0,
-    // we are going to reference another object instead
     links: (_value) => `{
         ${stringify(definition.links, {
       "*": (definition2) => `$ObjectTypeLinkDefinition<${ontology.requireObjectType(definition2.targetType).getImportedDefinitionIdentifier(true)}, ${definition2.multiplicity}>`
@@ -569,7 +567,7 @@ async function generatePerActionDataFiles({
     const uniqueApiNamesArray = extractReferencedObjectsFromAction(action.raw);
     const uniqueApiNames = new Set(uniqueApiNamesArray);
     const uniqueApiNamesString = stringUnionFrom([...uniqueApiNames]);
-    const fullActionDef = deleteUndefineds(wireActionTypeV2ToSdkActionDefinition(action.raw));
+    const fullActionDef = deleteUndefineds(wireActionTypeV2ToSdkActionMetadata(action.raw));
     function createParamsDef() {
       const entries = Object.entries(fullActionDef.parameters ?? {});
       entries.sort((a, b) => a[0].localeCompare(b[0]));
@@ -646,7 +644,7 @@ async function generatePerActionDataFiles({
           
           ${jsDocBlock.join("\n")}
           */
-          export interface ${action.shortApiName} extends MinActionDef<"${action.shortApiName}", ${uniqueApiNamesString}, ${action.shortApiName}.Signatures> {
+          export interface ${action.shortApiName} extends ActionDefinition<"${action.fullApiName}", ${uniqueApiNamesString}, ${action.shortApiName}.Signatures> {
             __DefinitionMetadata?: {
               ${stringify(fullActionDef, {
         "parameters": () => action.definitionParamsIdentifier
@@ -658,7 +656,9 @@ async function generatePerActionDataFiles({
         "description": () => void 0,
         "displayName": () => void 0,
         "modifiedEntities": () => void 0,
-        "parameters": () => void 0
+        "parameters": () => void 0,
+        "rid": () => void 0,
+        "status": () => void 0
       })}
             osdkMetadata: typeof $osdkMetadata;
             }
@@ -671,7 +671,9 @@ async function generatePerActionDataFiles({
         "description": () => void 0,
         "displayName": () => void 0,
         "modifiedEntities": () => void 0,
-        "parameters": () => void 0
+        "parameters": () => void 0,
+        "rid": () => void 0,
+        "status": () => void 0
       })},
           osdkMetadata: $osdkMetadata
         }
@@ -698,7 +700,7 @@ async function generatePerActionDataFiles({
     }
     const imports = getObjectImports(referencedObjectDefs, void 0, currentFilePath, true);
     await fs2.writeFile(path5__default.join(rootOutDir, currentFilePath), await formatTs(`
-          import type { MinActionDef, ObjectActionDataType, ObjectSetActionDataType } from "@osdk/api";
+          import type { ActionDefinition, ObjectActionDataType, ObjectSetActionDataType } from "@osdk/api";
           import type { ActionParam, ActionReturnTypeForOptions, ApplyActionOptions, ApplyBatchActionOptions,  } from '@osdk/client.api';
           import { $osdkMetadata} from "../../OntologyMetadata${importExt}";
           ${imports}
@@ -843,9 +845,10 @@ async function generateV2QueryFile(fs2, outDir, relOutDir, query, importExt, ont
   const outputBase = deleteUndefineds(wireQueryDataTypeToQueryDataTypeDefinition(query.output));
   const referencedObjectTypes = objectTypes.length > 0 ? objectTypes.map((apiNameObj) => `"${apiNameObj}"`).join("|") : "never";
   await fs2.writeFile(path5__default.join(outDir, `${query.shortApiName}.ts`), await formatTs(`
-        import type { MinQueryDef , VersionBound} from "@osdk/api";
+        import type { QueryDefinition , VersionBound} from "@osdk/api";
         import type { QueryParam, QueryResult } from "@osdk/client.api";
         import type { $ExpectedClientVersion } from "../../OntologyMetadata${importExt}";
+        import { $osdkMetadata} from "../../OntologyMetadata${importExt}";
         ${importObjects}
 
         export namespace ${query.shortApiName} {
@@ -871,12 +874,17 @@ async function generateV2QueryFile(fs2, outDir, relOutDir, query, importExt, ont
     
             ` : ""}
 
-        export interface Definition extends MinQueryDef<
+        
+
+        }
+
+        export interface ${query.shortApiName} extends QueryDefinition<
           "${query.fullApiName}", 
           ${referencedObjectTypes},
           ${query.shortApiName}.Signature
         >, VersionBound<$ExpectedClientVersion>{
-            ${stringify(baseProps)},
+         __DefinitionMetadata?: {
+             ${stringify(baseProps)}
             parameters: {
             ${parameterDefsForType(ontology, query)}
             };
@@ -884,33 +892,27 @@ async function generateV2QueryFile(fs2, outDir, relOutDir, query, importExt, ont
             ${stringify(outputBase)},
             ${getLineFor__OsdkTargetType(ontology, query.output)}
             };
-        }
-
-        }
-
-        /** @deprecated use \`${query.shortApiName}.Signature' instead */
-        export type ${query.shortApiName} = ${query.shortApiName}.Signature;
-
-
-
+            signature: ${query.shortApiName}.Signature;
+        }, 
+        ${stringify(baseProps, {
+    "description": () => void 0,
+    "displayName": () => void 0,
+    "rid": () => void 0
+  })}, 
+          osdkMetadata: typeof $osdkMetadata;
+              }
 
 
         export const ${query.shortApiName}: ${query.definitionIdentifier} = {
-            ${stringify(baseProps)},
-            parameters: {
-            ${parametersForConst(query)}
-            },
-            output: {
-            ${stringify(outputBase)},
-            }
+            ${stringify(baseProps, {
+    "description": () => void 0,
+    "displayName": () => void 0,
+    "rid": () => void 0
+  })},
+    osdkMetadata: $osdkMetadata
         };
         `));
 }
-function parametersForConst(query) {
-  return stringify(query.parameters, {
-    "*": (parameter, formatter) => formatter(deleteUndefineds(wireQueryParameterV2ToQueryParameterDefinition(parameter)))
-  });
-}
 function parameterDefsForType(ontology, query) {
   return stringify(query.parameters, {
     "*": (parameter, valueFormatter, apiName) => [`${queryParamJsDoc(wireQueryParameterV2ToQueryParameterDefinition(parameter), {
@@ -1007,13 +1009,6 @@ function __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(interfaceDef, ontology,
   }
   definition.properties;
   definition.properties = mergedProperties;
-  function maybeStripNamespace2(q) {
-    if (interfaceDef.apiNamespace && q.startsWith(`${interfaceDef.apiNamespace}.`)) {
-      return q.slice(interfaceDef.apiNamespace.length + 1);
-    } else {
-      return q;
-    }
-  }
   const objectSetIdentifier = `${interfaceDef.shortApiName}.ObjectSet`;
   const propertyKeysIdentifier = `${interfaceDef.shortApiName}.PropertyKeys`;
   const osdkObjectPropsIdentifier = `${interfaceDef.shortApiName}.Props`;
@@ -1021,7 +1016,7 @@ function __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(interfaceDef, ontology,
   const osdkObjectLinksIdentifier = `OsdkObjectLinks$${objectDefIdentifier}`;
   const osdkObjectIdentifier = `${interfaceDef.shortApiName}.OsdkObject`;
   const ids = {
-    objectDefIdentifier: `${interfaceDef.shortApiName}.Definition`,
+    objectDefIdentifier: interfaceDef.shortApiName,
     osdkObjectLinksIdentifier,
     osdkObjectPropsIdentifier,
     osdkObjectStrictPropsIdentifier,
@@ -1065,20 +1060,11 @@ ${stringify(definition.links, {
 
       ${createObjectSet(interfaceDef, ids)}
 
-      ${createDefinition(interfaceDef, ontology, "Definition", ids)}
-
       ${createOsdkObject(interfaceDef, "OsdkObject", ids)}
       
     }    
 
-
-
-
-  /** @deprecated use ${interfaceDef.shortApiName}.Definition **/
-  export type ${objectDefIdentifier} = ${interfaceDef.shortApiName}.Definition;
-
-
-
+    ${createDefinition(interfaceDef, ontology, interfaceDef.shortApiName, ids)}
 
 `;
   }
@@ -1086,22 +1072,11 @@ ${stringify(definition.links, {
   return `${imports.join("\n")}
     ${v2 ? getV2Types() : ""}
 
-    export const ${interfaceDef.shortApiName}: ${interfaceDef.shortApiName}.Definition = {
+    export const ${interfaceDef.shortApiName}: ${interfaceDef.shortApiName} = {
+      type: "interface",
+      apiName: "${interfaceDef.fullApiName}",
       osdkMetadata: $osdkMetadata,
-      objectSet: undefined as any,
-      props: undefined as any,
-      linksType: undefined as any,
-      strictProps: undefined as any,
-      ${stringify(definition, {
-    osdkMetadata: () => void 0,
-    properties: (properties) => `{
-        ${stringify(properties, {
-      "*": (propertyDefinition, _, key) => [`"${maybeStripNamespace2(key)}"`, _(propertyDefinition)]
-    })}
-      }`
-  })}
-      
-    };`;
+       };`;
 }
 
 // src/v2.0/generateClientSdkVersionTwoPointZero.ts