industrial-model 0.7.0 → 0.8.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { CogniteClient } from '@cognite/sdk';
-import { D as DataModelId, I as IndustrialModelClientOptions, Q as QueryExecutor, A as AggregateExecutor, U as UpsertExecutor, N as NodeId, a as DeleteResult } from './types-2jjbs2i7.cjs';
-export { b as AggregateResult, c as AggregateResultItem, d as DeleteExecutor, e as DeleteResultItem, E as EdgeCreationCallback, f as EdgeCreationCallbacks, g as EdgeCreationContext, h as EdgeMode, i as IndustrialModel, M as ModelProps, j as ModelRelations, O as OnEdgeCreation, k as QueryResult, l as QueryResultItem, m as QuerySelect, n as UpsertNode, o as UpsertOptions, p as UpsertProperties, q as UpsertResult, r as UpsertResultItem } from './types-2jjbs2i7.cjs';
+import { D as DataModelId, I as IndustrialModelClientOptions, Q as QueryExecutor, A as AggregateExecutor, U as UpsertExecutor, F as FilesExecutor, a as DatapointsExecutor, N as NodeId, b as DeleteResult } from './types-BrD2jPB-.cjs';
+export { c as AggregateResult, d as AggregateResultItem, e as DatapointAggregate, f as DatapointSeriesResult, g as DatapointsDeleteRange, h as DatapointsInsertItem, i as DatapointsLatestOptions, j as DatapointsLatestSeries, k as DatapointsResult, l as DatapointsRetrieveOptions, m as DeleteExecutor, n as DeleteResultItem, E as EdgeCreationCallback, o as EdgeCreationCallbacks, p as EdgeCreationContext, q as EdgeMode, r as FileDownloadUrl, s as FileUploadInfo, t as FileUploadResult, u as IndustrialModel, M as ModelProps, v as ModelRelations, O as OnEdgeCreation, w as QueryResult, x as QueryResultItem, y as QuerySelect, R as RawDatapoint, z as UpsertNode, B as UpsertOptions, C as UpsertProperties, G as UpsertResult, H as UpsertResultItem } from './types-BrD2jPB-.cjs';
 
 declare class IndustrialModelClient {
     private readonly cognite;
@@ -9,12 +9,17 @@ declare class IndustrialModelClient {
     private readonly upsertMapper;
     private readonly aggregateResultMapper;
     private readonly resultMapper;
+    private readonly datapointsMapper;
+    private readonly filesMapper;
+    private readonly deleteValidator;
     private readonly resultValidator;
     private readonly validateResults;
     constructor(client: CogniteClient, dataModelId: DataModelId, options?: IndustrialModelClientOptions);
     query<TModel>(): QueryExecutor<TModel>;
     aggregate<TModel>(): AggregateExecutor<TModel>;
     upsert<TModel>(): UpsertExecutor<TModel>;
+    readonly files: FilesExecutor;
+    readonly datapoints: DatapointsExecutor;
     delete<TItem extends NodeId>(items: TItem[]): Promise<DeleteResult>;
     private upsertInternal;
     private applyInstancesInChunks;
@@ -23,4 +28,4 @@ declare class IndustrialModelClient {
     private queryDependenciesPages;
 }
 
-export { DataModelId, DeleteResult, IndustrialModelClient, IndustrialModelClientOptions, NodeId };
+export { DataModelId, DatapointsExecutor, DeleteResult, FilesExecutor, IndustrialModelClient, IndustrialModelClientOptions, NodeId };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { CogniteClient } from '@cognite/sdk';
-import { D as DataModelId, I as IndustrialModelClientOptions, Q as QueryExecutor, A as AggregateExecutor, U as UpsertExecutor, N as NodeId, a as DeleteResult } from './types-2jjbs2i7.js';
-export { b as AggregateResult, c as AggregateResultItem, d as DeleteExecutor, e as DeleteResultItem, E as EdgeCreationCallback, f as EdgeCreationCallbacks, g as EdgeCreationContext, h as EdgeMode, i as IndustrialModel, M as ModelProps, j as ModelRelations, O as OnEdgeCreation, k as QueryResult, l as QueryResultItem, m as QuerySelect, n as UpsertNode, o as UpsertOptions, p as UpsertProperties, q as UpsertResult, r as UpsertResultItem } from './types-2jjbs2i7.js';
+import { D as DataModelId, I as IndustrialModelClientOptions, Q as QueryExecutor, A as AggregateExecutor, U as UpsertExecutor, F as FilesExecutor, a as DatapointsExecutor, N as NodeId, b as DeleteResult } from './types-BrD2jPB-.js';
+export { c as AggregateResult, d as AggregateResultItem, e as DatapointAggregate, f as DatapointSeriesResult, g as DatapointsDeleteRange, h as DatapointsInsertItem, i as DatapointsLatestOptions, j as DatapointsLatestSeries, k as DatapointsResult, l as DatapointsRetrieveOptions, m as DeleteExecutor, n as DeleteResultItem, E as EdgeCreationCallback, o as EdgeCreationCallbacks, p as EdgeCreationContext, q as EdgeMode, r as FileDownloadUrl, s as FileUploadInfo, t as FileUploadResult, u as IndustrialModel, M as ModelProps, v as ModelRelations, O as OnEdgeCreation, w as QueryResult, x as QueryResultItem, y as QuerySelect, R as RawDatapoint, z as UpsertNode, B as UpsertOptions, C as UpsertProperties, G as UpsertResult, H as UpsertResultItem } from './types-BrD2jPB-.js';
 
 declare class IndustrialModelClient {
     private readonly cognite;
@@ -9,12 +9,17 @@ declare class IndustrialModelClient {
     private readonly upsertMapper;
     private readonly aggregateResultMapper;
     private readonly resultMapper;
+    private readonly datapointsMapper;
+    private readonly filesMapper;
+    private readonly deleteValidator;
     private readonly resultValidator;
     private readonly validateResults;
     constructor(client: CogniteClient, dataModelId: DataModelId, options?: IndustrialModelClientOptions);
     query<TModel>(): QueryExecutor<TModel>;
     aggregate<TModel>(): AggregateExecutor<TModel>;
     upsert<TModel>(): UpsertExecutor<TModel>;
+    readonly files: FilesExecutor;
+    readonly datapoints: DatapointsExecutor;
     delete<TItem extends NodeId>(items: TItem[]): Promise<DeleteResult>;
     private upsertInternal;
     private applyInstancesInChunks;
@@ -23,4 +28,4 @@ declare class IndustrialModelClient {
     private queryDependenciesPages;
 }
 
-export { DataModelId, DeleteResult, IndustrialModelClient, IndustrialModelClientOptions, NodeId };
+export { DataModelId, DatapointsExecutor, DeleteResult, FilesExecutor, IndustrialModelClient, IndustrialModelClientOptions, NodeId };

package/dist/index.js

@@ -48,7 +48,92 @@ var CogniteSdkAdapter = class {
       items: response.items
     };
   }
+  async retrieveDatapoints(options) {
+    const { items, ...rest } = options;
+    const sdkItems = items.map(({ space, externalId, ...itemRest }) => ({
+      ...itemRest,
+      instanceId: { space, externalId }
+    }));
+    const response = await this.client.datapoints.retrieve({
+      ...rest,
+      items: sdkItems
+    });
+    return { items: response.map(mapDatapointResult) };
+  }
+  async retrieveLatestDatapoints(items, options) {
+    const sdkItems = items.map(({ space, externalId, before }) => ({
+      instanceId: { space, externalId },
+      ...before !== void 0 ? { before } : {}
+    }));
+    const response = await this.client.datapoints.retrieveLatest(
+      sdkItems,
+      options
+    );
+    return { items: response.map(mapDatapointResult) };
+  }
+  async insertDatapoints(items) {
+    const sdkItems = items.map(({ space, externalId, datapoints }) => ({
+      instanceId: { space, externalId },
+      datapoints
+    }));
+    await this.client.datapoints.insert(
+      sdkItems
+    );
+  }
+  async deleteDatapoints(items) {
+    const sdkItems = items.map(({ space, externalId, inclusiveBegin, exclusiveEnd }) => ({
+      instanceId: { space, externalId },
+      inclusiveBegin,
+      ...exclusiveEnd !== void 0 ? { exclusiveEnd } : {}
+    }));
+    await this.client.datapoints.delete(
+      sdkItems
+    );
+  }
+  async uploadFile(fileInfo, content) {
+    const { instanceId, ...rest } = fileInfo;
+    const response = await this.client.files.upload(
+      { ...rest, instanceId },
+      content,
+      false,
+      content !== void 0
+    );
+    return mapFileResult(response);
+  }
+  async getFileDownloadUrls(ids) {
+    const response = await this.client.files.getDownloadUrls(
+      ids
+    );
+    return response.map((item) => ({
+      ...item.instanceId !== void 0 ? { instanceId: item.instanceId } : {},
+      downloadUrl: item.downloadUrl
+    }));
+  }
 };
+function mapFileResult(item) {
+  return {
+    ...item.instanceId !== void 0 ? { instanceId: item.instanceId } : {},
+    name: item.name,
+    uploaded: item.uploaded,
+    createdTime: item.createdTime,
+    lastUpdatedTime: item.lastUpdatedTime,
+    ...item.uploadedTime !== void 0 ? { uploadedTime: item.uploadedTime } : {},
+    ...item.mimeType !== void 0 ? { mimeType: item.mimeType } : {},
+    ...item.directory !== void 0 ? { directory: item.directory } : {},
+    ...item.source !== void 0 ? { source: item.source } : {},
+    ...item.uploadUrl !== void 0 ? { uploadUrl: item.uploadUrl } : {}
+  };
+}
+function mapDatapointResult(item) {
+  return {
+    ...item.instanceId?.space !== void 0 ? { space: item.instanceId.space } : {},
+    ...item.instanceId?.externalId !== void 0 ? { externalId: item.instanceId.externalId } : {},
+    isString: item.isString ?? false,
+    ...item.unit !== void 0 ? { unit: item.unit } : {},
+    datapoints: item.datapoints ?? [],
+    ...item.nextCursor !== void 0 ? { nextCursor: item.nextCursor } : {}
+  };
+}
 
 // src/constants.ts
 var NESTED_SEP = "|";
@@ -59,6 +144,15 @@ var MAX_DEPENDENCY_DEPTH = 3;
 var AGGREGATE_LIMIT = 1e3;
 var MAX_GROUP_BY = 5;
 
+// src/utils/array.ts
+function chunks(items, size) {
+  const result = [];
+  for (let index = 0; index < items.length; index += size) {
+    result.push(items.slice(index, index + size));
+  }
+  return result;
+}
+
 // src/utils/query.ts
 function mapNodesAndEdges(queryResult, _query) {
   return queryResult.items;
@@ -715,6 +809,63 @@ ${errors.map((error) => `- ${error}`).join("\n")}`
     return [];
   }
 };
+var dateSchema2 = z.date();
+var nodeIdSchema2 = z.object({ space: z.string(), externalId: z.string() }).loose();
+var retrieveOptionsSchema = z.object({
+  timeSeries: z.array(nodeIdSchema2),
+  start: dateSchema2.optional(),
+  end: dateSchema2.optional()
+}).loose();
+var deleteRangeSchema = z.object({
+  timeSeries: z.object({ space: z.string(), externalId: z.string() }).loose(),
+  start: dateSchema2,
+  end: dateSchema2.optional()
+}).loose();
+function formatIssues(error, prefix) {
+  return error.issues.map((issue) => {
+    const parts = prefix ? [prefix, ...issue.path] : [...issue.path];
+    return `${parts.map(String).join(".")}: ${issue.message}`;
+  });
+}
+var DatapointsValidator = class {
+  validateRetrieve(options) {
+    const result = retrieveOptionsSchema.safeParse(options);
+    if (!result.success) {
+      const messages = formatIssues(result.error);
+      throw new Error(`Invalid datapoints options:
+- ${messages.join("\n- ")}`);
+    }
+  }
+  validateDelete(ranges) {
+    const result = z.array(deleteRangeSchema).safeParse(ranges);
+    if (!result.success) {
+      const messages = formatIssues(result.error, "ranges");
+      throw new Error(`Invalid datapoints options:
+- ${messages.join("\n- ")}`);
+    }
+  }
+};
+var nodeIdSchema3 = z.object({
+  space: z.string().min(1),
+  externalId: z.string().min(1)
+}).loose();
+var deleteItemsSchema = z.array(nodeIdSchema3);
+function formatIssues2(error, prefix) {
+  return error.issues.map((issue) => {
+    const parts = [prefix, ...issue.path];
+    return `${parts.map(String).join(".")}: ${issue.message}`;
+  });
+}
+var DeleteValidator = class {
+  validateItems(items) {
+    const result = deleteItemsSchema.safeParse(items);
+    if (!result.success) {
+      const messages = formatIssues2(result.error, "items");
+      throw new Error(`Invalid delete options:
+- ${messages.join("\n- ")}`);
+    }
+  }
+};
 var nodeMetadataSchema = {
   instanceType: z.literal("node").optional(),
   space: z.string(),
@@ -1118,6 +1269,178 @@ var AggregateResultMapper = class {
   }
 };
 
+// src/mappers/datapoints-mapper.ts
+var CHUNK_SIZE = 100;
+var DatapointsMapper = class {
+  constructor(cognite) {
+    this.cognite = cognite;
+    this.validator = new DatapointsValidator();
+  }
+  async retrieve(options) {
+    this.validator.validateRetrieve(options);
+    const cogniteOptions = this.toCogniteOptions(options);
+    const allPages = options.limit === -1;
+    if (!allPages) {
+      const result = await this.cognite.retrieveDatapoints(cogniteOptions);
+      return this.mapResult(result.items, cogniteOptions.items, options.aggregate);
+    }
+    const accumulated = /* @__PURE__ */ new Map();
+    const itemByKey = new Map(cogniteOptions.items.map((item) => [this.toKey(item), item]));
+    let currentItems = cogniteOptions.items;
+    while (currentItems.length > 0) {
+      const result = await this.cognite.retrieveDatapoints({
+        ...cogniteOptions,
+        items: currentItems
+      });
+      const nextItems = [];
+      for (const resultItem of result.items) {
+        const key = this.toKey(resultItem);
+        let acc = accumulated.get(key);
+        if (!acc) {
+          acc = { ...resultItem, datapoints: [] };
+          accumulated.set(key, acc);
+        }
+        acc.datapoints.push(...resultItem.datapoints);
+        if (resultItem.nextCursor) {
+          acc.nextCursor = resultItem.nextCursor;
+        } else {
+          delete acc.nextCursor;
+        }
+        if (resultItem.nextCursor) {
+          const original = itemByKey.get(key);
+          nextItems.push({
+            ...original,
+            space: resultItem.space ?? original?.space ?? "",
+            externalId: resultItem.externalId ?? original?.externalId ?? "",
+            cursor: resultItem.nextCursor
+          });
+        }
+      }
+      currentItems = nextItems;
+    }
+    return this.mapResult(
+      Array.from(accumulated.values()),
+      cogniteOptions.items,
+      options.aggregate
+    );
+  }
+  async retrieveLatest(options) {
+    const items = options.timeSeries.map(
+      ({ space, externalId, before }) => ({
+        space,
+        externalId,
+        ...before !== void 0 ? { before } : {}
+      })
+    );
+    const latestOptions = options.ignoreUnknownIds !== void 0 ? { ignoreUnknownIds: options.ignoreUnknownIds } : void 0;
+    const result = await this.cognite.retrieveLatestDatapoints(items, latestOptions);
+    return this.mapResult(result.items, items);
+  }
+  async insert(items) {
+    const cogniteItems = items.map(({ timeSeries, datapoints }) => ({
+      space: timeSeries.space,
+      externalId: timeSeries.externalId,
+      datapoints
+    }));
+    for (const chunk of chunks(cogniteItems, CHUNK_SIZE)) {
+      await this.cognite.insertDatapoints(chunk);
+    }
+  }
+  async delete(ranges) {
+    this.validator.validateDelete(ranges);
+    const cogniteItems = ranges.map(({ timeSeries, start, end }) => ({
+      space: timeSeries.space,
+      externalId: timeSeries.externalId,
+      inclusiveBegin: start,
+      ...end !== void 0 ? { exclusiveEnd: end } : {}
+    }));
+    for (const chunk of chunks(cogniteItems, CHUNK_SIZE)) {
+      await this.cognite.deleteDatapoints(chunk);
+    }
+  }
+  toKey(item) {
+    return `${item.space ?? ""}:${item.externalId ?? ""}`;
+  }
+  toCogniteOptions(options) {
+    const { timeSeries, aggregate, ...rest } = options;
+    return {
+      ...rest,
+      ...aggregate !== void 0 ? { aggregates: [aggregate] } : {},
+      items: timeSeries.map(({ space, externalId }) => ({ space, externalId }))
+    };
+  }
+  mapResult(items, requestedItems, aggregate) {
+    const requestedByKey = new Map(requestedItems.map((item) => [this.toKey(item), item]));
+    const mappedItems = items.filter((item) => !item.isString).map((item) => {
+      const requested = requestedByKey.get(this.toKey(item));
+      const datapoints = aggregate !== void 0 ? item.datapoints.map((dp) => ({
+        timestamp: dp.timestamp,
+        value: dp[aggregate] ?? 0
+      })) : item.datapoints;
+      return {
+        timeSeries: {
+          space: item.space ?? requested?.space ?? "",
+          externalId: item.externalId ?? requested?.externalId ?? ""
+        },
+        ...item.unit !== void 0 ? { unit: item.unit } : {},
+        datapoints,
+        cursor: item.nextCursor ?? null
+      };
+    });
+    return { items: mappedItems };
+  }
+};
+
+// src/mappers/files-mapper.ts
+var FilesMapper = class {
+  constructor(cognite) {
+    this.cognite = cognite;
+  }
+  async upload(fileInfo, content) {
+    const { space, externalId, ...rest } = fileInfo;
+    const result = await this.cognite.uploadFile(
+      { instanceId: { space, externalId }, ...rest },
+      content
+    );
+    return this.mapUploadResult(result, { space, externalId });
+  }
+  async getDownloadUrls(nodeIds) {
+    if (nodeIds.length === 0) return [];
+    const ids = nodeIds.map(({ space, externalId }) => ({ instanceId: { space, externalId } }));
+    const result = await this.cognite.getFileDownloadUrls(ids);
+    return result.map(
+      (item, i) => this.mapDownloadUrl(item, nodeIds[i] ?? { space: "", externalId: "" })
+    );
+  }
+  toNodeId(item, fallback) {
+    return {
+      space: item.instanceId?.space ?? fallback.space,
+      externalId: item.instanceId?.externalId ?? fallback.externalId
+    };
+  }
+  mapUploadResult(item, fallback) {
+    const nodeId = this.toNodeId(item, fallback);
+    return {
+      ...nodeId,
+      name: item.name,
+      uploaded: item.uploaded,
+      createdTime: item.createdTime,
+      lastUpdatedTime: item.lastUpdatedTime,
+      ...item.uploadedTime !== void 0 ? { uploadedTime: item.uploadedTime } : {},
+      ...item.mimeType !== void 0 ? { mimeType: item.mimeType } : {},
+      ...item.directory !== void 0 ? { directory: item.directory } : {},
+      ...item.source !== void 0 ? { source: item.source } : {},
+      ...item.uploadUrl !== void 0 ? { uploadUrl: item.uploadUrl } : {}
+    };
+  }
+  mapDownloadUrl(item, fallback) {
+    return {
+      ...this.toNodeId(item, fallback),
+      downloadUrl: item.downloadUrl
+    };
+  }
+};
+
 // src/mappers/sort-mapper.ts
 var SortMapper = class {
   map(sort, rootView) {
@@ -1707,6 +2030,17 @@ var ViewMapper = class {
 var APPLY_ITEM_LIMIT = 1e3;
 var IndustrialModelClient = class {
   constructor(client, dataModelId, options = {}) {
+    this.deleteValidator = new DeleteValidator();
+    this.files = {
+      upload: (fileInfo, content) => this.filesMapper.upload(fileInfo, content),
+      getDownloadUrls: (nodeIds) => this.filesMapper.getDownloadUrls(nodeIds)
+    };
+    this.datapoints = {
+      retrieve: (options) => this.datapointsMapper.retrieve(options),
+      latest: (options) => this.datapointsMapper.retrieveLatest(options),
+      insert: (items) => this.datapointsMapper.insert(items),
+      delete: (ranges) => this.datapointsMapper.delete(ranges)
+    };
     const cognite = createCogniteAdapter(client);
     this.cognite = cognite;
     const viewMapper = new ViewMapper(cognite, dataModelId);
@@ -1715,6 +2049,8 @@ var IndustrialModelClient = class {
     this.upsertMapper = new UpsertMapper(viewMapper, cognite);
     this.aggregateResultMapper = new AggregateResultMapper();
     this.resultMapper = new QueryResultMapper(viewMapper);
+    this.datapointsMapper = new DatapointsMapper(cognite);
+    this.filesMapper = new FilesMapper(cognite);
     this.resultValidator = new QueryResultValidator(viewMapper);
     this.validateResults = options.validateResults ?? false;
   }
@@ -1731,14 +2067,12 @@ var IndustrialModelClient = class {
     return execute;
   }
   async delete(items) {
-    const deleteItems = items.map((item) => {
-      assertNodeId2(item);
-      return {
-        instanceType: "node",
-        space: item.space,
-        externalId: item.externalId
-      };
-    });
+    this.deleteValidator.validateItems(items);
+    const deleteItems = items.map((item) => ({
+      instanceType: "node",
+      space: item.space,
+      externalId: item.externalId
+    }));
     const response = await this.applyInstancesInChunks({
       items: [],
       delete: deleteItems
@@ -1830,18 +2164,6 @@ var IndustrialModelClient = class {
     return appendNodesAndEdges(result, nestedResults);
   }
 };
-function chunks(items, size) {
-  const result = [];
-  for (let index = 0; index < items.length; index += size) {
-    result.push(items.slice(index, index + size));
-  }
-  return result;
-}
-function assertNodeId2(value) {
-  if (value == null || typeof value !== "object" || Array.isArray(value) || typeof value.space !== "string" || value.space?.length === 0 || typeof value.externalId !== "string" || value.externalId?.length === 0) {
-    throw new Error("Invalid delete options:\n- items: expected NodeId values");
-  }
-}
 
 export { IndustrialModelClient };
 //# sourceMappingURL=index.js.map