@vulog/aima-document 1.1.87 → 1.1.89

package/dist/index.d.mts

@@ -33,9 +33,10 @@ type DocumentFull = {
     status: DocumentStatus;
     reviewer?: string;
     issuingCountry?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW';
-    issuingOffice: string;
-    issuingDate: string;
-    dlClass: string;
+    issuingOffice?: string;
+    issuingDate?: string;
+    dlClass?: string;
+    issuingSubdivision?: string;
 };
 type DocumentBody = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'> | 'status' | 'reviewer'> & {
     documentType: string;

package/dist/index.d.ts

@@ -33,9 +33,10 @@ type DocumentFull = {
     status: DocumentStatus;
     reviewer?: string;
     issuingCountry?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW';
-    issuingOffice: string;
-    issuingDate: string;
-    dlClass: string;
+    issuingOffice?: string;
+    issuingDate?: string;
+    dlClass?: string;
+    issuingSubdivision?: string;
 };
 type DocumentBody = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'> | 'status' | 'reviewer'> & {
     documentType: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-document",
-    "version": "1.1.87",
+    "version": "1.1.89",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.1.87",
-        "@vulog/aima-core": "1.1.87"
+        "@vulog/aima-client": "1.1.89",
+        "@vulog/aima-core": "1.1.89"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getUserDocuments.test.ts

@@ -30,17 +30,35 @@ describe('getUserDocument', () => {
         hasNumber: true,
         hasExpirationDate: false,
         numberUploadUrl: 2,
-        hasIssuingCountry: false,
+        hasIssuingCountry: true,
         hasIssuingOffice: true,
         hasIssuingDate: true,
-        hasDlClass: false
+        hasDlClass: true,
+        hasIssuingSubdivision: true,
     }
+    const docTypeSelfie = {
+        id: 460,
+        fleetId: FLEET_ID,
+        type: 'SELFIE',
+        name: 'Selfie',
+        mandatory: false,
+        hasNumber: false,
+        hasExpirationDate: false,
+        numberUploadUrl: 1,
+        hasIssuingCountry: false,
+        hasIssuingOffice: false,
+        hasIssuingDate: false,
+        hasDlClass: false,
+        hasIssuingSubdivision: false
+    };
     const idDocId = 10892065;
     const dlDocId = 10892077;
+    const selfieDocId = 10931811;
     const documents = {
         documentTypes: [
             { ...docTypeId },
-            { ...docTypeDl}
+            { ...docTypeDl },
+            { ...docTypeSelfie },
         ],
         documents: [
             {
@@ -49,6 +67,7 @@ describe('getUserDocument', () => {
                 userId: USER_ID,
                 documentType: { ...docTypeId },
                 expirationDate: '1970-01-01',
+                approvalDate: null,
                 files: [
                     {
                         id: null,
@@ -69,6 +88,7 @@ describe('getUserDocument', () => {
                 issuingOffice: 'Nice, 06',
                 issuingDate: '2023-01-16',
                 dlClass: null,
+                issuingSubdivision: null,
                 documentNumber: null
             },
             {
@@ -77,6 +97,7 @@ describe('getUserDocument', () => {
                 userId: USER_ID,
                 documentType: { ...docTypeDl },
                 expirationDate: '1970-01-01',
+                approvalDate: null,
                 files: [
                     {
                         id: null,
@@ -103,12 +124,43 @@ describe('getUserDocument', () => {
                 ],
                 status: 'VALID',
                 reviewer: '493a4d98-7437-42db-8d4e-bd722ac62caf',
-                issuingCountry: null,
+                issuingCountry: 'FR',
                 issuingOffice: 'Nice',
                 issuingDate: '1994-02-18',
+                dlClass: 'B',
+                issuingSubdivision: '06',
+                documentNumber: '123456'
+            },
+            {
+                id: selfieDocId,
+                fleetId: FLEET_ID,
+                userId: USER_ID,
+                documentType: { ...docTypeSelfie },
+                expirationDate: null,
+                approvalDate: null,
+                files: [
+                    {
+                        id: null,
+                        url: 'https://java-eu01.vulog.com/upload/fleets/${FLEET_ID}/file?tk=sbSfJzSpv8xJ4FN7ETn5Zq5ykKoAmYKIpFjvVPzVpsCcAGmrMWNJ3h4NunQu***',
+                        name: `${docTypeSelfie.type}_0`,
+                    }
+                ],
+                uploadUrls: [
+                    {
+                        id: null,
+                        url: 'https://java-eu01.vulog.com/upload/fleets/${FLEET_ID}/documents/10931800/SELFIE_0?tk=sbSfJzSpv8xJ4FN7ETn5Zn1MGPxqzzDIvE1WJ***',
+                        name: `${docTypeSelfie.type}_0`,
+                    }
+                ],
+                status: 'VALID',
+                reviewer: 'Registration',
+                issuingCountry: null,
+                issuingOffice: null,
+                issuingDate: null,
                 dlClass: null,
+                issuingSubdivision: null,
                 documentNumber: null
-            }
+            },
         ],
         documentByService: [
             {
@@ -179,6 +231,19 @@ describe('getUserDocument', () => {
                     config: {}
                });
             }
+            else if (url.startsWith(`/boapi/proxy/user/fleets/${FLEET_ID}/users/${USER_ID}/documents/${selfieDocId}/pi`)) {
+                return Promise.resolve({
+                    data: {
+                        fleetId: FLEET_ID,
+                        userId: USER_ID,
+                        documentId: selfieDocId
+                    },
+                    status: 200,
+                    statusText: 'OK',
+                    headers: {},
+                    config: {}
+               });
+            }
             // Pour les autres URLs, rejetez la promesse
             return Promise.reject(new Error('404 Not Found'));
         });
@@ -197,17 +262,64 @@ describe('getUserDocument', () => {
         expect(docs).toBeTruthy();
         expect(docs.documents).toBeTruthy();
         expect(docs.documents.length).toEqual(documents.documents.length);
-        expect(docs.documents.length).toEqual(2);
+        expect(docs.documents.length).toEqual(3);
         expect(docs.documents[0].id).toEqual(documents.documents[0].id);
         expect(docs.documents[0].documentNumber).toBeNull();
         expect(docs.documents[1].id).toEqual(documents.documents[1].id);
-        expect(docs.documents[1].documentNumber).toBeNull();
+        expect(docs.documents[1].documentNumber).toEqual(documents.documents[1].documentNumber);
+        expect(docs.documents[2].id).toEqual(documents.documents[2].id);
+        expect(docs.documents[2].documentNumber).toBeNull();
+
+        expect(docs.documents[0].fleetId).toEqual(documents.documents[0].fleetId);
+        expect(docs.documents[0].userId).toEqual(documents.documents[0].userId);
+        expect(docs.documents[0].documentType).not.toBeNull();
+        expect(docs.documents[0].documentNumber).toEqual(documents.documents[0].documentNumber);
+        expect(docs.documents[0].expirationDate).toEqual(documents.documents[0].expirationDate);
+        expect(docs.documents[0].files).toEqual(documents.documents[0].files);
+        expect(docs.documents[0].uploadUrls).toEqual(documents.documents[0].uploadUrls);
+        expect(docs.documents[0].status).toEqual(documents.documents[0].status);
+        expect(docs.documents[0].reviewer).toEqual(documents.documents[0].reviewer);
+        expect(docs.documents[0].issuingCountry).toEqual(documents.documents[0].issuingCountry);
+        expect(docs.documents[0].issuingOffice).toEqual(documents.documents[0].issuingOffice);
+        expect(docs.documents[0].issuingDate).toEqual(documents.documents[0].issuingDate);
+        expect(docs.documents[0].dlClass).toEqual(documents.documents[0].dlClass);
+        expect(docs.documents[0].issuingSubdivision).toEqual(documents.documents[0].issuingSubdivision);
+
+        expect(docs.documents[1].fleetId).toEqual(documents.documents[1].fleetId);
+        expect(docs.documents[1].userId).toEqual(documents.documents[1].userId);
+        expect(docs.documents[1].documentType).not.toBeNull();
+        expect(docs.documents[1].documentNumber).toEqual(documents.documents[1].documentNumber);
+        expect(docs.documents[1].expirationDate).toEqual(documents.documents[1].expirationDate);
+        expect(docs.documents[1].files).toEqual(documents.documents[1].files);
+        expect(docs.documents[1].uploadUrls).toEqual(documents.documents[1].uploadUrls);
+        expect(docs.documents[1].status).toEqual(documents.documents[1].status);
+        expect(docs.documents[1].reviewer).toEqual(documents.documents[1].reviewer);
+        expect(docs.documents[1].issuingCountry).toEqual(documents.documents[1].issuingCountry);
+        expect(docs.documents[1].issuingOffice).toEqual(documents.documents[1].issuingOffice);
+        expect(docs.documents[1].issuingDate).toEqual(documents.documents[1].issuingDate);
+        expect(docs.documents[1].dlClass).toEqual(documents.documents[1].dlClass);
+        expect(docs.documents[1].issuingSubdivision).toEqual(documents.documents[1].issuingSubdivision);
+        
+        expect(docs.documents[2].fleetId).toEqual(documents.documents[2].fleetId);
+        expect(docs.documents[2].userId).toEqual(documents.documents[2].userId);
+        expect(docs.documents[2].documentType).not.toBeNull();
+        expect(docs.documents[2].documentNumber).toEqual(documents.documents[2].documentNumber);
+        expect(docs.documents[2].expirationDate).toEqual(documents.documents[2].expirationDate);
+        expect(docs.documents[2].files).toEqual(documents.documents[2].files);
+        expect(docs.documents[2].uploadUrls).toEqual(documents.documents[2].uploadUrls);
+        expect(docs.documents[2].status).toEqual(documents.documents[2].status);
+        expect(docs.documents[2].reviewer).toEqual(documents.documents[2].reviewer);
+        expect(docs.documents[2].issuingCountry).toEqual(documents.documents[2].issuingCountry);
+        expect(docs.documents[2].issuingOffice).toEqual(documents.documents[2].issuingOffice);
+        expect(docs.documents[2].issuingDate).toEqual(documents.documents[2].issuingDate);
+        expect(docs.documents[2].dlClass).toEqual(documents.documents[2].dlClass);
+        expect(docs.documents[2].issuingSubdivision).toEqual(documents.documents[2].issuingSubdivision);
     });
 
     test('call with PI', async () => {
 
         const docs = await getUserDocuments(client, USER_ID, ['DOCUMENT_NUMBER_1']);
-        expect(getMock).toHaveBeenCalledTimes(3);
+        expect(getMock).toHaveBeenCalledTimes(4);
         expect(getMock).toBeCalledWith(`/boapi/proxy/user/fleets/${FLEET_ID}/users/${USER_ID}/documents`);
         expect(getMock).toBeCalledWith(`/boapi/proxy/user/fleets/${FLEET_ID}/users/${USER_ID}/documents/${idDocId}/pi?types=DOCUMENT_NUMBER_1`);
         expect(getMock).toBeCalledWith(`/boapi/proxy/user/fleets/${FLEET_ID}/users/${USER_ID}/documents/${dlDocId}/pi?types=DOCUMENT_NUMBER_1`);
@@ -215,11 +327,14 @@ describe('getUserDocument', () => {
         expect(docs).toBeTruthy();
         expect(docs.documents).toBeTruthy();
         expect(docs.documents.length).toEqual(documents.documents.length);
-        expect(docs.documents.length).toEqual(2);
+        expect(docs.documents.length).toEqual(3);
         expect(docs.documents[0].id).toEqual(documents.documents[0].id);
         expect(docs.documents[0].documentNumber).toBeTruthy();
         expect(docs.documents[1].id).toEqual(documents.documents[1].id);
         expect(docs.documents[1].documentNumber).toBeTruthy();
+        expect(docs.documents[2].id).toEqual(documents.documents[2].id);
+        expect(docs.documents[2].documentNumber).toBeFalsy();
+
         if(docs.documents[0].id === idDocId) {
             expect(docs.documents[0].documentNumber).toEqual(piId.documentNumber1);
             expect(docs.documents[1].documentNumber).toEqual(piDl.documentNumber1);

package/src/types.ts

@@ -285,9 +285,10 @@ export type DocumentFull = {
         | 'ZA'
         | 'ZM'
         | 'ZW';
-    issuingOffice: string;
-    issuingDate: string;
-    dlClass: string;
+    issuingOffice?: string;
+    issuingDate?: string;
+    dlClass?: string;
+    issuingSubdivision?: string;
 };
 
 export type DocumentBody = Partial<