industrial-model 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1,4 +1,53 @@
 import { CogniteClient } from '@cognite/sdk';
+import { z } from 'zod';
+
+interface ViewReference {
+    type: "view";
+    space: string;
+    externalId: string;
+    version: string;
+}
+interface ViewPropertyType {
+    type?: string;
+    source?: ViewReference;
+    list?: boolean;
+}
+interface ViewPropertyDefinition {
+    container: unknown;
+    containerPropertyIdentifier: string;
+    type: ViewPropertyType;
+}
+interface ReverseDirectRelationConnection {
+    through: {
+        source: ViewReference;
+        identifier: string;
+    };
+    source: ViewReference;
+    connectionType?: string;
+    targetsList?: boolean;
+}
+interface EdgeConnection {
+    type: unknown;
+    source: ViewReference;
+    direction?: "outwards" | "inwards";
+}
+type ViewDefinitionProperty = ViewPropertyDefinition | ReverseDirectRelationConnection | EdgeConnection;
+interface ViewDefinition {
+    space: string;
+    externalId: string;
+    version: string;
+    properties: Record<string, ViewDefinitionProperty>;
+}
+interface NodeDefinition {
+    instanceType: "node";
+    version?: number;
+    space: string;
+    externalId: string;
+    properties?: Record<string, Record<string, Record<string, unknown>>>;
+    createdTime?: number;
+    deletedTime?: number;
+    lastUpdatedTime?: number;
+}
 
 type NodeId = {
     externalId: string;
@@ -8,31 +57,78 @@ type DataModelId = NodeId & {
     version: string;
 };
 type SortDirection = "ascending" | "descending";
-type SelectFor<T, TRelation = never> = T extends Array<infer U> ? boolean | (U extends object ? QuerySelect<U, TRelation> : never) : T extends object ? boolean | QuerySelect<T, TRelation> : boolean;
-type QuerySelect<T, TRelation = never> = {
-    _all?: boolean;
-} & ([TRelation] extends [never] ? {
-    [K in keyof T]?: SelectFor<T[K], TRelation>;
-} : {
-    [K in Exclude<keyof T, keyof TRelation>]?: SelectFor<T[K], TRelation>;
-}) & ([TRelation] extends [never] ? {} : {
-    [K in keyof TRelation]?: SelectFor<TRelation[K], TRelation>;
-});
-type SortInput<T> = {
-    [K in keyof T as T[K] extends string | number | boolean | Date | NodeId ? K : never]?: SortDirection;
+interface IndustrialModelClientOptions {
+    validateResults?: boolean;
+}
+type Simplify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type Merge<A, B> = Simplify<Omit<A, keyof B> & B>;
+type NonNull<T> = Exclude<T, null | undefined>;
+type ArrayItem<T> = T extends readonly (infer U)[] ? U : never;
+type QueryDepth = 0 | 1 | 2 | 3;
+type PrevDepth = {
+    0: 0;
+    1: 0;
+    2: 1;
+    3: 2;
+};
+declare const MODEL_RELATIONS: unique symbol;
+type IndustrialModel<TProps, TRelations = {}> = Simplify<TProps & {
+    readonly [MODEL_RELATIONS]?: TRelations;
+}>;
+type ModelProps<TModel> = Simplify<Omit<TModel, typeof MODEL_RELATIONS>>;
+type ModelRelations<TModel> = TModel extends {
+    readonly [MODEL_RELATIONS]?: infer TRelations;
+} ? NonNull<TRelations> : never;
+type RelationKeys<TModel> = [ModelRelations<TModel>] extends [never] ? never : keyof ModelRelations<TModel>;
+type IsOptionalKey<T, K extends PropertyKey> = K extends keyof T ? {} extends Pick<T, K> ? true : false : false;
+type UnwrapRelationTarget<T> = NonNull<T> extends readonly unknown[] ? ArrayItem<NonNull<T>> : NonNull<T>;
+type BaseSelectFor<T, TDepth extends QueryDepth = 3> = [NonNull<T>] extends [NodeId] ? boolean : NonNull<T> extends readonly unknown[] ? [ArrayItem<NonNull<T>>] extends [NodeId] ? boolean : TDepth extends 0 ? boolean : NonNull<ArrayItem<NonNull<T>>> extends object ? boolean | QuerySelect<NonNull<ArrayItem<NonNull<T>>>, PrevDepth[TDepth]> : boolean : TDepth extends 0 ? boolean : NonNull<T> extends object ? boolean | QuerySelect<NonNull<T>, PrevDepth[TDepth]> : boolean;
+type RelationSelectFor<T, TDepth extends QueryDepth = 3> = TDepth extends 0 ? never : QuerySelect<UnwrapRelationTarget<T>, PrevDepth[TDepth]>;
+type QuerySelectValue<TModel, K extends PropertyKey, TDepth extends QueryDepth> = K extends RelationKeys<TModel> ? K extends keyof ModelProps<TModel> ? boolean | RelationSelectFor<ModelRelations<TModel>[K], TDepth> : RelationSelectFor<ModelRelations<TModel>[K], TDepth> : K extends keyof ModelProps<TModel> ? BaseSelectFor<ModelProps<TModel>[K], TDepth> : never;
+type QuerySelect<TModel, TDepth extends QueryDepth = 3> = {
+    _all?: true;
+} & {
+    [K in keyof ModelProps<TModel> | RelationKeys<TModel>]?: QuerySelectValue<TModel, K, TDepth>;
 };
-interface QueryOptions<T, TRelation = never> {
+type SortInput<TModel> = {
+    [K in keyof ModelProps<TModel> as NonNull<ModelProps<TModel>[K]> extends string | number | boolean | Date | NodeId ? K : never]?: SortDirection;
+};
+interface QueryOptions<TModel, TSelect extends QuerySelect<TModel> | undefined = QuerySelect<TModel> | undefined> {
     viewExternalId: string;
-    select?: QuerySelect<T, TRelation>;
-    filters?: WhereInput<T, TRelation>;
-    sortClauses?: SortInput<T>;
+    select?: TSelect;
+    filters?: WhereInput<TModel>;
+    sort?: SortInput<TModel>;
     limit?: number;
     cursor?: string | null;
 }
-interface QueryResult {
-    items: Record<string, unknown>[];
+type QueryResultMetadata = Pick<NodeDefinition, "space" | "externalId" | "version" | "createdTime" | "deletedTime" | "lastUpdatedTime">;
+type ResultShapeForKey<TModel, K extends PropertyKey> = K extends keyof ModelProps<TModel> ? ModelProps<TModel>[K] : K extends RelationKeys<TModel> ? ModelRelations<TModel>[K] : never;
+type ResultEntityForKey<TModel, K extends PropertyKey> = K extends RelationKeys<TModel> ? ModelRelations<TModel>[K] : K extends keyof ModelProps<TModel> ? ModelProps<TModel>[K] : never;
+type WrapResultValue<TShape, TValue> = [NonNull<TShape>] extends [readonly unknown[]] ? TValue[] : TValue;
+type AsQuerySelect<TModel, TSelect> = TSelect extends QuerySelect<TModel> ? TSelect : never;
+type SelectedValue<TModel, K extends PropertyKey, TValue, TDepth extends QueryDepth> = TValue extends true ? K extends keyof ModelProps<TModel> ? ModelProps<TModel>[K] : never : TDepth extends 0 ? never : TValue extends object ? WrapResultValue<ResultShapeForKey<TModel, K>, QueryResultItem<UnwrapRelationTarget<ResultEntityForKey<TModel, K>>, AsQuerySelect<UnwrapRelationTarget<ResultEntityForKey<TModel, K>>, TValue>, PrevDepth[TDepth]>> : never;
+type ExplicitSelectionResult<TModel, TSelect, TDepth extends QueryDepth> = Simplify<{
+    [K in keyof NonNull<TSelect> as K extends "_all" ? never : SelectedValue<TModel, K, NonNull<TSelect>[K], TDepth> extends never ? never : IsOptionalKey<ModelProps<TModel>, K> extends true ? never : IsOptionalKey<ModelRelations<TModel>, K> extends true ? never : K]-?: SelectedValue<TModel, K, NonNull<TSelect>[K], TDepth>;
+} & {
+    [K in keyof NonNull<TSelect> as K extends "_all" ? never : SelectedValue<TModel, K, NonNull<TSelect>[K], TDepth> extends never ? never : IsOptionalKey<ModelProps<TModel>, K> extends true ? K : IsOptionalKey<ModelRelations<TModel>, K> extends true ? K : never]?: SelectedValue<TModel, K, NonNull<TSelect>[K], TDepth>;
+}>;
+type QueryResultItem<TModel, TSelect extends QuerySelect<TModel> | undefined = undefined, TDepth extends QueryDepth = 3> = [TSelect] extends [undefined] ? Merge<QueryResultMetadata, ModelProps<TModel>> : Merge<TSelect extends {
+    _all: true;
+} ? Merge<QueryResultMetadata, ModelProps<TModel>> : QueryResultMetadata, ExplicitSelectionResult<TModel, TSelect, TDepth>>;
+interface QueryResult<TItem = Record<string, unknown>> {
+    items: TItem[];
     cursor: string | null;
 }
+type QueryExecutor<TModel> = {
+    <const TSelect extends QuerySelect<TModel>>(options: Omit<QueryOptions<TModel, TSelect>, "select"> & {
+        select: TSelect & QuerySelect<TModel>;
+    }): Promise<QueryResult<QueryResultItem<TModel, TSelect>>>;
+    (options: Omit<QueryOptions<TModel, undefined>, "select"> & {
+        select?: undefined;
+    }): Promise<QueryResult<QueryResultItem<TModel, undefined>>>;
+};
 type StringFilters = {
     eq?: string;
     in?: string[];
@@ -71,26 +167,36 @@ type ListFilters<T> = {
     containsAll?: T[];
     exists?: boolean;
 };
-type FilterFor<T, TRelation = never> = 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, TRelation> : never;
-type WhereInput<T, TRelation = never> = {
-    AND?: WhereInput<T, TRelation> | WhereInput<T, TRelation>[];
-    OR?: WhereInput<T, TRelation>[];
-    NOT?: WhereInput<T, TRelation> | WhereInput<T, TRelation>[];
-} & ([TRelation] extends [never] ? {
-    [K in keyof T]?: FilterFor<T[K], TRelation>;
-} : {
-    [K in Exclude<keyof T, keyof TRelation>]?: FilterFor<T[K], TRelation>;
-}) & ([TRelation] extends [never] ? {} : {
-    [K in keyof TRelation]?: FilterFor<TRelation[K], TRelation>;
-});
+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;
+type WhereInput<TModel> = {
+    AND?: WhereInput<TModel> | WhereInput<TModel>[];
+    OR?: WhereInput<TModel>[];
+    NOT?: WhereInput<TModel> | WhereInput<TModel>[];
+} & {
+    [K in keyof ModelProps<TModel> | RelationKeys<TModel>]?: QueryFilterValue<TModel, K>;
+};
 
-declare class IndustrialModel {
+declare class IndustrialModelClient {
     private readonly cognite;
     private readonly queryMapper;
     private readonly resultMapper;
-    constructor(client: CogniteClient, dataModelId: DataModelId);
-    query<T, TRelation = never>(options: QueryOptions<T, TRelation>): Promise<QueryResult>;
+    private readonly resultValidator;
+    private readonly validateResults;
+    constructor(client: CogniteClient, dataModelId: DataModelId, options?: IndustrialModelClientOptions);
+    query<TModel>(): QueryExecutor<TModel>;
+    private queryInternal;
     private queryDependenciesPages;
 }
 
-export { type DataModelId, IndustrialModel, type NodeId, type QueryOptions, type QueryResult };
+interface BuildViewSchemaOptions {
+    dateMode?: "preserve" | "coerce";
+}
+declare const nodeIdSchema: z.ZodObject<{
+    space: z.ZodString;
+    externalId: z.ZodString;
+}, 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 };