Merge pull request #34 from exadel-inc/EFRS-1233-Compreface-JS-SDK-running-issue-with-angular-framework

EFRS-1233-Compreface-JS-SDK-running-issue-with-angular-framework

Author: smchedlidze826

compreface.d.ts

@@ -0,0 +1,126 @@
+declare interface Detection {
+    detect<T>(image_path: string, localOptions?: any): Promise<T>;
+}
+
+declare interface Verification {
+    verify<T>(source_image_path: string, target_image_path: string, options?: any): Promise<T>
+}
+
+declare interface Recognition {
+    getFaceCollection(): FaceCollectionFunctions;
+    subjectFunctions(): SubjectFunctions;
+}
+
+declare interface FaceCollectionFunctions {
+    /**
+     * View the list of images in face collection
+     * @returns {Promise}
+     */
+    list<T>(): Promise<T>,
+
+    /**
+     * Add image (with subject) to face collection
+     * @param {String} image_path 
+     * @param {String} subject 
+     * @returns {Promise} 
+     */
+    add<T>(image_path: string, subject: string, options?: any): Promise<T>;
+
+    /**
+     * Verify face from image
+     * @param {String} image_path 
+     * @param {String} image_id 
+     * @returns {Promise}
+     */
+    verify<T>(image_path: string, image_id: string, options?: any): Promise<T>,
+
+    /**
+     * Delete image by id
+     * @param {String} image_id 
+     * @returns {Promise}
+     */
+    delete<T>(image_id: string): Promise<T>,
+
+    /**
+     * Delete multiple images
+     * @param {String} subject
+     * @returns {Promise}
+     */
+    delete_multiple_images<T>(image_ids: string[]): Promise<T>,
+    /**
+     * Delete image by subject
+     * @param {String} subject 
+     * @returns {Promise}
+     */
+    delete_all_subject<T>(subject: string): Promise<T>,
+
+    /**
+     * Delete all images in face collection
+     * @returns {Promise}
+     */
+    delete_all<T>(): Promise<T>,
+}
+
+declare interface SubjectFunctions {
+
+    /**
+     * List the subjects
+     * @returns {Promise}
+     */
+    list<T>(): Promise<T>,
+
+    /**
+     * Add subject
+     * @param {String} subject
+     * @returns {Promise}
+     */
+    add<T>(subject: string): Promise<T>,
+
+    /**
+     * Rename the subject
+     * @param {String} presentSubjectName
+     * @param {String} newSubjectName
+     * @returns {Promise}
+     */
+    rename<T>(presentSubjectName: string, newSubjectName: string): Promise<T>,
+
+    /**
+     * Delete a subject
+     * @param {String} subject
+     * @returns {Promise}
+     */
+    delete<T>(subject: string): Promise<T>,
+
+    /**
+     * Delete all subject
+     * @param {String} subject
+     * @returns {Promise}
+     */
+    deleteAll<T>(): Promise<T>;
+}
+
+export declare class CompreFace {
+    constructor(server: string, port: number, options?: any);
+
+    /**
+     * Initialize RecognitionService instance
+     * @param {String} api_key 
+     * @returns {Object}
+     */
+    initFaceRecognitionService(api_key: string): Recognition;
+
+    /**
+     * Initialize VerificationService instance
+     * @param {String} api_key 
+     * @returns {Object}
+     */
+    initFaceVerificationService(api_key: string): Verification;
+
+    /**
+     * Initialize DetectionService instance
+     * @param {String} api_key 
+     * @returns {Object}
+     */
+    initFaceDetectionService(api_key: string): Detection;
+}
+

package.json

@@ -5,6 +5,7 @@
   "description": "JavaScript SDK for CompreFace - free and open-source face recognition system from Exadel",
   "main": "index.js",
   "type": "module",
+  "types":"compreface.d.ts",
   "scripts": {
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage"
   },