@osdk/generator 2.2.0-beta.2 → 2.2.0-beta.20

package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js

@@ -84,8 +84,8 @@ function changeNames(ontology, newNames) {
     // Handle interface renames
     changeEachEntry(draft.interfaceTypes, newNames.interfaces, (ifaceType, oldIfaceName, newIfaceName) => {
       changeValue(ifaceType, "apiName", oldIfaceName, newIfaceName);
-      ifaceType.extendsInterfaces = ifaceType.extendsInterfaces.map(v => v === oldIfaceName ? newIfaceName : v);
-      changeEachEntry(ifaceType.properties, newNames.spts, (property, oldSptName, newSptName) => {
+      ifaceType.extendsInterfaces = ifaceType.allExtendsInterfaces.map(v => v === oldIfaceName ? newIfaceName : v);
+      changeEachEntry(ifaceType.allProperties, newNames.spts, (property, oldSptName, newSptName) => {
         changeValue(property, "apiName", oldSptName, newSptName);
       }, true);
     }, true);
@@ -195,7 +195,8 @@ const referencedOntology = {
             type: "string"
           },
           displayName: "Some Property",
-          rid: "idk"
+          rid: "idk",
+          required: true
         }
       },
       implementedByObjectTypes: [],
@@ -209,7 +210,17 @@ const referencedOntology = {
             type: "string"
           },
           displayName: "Some Property",
-          rid: "idk"
+          rid: "idk",
+          required: true
+        },
+        "com.example.dep.spt2": {
+          apiName: "com.example.dep.spt2",
+          dataType: {
+            type: "string"
+          },
+          displayName: "Some Property 2",
+          rid: "idk",
+          required: true
         }
       }
     }
@@ -232,6 +243,7 @@ const referencingOntology = {
       "apiName": "setTaskBody",
       "parameters": {
         "task": {
+          "displayName": "taskBody",
           "dataType": {
             "type": "object",
             "objectApiName": "com.example.dep.Task",
@@ -240,6 +252,7 @@ const referencingOntology = {
           "required": true
         },
         "body": {
+          "displayName": "body",
           "dataType": {
             "type": "string"
           },
@@ -461,13 +474,13 @@ describe("generator", () => {
             /**
              * An action which takes in an array of objects
              */
-            applyAction<P extends deleteTodos.Params, OP extends ApplyActionOptions>(
-              args: P,
+            applyAction<OP extends ApplyActionOptions>(
+              args: deleteTodos.Params,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
 
-            batchApplyAction<P extends ReadonlyArray<deleteTodos.Params>, OP extends ApplyBatchActionOptions>(
-              args: P,
+            batchApplyAction<OP extends ApplyBatchActionOptions>(
+              args: ReadonlyArray<deleteTodos.Params>,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
           }
@@ -537,13 +550,13 @@ describe("generator", () => {
             /**
              * An action which takes different types of parameters
              */
-            applyAction<P extends markTodoCompleted.Params, OP extends ApplyActionOptions>(
-              args: P,
+            applyAction<OP extends ApplyActionOptions>(
+              args: markTodoCompleted.Params,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
 
-            batchApplyAction<P extends ReadonlyArray<markTodoCompleted.Params>, OP extends ApplyBatchActionOptions>(
-              args: P,
+            batchApplyAction<OP extends ApplyBatchActionOptions>(
+              args: ReadonlyArray<markTodoCompleted.Params>,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
           }
@@ -599,6 +612,10 @@ describe("generator", () => {
           export type PropertyKeys = 'SomeProperty';
 
           export interface Props {
+            /**
+             *   display name: 'Sum Property',
+             *   description: Some property
+             */
             readonly SomeProperty: $PropType['string'] | undefined;
           }
           export type StrictProps = Props;
@@ -678,6 +695,9 @@ describe("generator", () => {
           }
 
           export interface Props {
+            /**
+             * (no ontology metadata)
+             */
             readonly email: $PropType['string'];
           }
           export type StrictProps = Props;
@@ -766,8 +786,18 @@ describe("generator", () => {
           }
 
           export interface Props {
+            /**
+             *   display name: 'Body',
+             *   description: The text of the todo
+             */
             readonly body: $PropType['string'] | undefined;
+            /**
+             * (no ontology metadata)
+             */
             readonly complete: $PropType['boolean'] | undefined;
+            /**
+             * (no ontology metadata)
+             */
             readonly id: $PropType['integer'];
           }
           export type StrictProps = Props;
@@ -851,7 +881,7 @@ describe("generator", () => {
           "/foo/ontology/queries.ts": "export { getCount } from './queries/getCount.js';
         export { returnsTodo } from './queries/returnsTodo.js';
         ",
-          "/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/client';
+          "/foo/ontology/queries/getCount.ts": "import type { ObjectSpecifier, QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/client';
         import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
         import { $osdkMetadata } from '../../OntologyMetadata.js';
 
@@ -904,7 +934,7 @@ describe("generator", () => {
           osdkMetadata: $osdkMetadata,
         };
         ",
-          "/foo/ontology/queries/returnsTodo.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/client';
+          "/foo/ontology/queries/returnsTodo.ts": "import type { ObjectSpecifier, QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/client';
         import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
         import { $osdkMetadata } from '../../OntologyMetadata.js';
         import type { Todo } from '../objects/Todo.js';
@@ -1044,13 +1074,13 @@ describe("generator", () => {
             /**
              * An action which takes in an array of objects
              */
-            applyAction<P extends deleteTodos.Params, OP extends ApplyActionOptions>(
-              args: P,
+            applyAction<OP extends ApplyActionOptions>(
+              args: deleteTodos.Params,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
 
-            batchApplyAction<P extends ReadonlyArray<deleteTodos.Params>, OP extends ApplyBatchActionOptions>(
-              args: P,
+            batchApplyAction<OP extends ApplyBatchActionOptions>(
+              args: ReadonlyArray<deleteTodos.Params>,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
           }
@@ -1120,13 +1150,13 @@ describe("generator", () => {
             /**
              * An action which takes different types of parameters
              */
-            applyAction<P extends markTodoCompleted.Params, OP extends ApplyActionOptions>(
-              args: P,
+            applyAction<OP extends ApplyActionOptions>(
+              args: markTodoCompleted.Params,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
 
-            batchApplyAction<P extends ReadonlyArray<markTodoCompleted.Params>, OP extends ApplyBatchActionOptions>(
-              args: P,
+            batchApplyAction<OP extends ApplyBatchActionOptions>(
+              args: ReadonlyArray<markTodoCompleted.Params>,
               options?: OP,
             ): Promise<ActionReturnTypeForOptions<OP>>;
           }
@@ -1182,6 +1212,10 @@ describe("generator", () => {
           export type PropertyKeys = 'SomeProperty';
 
           export interface Props {
+            /**
+             *   display name: 'Sum Property',
+             *   description: Some property
+             */
             readonly SomeProperty: $PropType['string'] | undefined;
           }
           export type StrictProps = Props;
@@ -1261,6 +1295,9 @@ describe("generator", () => {
           }
 
           export interface Props {
+            /**
+             * (no ontology metadata)
+             */
             readonly email: $PropType['string'];
           }
           export type StrictProps = Props;
@@ -1349,8 +1386,18 @@ describe("generator", () => {
           }
 
           export interface Props {
+            /**
+             *   display name: 'Body',
+             *   description: The text of the todo
+             */
             readonly body: $PropType['string'] | undefined;
+            /**
+             * (no ontology metadata)
+             */
             readonly complete: $PropType['boolean'] | undefined;
+            /**
+             * (no ontology metadata)
+             */
             readonly id: $PropType['integer'];
           }
           export type StrictProps = Props;
@@ -1434,7 +1481,7 @@ describe("generator", () => {
           "/foo/ontology/queries.ts": "export { getCount } from './queries/getCount.js';
         export { returnsTodo } from './queries/returnsTodo.js';
         ",
-          "/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
+          "/foo/ontology/queries/getCount.ts": "import type { ObjectSpecifier, QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
         import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
         import { $osdkMetadata } from '../../OntologyMetadata.js';
 
@@ -1487,7 +1534,7 @@ describe("generator", () => {
           osdkMetadata: $osdkMetadata,
         };
         ",
-          "/foo/ontology/queries/returnsTodo.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
+          "/foo/ontology/queries/returnsTodo.ts": "import type { ObjectSpecifier, QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
         import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
         import { $osdkMetadata } from '../../OntologyMetadata.js';
         import type { Todo } from '../objects/Todo.js';
@@ -1598,7 +1645,7 @@ describe("generator", () => {
     it("generates the correct code", async () => {
       await expect(generateClientSdkVersionTwoPointZero(referencingOntology, "", helper.minimalFiles, BASE_PATH, "module", new Map([["com.example.dep.Task", "@com.example.dep/osdk"]]), new Map([["com.example.dep.SomeInterface", "@com.example.dep/osdk"]]), new Map([["com.example.dep.spt", "@com.example.dep/osdk"]]), true)).resolves.toMatchInlineSnapshot(`undefined`);
       expect(helper.getFiles()["/foo/ontology/queries/getTask.ts"]).toMatchInlineSnapshot(`
-          "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
+          "import type { ObjectSpecifier, QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
           import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
           import { $osdkMetadata } from '../../OntologyMetadata.js';
           import type { Task as $Imported$com$example$dep$Task } from '@com.example.dep/osdk';
@@ -1685,7 +1732,13 @@ describe("generator", () => {
             export type Links = {};
 
             export interface Props {
+              /**
+               * (no ontology metadata)
+               */
               readonly body: $PropType['string'] | undefined;
+              /**
+               * (no ontology metadata)
+               */
               readonly id: $PropType['integer'];
             }
             export type StrictProps = Props;
@@ -1791,13 +1844,13 @@ describe("generator", () => {
 
             // Represents a fqn of the action
             export interface Signatures {
-              applyAction<P extends setTaskBody.Params, OP extends ApplyActionOptions>(
-                args: P,
+              applyAction<OP extends ApplyActionOptions>(
+                args: setTaskBody.Params,
                 options?: OP,
               ): Promise<ActionReturnTypeForOptions<OP>>;
 
-              batchApplyAction<P extends ReadonlyArray<setTaskBody.Params>, OP extends ApplyBatchActionOptions>(
-                args: P,
+              batchApplyAction<OP extends ApplyBatchActionOptions>(
+                args: ReadonlyArray<setTaskBody.Params>,
                 options?: OP,
               ): Promise<ActionReturnTypeForOptions<OP>>;
             }
@@ -1876,10 +1929,17 @@ describe("generator", () => {
         export type OsdkObjectLinks$SomeInterface = {};
 
         export namespace SomeInterface {
-          export type PropertyKeys = 'spt';
+          export type PropertyKeys = 'spt' | 'spt2';
 
           export interface Props {
+            /**
+             *   display name: 'Some Property'
+             */
             readonly spt: $PropType['string'] | undefined;
+            /**
+             *   display name: 'Some Property 2'
+             */
+            readonly spt2: $PropType['string'] | undefined;
           }
           export type StrictProps = Props;
 
@@ -1916,6 +1976,10 @@ describe("generator", () => {
                *   display name: 'Some Property'
                */
               spt: $PropertyDef<'string', 'nullable', 'single'>;
+              /**
+               *   display name: 'Some Property 2'
+               */
+              spt2: $PropertyDef<'string', 'nullable', 'single'>;
             };
             rid: 'idk2';
             type: 'interface';
@@ -1952,7 +2016,13 @@ describe("generator", () => {
           export type Links = {};
 
           export interface Props {
+            /**
+             * (no ontology metadata)
+             */
             readonly body: $PropType['string'] | undefined;
+            /**
+             * (no ontology metadata)
+             */
             readonly taskId: $PropType['string'];
           }
           export type StrictProps = Props;