Add email flag validation (#181)

* Moved float validation to a seperate flag type.

* Moved uuidCsv validation to a new flag type. Added email custom flag. Added integration tests for testing email flags.

* Removed validateFloat export from custom-flags/float.ts.

* Updated float custom flag to return a number instead of a string.

* Added expected format to float custom flag error message.

Author: Nadegamra

integration-tests/access-control/group.test.ts

@@ -152,6 +152,13 @@ const tests = () => {
     );
     expect(deleteError?.message).to.contain("'another-invalid-uuid' is not a valid UUID.");
   });
+
+  it("Should return an error when invalid email is provided as --member", async () => {
+    const { error: updateError } = await runCommand<Group>(
+      `access-control group update -i ${crypto.randomUUID()} -g ${crypto.randomUUID()} --member not-a-valid-email`,
+    );
+    expect(updateError?.message).to.contain("'not-a-valid-email' is not a valid email.");
+  });
 };
 
 export default tests;

integration-tests/access-control/member/owner.test.ts

@@ -93,6 +93,11 @@ const tests = () => {
     );
     expect(deleteError?.message).to.contain("'an-invalid-uuid' is not a valid UUID.");
   });
+
+  it("Should return an error when invalid email is provided as --email", async () => {
+    const { error: updateError } = await runCommand<OwnerResponse>(`access-control member owner add -i ${crypto.randomUUID()} --email not-a-valid-email`);
+    expect(updateError?.message).to.contain("'not-a-valid-email' is not a valid email.");
+  });
 };
 
 export default tests;

integration-tests/access-control/member/user.test.ts

@@ -365,6 +365,13 @@ const tests = () => {
     );
     expect(updateError?.message).to.contain("'an-invalid-uuid' is not a valid UUID.");
   });
+
+  it("Should return an error when invalid email is provided as --email", async () => {
+    const { error: updateError } = await runCommand<Member>(
+      `access-control member user add -i ${crypto.randomUUID()} --email not-a-valid-email --role-ids ${crypto.randomUUID()}`,
+    );
+    expect(updateError?.message).to.contain("'not-a-valid-email' is not a valid email.");
+  });
 };
 
 export default tests;

integration-tests/imodel/create-delete.test.ts

@@ -96,10 +96,10 @@ const tests = () =>
       );
 
       expect(createError).to.not.be.undefined;
-      expect(createError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --ne-latitude/);
-      expect(createError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --ne-longitude/);
-      expect(createError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --sw-latitude/);
-      expect(createError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --sw-longitude/);
+      expect(createError?.message).to.contain("--extent=[object Object] cannot also be provided when using --ne-latitude");
+      expect(createError?.message).to.contain("--extent=[object Object] cannot also be provided when using --ne-longitude");
+      expect(createError?.message).to.contain("--extent=[object Object] cannot also be provided when using --sw-latitude");
+      expect(createError?.message).to.contain("--extent=[object Object] cannot also be provided when using --sw-longitude");
     });
 
     it("should return an error if user does not provide all extent flags", async () => {
@@ -120,7 +120,7 @@ const tests = () =>
       );
 
       expect(createError).to.not.be.undefined;
-      expect(createError?.message).to.match(/All of the following must be provided when using --sw-latitude: --ne-latitude, --ne-longitude, --sw-longitude/);
+      expect(createError?.message).to.contain("All of the following must be provided when using --sw-latitude: --ne-latitude, --ne-longitude, --sw-longitude");
     });
 
     it("should return an error if a component of the provided extent is not a valid number", async () => {
@@ -130,7 +130,7 @@ const tests = () =>
       );
 
       expect(createError).to.not.be.undefined;
-      expect(createError?.message).to.match(/46.302abc is not a valid number./);
+      expect(createError?.message).to.contain("46.302abc is not a valid number. Expected format: '1234.56'.");
     });
 
     it("should return an error if a component of the provided extent is not valid JSON", async () => {
@@ -140,7 +140,7 @@ const tests = () =>
       );
 
       expect(createError).to.not.be.undefined;
-      expect(createError?.message).to.match(/'not-valid-json' is not valid serialized JSON./);
+      expect(createError?.message).to.contain("'not-valid-json' is not valid serialized JSON.");
     });
 
     it("should return an error if a component of the provided extent is not of valid JSON schema", async () => {
@@ -160,8 +160,8 @@ const tests = () =>
       );
 
       expect(createError).to.not.be.undefined;
-      expect(createError?.message).to.match(/missing required property 'southWest.latitude' of type 'number'/);
-      expect(createError?.message).to.match(/northEast.longitude: expected type 'number', received 'string'/);
+      expect(createError?.message).to.contain("missing required property 'southWest.latitude' of type 'number'");
+      expect(createError?.message).to.contain("northEast.longitude: expected type 'number', received 'string'");
     });
 
     it("should delete the iModel", async () => {

integration-tests/imodel/update.test.ts

@@ -103,10 +103,10 @@ const tests = () =>
       );
 
       expect(updateError).to.not.be.undefined;
-      expect(updateError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --ne-latitude/);
-      expect(updateError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --ne-longitude/);
-      expect(updateError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --sw-latitude/);
-      expect(updateError?.message).to.match(/--extent=\[object Object] cannot also be provided when using --sw-longitude/);
+      expect(updateError?.message).to.contain("--extent=[object Object] cannot also be provided when using --ne-latitude");
+      expect(updateError?.message).to.contain("--extent=[object Object] cannot also be provided when using --ne-longitude");
+      expect(updateError?.message).to.contain("--extent=[object Object] cannot also be provided when using --sw-latitude");
+      expect(updateError?.message).to.contain("--extent=[object Object] cannot also be provided when using --sw-longitude");
     });
 
     it("should return an error if user does not provide all extent flags", async () => {
@@ -128,7 +128,7 @@ const tests = () =>
       );
 
       expect(updateError).to.not.be.undefined;
-      expect(updateError?.message).to.match(/All of the following must be provided when using --sw-latitude: --ne-latitude, --ne-longitude, --sw-longitude/);
+      expect(updateError?.message).to.contain("All of the following must be provided when using --sw-latitude: --ne-latitude, --ne-longitude, --sw-longitude");
     });
 
     it("should return an error if a component of the provided extent is not a valid number", async () => {
@@ -137,7 +137,7 @@ const tests = () =>
       );
 
       expect(createError).to.not.be.undefined;
-      expect(createError?.message).to.match(/46.302abc is not a valid number./);
+      expect(createError?.message).to.contain("46.302abc is not a valid number. Expected format: '1234.56'.");
     });
 
     it("should return an error when invalid uuid is provided as --imodel-id", async () => {

src/commands/access-control/group/update.ts

@@ -49,7 +49,7 @@ export default class UpdateAccessControlGroup extends BaseCommand {
     "itwin-id": CustomFlags.iTwinIDFlag({
       description: "The ID of the iTwin where the group exists.",
     }),
-    member: Flags.string({
+    member: CustomFlags.email({
       description: "A list of members (emails) to be assigned to the group. Max amount of 50.",
       helpValue: "<string>",
       multiple: true,

src/commands/access-control/member/group/add.ts

@@ -3,12 +3,9 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 
-import { Flags } from "@oclif/core";
-
 import { ApiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
-import { validateUuidCSV } from "../../../../extensions/validation/validate-uuid-csv.js";
 import { GroupMember, GroupMemberInfo } from "../../../../services/access-control-client/models/group.js";
 
 export default class AddGroupMembers extends BaseCommand {
@@ -53,11 +50,10 @@ export default class AddGroupMembers extends BaseCommand {
     "itwin-id": CustomFlags.iTwinIDFlag({
       description: "The ID of the iTwin to which the groups will be added.",
     }),
-    "role-ids": Flags.string({
+    "role-ids": CustomFlags.uuidCsv({
       dependsOn: ["group-id"],
       description: `Specify a list of role IDs to be assigned to all of 'group-id' groups. Provided in CSV format without whitespaces.`,
       helpValue: "<string>",
-      parse: async (input) => validateUuidCSV(input),
       required: false,
     }),
   };

src/commands/access-control/member/owner/add.ts

@@ -3,8 +3,6 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 
-import { Flags } from "@oclif/core";
-
 import { ApiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
@@ -27,7 +25,7 @@ export default class AddOwner extends BaseCommand {
   ];
 
   public static flags = {
-    email: Flags.string({
+    email: CustomFlags.email({
       description: "The email address of the new owner.",
       helpValue: "<string>",
       required: true,

src/commands/access-control/member/user/add.ts

@@ -3,12 +3,9 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 
-import { Flags } from "@oclif/core";
-
 import { ApiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
-import { validateUuidCSV } from "../../../../extensions/validation/validate-uuid-csv.js";
 import { MembersResponse, UserMember } from "../../../../services/access-control-client/models/members.js";
 
 export default class AddUserMembers extends BaseCommand {
@@ -37,7 +34,7 @@ export default class AddUserMembers extends BaseCommand {
   ];
 
   public static flags = {
-    email: Flags.string({
+    email: CustomFlags.email({
       dependsOn: ["role-ids"],
       description: "Specify emails of the user to add roles to. This flag can be provided multiple times.",
       helpValue: "<string>",
@@ -55,14 +52,12 @@ export default class AddUserMembers extends BaseCommand {
       helpValue: "<string>",
       required: false,
     }),
-    "role-ids": Flags.string({
+    "role-ids": CustomFlags.uuidCsv({
       dependsOn: ["email"],
       description:
         "Specify IDs of roles to be assigned to a user in CSV format without any whitespaces. This flag can be provided multiple times. If the flag is provided only once, the contained list of role IDs will be assigned to all provided group-ids list. If flag is provided multiple times, each role-ids will be used for the corresponding group-id (fist role-ids list for the first group-id, second role-ids list for the second group-id and so on).",
       helpValue: "<string>",
       multiple: true,
-      // eslint-disable-next-line @typescript-eslint/promise-function-async
-      parse: (input) => validateUuidCSV(input),
       required: false,
     }),
   };

src/commands/imodel/create.ts

@@ -9,7 +9,6 @@ import { Flags } from "@oclif/core";
 import { ApiReference } from "../../extensions/api-reference.js";
 import BaseCommand from "../../extensions/base-command.js";
 import { CustomFlags } from "../../extensions/custom-flags.js";
-import { validateFloat } from "../../extensions/validation/validate-float.js";
 
 export default class CreateIModel extends BaseCommand {
   public static apiReference: ApiReference = {
@@ -63,44 +62,36 @@ export default class CreateIModel extends BaseCommand {
       helpValue: "<string>",
       required: true,
     }),
-    "ne-latitude": Flags.string({
+    "ne-latitude": CustomFlags.float({
       dependsOn: ["ne-longitude", "sw-latitude", "sw-longitude"],
       description: "Northeast latitude of the extent.",
       exclusive: ["extent"],
       helpValue: "<float>",
-      // eslint-disable-next-line @typescript-eslint/promise-function-async
-      parse: (input) => validateFloat(input),
       required: false,
     }),
-    "ne-longitude": Flags.string({
+    "ne-longitude": CustomFlags.float({
       dependsOn: ["ne-latitude", "sw-latitude", "sw-longitude"],
       description: "Northeast longitude of the extent.",
       exclusive: ["extent"],
       helpValue: "<float>",
-      // eslint-disable-next-line @typescript-eslint/promise-function-async
-      parse: (input) => validateFloat(input),
       required: false,
     }),
     save: Flags.boolean({
       description: "Save the iModel id to the context.",
       required: false,
     }),
-    "sw-latitude": Flags.string({
+    "sw-latitude": CustomFlags.float({
       dependsOn: ["ne-latitude", "ne-longitude", "sw-longitude"],
       description: "Southwest latitude of the extent.",
       exclusive: ["extent"],
       helpValue: "<float>",
-      // eslint-disable-next-line @typescript-eslint/promise-function-async
-      parse: (input) => validateFloat(input),
       required: false,
     }),
-    "sw-longitude": Flags.string({
+    "sw-longitude": CustomFlags.float({
       dependsOn: ["ne-latitude", "ne-longitude", "sw-latitude"],
       description: "Southwest longitude of the extent.",
       exclusive: ["extent"],
       helpValue: "<float>",
-      // eslint-disable-next-line @typescript-eslint/promise-function-async
-      parse: (input) => validateFloat(input),
       required: false,
     }),
   };
@@ -116,12 +107,12 @@ export default class CreateIModel extends BaseCommand {
     ) {
       flags.extent ??= {
         northEast: {
-          latitude: Number.parseFloat(flags["ne-latitude"]),
-          longitude: Number.parseFloat(flags["ne-longitude"]),
+          latitude: flags["ne-latitude"],
+          longitude: flags["ne-longitude"],
         },
         southWest: {
-          latitude: Number.parseFloat(flags["sw-latitude"]),
-          longitude: Number.parseFloat(flags["sw-longitude"]),
+          latitude: flags["sw-latitude"],
+          longitude: flags["sw-longitude"],
         },
       };
     }