@vulog/aima-document 1.1.26 → 1.1.27

package/dist/index.d.mts

@@ -19,6 +19,7 @@ type FileUrl = {
     url: string;
     name: string;
 };
+type DocumentStatus = 'MISSING' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PENDING_REVIEW';
 type DocumentFull = {
     id: number;
     fleetId: string;
@@ -28,17 +29,20 @@ type DocumentFull = {
     expirationDate?: string;
     files: FileUrl[];
     uploadUrls: FileUrl[];
-    status: string;
+    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;
 };
-type DocumentCreate = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'>> & {
+type DocumentBody = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'> | 'status' | 'reviewer'> & {
     documentType: string;
 };
-type DocumentUpdate = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'>>;
+type DocumentStatusReview = {
+    status: DocumentStatus;
+    reviewer: string;
+};
 type DocumentByService = {
     serviceId: string;
     areMandatoryPresent: boolean;
@@ -56,10 +60,10 @@ type DocumentSummary = {
     documentByFranchise: DocumentByFranchise[] | null;
 };
 
-declare const createDocument: (client: Client, userId: string, document: DocumentCreate) => Promise<DocumentFull>;
+declare const createOrUpdateDocument: (client: Client, userId: string, document: DocumentBody) => Promise<DocumentFull>;
 
 declare const getUserDocuments: (client: Client, userId: string) => Promise<DocumentSummary>;
 
-declare const updateDocument: (client: Client, userId: string, documentId: number, document: DocumentUpdate) => Promise<DocumentFull>;
+declare const updateDocumentStatus: (client: Client, userId: string, documentId: number, document: DocumentStatusReview) => Promise<DocumentFull>;
 
-export { type DocumentByFranchise, type DocumentByService, type DocumentCreate, type DocumentFull, type DocumentSummary, type DocumentType, type DocumentUpdate, type FileUrl, createDocument, getUserDocuments, updateDocument };
+export { type DocumentBody, type DocumentByFranchise, type DocumentByService, type DocumentFull, type DocumentStatus, type DocumentStatusReview, type DocumentSummary, type DocumentType, type FileUrl, createOrUpdateDocument, getUserDocuments, updateDocumentStatus };

package/dist/index.d.ts

@@ -19,6 +19,7 @@ type FileUrl = {
     url: string;
     name: string;
 };
+type DocumentStatus = 'MISSING' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PENDING_REVIEW';
 type DocumentFull = {
     id: number;
     fleetId: string;
@@ -28,17 +29,20 @@ type DocumentFull = {
     expirationDate?: string;
     files: FileUrl[];
     uploadUrls: FileUrl[];
-    status: string;
+    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;
 };
-type DocumentCreate = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'>> & {
+type DocumentBody = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'> | 'status' | 'reviewer'> & {
     documentType: string;
 };
-type DocumentUpdate = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'>>;
+type DocumentStatusReview = {
+    status: DocumentStatus;
+    reviewer: string;
+};
 type DocumentByService = {
     serviceId: string;
     areMandatoryPresent: boolean;
@@ -56,10 +60,10 @@ type DocumentSummary = {
     documentByFranchise: DocumentByFranchise[] | null;
 };
 
-declare const createDocument: (client: Client, userId: string, document: DocumentCreate) => Promise<DocumentFull>;
+declare const createOrUpdateDocument: (client: Client, userId: string, document: DocumentBody) => Promise<DocumentFull>;
 
 declare const getUserDocuments: (client: Client, userId: string) => Promise<DocumentSummary>;
 
-declare const updateDocument: (client: Client, userId: string, documentId: number, document: DocumentUpdate) => Promise<DocumentFull>;
+declare const updateDocumentStatus: (client: Client, userId: string, documentId: number, document: DocumentStatusReview) => Promise<DocumentFull>;
 
-export { type DocumentByFranchise, type DocumentByService, type DocumentCreate, type DocumentFull, type DocumentSummary, type DocumentType, type DocumentUpdate, type FileUrl, createDocument, getUserDocuments, updateDocument };
+export { type DocumentBody, type DocumentByFranchise, type DocumentByService, type DocumentFull, type DocumentStatus, type DocumentStatusReview, type DocumentSummary, type DocumentType, type FileUrl, createOrUpdateDocument, getUserDocuments, updateDocumentStatus };

package/dist/index.js

@@ -20,18 +20,18 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  createDocument: () => createDocument,
+  createOrUpdateDocument: () => createOrUpdateDocument,
   getUserDocuments: () => getUserDocuments,
-  updateDocument: () => updateDocument
+  updateDocumentStatus: () => updateDocumentStatus
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/createDocument.ts
+// src/createOrUpdateDocument.ts
 var import_zod = require("zod");
 var schema = import_zod.z.object({
   userId: import_zod.z.string().nonempty().uuid()
 });
-var createDocument = async (client, userId, document) => {
+var createOrUpdateDocument = async (client, userId, document) => {
   const result = schema.safeParse({ userId });
   if (!result.success) {
     throw new TypeError("Invalid args", {
@@ -59,13 +59,13 @@ var getUserDocuments = async (client, userId) => {
   return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/documents`).then(({ data }) => data);
 };
 
-// src/updateDocument.ts
+// src/updateDocumentStatus.ts
 var import_zod3 = require("zod");
 var schema3 = import_zod3.z.object({
   userId: import_zod3.z.string().nonempty().uuid(),
   documentId: import_zod3.z.number().nonnegative().int()
 });
-var updateDocument = async (client, userId, documentId, document) => {
+var updateDocumentStatus = async (client, userId, documentId, document) => {
   const result = schema3.safeParse({ userId, documentId });
   if (!result.success) {
     throw new TypeError("Invalid args", {
@@ -79,7 +79,7 @@ var updateDocument = async (client, userId, documentId, document) => {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  createDocument,
+  createOrUpdateDocument,
   getUserDocuments,
-  updateDocument
+  updateDocumentStatus
 });

package/dist/index.mjs

@@ -1,9 +1,9 @@
-// src/createDocument.ts
+// src/createOrUpdateDocument.ts
 import { z } from "zod";
 var schema = z.object({
   userId: z.string().nonempty().uuid()
 });
-var createDocument = async (client, userId, document) => {
+var createOrUpdateDocument = async (client, userId, document) => {
   const result = schema.safeParse({ userId });
   if (!result.success) {
     throw new TypeError("Invalid args", {
@@ -31,13 +31,13 @@ var getUserDocuments = async (client, userId) => {
   return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/documents`).then(({ data }) => data);
 };
 
-// src/updateDocument.ts
+// src/updateDocumentStatus.ts
 import { z as z3 } from "zod";
 var schema3 = z3.object({
   userId: z3.string().nonempty().uuid(),
   documentId: z3.number().nonnegative().int()
 });
-var updateDocument = async (client, userId, documentId, document) => {
+var updateDocumentStatus = async (client, userId, documentId, document) => {
   const result = schema3.safeParse({ userId, documentId });
   if (!result.success) {
     throw new TypeError("Invalid args", {
@@ -50,7 +50,7 @@ var updateDocument = async (client, userId, documentId, document) => {
   ).then(({ data }) => data);
 };
 export {
-  createDocument,
+  createOrUpdateDocument,
   getUserDocuments,
-  updateDocument
+  updateDocumentStatus
 };

package/package.json

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

package/src/{createDocument.ts → createOrUpdateDocument.ts}

@@ -1,16 +1,16 @@
 import { Client } from '@vulog/aima-client';
 import { z } from 'zod';
 
-import { DocumentCreate, DocumentFull } from './types';
+import { DocumentBody, DocumentFull } from './types';
 
 const schema = z.object({
     userId: z.string().nonempty().uuid(),
 });
 
-export const createDocument = async (
+export const createOrUpdateDocument = async (
     client: Client,
     userId: string,
-    document: DocumentCreate
+    document: DocumentBody
 ): Promise<DocumentFull> => {
     const result = schema.safeParse({ userId });
     if (!result.success) {

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './createDocument';
+export * from './createOrUpdateDocument';
 export * from './getUserDocuments';
 export * from './types';
-export * from './updateDocument';
+export * from './updateDocumentStatus';

package/src/types.ts

@@ -19,6 +19,8 @@ export type FileUrl = {
     name: string;
 };
 
+export type DocumentStatus = 'MISSING' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PENDING_REVIEW';
+
 export type DocumentFull = {
     id: number;
     fleetId: string;
@@ -28,7 +30,7 @@ export type DocumentFull = {
     expirationDate?: string;
     files: FileUrl[];
     uploadUrls: FileUrl[];
-    status: string;
+    status: DocumentStatus;
     reviewer?: string;
     issuingCountry?:
         | 'AD'
@@ -286,11 +288,16 @@ export type DocumentFull = {
     dlClass: string;
 };
 
-export type DocumentCreate = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'>> & {
+export type DocumentBody = Partial<
+    Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'> | 'status' | 'reviewer'
+> & {
     documentType: string;
 };
 
-export type DocumentUpdate = Partial<Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'>>;
+export type DocumentStatusReview = {
+    status: DocumentStatus;
+    reviewer: string;
+};
 
 export type DocumentByService = {
     serviceId: string;

package/src/{updateDocument.ts → updateDocumentStatus.ts}

@@ -1,18 +1,18 @@
 import { Client } from '@vulog/aima-client';
 import { z } from 'zod';
 
-import { DocumentUpdate, DocumentFull } from './types';
+import { DocumentStatusReview, DocumentFull } from './types';
 
 const schema = z.object({
     userId: z.string().nonempty().uuid(),
     documentId: z.number().nonnegative().int(),
 });
 
-export const updateDocument = async (
+export const updateDocumentStatus = async (
     client: Client,
     userId: string,
     documentId: number,
-    document: DocumentUpdate
+    document: DocumentStatusReview
 ): Promise<DocumentFull> => {
     const result = schema.safeParse({ userId, documentId });
     if (!result.success) {