@osdk/generator 2.2.0-beta.8 → 2.2.0-rc.24

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

@@ -243,6 +243,7 @@ const referencingOntology = {
       "apiName": "setTaskBody",
       "parameters": {
         "task": {
+          "displayName": "taskBody",
           "dataType": {
             "type": "object",
             "objectApiName": "com.example.dep.Task",
@@ -251,6 +252,7 @@ const referencingOntology = {
           "required": true
         },
         "body": {
+          "displayName": "body",
           "dataType": {
             "type": "string"
           },
@@ -472,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>>;
           }
@@ -548,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>>;
           }
@@ -610,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;
@@ -689,6 +695,9 @@ describe("generator", () => {
           }
 
           export interface Props {
+            /**
+             * (no ontology metadata)
+             */
             readonly email: $PropType['string'];
           }
           export type StrictProps = Props;
@@ -777,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;
@@ -886,7 +905,8 @@ describe("generator", () => {
             apiName: 'getCount';
             rid: 'rid.query.1';
             type: 'query';
-            version: '0';
+            version: '1.1.0';
+            isFixedVersion: false;
             parameters: {
               /**
                * (no ontology metadata)
@@ -904,14 +924,15 @@ describe("generator", () => {
           };
           apiName: 'getCount';
           type: 'query';
-          version: '0';
+          version: '1.1.0';
           osdkMetadata: typeof $osdkMetadata;
         }
 
         export const getCount: getCount = {
           apiName: 'getCount',
           type: 'query',
-          version: '0',
+          version: '1.1.0',
+          isFixedVersion: false,
           osdkMetadata: $osdkMetadata,
         };
         ",
@@ -940,7 +961,8 @@ describe("generator", () => {
             apiName: 'returnsTodo';
             rid: 'rid.query.2';
             type: 'query';
-            version: '0';
+            version: '3.2.0';
+            isFixedVersion: false;
             parameters: {
               /**
                *   description: Random desc so we test jsdoc
@@ -963,14 +985,15 @@ describe("generator", () => {
           };
           apiName: 'returnsTodo';
           type: 'query';
-          version: '0';
+          version: '3.2.0';
           osdkMetadata: typeof $osdkMetadata;
         }
 
         export const returnsTodo: returnsTodo = {
           apiName: 'returnsTodo',
           type: 'query',
-          version: '0',
+          version: '3.2.0',
+          isFixedVersion: false,
           osdkMetadata: $osdkMetadata,
         };
         ",
@@ -1055,13 +1078,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>>;
           }
@@ -1131,13 +1154,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>>;
           }
@@ -1193,6 +1216,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;
@@ -1272,6 +1299,9 @@ describe("generator", () => {
           }
 
           export interface Props {
+            /**
+             * (no ontology metadata)
+             */
             readonly email: $PropType['string'];
           }
           export type StrictProps = Props;
@@ -1360,8 +1390,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;
@@ -1469,7 +1509,8 @@ describe("generator", () => {
             apiName: 'foo.bar.getCount';
             rid: 'rid.query.1';
             type: 'query';
-            version: '0';
+            version: '1.1.0';
+            isFixedVersion: false;
             parameters: {
               /**
                * (no ontology metadata)
@@ -1487,14 +1528,15 @@ describe("generator", () => {
           };
           apiName: 'foo.bar.getCount';
           type: 'query';
-          version: '0';
+          version: '1.1.0';
           osdkMetadata: typeof $osdkMetadata;
         }
 
         export const getCount: getCount = {
           apiName: 'foo.bar.getCount',
           type: 'query',
-          version: '0',
+          version: '1.1.0',
+          isFixedVersion: false,
           osdkMetadata: $osdkMetadata,
         };
         ",
@@ -1523,7 +1565,8 @@ describe("generator", () => {
             apiName: 'foo.bar.returnsTodo';
             rid: 'rid.query.2';
             type: 'query';
-            version: '0';
+            version: '3.2.0';
+            isFixedVersion: false;
             parameters: {
               /**
                *   description: Random desc so we test jsdoc
@@ -1546,14 +1589,15 @@ describe("generator", () => {
           };
           apiName: 'foo.bar.returnsTodo';
           type: 'query';
-          version: '0';
+          version: '3.2.0';
           osdkMetadata: typeof $osdkMetadata;
         }
 
         export const returnsTodo: returnsTodo = {
           apiName: 'foo.bar.returnsTodo',
           type: 'query',
-          version: '0',
+          version: '3.2.0',
+          isFixedVersion: false,
           osdkMetadata: $osdkMetadata,
         };
         ",
@@ -1635,6 +1679,7 @@ describe("generator", () => {
               rid: 'ri.a.b.c';
               type: 'query';
               version: '0';
+              isFixedVersion: false;
               parameters: {
                 /**
                  * (no ontology metadata)
@@ -1664,6 +1709,7 @@ describe("generator", () => {
             apiName: 'getTask',
             type: 'query',
             version: '0',
+            isFixedVersion: false,
             osdkMetadata: $osdkMetadata,
           };
           "
@@ -1696,7 +1742,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;
@@ -1802,13 +1854,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>>;
             }
@@ -1848,6 +1900,380 @@ describe("generator", () => {
         `);
     });
   });
+  describe("queries with versions", () => {
+    it("can generate properly when queries have versions and optionally have fixed versions", async () => {
+      await generateClientSdkVersionTwoPointZero({
+        ontology: TodoWireOntology.ontology,
+        actionTypes: {},
+        interfaceTypes: {},
+        objectTypes: TodoWireOntology.objectTypes,
+        queryTypes: {
+          "getCount:1.1.0": {
+            ...TodoWireOntology.queryTypes.getCount
+          },
+          "returnsTodo:3.2.0": {
+            ...TodoWireOntology.queryTypes.returnsTodo,
+            version: "0"
+          }
+        },
+        sharedPropertyTypes: {}
+      }, "typescript-sdk/0.0.0 osdk-cli/0.0.0", helper.minimalFiles, BASE_PATH, "module", new Map(), new Map(), new Map(), false, ["getCount"]);
+      expect(tweakedFilesForSnapshotConsistency(helper.getFiles())).toMatchInlineSnapshot(`
+        {
+          "/foo/OntologyMetadata.ts": "export type $ExpectedClientVersion = 'PLACEHOLDER';
+        export const $osdkMetadata = { extraUserAgent: 'typescript-sdk/0.0.0 osdk-cli/0.0.0' };
+
+        export const $ontologyRid = 'ridHere';
+        ",
+          "/foo/index.ts": "export {} from './ontology/actions.js';
+        export * as $Actions from './ontology/actions.js';
+        export {} from './ontology/interfaces.js';
+        export * as $Interfaces from './ontology/interfaces.js';
+        export { Person, Todo } from './ontology/objects.js';
+        export * as $Objects from './ontology/objects.js';
+        export { getCount, returnsTodo } from './ontology/queries.js';
+        export * as $Queries from './ontology/queries.js';
+        export { $osdkMetadata } from './OntologyMetadata.js';
+        export { $ontologyRid } from './OntologyMetadata.js';
+        ",
+          "/foo/ontology/actions.ts": "export {};
+        ",
+          "/foo/ontology/interfaces.ts": "export {};
+        ",
+          "/foo/ontology/objects.ts": "export { Person } from './objects/Person.js';
+        export { Todo } from './objects/Todo.js';
+        ",
+          "/foo/ontology/objects/Person.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/client';
+        import { $osdkMetadata } from '../../OntologyMetadata.js';
+        import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
+        import type { Todo } from './Todo.js';
+        import type {
+          PropertyKeys as $PropertyKeys,
+          ObjectTypeDefinition as $ObjectTypeDefinition,
+          ObjectMetadata as $ObjectMetadata,
+        } from '@osdk/client';
+        import type {
+          ObjectSet as $ObjectSet,
+          Osdk as $Osdk,
+          OsdkObject as $OsdkObject,
+          PropertyValueWireToClient as $PropType,
+          SingleLinkAccessor as $SingleLinkAccessor,
+        } from '@osdk/client';
+
+        export namespace Person {
+          export type PropertyKeys = 'email';
+
+          export interface Links {
+            readonly Todos: Todo.ObjectSet;
+          }
+
+          export interface Props {
+            /**
+             * (no ontology metadata)
+             */
+            readonly email: $PropType['string'];
+          }
+          export type StrictProps = Props;
+
+          export interface ObjectSet extends $ObjectSet<Person, Person.ObjectSet> {}
+
+          export type OsdkInstance<
+            OPTIONS extends never | '$rid' = never,
+            K extends keyof Person.Props = keyof Person.Props,
+          > = $Osdk.Instance<Person, OPTIONS, K>;
+
+          /** @deprecated use OsdkInstance */
+          export type OsdkObject<
+            OPTIONS extends never | '$rid' = never,
+            K extends keyof Person.Props = keyof Person.Props,
+          > = OsdkInstance<OPTIONS, K>;
+        }
+
+        export interface Person extends $ObjectTypeDefinition {
+          osdkMetadata: typeof $osdkMetadata;
+          type: 'object';
+          apiName: 'Person';
+          __DefinitionMetadata?: {
+            objectSet: Person.ObjectSet;
+            props: Person.Props;
+            linksType: Person.Links;
+            strictProps: Person.StrictProps;
+            apiName: 'Person';
+            description: 'A person';
+            displayName: 'Person';
+            icon: {
+              type: 'blueprint';
+              name: 'document';
+              color: 'blue';
+            };
+            implements: [];
+            interfaceMap: {};
+            inverseInterfaceMap: {};
+            links: {
+              Todos: $ObjectMetadata.Link<Todo, true>;
+            };
+            pluralDisplayName: 'Persons';
+            primaryKeyApiName: 'email';
+            primaryKeyType: 'string';
+            properties: {
+              /**
+               * (no ontology metadata)
+               */
+              email: $PropertyDef<'string', 'non-nullable', 'single'>;
+            };
+            rid: 'ridForPerson';
+            status: 'ACTIVE';
+            titleProperty: 'email';
+            type: 'object';
+          };
+        }
+
+        export const Person: Person = {
+          type: 'object',
+          apiName: 'Person',
+          osdkMetadata: $osdkMetadata,
+        };
+        ",
+          "/foo/ontology/objects/Todo.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/client';
+        import { $osdkMetadata } from '../../OntologyMetadata.js';
+        import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
+        import type { Person } from './Person.js';
+        import type {
+          PropertyKeys as $PropertyKeys,
+          ObjectTypeDefinition as $ObjectTypeDefinition,
+          ObjectMetadata as $ObjectMetadata,
+        } from '@osdk/client';
+        import type {
+          ObjectSet as $ObjectSet,
+          Osdk as $Osdk,
+          OsdkObject as $OsdkObject,
+          PropertyValueWireToClient as $PropType,
+          SingleLinkAccessor as $SingleLinkAccessor,
+        } from '@osdk/client';
+
+        export namespace Todo {
+          export type PropertyKeys = 'id' | 'body' | 'complete';
+
+          export interface Links {
+            readonly Assignee: $SingleLinkAccessor<Person>;
+          }
+
+          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;
+
+          export interface ObjectSet extends $ObjectSet<Todo, Todo.ObjectSet> {}
+
+          export type OsdkInstance<
+            OPTIONS extends never | '$rid' = never,
+            K extends keyof Todo.Props = keyof Todo.Props,
+          > = $Osdk.Instance<Todo, OPTIONS, K>;
+
+          /** @deprecated use OsdkInstance */
+          export type OsdkObject<
+            OPTIONS extends never | '$rid' = never,
+            K extends keyof Todo.Props = keyof Todo.Props,
+          > = OsdkInstance<OPTIONS, K>;
+        }
+
+        export interface Todo extends $ObjectTypeDefinition {
+          osdkMetadata: typeof $osdkMetadata;
+          type: 'object';
+          apiName: 'Todo';
+          __DefinitionMetadata?: {
+            objectSet: Todo.ObjectSet;
+            props: Todo.Props;
+            linksType: Todo.Links;
+            strictProps: Todo.StrictProps;
+            apiName: 'Todo';
+            description: 'Its a todo item.';
+            displayName: 'AwesomeTodoDisplayname';
+            icon: {
+              type: 'blueprint';
+              name: 'document';
+              color: 'blue';
+            };
+            implements: ['SomeInterface'];
+            interfaceMap: {
+              SomeInterface: {
+                SomeProperty: 'body';
+              };
+            };
+            inverseInterfaceMap: {
+              SomeInterface: {
+                body: 'SomeProperty';
+              };
+            };
+            links: {
+              Assignee: $ObjectMetadata.Link<Person, false>;
+            };
+            pluralDisplayName: 'AwesomeTodoDisplayNames';
+            primaryKeyApiName: 'id';
+            primaryKeyType: 'integer';
+            properties: {
+              /**
+               *   display name: 'Body',
+               *   description: The text of the todo
+               */
+              body: $PropertyDef<'string', 'nullable', 'single'>;
+              /**
+               * (no ontology metadata)
+               */
+              complete: $PropertyDef<'boolean', 'nullable', 'single'>;
+              /**
+               * (no ontology metadata)
+               */
+              id: $PropertyDef<'integer', 'non-nullable', 'single'>;
+            };
+            rid: 'ridForTodo';
+            status: 'ACTIVE';
+            titleProperty: 'body';
+            type: 'object';
+          };
+        }
+
+        export const Todo: Todo = {
+          type: 'object',
+          apiName: 'Todo',
+          osdkMetadata: $osdkMetadata,
+        };
+        ",
+          "/foo/ontology/queries.ts": "export { getCount } from './queries/getCount.js';
+        export { returnsTodo } from './queries/returnsTodo.js';
+        ",
+          "/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';
+
+        export namespace getCount {
+          export interface Signature {
+            (query: getCount.Parameters): Promise<getCount.ReturnType>;
+          }
+
+          export interface Parameters {
+            /**
+             * (no ontology metadata)
+             */
+            readonly completed: QueryParam.PrimitiveType<'boolean'>;
+          }
+
+          export type ReturnType = QueryResult.PrimitiveType<'integer'>;
+        }
+
+        export interface getCount extends QueryDefinition<getCount.Signature>, VersionBound<$ExpectedClientVersion> {
+          __DefinitionMetadata?: {
+            apiName: 'getCount';
+            rid: 'rid.query.1';
+            type: 'query';
+            version: '1.1.0';
+            isFixedVersion: true;
+            parameters: {
+              /**
+               * (no ontology metadata)
+               */
+              completed: {
+                nullable: false;
+                type: 'boolean';
+              };
+            };
+            output: {
+              nullable: false;
+              type: 'integer';
+            };
+            signature: getCount.Signature;
+          };
+          apiName: 'getCount';
+          type: 'query';
+          version: '1.1.0';
+          osdkMetadata: typeof $osdkMetadata;
+        }
+
+        export const getCount: getCount = {
+          apiName: 'getCount',
+          type: 'query',
+          version: '1.1.0',
+          isFixedVersion: true,
+          osdkMetadata: $osdkMetadata,
+        };
+        ",
+          "/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';
+
+        export namespace returnsTodo {
+          export interface Signature {
+            (query: returnsTodo.Parameters): Promise<returnsTodo.ReturnType>;
+          }
+
+          export interface Parameters {
+            /**
+             *   description: Random desc so we test jsdoc
+             */
+            readonly someTodo: QueryParam.ObjectType<Todo>;
+          }
+
+          export type ReturnType = QueryResult.ObjectType<Todo>;
+        }
+
+        export interface returnsTodo extends QueryDefinition<returnsTodo.Signature>, VersionBound<$ExpectedClientVersion> {
+          __DefinitionMetadata?: {
+            apiName: 'returnsTodo';
+            rid: 'rid.query.2';
+            type: 'query';
+            version: '0';
+            isFixedVersion: false;
+            parameters: {
+              /**
+               *   description: Random desc so we test jsdoc
+               */
+              someTodo: {
+                description: 'Random desc so we test jsdoc';
+                nullable: false;
+                object: 'Todo';
+                type: 'object';
+                __OsdkTargetType?: Todo;
+              };
+            };
+            output: {
+              nullable: false;
+              object: 'Todo';
+              type: 'object';
+              __OsdkTargetType?: Todo;
+            };
+            signature: returnsTodo.Signature;
+          };
+          apiName: 'returnsTodo';
+          type: 'query';
+          version: '0';
+          osdkMetadata: typeof $osdkMetadata;
+        }
+
+        export const returnsTodo: returnsTodo = {
+          apiName: 'returnsTodo',
+          type: 'query',
+          version: '0',
+          isFixedVersion: false,
+          osdkMetadata: $osdkMetadata,
+        };
+        ",
+        }
+      `);
+    });
+  });
   it("can generate an sdk package that is entirely a library", async () => {
     const mockConsola = vi.spyOn(consola, "info");
     await expect(generateClientSdkVersionTwoPointZero(referencedOntology, "", helper.minimalFiles, BASE_PATH, "module")).resolves.toMatchInlineSnapshot(`undefined`);
@@ -1890,7 +2316,13 @@ describe("generator", () => {
           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;
@@ -1968,7 +2400,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;