@zajno/common 2.2.10 → 2.2.12

package/dates/calendarIndex.d.ts

@@ -0,0 +1,47 @@
+export interface IMonthIndex {
+    month: number;
+}
+export interface IWeekIndex extends IMonthIndex {
+    week: number;
+}
+export interface IDayIndex extends IWeekIndex {
+    day: number;
+}
+/**
+ * Helps with converting sequential index to 0- or 1-based month, week, day index.
+ *
+ * Allows to use any number of days per week, not just 7. Also one can set any number of weeks per month (but it will be used globally).
+ *
+ * To update the value, either set `raw` property or use `set` method.
+ *
+ * Usage case: some ordered sequence of items, each has its own index, and you want to distribute them by months, weeks and days, knowing the number of items assigned per week.
+ */
+export declare class CalendarIndex implements IDayIndex {
+    readonly perWeek: number;
+    readonly base: 1 | 0;
+    static WEEKS_PER_MONTH: number;
+    /** sequential index */
+    raw: number;
+    /**
+     * @param perWeek how many indexes allocated per week
+     * @param [base=0] 1 or 0 - determines base for all indexes (0 by default)
+     */
+    constructor(perWeek?: number, base?: 1 | 0);
+    get perMonth(): number;
+    /** 1/0-based month index based on `perWeek` property */
+    get month(): number;
+    get fullWeek(): number;
+    /** 1/0-based week index based on `perWeek` property */
+    get week(): number;
+    get day(): number;
+    set(month: number, week?: number, day?: number): this;
+    toIndex(): IDayIndex;
+}
+/** returns based (1/0) remainder of `value / div`
+ *
+ * Ex.: get day of week
+*/
+export declare function basedRemainder(this: void, base: 1 | 0, value: number, div: number): number;
+/** returns based (1/0) floor'ed of `value / div` */
+export declare function basedFloor(this: void, base: 1 | 0, value: number, div: number): number;
+//# sourceMappingURL=calendarIndex.d.ts.map

package/dates/calendarIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calendarIndex.d.ts","sourceRoot":"","sources":["../../src/dates/calendarIndex.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,WAAW;IACxB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC3C,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAU,SAAQ,UAAU;IACzC,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,qBAAa,aAAc,YAAW,SAAS;IAW/B,QAAQ,CAAC,OAAO,EAAE,MAAM;IAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC;IAT9D,MAAM,CAAC,eAAe,SAAK;IAE3B,uBAAuB;IAChB,GAAG,EAAE,MAAM,CAAK;IAEvB;;;OAGG;gBACkB,OAAO,GAAE,MAAU,EAAW,IAAI,GAAE,CAAC,GAAG,CAAK;IAElE,IAAW,QAAQ,WAA2D;IAE9E,wDAAwD;IACxD,IAAW,KAAK,WAMf;IAED,IAAW,QAAQ,WAMlB;IAED,uDAAuD;IACvD,IAAW,IAAI,WAOd;IAED,IAAW,GAAG,WAEb;IAEM,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,MAAkB,EAAE,GAAG,GAAE,MAAkB;IAOpE,OAAO,IAAI,SAAS;CAO9B;AAED;;;EAGE;AACF,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,UAEjF;AAED,oDAAoD;AACpD,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,UAE7E"}

package/dates/calendarIndex.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.basedFloor = exports.basedRemainder = exports.CalendarIndex = void 0;
+/**
+ * Helps with converting sequential index to 0- or 1-based month, week, day index.
+ *
+ * Allows to use any number of days per week, not just 7. Also one can set any number of weeks per month (but it will be used globally).
+ *
+ * To update the value, either set `raw` property or use `set` method.
+ *
+ * Usage case: some ordered sequence of items, each has its own index, and you want to distribute them by months, weeks and days, knowing the number of items assigned per week.
+ */
+class CalendarIndex {
+    perWeek;
+    base;
+    static WEEKS_PER_MONTH = 4;
+    /** sequential index */
+    raw = 0;
+    /**
+     * @param perWeek how many indexes allocated per week
+     * @param [base=0] 1 or 0 - determines base for all indexes (0 by default)
+     */
+    constructor(perWeek = 7, base = 0) {
+        this.perWeek = perWeek;
+        this.base = base;
+    }
+    get perMonth() { return this.perWeek * CalendarIndex.WEEKS_PER_MONTH; }
+    /** 1/0-based month index based on `perWeek` property */
+    get month() {
+        if (this.raw <= 0) {
+            return 0;
+        }
+        return basedFloor(this.base, this.raw, this.perMonth);
+    }
+    get fullWeek() {
+        if (this.raw <= 0) {
+            return 0;
+        }
+        return basedFloor(this.base, this.raw, this.perWeek);
+    }
+    /** 1/0-based week index based on `perWeek` property */
+    get week() {
+        const fw = this.fullWeek;
+        if (fw === 0) {
+            return 0;
+        }
+        return basedRemainder(this.base, fw, CalendarIndex.WEEKS_PER_MONTH);
+    }
+    get day() {
+        return basedRemainder(this.base, this.raw, this.perWeek);
+    }
+    set(month, week = this.base, day = this.base) {
+        const m = Math.max(month - this.base, 0);
+        const w = Math.max(week - this.base, 0);
+        this.raw = m * this.perMonth + w * this.perWeek + day;
+        return this;
+    }
+    toIndex() {
+        return {
+            month: this.month,
+            week: this.week,
+            day: this.day,
+        };
+    }
+}
+exports.CalendarIndex = CalendarIndex;
+/** returns based (1/0) remainder of `value / div`
+ *
+ * Ex.: get day of week
+*/
+function basedRemainder(base, value, div) {
+    return (value - base) % div + base;
+}
+exports.basedRemainder = basedRemainder;
+/** returns based (1/0) floor'ed of `value / div` */
+function basedFloor(base, value, div) {
+    return Math.floor((value - base) / div) + base;
+}
+exports.basedFloor = basedFloor;
+//# sourceMappingURL=calendarIndex.js.map

package/dates/calendarIndex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calendarIndex.js","sourceRoot":"","sources":["../../src/dates/calendarIndex.ts"],"names":[],"mappings":";;;AAaA;;;;;;;;GAQG;AACH,MAAa,aAAa;IAWD;IAA8B;IATnD,MAAM,CAAC,eAAe,GAAG,CAAC,CAAC;IAE3B,uBAAuB;IAChB,GAAG,GAAW,CAAC,CAAC;IAEvB;;;OAGG;IACH,YAAqB,UAAkB,CAAC,EAAW,OAAc,CAAC;QAA7C,YAAO,GAAP,OAAO,CAAY;QAAW,SAAI,GAAJ,IAAI,CAAW;IAAI,CAAC;IAEvE,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC,CAAC;IAE9E,wDAAwD;IACxD,IAAW,KAAK;QACZ,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;YAChB,OAAO,CAAC,CAAC;QACb,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,IAAW,QAAQ;QACf,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;YAChB,OAAO,CAAC,CAAC;QACb,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,uDAAuD;IACvD,IAAW,IAAI;QACX,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACzB,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,CAAC;QACb,CAAC;QAED,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IACxE,CAAC;IAED,IAAW,GAAG;QACV,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAEM,GAAG,CAAC,KAAa,EAAE,OAAe,IAAI,CAAC,IAAI,EAAE,MAAc,IAAI,CAAC,IAAI;QACvE,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACtD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,OAAO;QACV,OAAO;YACH,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,GAAG;SAChB,CAAC;IACN,CAAC;;AA3DL,sCA4DC;AAED;;;EAGE;AACF,SAAgB,cAAc,CAAa,IAAW,EAAE,KAAa,EAAE,GAAW;IAC9E,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC;AACvC,CAAC;AAFD,wCAEC;AAED,oDAAoD;AACpD,SAAgB,UAAU,CAAa,IAAW,EAAE,KAAa,EAAE,GAAW;IAC1E,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC;AACnD,CAAC;AAFD,gCAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zajno/common",
-  "version": "2.2.10",
+  "version": "2.2.12",
   "description": "Zajno's re-usable utilities for JS/TS projects",
   "private": false,
   "repository": {