industrial-model 0.7.0 → 0.8.0

package/dist/{types-2jjbs2i7.d.cts → types-BrD2jPB-.d.cts}

@@ -17,9 +17,9 @@ type DataModelId = NodeId & {
     version: string;
 };
 type SortDirection = "ascending" | "descending";
-interface IndustrialModelClientOptions {
+type IndustrialModelClientOptions = {
     validateResults?: boolean;
-}
+};
 type Simplify<T> = {
     [K in keyof T]: T[K];
 } & {};
@@ -55,14 +55,14 @@ type QuerySelect<TModel, TDepth extends QueryDepth = 3> = {
 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> {
+type QueryOptions<TModel, TSelect extends QuerySelect<TModel> | undefined = QuerySelect<TModel> | undefined> = {
     viewExternalId: string;
     select?: TSelect;
     filters?: WhereInput<TModel>;
     sort?: SortInput<TModel>;
     limit?: number;
     cursor?: string | null;
-}
+};
 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;
@@ -77,10 +77,10 @@ type ExplicitSelectionResult<TModel, TSelect, TDepth extends QueryDepth> = Simpl
 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>> {
+type 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>;
@@ -143,19 +143,19 @@ type AggregateValue<TDef> = TDef extends {
     property: P;
     value: number;
 } : never;
-interface AggregateOptions<TModel> {
+type 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>> {
+type 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 RelationReferenceValue<T> = [NonNull<T>] extends [readonly unknown[]] ? NodeId[] : NodeId;
 type NodeIdLike = {
@@ -172,22 +172,22 @@ type UpsertProperties<TModel> = Simplify<Partial<ModelProps<TModel>> & {
     [K in RelationKeys<TModel>]?: RelationReferenceValue<ModelRelations<TModel>[K]>;
 }>;
 type UpsertNode<TModel> = Simplify<NodeId & Partial<Omit<UpsertProperties<TModel>, keyof NodeId>>>;
-interface EdgeCreationContext {
+type EdgeCreationContext = {
     startNode: NodeId;
     endNode: NodeId;
     edgeType: NodeId;
-}
+};
 type EdgeCreationCallback = (context: EdgeCreationContext) => NodeId;
 type EdgeCreationCallbacks<TProperty extends string = string> = Partial<Record<TProperty, EdgeCreationCallback>>;
 type OnEdgeCreation<TModel> = EdgeCreationCallbacks<Extract<ArrayReferencePropertyKeys<TModel> | ArrayRelationKeys<TModel>, string>>;
 type EdgeMode = "append" | "replace";
-interface UpsertOptions<TModel> {
+type UpsertOptions<TModel> = {
     viewExternalId: string;
     items: UpsertNode<TModel>[];
     onEdgeCreation?: OnEdgeCreation<TModel>;
     replace?: boolean;
     edgeMode?: EdgeMode;
-}
+};
 type UpsertResultItem = {
     instanceType: "node" | "edge";
     version?: number;
@@ -197,17 +197,93 @@ type UpsertResultItem = {
     createdTime?: number;
     lastUpdatedTime?: number;
 };
-interface UpsertResult {
+type UpsertResult = {
     items: UpsertResultItem[];
-}
+};
 type UpsertExecutor<TModel> = (options: UpsertOptions<TModel>) => Promise<UpsertResult>;
 type DeleteResultItem = Omit<UpsertResultItem, "instanceType"> & {
     instanceType: "node";
 };
-interface DeleteResult {
+type DeleteResult = {
     items: DeleteResultItem[];
-}
+};
 type DeleteExecutor = <TItem extends NodeId>(items: TItem[]) => Promise<DeleteResult>;
+type DatapointAggregate = "average" | "max" | "min" | "count" | "sum" | "interpolation" | "stepInterpolation" | "totalVariation" | "continuousVariance" | "discreteVariance";
+type RawDatapoint = {
+    timestamp: Date;
+    value: number;
+};
+type DatapointSeriesResult = {
+    timeSeries: NodeId;
+    unit?: string;
+    datapoints: RawDatapoint[];
+    cursor: string | null;
+};
+type DatapointsResult = {
+    items: DatapointSeriesResult[];
+};
+type DatapointsRetrieveOptions = {
+    timeSeries: NodeId[];
+    start?: Date;
+    end?: Date;
+    /** Number of datapoints to return per time series, or -1 to auto-paginate all pages. */
+    limit?: number;
+    aggregate?: DatapointAggregate;
+    granularity?: string;
+    includeOutsidePoints?: boolean;
+    ignoreUnknownIds?: boolean;
+    timeZone?: string;
+};
+type DatapointsLatestSeries = NodeId & {
+    before?: Date;
+};
+type DatapointsLatestOptions = {
+    timeSeries: DatapointsLatestSeries[];
+    ignoreUnknownIds?: boolean;
+};
+type DatapointsInsertItem = {
+    timeSeries: NodeId;
+    datapoints: Array<{
+        timestamp: Date;
+        value: number;
+    }>;
+};
+type DatapointsDeleteRange = {
+    timeSeries: NodeId;
+    start: Date;
+    end?: Date;
+};
+type DatapointsExecutor = {
+    retrieve(options: DatapointsRetrieveOptions): Promise<DatapointsResult>;
+    latest(options: DatapointsLatestOptions): Promise<DatapointsResult>;
+    insert(items: DatapointsInsertItem[]): Promise<void>;
+    delete(ranges: DatapointsDeleteRange[]): Promise<void>;
+};
+type FileUploadInfo = NodeId & {
+    name: string;
+    mimeType?: string;
+    directory?: string;
+    source?: string;
+    metadata?: Record<string, string>;
+};
+type FileUploadResult = NodeId & {
+    name: string;
+    uploaded: boolean;
+    mimeType?: string;
+    directory?: string;
+    source?: string;
+    uploadedTime?: Date;
+    createdTime: Date;
+    lastUpdatedTime: Date;
+    uploadUrl?: string;
+};
+type FileDownloadUrl = NodeId & {
+    downloadUrl: string;
+};
+type FilesExecutor = {
+    upload(fileInfo: FileUploadInfo, content?: unknown): Promise<FileUploadResult>;
+    getDownloadUrls(nodeIds: NodeId[]): Promise<FileDownloadUrl[]>;
+};
 type SearchFilter = {
     query: string;
     operator?: "OR" | "AND";
@@ -264,4 +340,4 @@ type WhereInput<TModel> = {
     [K in keyof ModelProps<TModel> | RelationKeys<TModel>]?: QueryFilterValue<TModel, K>;
 };
 
-export type { AggregateExecutor as A, DataModelId as D, EdgeCreationCallback as E, IndustrialModelClientOptions as I, ModelProps as M, NodeId as N, OnEdgeCreation as O, QueryExecutor as Q, UpsertExecutor as U, DeleteResult as a, AggregateResult as b, AggregateResultItem as c, DeleteExecutor as d, DeleteResultItem as e, EdgeCreationCallbacks as f, EdgeCreationContext as g, EdgeMode as h, IndustrialModel as i, ModelRelations as j, QueryResult as k, QueryResultItem as l, QuerySelect as m, UpsertNode as n, UpsertOptions as o, UpsertProperties as p, UpsertResult as q, UpsertResultItem as r, AggregateOptions as s, QueryOptions as t };
+export type { AggregateExecutor as A, UpsertOptions as B, UpsertProperties as C, DataModelId as D, EdgeCreationCallback as E, FilesExecutor as F, UpsertResult as G, UpsertResultItem as H, IndustrialModelClientOptions as I, AggregateOptions as J, QueryOptions as K, ModelProps as M, NodeId as N, OnEdgeCreation as O, QueryExecutor as Q, RawDatapoint as R, UpsertExecutor as U, DatapointsExecutor as a, DeleteResult as b, AggregateResult as c, AggregateResultItem as d, DatapointAggregate as e, DatapointSeriesResult as f, DatapointsDeleteRange as g, DatapointsInsertItem as h, DatapointsLatestOptions as i, DatapointsLatestSeries as j, DatapointsResult as k, DatapointsRetrieveOptions as l, DeleteExecutor as m, DeleteResultItem as n, EdgeCreationCallbacks as o, EdgeCreationContext as p, EdgeMode as q, FileDownloadUrl as r, FileUploadInfo as s, FileUploadResult as t, IndustrialModel as u, ModelRelations as v, QueryResult as w, QueryResultItem as x, QuerySelect as y, UpsertNode as z };

package/dist/{types-2jjbs2i7.d.ts → types-BrD2jPB-.d.ts}

@@ -17,9 +17,9 @@ type DataModelId = NodeId & {
     version: string;
 };
 type SortDirection = "ascending" | "descending";
-interface IndustrialModelClientOptions {
+type IndustrialModelClientOptions = {
     validateResults?: boolean;
-}
+};
 type Simplify<T> = {
     [K in keyof T]: T[K];
 } & {};
@@ -55,14 +55,14 @@ type QuerySelect<TModel, TDepth extends QueryDepth = 3> = {
 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> {
+type QueryOptions<TModel, TSelect extends QuerySelect<TModel> | undefined = QuerySelect<TModel> | undefined> = {
     viewExternalId: string;
     select?: TSelect;
     filters?: WhereInput<TModel>;
     sort?: SortInput<TModel>;
     limit?: number;
     cursor?: string | null;
-}
+};
 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;
@@ -77,10 +77,10 @@ type ExplicitSelectionResult<TModel, TSelect, TDepth extends QueryDepth> = Simpl
 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>> {
+type 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>;
@@ -143,19 +143,19 @@ type AggregateValue<TDef> = TDef extends {
     property: P;
     value: number;
 } : never;
-interface AggregateOptions<TModel> {
+type 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>> {
+type 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 RelationReferenceValue<T> = [NonNull<T>] extends [readonly unknown[]] ? NodeId[] : NodeId;
 type NodeIdLike = {
@@ -172,22 +172,22 @@ type UpsertProperties<TModel> = Simplify<Partial<ModelProps<TModel>> & {
     [K in RelationKeys<TModel>]?: RelationReferenceValue<ModelRelations<TModel>[K]>;
 }>;
 type UpsertNode<TModel> = Simplify<NodeId & Partial<Omit<UpsertProperties<TModel>, keyof NodeId>>>;
-interface EdgeCreationContext {
+type EdgeCreationContext = {
     startNode: NodeId;
     endNode: NodeId;
     edgeType: NodeId;
-}
+};
 type EdgeCreationCallback = (context: EdgeCreationContext) => NodeId;
 type EdgeCreationCallbacks<TProperty extends string = string> = Partial<Record<TProperty, EdgeCreationCallback>>;
 type OnEdgeCreation<TModel> = EdgeCreationCallbacks<Extract<ArrayReferencePropertyKeys<TModel> | ArrayRelationKeys<TModel>, string>>;
 type EdgeMode = "append" | "replace";
-interface UpsertOptions<TModel> {
+type UpsertOptions<TModel> = {
     viewExternalId: string;
     items: UpsertNode<TModel>[];
     onEdgeCreation?: OnEdgeCreation<TModel>;
     replace?: boolean;
     edgeMode?: EdgeMode;
-}
+};
 type UpsertResultItem = {
     instanceType: "node" | "edge";
     version?: number;
@@ -197,17 +197,93 @@ type UpsertResultItem = {
     createdTime?: number;
     lastUpdatedTime?: number;
 };
-interface UpsertResult {
+type UpsertResult = {
     items: UpsertResultItem[];
-}
+};
 type UpsertExecutor<TModel> = (options: UpsertOptions<TModel>) => Promise<UpsertResult>;
 type DeleteResultItem = Omit<UpsertResultItem, "instanceType"> & {
     instanceType: "node";
 };
-interface DeleteResult {
+type DeleteResult = {
     items: DeleteResultItem[];
-}
+};
 type DeleteExecutor = <TItem extends NodeId>(items: TItem[]) => Promise<DeleteResult>;
+type DatapointAggregate = "average" | "max" | "min" | "count" | "sum" | "interpolation" | "stepInterpolation" | "totalVariation" | "continuousVariance" | "discreteVariance";
+type RawDatapoint = {
+    timestamp: Date;
+    value: number;
+};
+type DatapointSeriesResult = {
+    timeSeries: NodeId;
+    unit?: string;
+    datapoints: RawDatapoint[];
+    cursor: string | null;
+};
+type DatapointsResult = {
+    items: DatapointSeriesResult[];
+};
+type DatapointsRetrieveOptions = {
+    timeSeries: NodeId[];
+    start?: Date;
+    end?: Date;
+    /** Number of datapoints to return per time series, or -1 to auto-paginate all pages. */
+    limit?: number;
+    aggregate?: DatapointAggregate;
+    granularity?: string;
+    includeOutsidePoints?: boolean;
+    ignoreUnknownIds?: boolean;
+    timeZone?: string;
+};
+type DatapointsLatestSeries = NodeId & {
+    before?: Date;
+};
+type DatapointsLatestOptions = {
+    timeSeries: DatapointsLatestSeries[];
+    ignoreUnknownIds?: boolean;
+};
+type DatapointsInsertItem = {
+    timeSeries: NodeId;
+    datapoints: Array<{
+        timestamp: Date;
+        value: number;
+    }>;
+};
+type DatapointsDeleteRange = {
+    timeSeries: NodeId;
+    start: Date;
+    end?: Date;
+};
+type DatapointsExecutor = {
+    retrieve(options: DatapointsRetrieveOptions): Promise<DatapointsResult>;
+    latest(options: DatapointsLatestOptions): Promise<DatapointsResult>;
+    insert(items: DatapointsInsertItem[]): Promise<void>;
+    delete(ranges: DatapointsDeleteRange[]): Promise<void>;
+};
+type FileUploadInfo = NodeId & {
+    name: string;
+    mimeType?: string;
+    directory?: string;
+    source?: string;
+    metadata?: Record<string, string>;
+};
+type FileUploadResult = NodeId & {
+    name: string;
+    uploaded: boolean;
+    mimeType?: string;
+    directory?: string;
+    source?: string;
+    uploadedTime?: Date;
+    createdTime: Date;
+    lastUpdatedTime: Date;
+    uploadUrl?: string;
+};
+type FileDownloadUrl = NodeId & {
+    downloadUrl: string;
+};
+type FilesExecutor = {
+    upload(fileInfo: FileUploadInfo, content?: unknown): Promise<FileUploadResult>;
+    getDownloadUrls(nodeIds: NodeId[]): Promise<FileDownloadUrl[]>;
+};
 type SearchFilter = {
     query: string;
     operator?: "OR" | "AND";
@@ -264,4 +340,4 @@ type WhereInput<TModel> = {
     [K in keyof ModelProps<TModel> | RelationKeys<TModel>]?: QueryFilterValue<TModel, K>;
 };
 
-export type { AggregateExecutor as A, DataModelId as D, EdgeCreationCallback as E, IndustrialModelClientOptions as I, ModelProps as M, NodeId as N, OnEdgeCreation as O, QueryExecutor as Q, UpsertExecutor as U, DeleteResult as a, AggregateResult as b, AggregateResultItem as c, DeleteExecutor as d, DeleteResultItem as e, EdgeCreationCallbacks as f, EdgeCreationContext as g, EdgeMode as h, IndustrialModel as i, ModelRelations as j, QueryResult as k, QueryResultItem as l, QuerySelect as m, UpsertNode as n, UpsertOptions as o, UpsertProperties as p, UpsertResult as q, UpsertResultItem as r, AggregateOptions as s, QueryOptions as t };
+export type { AggregateExecutor as A, UpsertOptions as B, UpsertProperties as C, DataModelId as D, EdgeCreationCallback as E, FilesExecutor as F, UpsertResult as G, UpsertResultItem as H, IndustrialModelClientOptions as I, AggregateOptions as J, QueryOptions as K, ModelProps as M, NodeId as N, OnEdgeCreation as O, QueryExecutor as Q, RawDatapoint as R, UpsertExecutor as U, DatapointsExecutor as a, DeleteResult as b, AggregateResult as c, AggregateResultItem as d, DatapointAggregate as e, DatapointSeriesResult as f, DatapointsDeleteRange as g, DatapointsInsertItem as h, DatapointsLatestOptions as i, DatapointsLatestSeries as j, DatapointsResult as k, DatapointsRetrieveOptions as l, DeleteExecutor as m, DeleteResultItem as n, EdgeCreationCallbacks as o, EdgeCreationContext as p, EdgeMode as q, FileDownloadUrl as r, FileUploadInfo as s, FileUploadResult as t, IndustrialModel as u, ModelRelations as v, QueryResult as w, QueryResultItem as x, QuerySelect as y, UpsertNode as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "industrial-model",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "TypeScript SDK for querying Cognite Industrial Data Models with a type-safe, graph-aware API",
   "license": "MIT",
   "keywords": [