@vulog/aima-document 1.1.20

package/.eslintrc.js

@@ -0,0 +1,112 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        // Indicates the location of the TypeScript configuration file
+        project: 'tsconfig.json',
+        // Sets the root directory for the TypeScript configuration
+        tsconfigRootDir: __dirname,
+        // Specifies the version of ECMAScript syntax to be used
+        ecmaVersion: 'latest',
+        // Indicates the type of source code (script or module)
+        sourceType: 'module',
+    },
+    plugins: ['@typescript-eslint', 'prettier', 'import'],
+    extends: [
+        'airbnb-base',
+        'airbnb-typescript/base',
+        'plugin:@typescript-eslint/recommended',
+        'prettier',
+        'plugin:prettier/recommended',
+    ],
+    root: true,
+    env: {
+        es6: true,
+        node: true,
+    },
+    ignorePatterns: [
+        '/dist/**/*', // Ignore built files.
+        '.eslintrc.js',
+        '**/*.test.ts',
+    ],
+    rules: {
+        // Configures the Prettier integration with ESLint
+        'prettier/prettier': ['error', { endOfLine: 'auto' }],
+        // Disables the rule requiring an 'I' prefix for interfaces
+        '@typescript-eslint/interface-name-prefix': 'off',
+        // Configures the naming conventions for various code constructs
+        '@typescript-eslint/naming-convention': [
+            // ... various naming convention configurations ...
+            'error',
+            // Allows any naming format for destructured variables
+            {
+                selector: 'variable',
+                modifiers: ['destructured'],
+                format: null,
+            },
+            // Requires strict camelCase for function names
+            {
+                selector: 'function',
+                format: ['strictCamelCase'],
+            },
+            // Requires boolean variables to have one of the specified prefixes
+            {
+                selector: 'variable',
+                format: null,
+                types: ['boolean'],
+                prefix: ['is', 'should', 'has', 'can', 'did', 'will'],
+            },
+            // Requires enum names to have a strict PascalCase format
+            {
+                selector: 'enum',
+                format: ['StrictPascalCase'],
+            },
+        ],
+        'import/extensions': 'off',
+        // Disables the rule requiring explicit return types for functions
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        // Disables the rule requiring explicit boundary types for modules
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        // Disables the rule prohibiting the use of 'any' type
+        '@typescript-eslint/no-explicit-any': 'off',
+        // Disables the rule detecting unused variables
+        'no-unused-vars': 0,
+        // Disables the rule disallowing named exports used as a default export
+        'import/no-named-as-default': 0,
+        // Configures the order and formatting of import statements
+        'import/order': [
+            // ... import order configuration ...
+            'error',
+            {
+                // Configure the alphabetization settings
+                alphabetize: {
+                    // Enforce ascending alphabetical order
+                    order: 'asc',
+                    // Do not ignore the case while sorting
+                    caseInsensitive: false,
+                },
+                // Enforce newlines between different groups and inside groups of imports
+                'newlines-between': 'always-and-inside-groups',
+                // Warn when there is an import statement that is not part of any group
+                warnOnUnassignedImports: true,
+            },
+        ],
+        // Configures the rule detecting extraneous dependencies
+        'import/no-extraneous-dependencies': [
+            // ... extraneous dependencies configuration ...
+            'error',
+            {
+                // Specify the file patterns where devDependencies imports are allowed
+                devDependencies: [
+                    // Allow devDependencies imports in test and spec files
+                    '**/*.test.{ts,js}',
+                    '**/*.spec.{ts,js}',
+                    // Allow devDependencies imports in the 'test' folder
+                    './test/**.{ts,js}',
+                    // Allow devDependencies imports in the 'scripts' folder
+                    './scripts/**/*.{ts,js}',
+                ],
+            },
+        ],
+        'import/prefer-default-export': 'off',
+    },
+};

package/README.md

@@ -0,0 +1 @@
+# @vulog/aima-pricing

package/dist/index.d.mts

@@ -0,0 +1,57 @@
+import { Client } from '@vulog/aima-client';
+
+type DocumentType = {
+    id: number;
+    fleetId: string;
+    type: string;
+    name: string;
+    mandatory: boolean;
+    hasNumber: boolean;
+    hasExpirationDate: boolean;
+    numberUploadUrl: number;
+    hasIssuingCountry: boolean;
+    hasIssuingOffice: boolean;
+    hasIssuingDate: boolean;
+    hasDlClass: boolean;
+};
+type FileUrl = {
+    id: number;
+    url: string;
+    name: string;
+};
+type DocumentFull = {
+    id: number;
+    fleetId: string;
+    userId: string;
+    documentType: DocumentType;
+    documentNumber?: string;
+    expirationDate?: string;
+    files: FileUrl[];
+    uploadUrls: FileUrl[];
+    status: string;
+    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 DocumentByService = {
+    serviceId: string;
+    areMandatoryPresent: boolean;
+    mandatoryDocumentTypeId: number[];
+};
+type DocumentByFranchise = {
+    fleetId: string;
+    serviceId: string;
+    mandatoryDocumentTypeId: number[];
+};
+type DocumentSummary = {
+    documentTypes: DocumentType[];
+    documents: DocumentFull[];
+    documentByService: DocumentByService[];
+    documentByFranchise: DocumentByFranchise[] | null;
+};
+
+declare const getUserDocuments: (client: Client, userId: string) => Promise<DocumentSummary>;
+
+export { type DocumentByFranchise, type DocumentByService, type DocumentFull, type DocumentSummary, type DocumentType, type FileUrl, getUserDocuments };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { Client } from '@vulog/aima-client';
+
+type DocumentType = {
+    id: number;
+    fleetId: string;
+    type: string;
+    name: string;
+    mandatory: boolean;
+    hasNumber: boolean;
+    hasExpirationDate: boolean;
+    numberUploadUrl: number;
+    hasIssuingCountry: boolean;
+    hasIssuingOffice: boolean;
+    hasIssuingDate: boolean;
+    hasDlClass: boolean;
+};
+type FileUrl = {
+    id: number;
+    url: string;
+    name: string;
+};
+type DocumentFull = {
+    id: number;
+    fleetId: string;
+    userId: string;
+    documentType: DocumentType;
+    documentNumber?: string;
+    expirationDate?: string;
+    files: FileUrl[];
+    uploadUrls: FileUrl[];
+    status: string;
+    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 DocumentByService = {
+    serviceId: string;
+    areMandatoryPresent: boolean;
+    mandatoryDocumentTypeId: number[];
+};
+type DocumentByFranchise = {
+    fleetId: string;
+    serviceId: string;
+    mandatoryDocumentTypeId: number[];
+};
+type DocumentSummary = {
+    documentTypes: DocumentType[];
+    documents: DocumentFull[];
+    documentByService: DocumentByService[];
+    documentByFranchise: DocumentByFranchise[] | null;
+};
+
+declare const getUserDocuments: (client: Client, userId: string) => Promise<DocumentSummary>;
+
+export { type DocumentByFranchise, type DocumentByService, type DocumentFull, type DocumentSummary, type DocumentType, type FileUrl, getUserDocuments };

package/dist/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  getUserDocuments: () => getUserDocuments
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/getUserDocuments.ts
+var import_zod = require("zod");
+var schema = import_zod.z.object({
+  userId: import_zod.z.string().trim().nonempty().uuid()
+});
+var getUserDocuments = async (client, userId) => {
+  const result = schema.safeParse({ userId });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/documents`).then(({ data }) => data);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getUserDocuments
+});

package/dist/index.mjs

@@ -0,0 +1,17 @@
+// src/getUserDocuments.ts
+import { z } from "zod";
+var schema = z.object({
+  userId: z.string().trim().nonempty().uuid()
+});
+var getUserDocuments = async (client, userId) => {
+  const result = schema.safeParse({ userId });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/documents`).then(({ data }) => data);
+};
+export {
+  getUserDocuments
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@vulog/aima-document",
+    "version": "1.1.20",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsup",
+        "dev": "tsup --watch",
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "lint": "eslint src/**/* --ext .ts"
+    },
+    "keywords": [
+        "AIMA",
+        "VULOG",
+        "DOCUMENT"
+    ],
+    "author": "Vulog",
+    "license": "ISC",
+    "dependencies": {
+        "@vulog/aima-client": "1.1.20",
+        "@vulog/aima-core": "1.1.20"
+    },
+    "peerDependencies": {
+        "zod": "^3.24.1"
+    },
+    "description": ""
+}

package/src/getUserDocuments.ts

@@ -0,0 +1,21 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+import { DocumentSummary } from './types';
+
+const schema = z.object({
+    userId: z.string().trim().nonempty().uuid(),
+});
+
+export const getUserDocuments = async (client: Client, userId: string): Promise<DocumentSummary> => {
+    const result = schema.safeParse({ userId });
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+
+    return client
+        .get<DocumentSummary>(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/documents`)
+        .then(({ data }) => data);
+};

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './getUserDocuments';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,306 @@
+export type DocumentType = {
+    id: number;
+    fleetId: string;
+    type: string;
+    name: string;
+    mandatory: boolean;
+    hasNumber: boolean;
+    hasExpirationDate: boolean;
+    numberUploadUrl: number;
+    hasIssuingCountry: boolean;
+    hasIssuingOffice: boolean;
+    hasIssuingDate: boolean;
+    hasDlClass: boolean;
+};
+
+export type FileUrl = {
+    id: number;
+    url: string;
+    name: string;
+};
+
+export type DocumentFull = {
+    id: number;
+    fleetId: string;
+    userId: string;
+    documentType: DocumentType;
+    documentNumber?: string;
+    expirationDate?: string;
+    files: FileUrl[];
+    uploadUrls: FileUrl[];
+    status: string;
+    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;
+};
+
+export type DocumentByService = {
+    serviceId: string;
+    areMandatoryPresent: boolean;
+    mandatoryDocumentTypeId: number[];
+};
+
+export type DocumentByFranchise = {
+    fleetId: string;
+    serviceId: string;
+    mandatoryDocumentTypeId: number[];
+};
+
+export type DocumentSummary = {
+    documentTypes: DocumentType[];
+    documents: DocumentFull[];
+    documentByService: DocumentByService[];
+    documentByFranchise: DocumentByFranchise[] | null;
+};

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "include": ["src"],
+    "exclude": ["**/*.test.ts"],
+    "compilerOptions": {
+        "module": "esnext",
+        "target": "esnext",
+        "lib": ["esnext"],
+        "declaration": true,
+        "strict": true,
+        "moduleResolution": "node",
+        "skipLibCheck": true,
+        "esModuleInterop": true,
+        "outDir": "dist",
+        "rootDir": "src"
+    }
+}

package/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+    entry: ['src/index.ts'],
+    clean: true,
+    format: ['cjs', 'esm'],
+    dts: true,
+});

package/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: 'node',
+    },
+});