industrial-model 0.11.2 → 0.12.0

package/dist/{types-69DRhgww.d.cts → types-CFkHwXW6.d.cts}

@@ -1,3 +1,188 @@
+interface ViewReference {
+    type: "view";
+    space: string;
+    externalId: string;
+    version: string;
+}
+interface ViewPropertyType {
+    type?: string;
+    source?: ViewReference;
+    list?: boolean;
+    values?: Record<string, {
+        name?: string;
+    }>;
+}
+interface ViewPropertyDefinition {
+    container: unknown;
+    containerPropertyIdentifier: string;
+    type: ViewPropertyType;
+    nullable?: boolean;
+}
+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>;
+}
+type FilterDefinition = {
+    and: FilterDefinition[];
+} | {
+    or: FilterDefinition[];
+} | {
+    not: FilterDefinition;
+} | {
+    equals: {
+        property: string[];
+        value: string | number | boolean;
+    };
+} | {
+    in: {
+        property: string[];
+        values: (string | number | boolean)[];
+    };
+} | {
+    range: {
+        property: string[];
+        gt?: number | string;
+        gte?: number | string;
+        lt?: number | string;
+        lte?: number | string;
+    };
+} | {
+    exists: {
+        property: string[];
+    };
+} | {
+    prefix: {
+        property: string[];
+        value: string;
+    };
+} | {
+    containsAll: {
+        property: string[];
+        values: (string | number | boolean)[];
+    };
+} | {
+    containsAny: {
+        property: string[];
+        values: (string | number | boolean)[];
+    };
+} | {
+    nested: {
+        scope: string[];
+        filter: FilterDefinition;
+    };
+} | {
+    instanceReferences: Array<{
+        space: string;
+        externalId: string;
+    }>;
+} | {
+    hasData: ViewReference[];
+};
+type TableExpressionFilter = FilterDefinition | {
+    and: FilterDefinition[];
+};
+interface PropertySort {
+    property: string[];
+    direction: SortDirection;
+    nullsFirst: boolean;
+}
+interface QuerySelectExpression {
+    sources?: Array<{
+        source: ViewReference;
+        properties: string[];
+    }>;
+}
+interface QueryNodeTableExpression {
+    nodes: {
+        filter?: TableExpressionFilter;
+        from?: string;
+        direction?: "outwards" | "inwards";
+        through?: {
+            view: ViewReference;
+            identifier: string;
+        } | {
+            source: ViewReference;
+            identifier: string;
+        };
+    };
+    sort?: PropertySort[];
+    limit?: number;
+}
+interface QueryEdgeTableExpression {
+    edges: {
+        from: string;
+        maxDistance?: number;
+        filter?: TableExpressionFilter;
+        direction?: "outwards" | "inwards";
+    };
+    limit?: number;
+}
+type QueryTableExpression = QueryNodeTableExpression | QueryEdgeTableExpression;
+interface InstancesQueryRequest {
+    with: Record<string, QueryTableExpression>;
+    select: Record<string, QuerySelectExpression | Record<string, never>>;
+    cursors?: Record<string, string>;
+}
+interface InstancesApplySource {
+    source: ViewReference;
+    properties: Record<string, unknown>;
+}
+interface InstancesApplyNodeWrite {
+    instanceType: "node";
+    space: string;
+    externalId: string;
+    existingVersion?: number;
+    sources?: InstancesApplySource[];
+}
+interface InstancesApplyEdgeWrite {
+    instanceType: "edge";
+    space: string;
+    externalId: string;
+    type: unknown;
+    startNode: NodeId;
+    endNode: NodeId;
+    existingVersion?: number;
+    sources?: InstancesApplySource[];
+}
+interface InstancesApplyDelete {
+    instanceType: "node" | "edge";
+    space: string;
+    externalId: string;
+}
+interface InstancesApplyRequest {
+    items: Array<InstancesApplyNodeWrite | InstancesApplyEdgeWrite>;
+    delete?: InstancesApplyDelete[];
+    replace?: boolean;
+}
+interface InstancesApplyResultItem {
+    instanceType: "node" | "edge";
+    version?: number;
+    wasModified?: boolean;
+    space: string;
+    externalId: string;
+    createdTime?: number;
+    lastUpdatedTime?: number;
+}
+interface InstancesApplyResponse {
+    items: InstancesApplyResultItem[];
+}
 interface NodeDefinition {
     instanceType: "node";
     version?: number;
@@ -8,6 +193,182 @@ interface NodeDefinition {
     deletedTime?: number;
     lastUpdatedTime?: number;
 }
+interface EdgeDefinition {
+    instanceType: "edge";
+    space: string;
+    externalId: string;
+    startNode: {
+        space: string;
+        externalId: string;
+    };
+    endNode: {
+        space: string;
+        externalId: string;
+    };
+}
+type NodeOrEdge = NodeDefinition | EdgeDefinition;
+interface InstancesQueryResponse {
+    items: Record<string, NodeOrEdge[]>;
+    nextCursor: Record<string, string>;
+}
+interface InstancesSearchRequest {
+    view: ViewReference;
+    query: string;
+    instanceType: "node";
+    properties: string[];
+    operator?: "OR" | "AND";
+    filter?: FilterDefinition;
+    limit?: number;
+}
+interface InstancesSearchResponse {
+    items: NodeOrEdge[];
+}
+interface DataModelRetrieveItem {
+    views?: ViewDefinition[];
+    createdTime: number;
+}
+interface DataModelRetrieveOptions {
+    inlineViews?: boolean;
+}
+type AggregateFunctionName = "avg" | "min" | "max" | "sum" | "count";
+type InstancesAggregateDefinition = {
+    avg: {
+        property: string;
+    };
+} | {
+    min: {
+        property: string;
+    };
+} | {
+    max: {
+        property: string;
+    };
+} | {
+    sum: {
+        property: string;
+    };
+} | {
+    count: {
+        property?: string;
+    };
+};
+interface InstancesAggregateRequest {
+    view: ViewReference;
+    instanceType: "node";
+    limit: number;
+    filter?: FilterDefinition;
+    groupBy?: string[];
+    aggregates?: InstancesAggregateDefinition[];
+}
+interface InstancesAggregateValue {
+    aggregate: AggregateFunctionName;
+    property?: string;
+    value?: number;
+}
+interface InstancesAggregateResultItem {
+    aggregates: InstancesAggregateValue[];
+    group?: Record<string, string | number | boolean | {
+        space: string;
+        externalId: string;
+    }>;
+    instanceType: "node" | "edge";
+}
+interface InstancesAggregateResponse {
+    items: InstancesAggregateResultItem[];
+}
+
+/** Numeric datapoint from a raw (non-aggregate) time series query. */
+type CogniteDoubleDatapoint = {
+    timestamp: Date;
+    value: number;
+};
+/** Numeric datapoint from an aggregate time series query.
+ *  Each field corresponds to one aggregate function as defined by the Cognite API. */
+type CogniteAggregateDatapoint = {
+    timestamp: Date;
+} & {
+    [K in DatapointAggregate]?: number;
+};
+/** A numeric datapoint as returned by the Cognite API.
+ *  String time series datapoints are excluded — they are filtered out before processing. */
+type CogniteNumericDatapoint = CogniteDoubleDatapoint | CogniteAggregateDatapoint;
+interface CogniteDatapointResultItem {
+    space?: string;
+    externalId?: string;
+    isString: boolean;
+    unit?: string;
+    datapoints: CogniteNumericDatapoint[];
+    nextCursor?: string;
+}
+interface CogniteDatapointRetrieveItem extends NodeId {
+    start?: string | number | Date;
+    end?: string | number | Date;
+    limit?: number;
+    cursor?: string;
+    aggregates?: DatapointAggregate[];
+    granularity?: string;
+    includeOutsidePoints?: boolean;
+    targetUnit?: string;
+    targetUnitSystem?: string;
+    timeZone?: string;
+}
+interface CogniteDatapointRetrieveOptions {
+    items: CogniteDatapointRetrieveItem[];
+    start?: string | number | Date;
+    end?: string | number | Date;
+    limit?: number;
+    aggregates?: DatapointAggregate[];
+    granularity?: string;
+    includeOutsidePoints?: boolean;
+    ignoreUnknownIds?: boolean;
+    timeZone?: string;
+}
+interface CogniteDatapointLatestItem extends NodeId {
+    before?: string | Date | number;
+}
+interface CogniteDatapointInsertItem extends NodeId {
+    datapoints: Array<{
+        timestamp: number | Date;
+        value: number;
+    }>;
+}
+interface CogniteDatapointDeleteItem extends NodeId {
+    inclusiveBegin: number | Date;
+    exclusiveEnd?: number | Date;
+}
+interface CogniteFileInstanceId {
+    space?: string;
+    externalId?: string;
+}
+interface CogniteFileInfo {
+    instanceId?: CogniteFileInstanceId;
+    name: string;
+    uploaded: boolean;
+    uploadedTime?: Date;
+    createdTime: Date;
+    lastUpdatedTime: Date;
+    mimeType?: string;
+    directory?: string;
+    source?: string;
+}
+interface CogniteFileUploadResult extends CogniteFileInfo {
+    uploadUrl?: string;
+}
+interface CogniteFileUploadInfo {
+    instanceId: {
+        space: string;
+        externalId: string;
+    };
+    name: string;
+    mimeType?: string;
+    directory?: string;
+    source?: string;
+    metadata?: Record<string, string>;
+}
+interface CogniteFileDownloadUrl {
+    instanceId?: CogniteFileInstanceId;
+    downloadUrl: string;
+}
 
 type NodeId = {
     externalId: string;
@@ -340,4 +701,4 @@ type WhereInput<TModel> = {
     [K in keyof ModelProps<TModel> | RelationKeys<TModel>]?: QueryFilterValue<TModel, K>;
 };
 
-export type { AggregateExecutor as A, QuerySelect as B, UpsertNode as C, DataModelId as D, EdgeCreationCallback as E, FilesExecutor as F, UpsertOptions as G, UpsertProperties as H, IndustrialModelClientOptions as I, UpsertResult as J, UpsertResultItem 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, AggregateOptions as c, AggregateResult as d, AggregateResultItem as e, DatapointAggregate as f, DatapointSeriesResult as g, DatapointsDeleteRange as h, DatapointsInsertItem as i, DatapointsLatestOptions as j, DatapointsLatestSeries as k, DatapointsResult as l, DatapointsRetrieveOptions as m, DeleteExecutor as n, DeleteResultItem as o, EdgeCreationCallbacks as p, EdgeCreationContext as q, EdgeMode as r, FileDownloadUrl as s, FileUploadInfo as t, FileUploadResult as u, IndustrialModel as v, ModelRelations as w, QueryOptions as x, QueryResult as y, QueryResultItem as z };
+export type { InstancesApplyResponse as $, AggregateExecutor as A, QuerySelect as B, UpsertNode as C, DataModelId as D, EdgeCreationCallback as E, FilesExecutor as F, UpsertOptions as G, UpsertProperties as H, IndustrialModelClientOptions as I, UpsertResult as J, UpsertResultItem as K, DataModelRetrieveOptions as L, ModelProps as M, NodeId as N, OnEdgeCreation as O, DataModelRetrieveItem as P, QueryExecutor as Q, RawDatapoint as R, InstancesQueryRequest as S, InstancesQueryResponse as T, UpsertExecutor as U, ViewDefinition as V, InstancesSearchRequest as W, InstancesSearchResponse as X, InstancesAggregateRequest as Y, InstancesAggregateResponse as Z, InstancesApplyRequest as _, DatapointsExecutor as a, CogniteDatapointRetrieveOptions as a0, CogniteDatapointResultItem as a1, CogniteDatapointLatestItem as a2, CogniteDatapointInsertItem as a3, CogniteDatapointDeleteItem as a4, CogniteFileUploadInfo as a5, CogniteFileUploadResult as a6, CogniteFileDownloadUrl as a7, DeleteResult as b, AggregateOptions as c, AggregateResult as d, AggregateResultItem as e, DatapointAggregate as f, DatapointSeriesResult as g, DatapointsDeleteRange as h, DatapointsInsertItem as i, DatapointsLatestOptions as j, DatapointsLatestSeries as k, DatapointsResult as l, DatapointsRetrieveOptions as m, DeleteExecutor as n, DeleteResultItem as o, EdgeCreationCallbacks as p, EdgeCreationContext as q, EdgeMode as r, FileDownloadUrl as s, FileUploadInfo as t, FileUploadResult as u, IndustrialModel as v, ModelRelations as w, QueryOptions as x, QueryResult as y, QueryResultItem as z };