@vulog/aima-user 1.2.34 → 1.2.36

package/dist/index.cjs

@@ -198,7 +198,7 @@ const getProfilePersonalInfoById = async (client, userId, profileId, types) => {
 const getRegistrationOverview = async (client, userId) => {
 	const result = zod.z.string().uuid().safeParse(userId);
 	if (!result.success) throw new TypeError("Invalid userId", { cause: result.error.issues });
-	return client.get(`boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/services`).then(({ data: { userId: uid, ...data } }) => data);
+	return client.get(`boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/services`).then(({ data: { userId: _, ...data } }) => data);
 };
 //#endregion
 //#region src/getUserById.ts
@@ -210,6 +210,13 @@ const getUserById = async (client, id, addAccountStatus = false) => {
 	return user;
 };
 //#endregion
+//#region src/getUserByEmail.ts
+const getUserByEmail = async (client, email) => {
+	const result = zod.z.string().trim().min(1).email().safeParse(email);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/usernames/${encodeURIComponent(result.data)}`).then(({ data }) => data);
+};
+//#endregion
 //#region src/getUserPersonalInfoById.ts
 const argsSchema$2 = zod.z.object({
 	id: zod.z.string().trim().min(1).uuid(),
@@ -464,6 +471,7 @@ exports.getFleetBillingGroups = getFleetBillingGroups;
 exports.getLabelsForUser = getLabelsForUser;
 exports.getProfilePersonalInfoById = getProfilePersonalInfoById;
 exports.getRegistrationOverview = getRegistrationOverview;
+exports.getUserByEmail = getUserByEmail;
 exports.getUserById = getUserById;
 exports.getUserPersonalInfoById = getUserPersonalInfoById;
 exports.getUsers = getUsers;

package/dist/index.d.cts

@@ -233,6 +233,9 @@ declare const getRegistrationOverview: (client: Client, userId: string) => Promi
 //#region src/getUserById.d.ts
 declare const getUserById: (client: Client, id: string, addAccountStatus?: boolean) => Promise<User>;
 //#endregion
+//#region src/getUserByEmail.d.ts
+declare const getUserByEmail: (client: Client, email: string) => Promise<User>;
+//#endregion
 //#region src/getUserPersonalInfoById.d.ts
 declare const getUserPersonalInfoById: (client: Client, id: string, types: PersonalInformationUserType[]) => Promise<PersonalInformationUser>;
 //#endregion
@@ -324,4 +327,4 @@ type UserSort = z.infer<typeof sortSchema>;
 type UserFilters = z.infer<typeof userFiltersSchema>;
 declare const getUsers: (client: Client, options?: PaginableOptions<UserFilters, UserSort>) => Promise<PaginableResponse<UserStatus>>;
 //#endregion
-export { AccountStatus, Address, BillingGroup, CreateBusinessProfile, CreateUser, CreateUserOptions, Entity, FiscalInformation, IndividualBusiness, Label, PersonalCompany, PersonalInformationBirth, PersonalInformationIdentity, PersonalInformationProfile, PersonalInformationProfileType, PersonalInformationUser, PersonalInformationUserType, Profile, ProfilePaths, ProfileServiceRegistration, ProfileStatus, ProfileType, ResponseFind, SearchType, ServiceRegistrationWithReason, ServiceStatus, ServicesRegistrationList, ServicesUpdate, User, UserAgreement, UserFilters, UserFull, UserPaths, UserProfile, UserServiceRegistration, UserSort, UserStatus, UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, unassignBillingGroup, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };
+export { AccountStatus, Address, BillingGroup, CreateBusinessProfile, CreateUser, CreateUserOptions, Entity, FiscalInformation, IndividualBusiness, Label, PersonalCompany, PersonalInformationBirth, PersonalInformationIdentity, PersonalInformationProfile, PersonalInformationProfileType, PersonalInformationUser, PersonalInformationUserType, Profile, ProfilePaths, ProfileServiceRegistration, ProfileStatus, ProfileType, ResponseFind, SearchType, ServiceRegistrationWithReason, ServiceStatus, ServicesRegistrationList, ServicesUpdate, User, UserAgreement, UserFilters, UserFull, UserPaths, UserProfile, UserServiceRegistration, UserSort, UserStatus, UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserByEmail, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, unassignBillingGroup, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };

package/dist/index.d.mts

@@ -233,6 +233,9 @@ declare const getRegistrationOverview: (client: Client, userId: string) => Promi
 //#region src/getUserById.d.ts
 declare const getUserById: (client: Client, id: string, addAccountStatus?: boolean) => Promise<User>;
 //#endregion
+//#region src/getUserByEmail.d.ts
+declare const getUserByEmail: (client: Client, email: string) => Promise<User>;
+//#endregion
 //#region src/getUserPersonalInfoById.d.ts
 declare const getUserPersonalInfoById: (client: Client, id: string, types: PersonalInformationUserType[]) => Promise<PersonalInformationUser>;
 //#endregion
@@ -324,4 +327,4 @@ type UserSort = z.infer<typeof sortSchema>;
 type UserFilters = z.infer<typeof userFiltersSchema>;
 declare const getUsers: (client: Client, options?: PaginableOptions<UserFilters, UserSort>) => Promise<PaginableResponse<UserStatus>>;
 //#endregion
-export { AccountStatus, Address, BillingGroup, CreateBusinessProfile, CreateUser, CreateUserOptions, Entity, FiscalInformation, IndividualBusiness, Label, PersonalCompany, PersonalInformationBirth, PersonalInformationIdentity, PersonalInformationProfile, PersonalInformationProfileType, PersonalInformationUser, PersonalInformationUserType, Profile, ProfilePaths, ProfileServiceRegistration, ProfileStatus, ProfileType, ResponseFind, SearchType, ServiceRegistrationWithReason, ServiceStatus, ServicesRegistrationList, ServicesUpdate, User, UserAgreement, UserFilters, UserFull, UserPaths, UserProfile, UserServiceRegistration, UserSort, UserStatus, UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, unassignBillingGroup, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };
+export { AccountStatus, Address, BillingGroup, CreateBusinessProfile, CreateUser, CreateUserOptions, Entity, FiscalInformation, IndividualBusiness, Label, PersonalCompany, PersonalInformationBirth, PersonalInformationIdentity, PersonalInformationProfile, PersonalInformationProfileType, PersonalInformationUser, PersonalInformationUserType, Profile, ProfilePaths, ProfileServiceRegistration, ProfileStatus, ProfileType, ResponseFind, SearchType, ServiceRegistrationWithReason, ServiceStatus, ServicesRegistrationList, ServicesUpdate, User, UserAgreement, UserFilters, UserFull, UserPaths, UserProfile, UserServiceRegistration, UserSort, UserStatus, UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserByEmail, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, unassignBillingGroup, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };

package/dist/index.mjs

@@ -197,7 +197,7 @@ const getProfilePersonalInfoById = async (client, userId, profileId, types) => {
 const getRegistrationOverview = async (client, userId) => {
 	const result = z.string().uuid().safeParse(userId);
 	if (!result.success) throw new TypeError("Invalid userId", { cause: result.error.issues });
-	return client.get(`boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/services`).then(({ data: { userId: uid, ...data } }) => data);
+	return client.get(`boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/services`).then(({ data: { userId: _, ...data } }) => data);
 };
 //#endregion
 //#region src/getUserById.ts
@@ -209,6 +209,13 @@ const getUserById = async (client, id, addAccountStatus = false) => {
 	return user;
 };
 //#endregion
+//#region src/getUserByEmail.ts
+const getUserByEmail = async (client, email) => {
+	const result = z.string().trim().min(1).email().safeParse(email);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/usernames/${encodeURIComponent(result.data)}`).then(({ data }) => data);
+};
+//#endregion
 //#region src/getUserPersonalInfoById.ts
 const argsSchema$2 = z.object({
 	id: z.string().trim().min(1).uuid(),
@@ -451,4 +458,4 @@ const getUsers = async (client, options) => {
 	});
 };
 //#endregion
-export { acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, unassignBillingGroup, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };
+export { acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserByEmail, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, unassignBillingGroup, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vulog/aima-user",
     "type": "module",
-    "version": "1.2.34",
+    "version": "1.2.36",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",
     "types": "dist/index.d.cts",
@@ -22,7 +22,7 @@
         "dev": "tsdown --watch",
         "test": "vitest run",
         "test:watch": "vitest",
-        "lint": "eslint src/**/* --ext .ts"
+        "lint": "eslint src/"
     },
     "keywords": [
         "AIMA",
@@ -32,9 +32,9 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.2.34",
-        "@vulog/aima-config": "1.2.34",
-        "@vulog/aima-core": "1.2.34"
+        "@vulog/aima-client": "1.2.36",
+        "@vulog/aima-config": "1.2.36",
+        "@vulog/aima-core": "1.2.36"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getRegistrationOverview.ts

@@ -15,5 +15,5 @@ export const getRegistrationOverview = async (client: Client, userId: string): P
         .get<
             UserServiceRegistration & { userId: string }
         >(`boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/${userId}/services`)
-        .then(({ data: { userId: uid, ...data } }) => data);
+        .then(({ data: { userId: _, ...data } }) => data);
 };

package/src/getUserByEmail.test.ts

@@ -0,0 +1,61 @@
+import { describe, test, expect, vi, beforeEach } from 'vitest';
+import { Client } from '@vulog/aima-client';
+import { getUserByEmail } from './getUserByEmail';
+
+describe('getUserByEmail', () => {
+    const FLEET_ID = 'FLEET_ID';
+    const getMock = vi.fn();
+    const client = {
+        get: getMock,
+        clientOptions: {
+            fleetId: FLEET_ID,
+        },
+    } as unknown as Client;
+
+    beforeEach(() => {
+        getMock.mockReset();
+    });
+
+    test('throws Invalid args when email is invalid', async () => {
+        await expect(getUserByEmail(client, 'not-an-email')).rejects.toThrow(TypeError);
+        await expect(getUserByEmail(client, 'not-an-email')).rejects.toMatchObject({
+            message: 'Invalid args',
+        });
+        expect(getMock).not.toHaveBeenCalled();
+    });
+
+    test('throws Invalid args when email is empty', async () => {
+        await expect(getUserByEmail(client, '')).rejects.toThrow(TypeError);
+        expect(getMock).not.toHaveBeenCalled();
+    });
+
+    test('calls GET with correct URL (email encoded) and returns user', async () => {
+        const email = 'user+tag@example.com';
+        const userData = {
+            id: '20fb98a3-b60d-491a-9359-62e55f51fcb9',
+            fleetId: FLEET_ID,
+            registrationDate: '2024-01-15T10:00:00Z',
+            locale: 'en_GB',
+            agreements: [],
+            profiles: [],
+            dataPrivacyConsent: true,
+            marketingConsent: false,
+            surveyConsent: false,
+            shareDataConsent: false,
+            surveyConsentUpdateDate: '',
+            shareDataConsentUpdateDate: '',
+            profilingConsent: false,
+            profilingConsentUpdateDate: '',
+        };
+        getMock.mockResolvedValueOnce({ data: userData });
+
+        const result = await getUserByEmail(client, email);
+
+        expect(getMock).toHaveBeenCalledTimes(1);
+        expect(getMock).toHaveBeenCalledWith(
+            `/boapi/proxy/user/fleets/${FLEET_ID}/usernames/${encodeURIComponent(email)}`
+        );
+        expect(result).toEqual(userData);
+        expect(result.id).toBe(userData.id);
+    });
+});

package/src/getUserByEmail.ts

@@ -0,0 +1,19 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+import { User } from './types';
+
+export const getUserByEmail = async (client: Client, email: string): Promise<User> => {
+    const result = z.string().trim().min(1).email().safeParse(email);
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+
+    return client
+        .get<User>(
+            `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/usernames/${encodeURIComponent(result.data)}`
+        )
+        .then(({ data }) => data);
+};

package/src/index.ts

@@ -7,6 +7,7 @@ export * from './findUser';
 export * from './getProfilePersonalInfoById';
 export * from './getRegistrationOverview';
 export * from './getUserById';
+export * from './getUserByEmail';
 export * from './getUserPersonalInfoById';
 export * from './getUsersPIByIds';
 export * from './label';

package/.eslintrc.cjs

@@ -1,112 +0,0 @@
-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',
-    },
-};