industrial-model 0.7.0 → 0.8.0

package/dist/cognite-core/index.d.cts

@@ -1,5 +1,5 @@
 import { CogniteClient } from '@cognite/sdk';
-import { i as IndustrialModel, N as NodeId, s as AggregateOptions, b as AggregateResult, c as AggregateResultItem, m as QuerySelect, t as QueryOptions, k as QueryResult, l as QueryResultItem, o as UpsertOptions, q as UpsertResult, I as IndustrialModelClientOptions, a as DeleteResult } from '../types-2jjbs2i7.cjs';
+import { u as IndustrialModel, N as NodeId, J as AggregateOptions, c as AggregateResult, d as AggregateResultItem, y as QuerySelect, K as QueryOptions, w as QueryResult, x as QueryResultItem, B as UpsertOptions, G as UpsertResult, I as IndustrialModelClientOptions, b as DeleteResult, a as DatapointsExecutor } from '../types-BrD2jPB-.cjs';
 
 type CogniteCoreViewExternalId = "CogniteDescribable" | "CogniteSourceable" | "CogniteSourceSystem" | "CogniteSchedulable" | "CogniteVisualizable" | "Cognite3DTransformation" | "CogniteCubeMap" | "Cognite3DObject" | "Cognite3DModel" | "CogniteCADModel" | "Cognite3DRevision" | "CognitePointCloudModel" | "Cognite360ImageModel" | "CogniteCADRevision" | "CognitePointCloudRevision" | "Cognite360ImageCollection" | "CogniteCADNode" | "CognitePointCloudVolume" | "Cognite360Image" | "Cognite360ImageStation" | "Cognite360ImageAnnotation" | "CogniteAsset" | "CogniteAssetClass" | "CogniteAssetType" | "CogniteEquipment" | "CogniteEquipmentType" | "CogniteFile" | "CogniteFileCategory" | "CogniteActivity" | "CogniteTimeSeries" | "CogniteAnnotation" | "CogniteDiagramAnnotation" | "CogniteUnit";
 type CogniteDescribable = IndustrialModel<{
@@ -530,6 +530,7 @@ declare class CogniteCoreClient {
     aggregate<TView extends CogniteCoreViewExternalId>(viewExternalId: TView): CogniteCoreAggregateExecutor<TView>;
     upsert<TView extends CogniteCoreViewExternalId>(viewExternalId: TView): CogniteCoreUpsertExecutor<TView>;
     delete<TItem extends NodeId>(items: TItem[]): Promise<DeleteResult>;
+    get datapoints(): DatapointsExecutor;
 }
 
 export { COGNITE_CORE_DATA_MODEL, type Cognite360Image, type Cognite360ImageAnnotation, type Cognite360ImageCollection, type Cognite360ImageModel, type Cognite360ImageStation, type Cognite3DModel, type Cognite3DObject, type Cognite3DRevision, type Cognite3DTransformation, type CogniteActivity, type CogniteAnnotation, type CogniteAsset, type CogniteAssetClass, type CogniteAssetType, type CogniteCADModel, type CogniteCADNode, type CogniteCADRevision, type CogniteCoreAggregateExecutor, CogniteCoreClient, type CogniteCoreModel, type CogniteCoreModelByView, type CogniteCoreQueryExecutor, type CogniteCoreUpsertExecutor, type CogniteCoreViewExternalId, type CogniteCubeMap, type CogniteDescribable, type CogniteDiagramAnnotation, type CogniteEquipment, type CogniteEquipmentType, type CogniteFile, type CogniteFileCategory, type CognitePointCloudModel, type CognitePointCloudRevision, type CognitePointCloudVolume, type CogniteSchedulable, type CogniteSourceSystem, type CogniteSourceable, type CogniteTimeSeries, type CogniteUnit, type CogniteVisualizable };

package/dist/cognite-core/index.d.ts

@@ -1,5 +1,5 @@
 import { CogniteClient } from '@cognite/sdk';
-import { i as IndustrialModel, N as NodeId, s as AggregateOptions, b as AggregateResult, c as AggregateResultItem, m as QuerySelect, t as QueryOptions, k as QueryResult, l as QueryResultItem, o as UpsertOptions, q as UpsertResult, I as IndustrialModelClientOptions, a as DeleteResult } from '../types-2jjbs2i7.js';
+import { u as IndustrialModel, N as NodeId, J as AggregateOptions, c as AggregateResult, d as AggregateResultItem, y as QuerySelect, K as QueryOptions, w as QueryResult, x as QueryResultItem, B as UpsertOptions, G as UpsertResult, I as IndustrialModelClientOptions, b as DeleteResult, a as DatapointsExecutor } from '../types-BrD2jPB-.js';
 
 type CogniteCoreViewExternalId = "CogniteDescribable" | "CogniteSourceable" | "CogniteSourceSystem" | "CogniteSchedulable" | "CogniteVisualizable" | "Cognite3DTransformation" | "CogniteCubeMap" | "Cognite3DObject" | "Cognite3DModel" | "CogniteCADModel" | "Cognite3DRevision" | "CognitePointCloudModel" | "Cognite360ImageModel" | "CogniteCADRevision" | "CognitePointCloudRevision" | "Cognite360ImageCollection" | "CogniteCADNode" | "CognitePointCloudVolume" | "Cognite360Image" | "Cognite360ImageStation" | "Cognite360ImageAnnotation" | "CogniteAsset" | "CogniteAssetClass" | "CogniteAssetType" | "CogniteEquipment" | "CogniteEquipmentType" | "CogniteFile" | "CogniteFileCategory" | "CogniteActivity" | "CogniteTimeSeries" | "CogniteAnnotation" | "CogniteDiagramAnnotation" | "CogniteUnit";
 type CogniteDescribable = IndustrialModel<{
@@ -530,6 +530,7 @@ declare class CogniteCoreClient {
     aggregate<TView extends CogniteCoreViewExternalId>(viewExternalId: TView): CogniteCoreAggregateExecutor<TView>;
     upsert<TView extends CogniteCoreViewExternalId>(viewExternalId: TView): CogniteCoreUpsertExecutor<TView>;
     delete<TItem extends NodeId>(items: TItem[]): Promise<DeleteResult>;
+    get datapoints(): DatapointsExecutor;
 }
 
 export { COGNITE_CORE_DATA_MODEL, type Cognite360Image, type Cognite360ImageAnnotation, type Cognite360ImageCollection, type Cognite360ImageModel, type Cognite360ImageStation, type Cognite3DModel, type Cognite3DObject, type Cognite3DRevision, type Cognite3DTransformation, type CogniteActivity, type CogniteAnnotation, type CogniteAsset, type CogniteAssetClass, type CogniteAssetType, type CogniteCADModel, type CogniteCADNode, type CogniteCADRevision, type CogniteCoreAggregateExecutor, CogniteCoreClient, type CogniteCoreModel, type CogniteCoreModelByView, type CogniteCoreQueryExecutor, type CogniteCoreUpsertExecutor, type CogniteCoreViewExternalId, type CogniteCubeMap, type CogniteDescribable, type CogniteDiagramAnnotation, type CogniteEquipment, type CogniteEquipmentType, type CogniteFile, type CogniteFileCategory, type CognitePointCloudModel, type CognitePointCloudRevision, type CognitePointCloudVolume, type CogniteSchedulable, type CogniteSourceSystem, type CogniteSourceable, type CogniteTimeSeries, type CogniteUnit, type CogniteVisualizable };

package/dist/cognite-core/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");
-  }
-}
 
 // src/cognite-core/client.ts
 var COGNITE_CORE_DATA_MODEL = {
@@ -1872,6 +2194,9 @@ var CogniteCoreClient = class {
   delete(items) {
     return this.model.delete(items);
   }
+  get datapoints() {
+    return this.model.datapoints;
+  }
 };
 
 export { COGNITE_CORE_DATA_MODEL, CogniteCoreClient };