industrial-model 0.3.0 → 0.5.0

package/dist/index.d.cts

@@ -129,10 +129,83 @@ type QueryExecutor<TModel> = {
         select?: undefined;
     }): Promise<QueryResult<QueryResultItem<TModel, undefined>>>;
 };
+type GroupableValue<T> = [NonNull<T>] extends [NodeId] ? true : [NonNull<T>] extends [string | number | boolean] ? true : false;
+type GroupByKey<TModel> = {
+    [K in keyof ModelProps<TModel>]: GroupableValue<ModelProps<TModel>[K]> extends true ? K : never;
+}[keyof ModelProps<TModel>];
+type AggregateGroupBy<TModel> = {
+    [K in GroupByKey<TModel>]?: true;
+};
+type NumericKey<TModel> = {
+    [K in keyof ModelProps<TModel>]: ModelProps<TModel>[K] extends number ? K : never;
+}[keyof ModelProps<TModel>];
+type CountableKey<TModel> = GroupByKey<TModel> | "externalId" | "space";
+type AggregateDefinition<TModel> = {
+    avg: NumericKey<TModel>;
+} | {
+    min: NumericKey<TModel>;
+} | {
+    max: NumericKey<TModel>;
+} | {
+    sum: NumericKey<TModel>;
+} | {
+    count: CountableKey<TModel> | Record<string, never>;
+};
+type SelectedGroupKeys<TGroupBy> = Extract<{
+    [K in keyof TGroupBy & string]: TGroupBy[K] extends true ? K : never;
+}[keyof TGroupBy & string], string>;
+type GroupValues<TModel, TGroupBy extends AggregateGroupBy<TModel> | undefined> = TGroupBy extends AggregateGroupBy<TModel> ? Simplify<Pick<ModelProps<TModel>, SelectedGroupKeys<TGroupBy> & keyof ModelProps<TModel>>> : undefined;
+type AggregateValue<TDef> = TDef extends {
+    avg: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    min: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    max: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    sum: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    count: infer P;
+} ? Record<string, never> extends P ? {
+    value: number;
+} : {
+    property: P;
+    value: number;
+} : never;
+interface AggregateOptions<TModel> {
+    viewExternalId: string;
+    filters?: WhereInput<TModel>;
+    groupBy?: AggregateGroupBy<TModel>;
+    aggregate?: AggregateDefinition<TModel>;
+}
+type AggregateResultItem<TModel, TGroupBy extends AggregateGroupBy<TModel> | undefined = undefined, TAggregate extends AggregateDefinition<TModel> | undefined = undefined> = {
+    group?: GroupValues<TModel, TGroupBy>;
+    aggregate?: AggregateValue<TAggregate>;
+};
+interface AggregateResult<TItem = Record<string, unknown>> {
+    items: TItem[];
+}
+type AggregateExecutor<TModel> = <const TOptions extends AggregateOptions<TModel>>(options: TOptions) => Promise<AggregateResult<AggregateResultItem<TModel, TOptions["groupBy"], TOptions["aggregate"]>>>;
+type SearchFilter = {
+    query: string;
+    operator?: "OR" | "AND";
+};
 type StringFilters = {
     eq?: string;
     in?: string[];
     prefix?: string;
+    search?: SearchFilter;
     exists?: boolean;
 };
 type NumberFilters = {
@@ -166,7 +239,9 @@ type ListFilters<T> = {
     containsAny?: T[];
     containsAll?: T[];
     exists?: boolean;
-};
+} & (T extends string ? {
+    search?: SearchFilter;
+} : unknown);
 type BaseFilterFor<T> = T extends NodeId ? NodeIdFilters : T extends string ? StringFilters : T extends number ? NumberFilters : T extends boolean ? BooleanFilters : T extends Date ? DateFilters : T extends Array<infer U> ? ListFilters<U> : T extends object ? NodeIdFilters | WhereInput<T> : never;
 type RelationFilterFor<T> = UnwrapRelationTarget<T> extends object ? WhereInput<UnwrapRelationTarget<T>> : never;
 type QueryFilterValue<TModel, K extends PropertyKey> = K extends RelationKeys<TModel> ? K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> | RelationFilterFor<ModelRelations<TModel>[K]> : RelationFilterFor<ModelRelations<TModel>[K]> : K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> : never;
@@ -181,11 +256,15 @@ type WhereInput<TModel> = {
 declare class IndustrialModelClient {
     private readonly cognite;
     private readonly queryMapper;
+    private readonly aggregateMapper;
+    private readonly aggregateResultMapper;
     private readonly resultMapper;
     private readonly resultValidator;
     private readonly validateResults;
     constructor(client: CogniteClient, dataModelId: DataModelId, options?: IndustrialModelClientOptions);
     query<TModel>(): QueryExecutor<TModel>;
+    aggregate<TModel>(): AggregateExecutor<TModel>;
+    private aggregateInternal;
     private queryInternal;
     private queryDependenciesPages;
 }
@@ -199,4 +278,4 @@ declare const nodeIdSchema: z.ZodObject<{
 }, z.core.$strip>;
 declare function buildViewSchema(view: ViewDefinition, options?: BuildViewSchemaOptions): z.ZodObject<Record<string, z.ZodType>>;
 
-export { type BuildViewSchemaOptions, type DataModelId, type IndustrialModel, IndustrialModelClient, type IndustrialModelClientOptions, type ModelProps, type ModelRelations, type NodeId, type QueryOptions, type QueryResult, type QueryResultItem, type QueryResultMetadata, type QuerySelect, buildViewSchema, nodeIdSchema };
+export { type AggregateDefinition, type AggregateGroupBy, type AggregateOptions, type AggregateResult, type AggregateResultItem, type BuildViewSchemaOptions, type DataModelId, type GroupByKey, type IndustrialModel, IndustrialModelClient, type IndustrialModelClientOptions, type ModelProps, type ModelRelations, type NodeId, type QueryOptions, type QueryResult, type QueryResultItem, type QueryResultMetadata, type QuerySelect, buildViewSchema, nodeIdSchema };

package/dist/index.d.ts

@@ -129,10 +129,83 @@ type QueryExecutor<TModel> = {
         select?: undefined;
     }): Promise<QueryResult<QueryResultItem<TModel, undefined>>>;
 };
+type GroupableValue<T> = [NonNull<T>] extends [NodeId] ? true : [NonNull<T>] extends [string | number | boolean] ? true : false;
+type GroupByKey<TModel> = {
+    [K in keyof ModelProps<TModel>]: GroupableValue<ModelProps<TModel>[K]> extends true ? K : never;
+}[keyof ModelProps<TModel>];
+type AggregateGroupBy<TModel> = {
+    [K in GroupByKey<TModel>]?: true;
+};
+type NumericKey<TModel> = {
+    [K in keyof ModelProps<TModel>]: ModelProps<TModel>[K] extends number ? K : never;
+}[keyof ModelProps<TModel>];
+type CountableKey<TModel> = GroupByKey<TModel> | "externalId" | "space";
+type AggregateDefinition<TModel> = {
+    avg: NumericKey<TModel>;
+} | {
+    min: NumericKey<TModel>;
+} | {
+    max: NumericKey<TModel>;
+} | {
+    sum: NumericKey<TModel>;
+} | {
+    count: CountableKey<TModel> | Record<string, never>;
+};
+type SelectedGroupKeys<TGroupBy> = Extract<{
+    [K in keyof TGroupBy & string]: TGroupBy[K] extends true ? K : never;
+}[keyof TGroupBy & string], string>;
+type GroupValues<TModel, TGroupBy extends AggregateGroupBy<TModel> | undefined> = TGroupBy extends AggregateGroupBy<TModel> ? Simplify<Pick<ModelProps<TModel>, SelectedGroupKeys<TGroupBy> & keyof ModelProps<TModel>>> : undefined;
+type AggregateValue<TDef> = TDef extends {
+    avg: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    min: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    max: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    sum: infer P extends PropertyKey;
+} ? {
+    property: P;
+    value: number;
+} : TDef extends {
+    count: infer P;
+} ? Record<string, never> extends P ? {
+    value: number;
+} : {
+    property: P;
+    value: number;
+} : never;
+interface AggregateOptions<TModel> {
+    viewExternalId: string;
+    filters?: WhereInput<TModel>;
+    groupBy?: AggregateGroupBy<TModel>;
+    aggregate?: AggregateDefinition<TModel>;
+}
+type AggregateResultItem<TModel, TGroupBy extends AggregateGroupBy<TModel> | undefined = undefined, TAggregate extends AggregateDefinition<TModel> | undefined = undefined> = {
+    group?: GroupValues<TModel, TGroupBy>;
+    aggregate?: AggregateValue<TAggregate>;
+};
+interface AggregateResult<TItem = Record<string, unknown>> {
+    items: TItem[];
+}
+type AggregateExecutor<TModel> = <const TOptions extends AggregateOptions<TModel>>(options: TOptions) => Promise<AggregateResult<AggregateResultItem<TModel, TOptions["groupBy"], TOptions["aggregate"]>>>;
+type SearchFilter = {
+    query: string;
+    operator?: "OR" | "AND";
+};
 type StringFilters = {
     eq?: string;
     in?: string[];
     prefix?: string;
+    search?: SearchFilter;
     exists?: boolean;
 };
 type NumberFilters = {
@@ -166,7 +239,9 @@ type ListFilters<T> = {
     containsAny?: T[];
     containsAll?: T[];
     exists?: boolean;
-};
+} & (T extends string ? {
+    search?: SearchFilter;
+} : unknown);
 type BaseFilterFor<T> = T extends NodeId ? NodeIdFilters : T extends string ? StringFilters : T extends number ? NumberFilters : T extends boolean ? BooleanFilters : T extends Date ? DateFilters : T extends Array<infer U> ? ListFilters<U> : T extends object ? NodeIdFilters | WhereInput<T> : never;
 type RelationFilterFor<T> = UnwrapRelationTarget<T> extends object ? WhereInput<UnwrapRelationTarget<T>> : never;
 type QueryFilterValue<TModel, K extends PropertyKey> = K extends RelationKeys<TModel> ? K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> | RelationFilterFor<ModelRelations<TModel>[K]> : RelationFilterFor<ModelRelations<TModel>[K]> : K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> : never;
@@ -181,11 +256,15 @@ type WhereInput<TModel> = {
 declare class IndustrialModelClient {
     private readonly cognite;
     private readonly queryMapper;
+    private readonly aggregateMapper;
+    private readonly aggregateResultMapper;
     private readonly resultMapper;
     private readonly resultValidator;
     private readonly validateResults;
     constructor(client: CogniteClient, dataModelId: DataModelId, options?: IndustrialModelClientOptions);
     query<TModel>(): QueryExecutor<TModel>;
+    aggregate<TModel>(): AggregateExecutor<TModel>;
+    private aggregateInternal;
     private queryInternal;
     private queryDependenciesPages;
 }
@@ -199,4 +278,4 @@ declare const nodeIdSchema: z.ZodObject<{
 }, z.core.$strip>;
 declare function buildViewSchema(view: ViewDefinition, options?: BuildViewSchemaOptions): z.ZodObject<Record<string, z.ZodType>>;
 
-export { type BuildViewSchemaOptions, type DataModelId, type IndustrialModel, IndustrialModelClient, type IndustrialModelClientOptions, type ModelProps, type ModelRelations, type NodeId, type QueryOptions, type QueryResult, type QueryResultItem, type QueryResultMetadata, type QuerySelect, buildViewSchema, nodeIdSchema };
+export { type AggregateDefinition, type AggregateGroupBy, type AggregateOptions, type AggregateResult, type AggregateResultItem, type BuildViewSchemaOptions, type DataModelId, type GroupByKey, type IndustrialModel, IndustrialModelClient, type IndustrialModelClientOptions, type ModelProps, type ModelRelations, type NodeId, type QueryOptions, type QueryResult, type QueryResultItem, type QueryResultMetadata, type QuerySelect, buildViewSchema, nodeIdSchema };