Convert `api.ts`, `api-implementation.ts` and `frames.ts` to ES6 modules (#5283)

This fixes ESLint errors in these files.

Set the `resolveJsonModule` setting, so that TypeScript can recognize the
`package.json` import.

cvat-core/src/api-implementation.ts

@@ -3,31 +3,30 @@
 //
 // SPDX-License-Identifier: MIT
 
-const config = require('./config').default;
+import config from './config';
 
-(() => {
+import PluginRegistry from './plugins';
-    const PluginRegistry = require('./plugins').default;
+import serverProxy from './server-proxy';
-    const serverProxy = require('./server-proxy').default;
+import lambdaManager from './lambda-manager';
-    const lambdaManager = require('./lambda-manager').default;
+import {
-    const {
     isBoolean,
     isInteger,
     isString,
     checkFilter,
     checkExclusiveFields,
     checkObjectType,
-    } = require('./common');
+} from './common';
-
+
-    const User = require('./user').default;
+import User from './user';
-    const { AnnotationFormats } = require('./annotation-formats');
+import { AnnotationFormats } from './annotation-formats';
-    const { ArgumentError } = require('./exceptions');
+import { ArgumentError } from './exceptions';
-    const { Task, Job } = require('./session');
+import { Task, Job } from './session';
-    const Project = require('./project').default;
+import Project from './project';
-    const CloudStorage = require('./cloud-storage').default;
+import CloudStorage from './cloud-storage';
-    const Organization = require('./organization').default;
+import Organization from './organization';
-    const Webhook = require('./webhook').default;
+import Webhook from './webhook';
-
+
-    function implementAPI(cvat) {
+export default function implementAPI(cvat) {
     cvat.plugins.list.implementation = PluginRegistry.list;
     cvat.plugins.register.implementation = PluginRegistry.register.bind(cvat);
 
@@ -326,6 +325,3 @@ const config = require('./config').default;
 
     return cvat;
 }
-
-    module.exports = implementAPI;
-})();

cvat-core/src/api.ts

@@ -8,34 +8,36 @@
  * @module API
  */
 
-function build() {
+import PluginRegistry from './plugins';
-    const PluginRegistry = require('./plugins').default;
+import loggerStorage from './logger-storage';
-    const loggerStorage = require('./logger-storage').default;
+import { Log } from './log';
-    const { Log } = require('./log');
+import ObjectState from './object-state';
-    const ObjectState = require('./object-state').default;
+import Statistics from './statistics';
-    const Statistics = require('./statistics').default;
+import Comment from './comment';
-    const Comment = require('./comment').default;
+import Issue from './issue';
-    const Issue = require('./issue').default;
+import { Job, Task } from './session';
-    const { Job, Task } = require('./session');
+import Project from './project';
-    const Project = require('./project').default;
+import implementProject from './project-implementation';
-    const implementProject = require('./project-implementation').default;
+import { Attribute, Label } from './labels';
-    const { Attribute, Label } = require('./labels');
+import MLModel from './ml-model';
-    const MLModel = require('./ml-model').default;
+import { FrameData } from './frames';
-    const { FrameData } = require('./frames');
+import CloudStorage from './cloud-storage';
-    const CloudStorage = require('./cloud-storage').default;
+import Organization from './organization';
-    const Organization = require('./organization').default;
+import Webhook from './webhook';
-    const Webhook = require('./webhook').default;
 
-    const enums = require('./enums');
+import * as enums from './enums';
 
-    const {
+import {
     Exception, ArgumentError, DataError, ScriptingError, PluginError, ServerError,
-    } = require('./exceptions');
+} from './exceptions';
+
+import User from './user';
+import pjson from '../package.json';
+import config from './config';
 
-    const User = require('./user').default;
+import implementAPI from './api-implementation';
-    const pjson = require('../package.json');
-    const config = require('./config').default;
 
+function build() {
     /**
      * API entrypoint
      * @namespace cvat
@@ -925,9 +927,8 @@ function build() {
     cvat.cloudStorages = Object.freeze(cvat.cloudStorages);
     cvat.organizations = Object.freeze(cvat.organizations);
 
-    const implementAPI = require('./api-implementation');
     const implemented = Object.freeze(implementAPI(cvat));
     return implemented;
 }
 
-module.exports = build();
+export default build();

cvat-core/src/frames.ts

@@ -3,12 +3,11 @@
 //
 // SPDX-License-Identifier: MIT
 
-(() => {
+import * as cvatData from 'cvat-data';
-    const cvatData = require('cvat-data');
+import { isBrowser, isNode } from 'browser-or-node';
-    const PluginRegistry = require('./plugins').default;
+import PluginRegistry from './plugins';
-    const serverProxy = require('./server-proxy').default;
+import serverProxy from './server-proxy';
-    const { isBrowser, isNode } = require('browser-or-node');
+import { Exception, ArgumentError, DataError } from './exceptions';
-    const { Exception, ArgumentError, DataError } = require('./exceptions');
 
 // This is the frames storage
 const frameDataCache = {};
@@ -18,7 +17,7 @@
  * @memberof module:API.cvat.classes
  * @hideconstructor
  */
-    class FrameData {
+export class FrameData {
     constructor({
         width,
         height,
@@ -652,7 +651,7 @@
     });
 }
 
-    async function getContextImage(jobID, frame) {
+export async function getContextImage(jobID, frame) {
     if (frameDataCache[jobID].frameBuffer.isContextImageAvailable(frame)) {
         return frameDataCache[jobID].frameBuffer.getContextImage(frame);
     }
@@ -661,7 +660,7 @@
     return frameDataCache[jobID].frameBuffer.getContextImage(frame);
 }
 
-    async function getPreview(taskID = null, jobID = null) {
+export async function getPreview(taskID = null, jobID = null) {
     return new Promise((resolve, reject) => {
         // Just go to server and get preview (no any cache)
         serverProxy.frames
@@ -684,7 +683,7 @@
     });
 }
 
-    async function getFrame(
+export async function getFrame(
     jobID,
     chunkSize,
     chunkType,
@@ -741,7 +740,7 @@
     return frameDataCache[jobID].frameBuffer.require(frame, jobID, isPlaying, step);
 }
 
-    async function getDeletedFrames(instanceType, id) {
+export async function getDeletedFrames(instanceType, id) {
     if (instanceType === 'job') {
         const { meta } = frameDataCache[id];
         return meta.deleted_frames;
@@ -756,19 +755,19 @@
     throw new Exception(`getDeletedFrames is not implemented for ${instanceType}`);
 }
 
-    function deleteFrame(jobID, frame) {
+export function deleteFrame(jobID, frame) {
     const { meta } = frameDataCache[jobID];
     meta.deleted_frames[frame] = true;
 }
 
-    function restoreFrame(jobID, frame) {
+export function restoreFrame(jobID, frame) {
     const { meta } = frameDataCache[jobID];
     if (frame in meta.deleted_frames) {
         delete meta.deleted_frames[frame];
     }
 }
 
-    async function patchMeta(jobID) {
+export async function patchMeta(jobID) {
     const { meta } = frameDataCache[jobID];
     const newMeta = await serverProxy.frames.saveMeta('job', jobID, {
         deleted_frames: Object.keys(meta.deleted_frames),
@@ -787,7 +786,7 @@
     frameDataCache[jobID].meta.deleted_frames = prevDeletedFrames;
 }
 
-    async function findNotDeletedFrame(jobID, frameFrom, frameTo, offset) {
+export async function findNotDeletedFrame(jobID, frameFrom, frameTo, offset) {
     let meta;
     if (!frameDataCache[jobID]) {
         meta = await serverProxy.frames.getMeta('job', jobID);
@@ -812,7 +811,7 @@
     return lastUndeletedFrame;
 }
 
-    function getRanges(jobID) {
+export function getRanges(jobID) {
     if (!(jobID in frameDataCache)) {
         return {
             decoded: [],
@@ -826,24 +825,9 @@
     };
 }
 
-    function clear(jobID) {
+export function clear(jobID) {
     if (jobID in frameDataCache) {
         frameDataCache[jobID].frameBuffer.clear();
         delete frameDataCache[jobID];
     }
 }
-
-    module.exports = {
-        FrameData,
-        getFrame,
-        getDeletedFrames,
-        deleteFrame,
-        restoreFrame,
-        patchMeta,
-        getRanges,
-        getPreview,
-        clear,
-        findNotDeletedFrame,
-        getContextImage,
-    };
-})();

cvat-core/tests/api/annotations.js

@@ -13,7 +13,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 const serverProxy = require('../../src/server-proxy').default;
 
 // Test cases

cvat-core/tests/api/cloud-storages.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 const CloudStorage= require('../../src/cloud-storage').default;
 const { cloudStoragesDummyData } = require('../mocks/dummy-data.mock');

cvat-core/tests/api/frames.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 const { FrameData } = require('../../src/frames');
 

cvat-core/tests/api/jobs.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 const { Job } = require('../../src/session');
 

cvat-core/tests/api/object-state.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 describe('Feature: set attributes for an object state', () => {
     test('set a valid value', () => {

cvat-core/tests/api/plugins.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 describe('Feature: dummy feature', () => {
     test('dummy test', async () => {

cvat-core/tests/api/projects.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 const Project = require('../../src/project').default;
 

cvat-core/tests/api/server.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 const { AnnotationFormats, Loader, Dumper } = require('../../src/annotation-formats');
 
 // Test cases

cvat-core/tests/api/tasks.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 const { Task } = require('../../src/session');
 

cvat-core/tests/api/user.js

@@ -12,7 +12,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 const User = require('../../src/user').default;
 

cvat-core/tests/api/webhooks.js

@@ -11,7 +11,7 @@ jest.mock('../../src/server-proxy', () => {
 });
 
 // Initialize api
-window.cvat = require('../../src/api');
+window.cvat = require('../../src/api').default;
 
 const Webhook = require('../../src/webhook').default;
 const { webhooksDummyData, webhooksEventsDummyData } = require('../mocks/dummy-data.mock');

cvat-core/tsconfig.json

@@ -8,6 +8,7 @@
       "isolatedModules": true,
       "noEmit": true,
       "baseUrl": "src",
+      "resolveJsonModule": true,
     },
     "include": ["src/*.ts"]
 }