feat: renamed interfaces (#388)

BREAKING CHANGE:

Interfaces renamed:
- AzureADConfigurationDTO -> AzureADConfiguration
- DatapointsGetAggregateDatapoint -> DatapointsAggregates
- DatapointsGetDatapoint -> Datapoints
- DatapointsGetDoubleDatapoint -> DoubleDatapoints
- DatapointsGetStringDatapoint -> StringDatapoints
- DatapointsInsertProperties -> ExternalDatapoints
- DatapointsPostDatapoint -> ExternalDatapointsQuery
- ExternalFilesMetadata -> ExternalFileInfo
- FilesMetadata -> FileInfo
- GetAggregateDatapoint -> DatapointAggregate
- GetDatapointMetadata -> DatapointInfo
- GetDoubleDatapoint -> DoubleDatapoint
- GetStringDatapoint -> StringDatapoint
- GetTimeSeriesMetadataDTO -> Timeseries
- OAuth2ConfigurationDTO -> OAuth2Configuration
- PostDatapoint -> ExternalDatapoint
- PostTimeSeriesMetadataDTO -> ExternalTimeseries
- TimeSeriesSearchDTO -> TimeseriesSearchFilter
- TimeseriesFilter -> TimeseriesFilterQuery (structure changed)
- TimeseriesFilterProps -> TimeseriesFilter
- UploadFileMetadataResponse -> FileUploadResponse

Removed interfaces:
- Filter (use TimeseriesFilter)
- Search (use TimeseriesSearch)

Changed:
- `timeseries.list()` signature is now consistent with other resource types

packages/stable/src/__tests__/api/asset.int.spec.ts

@@ -1,10 +1,10 @@
 // Copyright 2020 Cognite AS
 
-import { Asset } from '../../api/classes/asset';
+import { AssetImpl } from '../../api/classes/asset';
 import { EventsAPI } from '../../api/events/eventsApi';
 import { TimeSeriesAPI } from '../../api/timeSeries/timeSeriesApi';
 import CogniteClient from '../../cogniteClient';
-import { CogniteEvent, GetTimeSeriesMetadataDTO } from '../../types';
+import { CogniteEvent, Timeseries } from '../../types';
 import {
   randomInt,
   runTestWithRetryWhenFailing,
@@ -37,7 +37,7 @@ describe('Asset', () => {
         parentExternalId: newRoot.externalId,
       };
       const createdAssets = await client.assets.create([newRoot, newChild]);
-      expect(await createdAssets[1].parent()).toBeInstanceOf(Asset);
+      expect(await createdAssets[1].parent()).toBeInstanceOf(AssetImpl);
       expect(await createdAssets[0].parent()).toBe(null);
       await client.assets.delete([{ id: createdAssets[0].id }], {
         recursive: true,
@@ -127,7 +127,7 @@ describe('Asset', () => {
         : { assetIds: [createdAssets[0].id] };
     const resourceList = new Array(5).fill(content);
     const resources = await api.create(resourceList);
-    let fetchedResource: (GetTimeSeriesMetadataDTO | CogniteEvent)[];
+    let fetchedResource: (Timeseries | CogniteEvent)[];
     await runTestWithRetryWhenFailing(async () => {
       if (api instanceof TimeSeriesAPI) {
         fetchedResource = await createdAssets[0].timeSeries();

packages/stable/src/__tests__/api/asset.unit.spec.ts

@@ -1,6 +1,6 @@
 // Copyright 2020 Cognite AS
 import * as nock from 'nock';
-import { Asset } from '../../api/classes/asset';
+import { AssetImpl } from '../../api/classes/asset';
 import CogniteClient from '../../cogniteClient';
 import { mockBaseUrl, randomInt, setupMockableClient } from '../testUtils';
 
@@ -48,7 +48,7 @@ describe('Asset class unit test', () => {
     const createdAssets = await client.assets.create([newRoot, ...childArray]);
     const children = await createdAssets[0].children();
     expect(children.length).toBe(102);
-    expect(children[0]).toBeInstanceOf(Asset);
+    expect(children[0]).toBeInstanceOf(AssetImpl);
     expect(children[0].name).toEqual(childArray[0].name);
   });
 });

packages/stable/src/__tests__/api/assets.int.spec.ts

@@ -1,7 +1,7 @@
 // Copyright 2020 Cognite AS
 
 import { CogniteError, CogniteMultiError } from '@cognite/sdk-core';
-import { Asset as AssetClass } from '../../api/classes/asset';
+import { AssetImpl } from '../../api/classes/asset';
 import CogniteClient from '../../cogniteClient';
 import { Asset } from '../../types';
 import {
@@ -205,18 +205,22 @@ describe('Asset integration test', () => {
   });
 
   test('list', async () => {
-    const response = await client.assets.list({ limit: 1 });
-    expect(response.nextCursor).toBeDefined();
-    expect(response.items).toBeDefined();
-    expect(response.items[0].id).toBeDefined();
-    expect(response.items[0]).toBeInstanceOf(AssetClass);
+    const { nextCursor, items } = await client.assets.list({
+      limit: 1,
+      partition: '1/10',
+    });
+    expect(nextCursor).toBeDefined();
+    expect(items).toBeDefined();
+    expect(items[0].id).toBeDefined();
+    expect(items[0]).toBeInstanceOf(AssetImpl);
+    expect(items.length).toBe(1);
   });
 
   test('list.next', async () => {
     const response = await client.assets.list({ limit: 1 });
     expect(response.next).toBeDefined();
     const nextPage = await response.next!();
-    expect(nextPage.items[0]).toBeInstanceOf(AssetClass);
+    expect(nextPage.items[0]).toBeInstanceOf(AssetImpl);
   });
 
   test('list with autoPaging', async () => {
@@ -322,12 +326,6 @@ describe('Asset integration test', () => {
     expect(result.length).toBe(limit);
   });
 
-  test('list partition', async () => {
-    const limit = 5;
-    const result = await client.assets.list({ partition: '1/10', limit });
-    expect(result.items.length).toBe(limit);
-  });
-
   test('delete', async () => {
     await client.assets.delete(
       [createdChild1, createdRoot1, ...createdAssets2, ...assets].map(

packages/stable/src/__tests__/api/datapoints.int.spec.ts

@@ -1,13 +1,13 @@
 // Copyright 2020 Cognite AS
 
 import CogniteClient from '../../cogniteClient';
-import { GetTimeSeriesMetadataDTO } from '../../types';
+import { Timeseries } from '../../types';
 import { setupLoggedInClient } from '../testUtils';
 
 describe('Datapoints integration test', () => {
   let client: CogniteClient;
-  let timeserie: GetTimeSeriesMetadataDTO;
-  let testTimeserieWithDatapoints: GetTimeSeriesMetadataDTO;
+  let timeserie: Timeseries;
+  let testTimeserieWithDatapoints: Timeseries;
   beforeAll(async () => {
     client = setupLoggedInClient();
     [timeserie] = await client.timeseries.create([{ name: 'tmp' }]);

packages/stable/src/__tests__/api/datasets.int.spec.ts

@@ -1,14 +1,14 @@
 // Copyright 2020 Cognite AS
 
-import { TimeSeries } from '../../api/classes/timeSeries';
+import { TimeseriesImpl } from '../../api/classes/timeSeries';
 import CogniteClient from '../../cogniteClient';
 import {
   Asset,
   CogniteEvent,
   CogniteInternalId,
   DataSet,
   DataSetFilterRequest,
-  FilesMetadata,
+  FileInfo,
   NullableSinglePatchLong,
   Sequence,
 } from '../../types';
@@ -81,7 +81,7 @@ describe('data sets integration test', () => {
   });
   describe('files data sets', () => {
     let dataSetId: CogniteInternalId;
-    let file: FilesMetadata;
+    let file: FileInfo;
 
     beforeAll(() => {
       dataSetId = datasets[0].id;
@@ -188,7 +188,7 @@ describe('data sets integration test', () => {
     });
   });
   describe('timeseries data sets', () => {
-    let timeseries: TimeSeries;
+    let timeseries: TimeseriesImpl;
     let dataSetId: CogniteInternalId;
 
     beforeAll(() => {
@@ -206,7 +206,7 @@ describe('data sets integration test', () => {
     test('list', async () => {
       await runTestWithRetryWhenFailing(async () => {
         const filteredTimeseries = await client.timeseries
-          .list(dataSetFilter(dataSetId).filter)
+          .list(dataSetFilter(dataSetId))
           .autoPagingToArray();
 
         expect(filteredTimeseries.length).toBeTruthy();

packages/stable/src/__tests__/api/events.int.spec.ts

@@ -148,20 +148,13 @@ describe('Events integration test', () => {
               max: events[0].endTime! + 1,
             },
           },
+          partition: '1/10',
           limit: 3,
         })
         .autoPagingToArray({ limit: 5 });
       expect(response.length).toBeGreaterThan(0);
     });
 
-    test('partitions', async () => {
-      const response = await client.events.list({
-        partition: '1/10',
-        limit: 10,
-      });
-      expect(response.items.length).toBeGreaterThan(0);
-    });
-
     test('to json|string', async () => {
       const response = await client.events.list({ limit: 2 });
       expect(typeof JSON.stringify(response.items)).toBe('string');

packages/stable/src/__tests__/api/files.int.spec.ts

@@ -2,9 +2,9 @@
 
 import { HttpResponseType } from '@cognite/sdk-core';
 import { readFileSync } from 'fs';
-import { Asset } from '../../api/classes/asset';
+import { AssetImpl } from '../../api/classes/asset';
 import CogniteClient from '../../cogniteClient';
-import { FilesMetadata } from '../../types';
+import { FileInfo } from '../../types';
 import { join } from 'path';
 import {
   getFileCreateArgs,
@@ -17,7 +17,7 @@ const testfile = join(__dirname, '../test3dFile.fbx');
 
 describe('Files integration test', () => {
   let client: CogniteClient;
-  let asset: Asset;
+  let asset: AssetImpl;
   beforeAll(async () => {
     client = setupLoggedInClient();
     [asset] = await client.assets.create([
@@ -38,7 +38,7 @@ describe('Files integration test', () => {
     sourceCreatedTime,
   } = getFileCreateArgs();
 
-  let file: FilesMetadata;
+  let file: FileInfo;
 
   test('create', async () => {
     file = await client.files.upload(localFileMeta, fileContent, false, true);
@@ -149,7 +149,7 @@ describe('Files integration test', () => {
       mimeType: 'application/octet-stream',
     };
     const fileContentBinary = readFileSync(testfile);
-    let binaryFile: FilesMetadata;
+    let binaryFile: FileInfo;
 
     test('create', async () => {
       binaryFile = await client.files.upload(

packages/stable/src/__tests__/api/revisions3D.int.spec.ts

@@ -7,7 +7,7 @@ import {
   AssetMapping3D,
   CreateAssetMapping3D,
   CreateRevision3D,
-  FilesMetadata,
+  FileInfo,
   Model3D,
   Node3D,
   Revision3D,
@@ -34,7 +34,7 @@ describeIfCondition(
     let client: CogniteClient;
 
     let revisions: Revision3D[];
-    let file: FilesMetadata;
+    let file: FileInfo;
     let model: Model3D;
     let assets: Asset[];
     let assetMappings: AssetMapping3D[];

packages/stable/src/__tests__/api/sequences.int.spec.ts

@@ -1,7 +1,7 @@
 // Copyright 2020 Cognite AS
 
 import * as nock from 'nock';
-import { Asset } from '../../api/classes/asset';
+import { Asset } from '../../types';
 import CogniteClient from '../../cogniteClient';
 import {
   ExternalSequence,

packages/stable/src/__tests__/api/timeSeriesList.unit.spec.ts

@@ -3,17 +3,14 @@ import { uniqBy } from 'lodash';
 import * as nock from 'nock';
 import { TimeSeriesList } from '../../api/classes/timeSeriesList';
 import CogniteClient from '../../cogniteClient';
-import {
-  DatapointsPostDatapoint,
-  PostTimeSeriesMetadataDTO,
-} from '../../types';
+import { ExternalDatapoints, ExternalTimeseries } from '../../types';
 import { mockBaseUrl, randomInt, setupMockableClient } from '../testUtils';
 
 describe('TimeSeriesList class unit test', async () => {
   let client: CogniteClient;
   let createdTimeSeries: TimeSeriesList;
-  let datapointArray: DatapointsPostDatapoint[] = [];
-  let timeseriesArray: PostTimeSeriesMetadataDTO[] = [];
+  let datapointArray: ExternalDatapoints[] = [];
+  let timeseriesArray: ExternalTimeseries[] = [];
   beforeAll(async () => {
     client = setupMockableClient();
     nock.cleanAll();

packages/stable/src/__tests__/api/timeSeriesObject.unit.spec.ts

@@ -1,20 +1,17 @@
 // Copyright 2020 Cognite AS
 import * as nock from 'nock';
-import { Asset } from '../../api/classes/asset';
+import { AssetImpl } from '../../api/classes/asset';
 import { TimeSeriesList } from '../../api/classes/timeSeriesList';
 import CogniteClient from '../../cogniteClient';
-import {
-  DatapointsPostDatapoint,
-  PostTimeSeriesMetadataDTO,
-} from '../../types';
+import { ExternalDatapoints, ExternalTimeseries } from '../../types';
 import { mockBaseUrl, randomInt, setupMockableClient } from '../testUtils';
 
 describe('TimeSeries class unit test', () => {
   let client: CogniteClient;
-  let newTimeSeries: PostTimeSeriesMetadataDTO;
+  let newTimeSeries: ExternalTimeseries;
   let createdTimeSeries: TimeSeriesList;
-  let timeSeriesWithAssetId: PostTimeSeriesMetadataDTO;
-  let datapointArray: DatapointsPostDatapoint[] = [];
+  let timeSeriesWithAssetId: ExternalTimeseries;
+  let datapointArray: ExternalDatapoints[] = [];
   beforeAll(() => {
     client = setupMockableClient();
     nock.cleanAll();
@@ -69,7 +66,7 @@ describe('TimeSeries class unit test', () => {
       });
     const assetFromTimeseries = await createdTimeSeries[1].getAsset();
     expect(assetFromTimeseries).not.toBe(null);
-    expect(assetFromTimeseries).toBeInstanceOf(Asset);
+    expect(assetFromTimeseries).toBeInstanceOf(AssetImpl);
   });
 
   test('delete', async () => {

packages/stable/src/__tests__/api/timeseries.int.spec.ts

@@ -1,7 +1,7 @@
 // Copyright 2020 Cognite AS
 
 import CogniteClient from '../../cogniteClient';
-import { Asset, GetTimeSeriesMetadataDTO } from '../../types';
+import { Asset, Timeseries } from '../../types';
 import {
   randomInt,
   runTestWithRetryWhenFailing,
@@ -37,7 +37,7 @@ describe('Timeseries integration test', () => {
     },
   ];
 
-  let createdTimeseries: GetTimeSeriesMetadataDTO[];
+  let createdTimeseries: Timeseries[];
 
   test('create', async () => {
     createdTimeseries = await client.timeseries.create(timeseries);
@@ -86,7 +86,7 @@ describe('Timeseries integration test', () => {
   test('list from assetIds', async () => {
     await runTestWithRetryWhenFailing(async () => {
       const result = await client.timeseries
-        .list({ assetIds: [asset.id] })
+        .list({ filter: { assetIds: [asset.id] } })
         .autoPagingToArray({ limit: Infinity });
       expect(result.length).toBe(1);
       expect(result[0].id).toBe(createdTimeseries[0].id);
@@ -107,37 +107,34 @@ describe('Timeseries integration test', () => {
     const { isString, name, unit } = timeseries[1];
     const { items } = await client.timeseries.list({
       partition: '1/2',
-      isString,
-      name,
-      unit,
+      filter: {
+        isString,
+        name,
+        unit,
+      },
     });
     expect(items.length).toBeGreaterThan(0);
   });
 
   test('list', async () => {
-    await client.timeseries
-      .list({ includeMetadata: false })
-      .autoPagingToArray({ limit: 100 });
-  });
-
-  test('list partition', async () => {
-    const items = await client.timeseries
-      .list({ includeMetadata: false, partition: '1/10' })
-      .autoPagingToArray({ limit: 100 });
+    const { items } = await client.timeseries.list({
+      limit: 1,
+      partition: '1/10',
+    });
     expect(items.length).toBeGreaterThan(0);
   });
 
   test('list with assetExternalIds', async () => {
     const { items } = await client.timeseries.list({
-      assetExternalIds: [asset.externalId!],
+      filter: { assetExternalIds: [asset.externalId!] },
       limit: 1,
     });
     expect(items[0].id).toBe(createdTimeseries[0].id);
   });
 
   test('list with assetSubtreeIds', async () => {
     const { items } = await client.timeseries.list({
-      assetSubtreeIds: [{ id: asset.id }],
+      filter: { assetSubtreeIds: [{ id: asset.id }] },
       limit: 1,
     });
     expect(items[0].id).toBe(createdTimeseries[0].id);