WIP Queries

.changeset/plenty-berries-add.md

@@ -0,0 +1,10 @@
+---
+"@osdk/legacy-client": minor
+"@osdk/shared.test": minor
+"@osdk/client.api": minor
+"@osdk/generator": minor
+"@osdk/client": minor
+"@osdk/api": minor
+---
+
+Add support for queries in 2.0

examples-extra/basic/sdk/src/generatedNoCheck/Ontology.ts

@@ -2,6 +2,7 @@ import type { OntologyDefinition } from '@osdk/api';
 import * as Actions from './ontology/actions/index.js';
 import * as Interfaces from './ontology/interfaces.js';
 import * as Objects from './ontology/objects.js';
+import * as Queries from './ontology/queries/index.js';
 import { OntologyMetadata } from './OntologyMetadata.js';
 
 export interface Ontology
@@ -32,7 +33,8 @@ export interface Ontology
     createTodo: typeof Actions.createTodo;
   };
   queries: {
-    // TODO
+    getTodoCount: typeof Queries.getTodoCount;
+    queryTakesAllParameterTypes: typeof Queries.queryTakesAllParameterTypes;
   };
   interfaces: {
     FooInterface: Interfaces.FooInterface;
@@ -57,7 +59,8 @@ export const Ontology: Ontology = {
     createTodo: Actions.createTodo,
   },
   queries: {
-    // TODO
+    getTodoCount: Queries.getTodoCount,
+    queryTakesAllParameterTypes: Queries.queryTakesAllParameterTypes,
   },
   interfaces: {
     FooInterface: Interfaces.FooInterface,

examples-extra/basic/sdk/src/generatedNoCheck/index.ts

@@ -2,3 +2,4 @@ export { Ontology } from './Ontology.js';
 export * from './ontology/actions/index.js';
 export * from './ontology/interfaces.js';
 export * from './ontology/objects.js';
+export * from './ontology/queries/index.js';

examples-extra/basic/sdk/src/generatedNoCheck/ontology/queries/getTodoCount.ts

@@ -0,0 +1,9 @@
+import { QueryDefinition } from '@osdk/api';
+
+export const getTodoCount = {
+  apiName: 'getTodoCount',
+  type: 'query',
+  version: '0.1.2',
+  parameters: {},
+  output: { nullable: false, type: 'integer' },
+} satisfies QueryDefinition<'getTodoCount', never>;

examples-extra/basic/sdk/src/generatedNoCheck/ontology/queries/index.ts

@@ -0,0 +1,2 @@
+export * from './getTodoCount.js';
+export * from './queryTakesAllParameterTypes.js';

examples-extra/basic/sdk/src/generatedNoCheck/ontology/queries/queryTakesAllParameterTypes.ts

@@ -0,0 +1,111 @@
+import { QueryDefinition } from '@osdk/api';
+import { Todo } from '../objects.js';
+export const queryTakesAllParameterTypes = {
+  apiName: 'queryTakesAllParameterTypes',
+  description: 'description of the query that takes all parameter types',
+  displayName: 'qTAPT',
+  type: 'query',
+  version: 'version',
+  parameters: {
+    double: { description: 'a double parameter', nullable: false, type: 'double' },
+    float: { nullable: false, type: 'float' },
+    integer: { nullable: false, type: 'integer' },
+    long: { nullable: false, type: 'long' },
+    attachment: { nullable: false, type: 'attachment' },
+    boolean: { nullable: false, type: 'boolean' },
+    date: { nullable: false, type: 'date' },
+    string: { nullable: false, type: 'string' },
+    timestamp: { nullable: false, type: 'timestamp' },
+    object: {
+      nullable: false,
+      object: 'Todo',
+      type: 'object',
+
+      __OsdkTargetType: Todo,
+    },
+    objectSet: {
+      nullable: false,
+      objectSet: 'Todo',
+      type: 'objectSet',
+
+      __OsdkTargetType: Todo,
+    },
+    array: { description: 'an array of strings', multiplicity: true, nullable: false, type: 'string' },
+    set: {
+      description: 'a set of strings',
+      nullable: false,
+      set: {
+        type: 'string',
+        nullable: false,
+      },
+      type: 'set',
+    },
+    unionNonNullable: {
+      description: 'a union of strings and integers',
+      nullable: false,
+      type: 'union',
+      union: [
+        {
+          type: 'string',
+          nullable: false,
+        },
+        {
+          type: 'integer',
+          nullable: false,
+        },
+      ],
+    },
+    unionNullable: {
+      description: 'a union of strings and integers but its optional',
+      nullable: true,
+      type: 'union',
+      union: [
+        {
+          type: 'string',
+          nullable: false,
+        },
+        {
+          type: 'integer',
+          nullable: false,
+        },
+      ],
+    },
+    struct: {
+      description: 'a struct with some fields',
+      nullable: false,
+      struct: {
+        name: {
+          type: 'string',
+          nullable: false,
+        },
+        id: {
+          type: 'integer',
+          nullable: false,
+        },
+      },
+      type: 'struct',
+    },
+    twoDimensionalAggregation: {
+      nullable: false,
+      twoDimensionalAggregation: {
+        keyType: 'string',
+        valueType: 'double',
+      },
+      type: 'twoDimensionalAggregation',
+    },
+    threeDimensionalAggregation: {
+      nullable: false,
+      threeDimensionalAggregation: {
+        keyType: 'range',
+        keySubtype: 'date',
+        valueType: {
+          keyType: 'range',
+          keySubtype: 'timestamp',
+          valueType: 'date',
+        },
+      },
+      type: 'threeDimensionalAggregation',
+    },
+  },
+  output: { nullable: false, type: 'string' },
+} satisfies QueryDefinition<'queryTakesAllParameterTypes', 'Todo'>;

examples-extra/docs_example/src/generatedNoCheck/Ontology.ts

@@ -20,9 +20,7 @@ export interface Ontology extends OntologyDefinition<'Employee' | 'equipment' |
     promoteEmployee: typeof Actions.promoteEmployee;
     promoteEmployeeObject: typeof Actions.promoteEmployeeObject;
   };
-  queries: {
-    // TODO
-  };
+  queries: {};
   interfaces: {};
 }
 
@@ -43,8 +41,6 @@ export const Ontology: Ontology = {
     promoteEmployee: Actions.promoteEmployee,
     promoteEmployeeObject: Actions.promoteEmployeeObject,
   },
-  queries: {
-    // TODO
-  },
+  queries: {},
   interfaces: {},
 };

examples-extra/docs_example/src/generatedNoCheck/index.ts

@@ -2,3 +2,4 @@ export { Ontology } from './Ontology';
 export * from './ontology/actions/index';
 export * from './ontology/interfaces';
 export * from './ontology/objects';
+export * from './ontology/queries/index';

examples-extra/docs_example/src/generatedNoCheck/ontology/queries/index.ts

@@ -0,0 +1 @@
+export {};

examples-extra/one_dot_one/src/generatedNoCheck/ontology/queries/queryTakesAllParameterTypes.ts

@@ -47,6 +47,7 @@ export const queryTakesAllParameterTypes = {
     twoDimensionalAggregation: {
       type: 'twoDimensionalAggregation',
       twoDimensionalAggregation: { keyType: 'string', valueType: 'double' },
+      nullable: false,
     },
     threeDimensionalAggregation: {
       type: 'threeDimensionalAggregation',
@@ -55,6 +56,7 @@ export const queryTakesAllParameterTypes = {
         keySubtype: 'date',
         valueType: { keyType: 'range', keySubtype: 'timestamp', valueType: 'date' },
       },
+      nullable: false,
     },
   },
   output: { type: 'string', nullable: false },

examples-extra/todoapp/src/generatedNoCheck2/Ontology.ts

@@ -12,9 +12,7 @@ export interface Ontology extends OntologyDefinition<'Todo'> {
     completeTodo: typeof Actions.completeTodo;
     createTodo: typeof Actions.createTodo;
   };
-  queries: {
-    // TODO
-  };
+  queries: {};
   interfaces: {};
 }
 
@@ -27,8 +25,6 @@ export const Ontology: Ontology = {
     completeTodo: Actions.completeTodo,
     createTodo: Actions.createTodo,
   },
-  queries: {
-    // TODO
-  },
+  queries: {},
   interfaces: {},
 };

examples-extra/todoapp/src/generatedNoCheck2/index.ts

@@ -2,3 +2,4 @@ export { Ontology } from './Ontology';
 export * from './ontology/actions/index';
 export * from './ontology/interfaces';
 export * from './ontology/objects';
+export * from './ontology/queries/index';

examples-extra/todoapp/src/generatedNoCheck2/ontology/queries/index.ts

@@ -0,0 +1 @@
+export {};

packages/api/src/ontology/QueryDefinition.ts

@@ -14,24 +14,37 @@
  * limitations under the License.
  */
 
-export interface QueryDefinition<Q extends string, K extends string> {
+import type { OsdkMetadata } from "../OsdkMetadata.js";
+import type { ObjectTypeDefinition } from "./ObjectTypeDefinition.js";
+
+export interface QueryDefinition<
+  Q extends string,
+  K extends string,
+> {
   type: "query";
   apiName: Q;
   description?: string;
   displayName?: string;
   version: string;
-  parameters: Record<string, QueryParameterDefinition<K>>;
-  output: QueryDataTypeDefinition<K>;
+  parameters: Record<string, QueryParameterDefinition<K, any>>;
+  output: QueryDataTypeDefinition<K, any>;
+  osdkMetadata?: OsdkMetadata;
 }
 
-export type QueryParameterDefinition<K extends string> = {
+export type QueryParameterDefinition<
+  K extends string,
+  T_Target extends ObjectTypeDefinition<any> = never,
+> = {
   description?: string;
-} & QueryDataTypeDefinition<K>;
+} & QueryDataTypeDefinition<K, T_Target>;
 
-export type QueryDataTypeDefinition<K extends string> =
+export type QueryDataTypeDefinition<
+  K extends string,
+  T_Target extends ObjectTypeDefinition<any> = never,
+> =
   | PrimitiveDataType
-  | ObjectQueryDataType<K>
-  | ObjectSetQueryDataType<K>
+  | ObjectQueryDataType<K, T_Target>
+  | ObjectSetQueryDataType<K, T_Target>
   | SetQueryDataType<K>
   | UnionQueryDataType<K>
   | StructQueryDataType<K>
@@ -59,16 +72,20 @@ export type PrimitiveDataType<
   Q extends WireQueryDataTypes = WireQueryDataTypes,
 > = BaseQueryDataTypeDefinition<Q>;
 
-export interface ObjectQueryDataType<K extends string>
-  extends BaseQueryDataTypeDefinition<"object">
-{
+export interface ObjectQueryDataType<
+  K extends string,
+  T_Target extends ObjectTypeDefinition<any> = never,
+> extends BaseQueryDataTypeDefinition<"object"> {
   object: K;
+  __OsdkTargetType?: T_Target;
 }
 
-export interface ObjectSetQueryDataType<K extends string>
-  extends BaseQueryDataTypeDefinition<"objectSet">
-{
+export interface ObjectSetQueryDataType<
+  K extends string,
+  T_Target extends ObjectTypeDefinition<any> = never,
+> extends BaseQueryDataTypeDefinition<"objectSet"> {
   objectSet: K;
+  __OsdkTargetType?: T_Target;
 }
 
 export interface SetQueryDataType<K extends string>