Projects

.gitignore

@@ -30,3 +30,7 @@ yarn-debug.log*
 yarn-error.log*
 
 .DS_Store
+
+#Ignore Cypress tests temp files
+/tests/cypress/fixtures
+/tests/cypress/screenshots

.vscode/launch.json

@@ -21,6 +21,21 @@
             },
             "smartStep": true,
         },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "ui.js: test",
+            "cwd": "${workspaceRoot}/tests",
+            "runtimeExecutable": "${workspaceRoot}/tests/node_modules/.bin/cypress",
+            "args": [
+                "run",
+                "--headless",
+                "--browser",
+                "chrome"
+            ],
+            "outputCapture": "std",
+            "console": "internalConsole"
+        },
         {
             "name": "server: django",
             "type": "python",

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
--
+- Added basic projects implementation (<https://github.com/openvinotoolkit/cvat/pull/2255>)
+
 
 ### Changed
 

cvat-canvas/.eslintignore

@@ -0,0 +1 @@
+webpack.config.js

cvat-core/.eslintignore

@@ -0,0 +1 @@
+webpack.config.js

cvat-core/src/api-implementation.js

@@ -16,6 +16,7 @@
     const { AnnotationFormats } = require('./annotation-formats');
     const { ArgumentError } = require('./exceptions');
     const { Task } = require('./session');
+    const { Project } = require('./project');
 
     function implementAPI(cvat) {
         cvat.plugins.list.implementation = PluginRegistry.list;
@@ -100,6 +101,11 @@
             return result;
         };
 
+        cvat.server.installedApps.implementation = async () => {
+            const result = await serverProxy.server.installedApps();
+            return result;
+        };
+
         cvat.users.get.implementation = async (filter) => {
             checkFilter(filter, {
                 id: isInteger,
@@ -163,6 +169,7 @@
         cvat.tasks.get.implementation = async (filter) => {
             checkFilter(filter, {
                 page: isInteger,
+                projectId: isInteger,
                 name: isString,
                 id: isInteger,
                 owner: isString,
@@ -184,8 +191,15 @@
                 }
             }
 
+            if (
+                'projectId' in filter
+                && (('page' in filter && Object.keys(filter).length > 2) || Object.keys(filter).length > 2)
+            ) {
+                throw new ArgumentError('Do not use the filter field "projectId" with other');
+            }
+
             const searchParams = new URLSearchParams();
-            for (const field of ['name', 'owner', 'assignee', 'search', 'status', 'mode', 'id', 'page']) {
+            for (const field of ['name', 'owner', 'assignee', 'search', 'status', 'mode', 'id', 'page', 'projectId']) {
                 if (Object.prototype.hasOwnProperty.call(filter, field)) {
                     searchParams.set(field, filter[field]);
                 }
@@ -199,11 +213,47 @@
             return tasks;
         };
 
-        cvat.server.installedApps.implementation = async () => {
-            const result = await serverProxy.server.installedApps();
-            return result;
+        cvat.projects.get.implementation = async (filter) => {
+            checkFilter(filter, {
+                id: isInteger,
+                page: isInteger,
+                name: isString,
+                assignee: isString,
+                owner: isString,
+                search: isString,
+                status: isEnum.bind(TaskStatus),
+            });
+
+            if ('search' in filter && Object.keys(filter).length > 1) {
+                if (!('page' in filter && Object.keys(filter).length === 2)) {
+                    throw new ArgumentError('Do not use the filter field "search" with others');
+                }
+            }
+
+            if ('id' in filter && Object.keys(filter).length > 1) {
+                if (!('page' in filter && Object.keys(filter).length === 2)) {
+                    throw new ArgumentError('Do not use the filter field "id" with others');
+                }
+            }
+
+            const searchParams = new URLSearchParams();
+            for (const field of ['name', 'assignee', 'owner', 'search', 'status', 'id', 'page']) {
+                if (Object.prototype.hasOwnProperty.call(filter, field)) {
+                    searchParams.set(field, filter[field]);
+                }
+            }
+
+            const projectsData = await serverProxy.projects.get(searchParams.toString());
+            // prettier-ignore
+            const projects = projectsData.map((project) => new Project(project));
+
+            projects.count = projectsData.count;
+
+            return projects;
         };
 
+        cvat.projects.searchNames.implementation = async (search, limit) => serverProxy.projects.searchNames(search, limit);
+
         return cvat;
     }
 

cvat-core/src/api.js

@@ -14,6 +14,7 @@ function build() {
     const ObjectState = require('./object-state');
     const Statistics = require('./statistics');
     const { Job, Task } = require('./session');
+    const { Project } = require('./project');
     const { Attribute, Label } = require('./labels');
     const MLModel = require('./ml-model');
 
@@ -274,6 +275,60 @@ function build() {
                 return result;
             },
         },
+        /**
+         * Namespace is used for getting projects
+         * @namespace projects
+         * @memberof module:API.cvat
+         */
+        projects: {
+            /**
+             * @typedef {Object} ProjectFilter
+             * @property {string} name Check if name contains this value
+             * @property {module:API.cvat.enums.ProjectStatus} status
+             * Check if status contains this value
+             * @property {integer} id Check if id equals this value
+             * @property {integer} page Get specific page
+             * (default REST API returns 20 projects per request.
+             * In order to get more, it is need to specify next page)
+             * @property {string} owner Check if owner user contains this value
+             * @property {string} search Combined search of contains among all fields
+             * @global
+             */
+
+            /**
+             * Method returns list of projects corresponding to a filter
+             * @method get
+             * @async
+             * @memberof module:API.cvat.projects
+             * @param {ProjectFilter} [filter={}] project filter
+             * @returns {module:API.cvat.classes.Project[]}
+             * @throws {module:API.cvat.exceptions.PluginError}
+             * @throws {module:API.cvat.exceptions.ServerError}
+             */
+            async get(filter = {}) {
+                const result = await PluginRegistry.apiWrapper(cvat.projects.get, filter);
+                return result;
+            },
+
+            /**
+             * Method returns list of project names with project ids
+             * corresponding to a search phrase
+             * used for autocomplete field
+             * @method searchNames
+             * @async
+             * @memberof module:API.cvat.projects
+             * @param {string} [search = ''] search phrase
+             * @param {number} [limit = 10] number of returning project names
+             * @returns {module:API.cvat.classes.Project[]}
+             * @throws {module:API.cvat.exceptions.PluginError}
+             * @throws {module:API.cvat.exceptions.ServerError}
+             *
+             */
+            async searchNames(search = '', limit = 10) {
+                const result = await PluginRegistry.apiWrapper(cvat.projects.searchNames, search, limit);
+                return result;
+            },
+        },
         /**
          * Namespace is used for getting tasks
          * @namespace tasks
@@ -291,6 +346,7 @@ function build() {
              * @property {integer} page Get specific page
              * (default REST API returns 20 tasks per request.
              * In order to get more, it is need to specify next page)
+             * @property {integer} projectId Check if project_id field contains this value
              * @property {string} owner Check if owner user contains this value
              * @property {string} assignee Check if assigneed contains this value
              * @property {string} search Combined search of contains among all fields
@@ -717,8 +773,9 @@ function build() {
          * @memberof module:API.cvat
          */
         classes: {
-            Task,
             User,
+            Project,
+            Task,
             Job,
             Log,
             Attribute,
@@ -730,6 +787,7 @@ function build() {
     };
 
     cvat.server = Object.freeze(cvat.server);
+    cvat.projects = Object.freeze(cvat.projects);
     cvat.tasks = Object.freeze(cvat.tasks);
     cvat.jobs = Object.freeze(cvat.jobs);
     cvat.users = Object.freeze(cvat.users);