@eliasrrosa/tutorhub-public-assets 0.0.7 → 0.0.9

package/dist/domain/entities/ISO8601Time.d.ts

@@ -2,7 +2,7 @@ import { IISO8601TimeValidator } from "./ISO8601TimeValidator";
 import { ITime } from "./Time";
 /**
  * Interface for interacting with ISO8601 time formats.
- * Accepted formats: HH:MM:SS and HH:MM.
+ * Accepted formats: HH:MM:SS, HH:MM, HH:MM:SSZ, HH:MM:SS.sssZ and HH:MM:SS(+|-)HH:MM.
  *
  * @throws if instantiated with a different format
  * @throws if any method is called with a different format
@@ -10,13 +10,16 @@ import { ITime } from "./Time";
 export declare class ISO8601Time implements ITime {
     readonly value: string;
     readonly validator: IISO8601TimeValidator;
+    readonly timezone?: string;
     /**
      * Throws if format is invalid.
      * Accepted formats: HH:MM:SS and HH:MM.
      */
     constructor(value?: string);
     private validateFormatOrThrow;
-    getTime(): string;
+    getTime(opts?: {
+        format?: "HH:MM" | "HH:MM:SS";
+    }): string;
     getMinutes(): string;
     getHours(): string;
     getSeconds(): string;

package/dist/domain/entities/ISO8601Time.js

@@ -4,7 +4,7 @@ exports.ISO8601Time = void 0;
 const ISO8601TimeValidator_1 = require("./ISO8601TimeValidator");
 /**
  * Interface for interacting with ISO8601 time formats.
- * Accepted formats: HH:MM:SS and HH:MM.
+ * Accepted formats: HH:MM:SS, HH:MM, HH:MM:SSZ, HH:MM:SS.sssZ and HH:MM:SS(+|-)HH:MM.
  *
  * @throws if instantiated with a different format
  * @throws if any method is called with a different format
@@ -24,12 +24,23 @@ class ISO8601Time {
         if (!this.validator.formatIsValid(this.value))
             throw new Error("Time format must be ISO8601.");
     }
-    getTime() {
+    getTime(opts) {
         this.validateFormatOrThrow();
-        if (this.validator.isHHmm(this.value)) {
-            return `${this.value}:00`;
+        if ((opts === null || opts === void 0 ? void 0 : opts.format) == "HH:MM" && this.validator.isHHmm(this.value)) {
+            return this.value;
         }
-        return this.value;
+        if (((opts === null || opts === void 0 ? void 0 : opts.format) == "HH:MM:SS" || !(opts === null || opts === void 0 ? void 0 : opts.format)) &&
+            this.validator.isHHmmSS(this.value)) {
+            return this.value;
+        }
+        if ((opts === null || opts === void 0 ? void 0 : opts.format) == "HH:MM" && this.validator.isHHmmSS(this.value)) {
+            return `${this.getHours()}:${this.getMinutes()}`;
+        }
+        if (((opts === null || opts === void 0 ? void 0 : opts.format) == "HH:MM:SS" || !(opts === null || opts === void 0 ? void 0 : opts.format)) &&
+            this.validator.isHHmm(this.value)) {
+            return `${this.getHours()}:${this.getMinutes()}:${this.getSeconds()}`;
+        }
+        throw new Error("Time format is invalid.");
     }
     getMinutes() {
         this.validateFormatOrThrow();

package/dist/domain/entities/ISO8601Time.test.js

@@ -20,6 +20,46 @@ describe("ISO8601Time", () => {
             const time = new ISO8601Time_1.ISO8601Time();
             expect(time.value).toBe("23:00:00");
         });
+        it("Should throw given irregular time format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("000:00:10");
+            expect(time).toThrow();
+        });
+        it("Should not throw given HH:MM format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("10:00");
+            expect(time).not.toThrow();
+        });
+        it("Should not throw given HH:MM:SS format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("10:00:00");
+            expect(time).not.toThrow();
+        });
+        it("Should throw given invalid HH:MM:SS format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("25:00:00");
+            expect(time).toThrow();
+        });
+        it("Should throw given invalid HH:MM format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("12:60");
+            expect(time).toThrow();
+        });
+        it("Should throw given invalid negative timezone", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("12:00:00-15:00");
+            expect(time).toThrow();
+        });
+        it("Should throw given invalid positive timezone", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("12:00:00+13:00");
+            expect(time).toThrow();
+        });
+        it("Should not throw given HH:MM:SS(+|-)HH:MM format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("12:00:00-03:00");
+            expect(time).not.toThrow();
+        });
+        it("Should not throw given HH:MM:SS.sssZ format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("12:00:00.000Z");
+            expect(time).not.toThrow();
+        });
+        it("Should not throw given HH:MM:SSZ format", () => {
+            const time = () => new ISO8601Time_1.ISO8601Time("12:00:00Z");
+            expect(time).not.toThrow();
+        });
     });
     describe("ISO8601Time.getNow()", () => {
         it("Should get now time.", () => {
@@ -59,5 +99,25 @@ describe("ISO8601Time", () => {
             const time2 = new ISO8601Time_1.ISO8601Time("00:01:02");
             expect(time2.getTime()).toBe("00:01:02");
         });
+        it("Should return HH:MM if format argument is passed", () => {
+            const time = new ISO8601Time_1.ISO8601Time("00:01");
+            expect(time.getTime({ format: "HH:MM" })).toBe("00:01");
+        });
+        it("Should return HH:MM if format argument is passed and time format is HH:MM:SS", () => {
+            const time = new ISO8601Time_1.ISO8601Time("00:01:10");
+            expect(time.getTime({ format: "HH:MM" })).toBe("00:01");
+        });
+        it("Should return HH:MM:SS by default", () => {
+            const time = new ISO8601Time_1.ISO8601Time("00:01:10");
+            expect(time.getTime()).toBe("00:01:10");
+        });
+        it("Should return HH:MM:SS by default even if format is HH:MM", () => {
+            const time = new ISO8601Time_1.ISO8601Time("00:01");
+            expect(time.getTime()).toBe("00:01:00");
+        });
+        it("Should return HH:MM:SS given format argument", () => {
+            const time = new ISO8601Time_1.ISO8601Time("00:01");
+            expect(time.getTime({ format: "HH:MM:SS" })).toBe("00:01:00");
+        });
     });
 });

package/dist/domain/entities/ISO8601TimeValidator.d.ts

@@ -2,11 +2,24 @@ import { ITimeValidator } from "./TimeValidator";
 export interface IISO8601TimeValidator extends ITimeValidator {
     isHHmmSS: (time: string) => boolean;
     isHHmm: (time: string) => boolean;
+    isHHmmSSPlusNumberedTimezone: (time: string) => boolean;
+    isHHmmSSsssZ: (time: string) => boolean;
+    isHHmmSSZ: (time: string) => boolean;
+    /** Accepted formats: `HH:MM:SS`, `HH:MM`, `HH:MM:SSZ`, `HH:MM:SS.sssZ` and `HH:MM:SS(+|-)HH:MM`. */
+    formatIsValid: (time: string) => boolean;
 }
-export declare class ISO8601TimeValidator implements ITimeValidator {
+export declare class ISO8601TimeValidator implements IISO8601TimeValidator {
+    private upTo23;
+    private upTo59;
     private hhMMssPattern;
     private hhMMPattern;
+    private hhMMssPlusNumberedTimezonePattern;
+    private hhMMssZPattern;
+    private hhMMssSSSZPattern;
     formatIsValid(time: string): boolean;
     isHHmmSS(time: string): boolean;
     isHHmm(time: string): boolean;
+    isHHmmSSPlusNumberedTimezone: (time: string) => boolean;
+    isHHmmSSZ: (time: string) => boolean;
+    isHHmmSSsssZ: (time: string) => boolean;
 }

package/dist/domain/entities/ISO8601TimeValidator.js

@@ -3,11 +3,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ISO8601TimeValidator = void 0;
 class ISO8601TimeValidator {
     constructor() {
-        this.hhMMssPattern = new RegExp("^([0-1][0-9]|[2][0-3]):[0-5][0-9]:[0-5][0-9]$");
-        this.hhMMPattern = new RegExp("^([0-1][0-9]|[2][0-3]):[0-5][0-9]$");
+        this.upTo23 = "([0-1][0-9]|[2][0-3])";
+        this.upTo59 = "[0-5][0-9]";
+        this.hhMMssPattern = new RegExp(`^${this.upTo23}:${this.upTo59}:${this.upTo59}$`);
+        this.hhMMPattern = new RegExp(`^${this.upTo23}:${this.upTo59}$`);
+        this.hhMMssPlusNumberedTimezonePattern = new RegExp(`^${this.upTo23}:${this.upTo59}:${this.upTo59}(\\+((0[0-9]|1[0-2]):${this.upTo59})|\\-((0[0-9]|1[0-4]):${this.upTo59}))$`);
+        this.hhMMssZPattern = new RegExp(`^${this.upTo23}:${this.upTo59}:${this.upTo59}Z$`);
+        this.hhMMssSSSZPattern = new RegExp(`^${this.upTo23}:${this.upTo59}:${this.upTo59}.[0-9]{3}Z$`);
+        this.isHHmmSSPlusNumberedTimezone = (time) => {
+            return this.hhMMssPlusNumberedTimezonePattern.test(time);
+        };
+        this.isHHmmSSZ = (time) => {
+            return this.hhMMssZPattern.test(time);
+        };
+        this.isHHmmSSsssZ = (time) => {
+            return this.hhMMssSSSZPattern.test(time);
+        };
     }
     formatIsValid(time) {
-        return this.isHHmm(time) || this.isHHmmSS(time);
+        return (this.isHHmm(time) ||
+            this.isHHmmSS(time) ||
+            this.isHHmmSSPlusNumberedTimezone(time) ||
+            this.isHHmmSSZ(time) ||
+            this.isHHmmSSsssZ(time));
     }
     isHHmmSS(time) {
         return this.hhMMssPattern.test(time);

package/dist/domain/entities/ISO8601TimeValidator.test.js

@@ -4,12 +4,24 @@ const ISO8601TimeValidator_1 = require("./ISO8601TimeValidator");
 describe("ISO8601TimeValidator", () => {
     const validator = new ISO8601TimeValidator_1.ISO8601TimeValidator();
     describe("ISO8601TimeValidator.formatIsValid()", () => {
-        it("Should not accept ISO8601 timestamp with offset.", () => {
+        it("Should accept ISO8601 timestamp with offset.", () => {
             const time = "00:00:00-03:00";
-            expect(validator.formatIsValid(time)).toBe(false);
+            expect(validator.formatIsValid(time)).toBe(true);
         });
-        it("Should not accept ISO8601 format with timestamp.", () => {
+        it("Should accept ISO8601 format with another offset.", () => {
             const time = "00:00:00-02:00";
+            expect(validator.formatIsValid(time)).toBe(true);
+        });
+        it("Should accept HH:MM:SSZ format.", () => {
+            const time = "00:00:00Z";
+            expect(validator.formatIsValid(time)).toBe(true);
+        });
+        it("Should accept HH:MM:SS.sssZ format.", () => {
+            const time = "00:00:00.000Z";
+            expect(validator.formatIsValid(time)).toBe(true);
+        });
+        it("Should not accept HH:MM:SS.sssZ format with non-numeric digits.", () => {
+            const time = "00:00:00.00dZ";
             expect(validator.formatIsValid(time)).toBe(false);
         });
         it("Should not accept non-ISO8601 formats.", () => {

package/dist/domain/entities/Time.d.ts

@@ -6,4 +6,5 @@ export interface ITime {
     getMinutes: () => string;
     getSeconds: () => string;
     getNow: () => string;
+    readonly timezone?: string;
 }

package/dist/index.cjs

@@ -224,15 +224,33 @@ var ISO8601DateTime = class _ISO8601DateTime {
 // src/domain/entities/ISO8601TimeValidator.ts
 var ISO8601TimeValidator = class {
   constructor() {
+    this.upTo23 = "([0-1][0-9]|[2][0-3])";
+    this.upTo59 = "[0-5][0-9]";
     this.hhMMssPattern = new RegExp(
-      "^([0-1][0-9]|[2][0-3]):[0-5][0-9]:[0-5][0-9]$"
+      `^${this.upTo23}:${this.upTo59}:${this.upTo59}$`
     );
-    this.hhMMPattern = new RegExp(
-      "^([0-1][0-9]|[2][0-3]):[0-5][0-9]$"
+    this.hhMMPattern = new RegExp(`^${this.upTo23}:${this.upTo59}$`);
+    this.hhMMssPlusNumberedTimezonePattern = new RegExp(
+      `^${this.upTo23}:${this.upTo59}:${this.upTo59}(\\+((0[0-9]|1[0-2]):${this.upTo59})|\\-((0[0-9]|1[0-4]):${this.upTo59}))$`
     );
+    this.hhMMssZPattern = new RegExp(
+      `^${this.upTo23}:${this.upTo59}:${this.upTo59}Z$`
+    );
+    this.hhMMssSSSZPattern = new RegExp(
+      `^${this.upTo23}:${this.upTo59}:${this.upTo59}.[0-9]{3}Z$`
+    );
+    this.isHHmmSSPlusNumberedTimezone = (time) => {
+      return this.hhMMssPlusNumberedTimezonePattern.test(time);
+    };
+    this.isHHmmSSZ = (time) => {
+      return this.hhMMssZPattern.test(time);
+    };
+    this.isHHmmSSsssZ = (time) => {
+      return this.hhMMssSSSZPattern.test(time);
+    };
   }
   formatIsValid(time) {
-    return this.isHHmm(time) || this.isHHmmSS(time);
+    return this.isHHmm(time) || this.isHHmmSS(time) || this.isHHmmSSPlusNumberedTimezone(time) || this.isHHmmSSZ(time) || this.isHHmmSSsssZ(time);
   }
   isHHmmSS(time) {
     return this.hhMMssPattern.test(time);
@@ -246,7 +264,7 @@ var ISO8601TimeValidator = class {
 var ISO8601Time = class _ISO8601Time {
   /**
    * Throws if format is invalid.
-   * Accepted formats: HH:MM:SS and HH:MM. 
+   * Accepted formats: HH:MM:SS and HH:MM.
    */
   constructor(value) {
     this.validator = new ISO8601TimeValidator();
@@ -258,12 +276,21 @@ var ISO8601Time = class _ISO8601Time {
     if (!this.validator.formatIsValid(this.value))
       throw new Error("Time format must be ISO8601.");
   }
-  getTime() {
+  getTime(opts) {
     this.validateFormatOrThrow();
-    if (this.validator.isHHmm(this.value)) {
-      return `${this.value}:00`;
+    if ((opts == null ? void 0 : opts.format) == "HH:MM" && this.validator.isHHmm(this.value)) {
+      return this.value;
+    }
+    if (((opts == null ? void 0 : opts.format) == "HH:MM:SS" || !(opts == null ? void 0 : opts.format)) && this.validator.isHHmmSS(this.value)) {
+      return this.value;
+    }
+    if ((opts == null ? void 0 : opts.format) == "HH:MM" && this.validator.isHHmmSS(this.value)) {
+      return `${this.getHours()}:${this.getMinutes()}`;
+    }
+    if (((opts == null ? void 0 : opts.format) == "HH:MM:SS" || !(opts == null ? void 0 : opts.format)) && this.validator.isHHmm(this.value)) {
+      return `${this.getHours()}:${this.getMinutes()}:${this.getSeconds()}`;
     }
-    return this.value;
+    throw new Error("Time format is invalid.");
   }
   getMinutes() {
     this.validateFormatOrThrow();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eliasrrosa/tutorhub-public-assets",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Assets, mainly interfaces, to be shared among different Tutorhub apps.",
   "type": "module",
   "main": "./dist/index.cjs",