@etsoo/shared 1.1.29 → 1.1.32

package/README.md

@@ -68,6 +68,7 @@ ETSOO Extended abstract history class
 |back|Back to the previous state|
 |clear|Clear all states but keep event listeners|
 |forward|Forward to the next state|
+|getStatus|Get [undo, redo] status|
 |go|Go to the specific state|
 |pushState|Adds an entry to the history stack|
 |replaceState|Modifies the current history entry|

package/__tests__/EHistory.ts

@@ -1,17 +1,7 @@
-import {
-    EHistory,
-    EHistoryEventData,
-    EHistoryEventType
-} from '../src/types/EHistory';
-import { EventBase } from '../src/types/EventClass';
+import { EHistory, EHistoryEvent } from '../src/types/EHistory';
 
 // Extended for tests
-class LHistoryEvent extends EventBase<EHistoryEventType, EHistoryEventData> {}
-class LHistory extends EHistory<number, EHistoryEventData> {
-    protected createEvent(type: EHistoryEventType, index: number) {
-        return new LHistoryEvent(this, type, { index });
-    }
-}
+class LHistory extends EHistory<number> {}
 
 test('Tests for history', () => {
     const history = new LHistory();
@@ -37,7 +27,7 @@ test('Tests for history', () => {
 
 test('Tests for events', () => {
     const navigatorFn = jest.fn();
-    const navigatorStopFn = jest.fn((event: LHistoryEvent) => {
+    const navigatorStopFn = jest.fn((event: EHistoryEvent) => {
         event.stopImmediatePropagation();
     });
     const clearFn = jest.fn();

package/lib/cjs/index.d.ts

@@ -1,5 +1,7 @@
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
+export * from './types/EHistory';
+export * from './types/EventClass';
 export * from './types/FormData';
 export * from './storage/IStorage';
 export * from './storage/WindowStorage';

package/lib/cjs/index.js

@@ -16,6 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/DelayedExecutorType"), exports);
 __exportStar(require("./types/EColor"), exports);
+__exportStar(require("./types/EHistory"), exports);
+__exportStar(require("./types/EventClass"), exports);
 __exportStar(require("./types/FormData"), exports);
 __exportStar(require("./storage/IStorage"), exports);
 __exportStar(require("./storage/WindowStorage"), exports);

package/lib/cjs/types/EHistory.d.ts

@@ -12,10 +12,15 @@ export interface EHistoryEventData {
      */
     index: number;
 }
+/**
+ * ETSOO Extended history event
+ */
+export declare class EHistoryEvent extends EventBase<EHistoryEventType, EHistoryEventData> {
+}
 /**
  * ETSOO Extended abstract history class
  */
-export declare abstract class EHistory<T, D extends EHistoryEventData> extends EventClass<EHistoryEventType, D> {
+export declare abstract class EHistory<T> extends EventClass<EHistoryEventType, EHistoryEventData> {
     private _index;
     /**
      * States
@@ -46,11 +51,15 @@ export declare abstract class EHistory<T, D extends EHistoryEventData> extends E
      * @param type Type
      * @param index Current index
      */
-    protected abstract createEvent(type: EHistoryEventType, index: number): EventBase<EHistoryEventType, D>;
+    protected createEvent(type: EHistoryEventType, index: number): EHistoryEvent;
     /**
      * Forward to the next state
      */
     forward(): void;
+    /**
+     * Get [undo, redo] status
+     */
+    getStatus(): [boolean, boolean];
     /**
      * Go to the specific state
      * @param delta A negative value moves backwards, a positive value moves forwards

package/lib/cjs/types/EHistory.js

@@ -1,7 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EHistory = void 0;
+exports.EHistory = exports.EHistoryEvent = void 0;
 const EventClass_1 = require("./EventClass");
+/**
+ * ETSOO Extended history event
+ */
+class EHistoryEvent extends EventClass_1.EventBase {
+}
+exports.EHistoryEvent = EHistoryEvent;
 /**
  * ETSOO Extended abstract history class
  */
@@ -50,12 +56,32 @@ class EHistory extends EventClass_1.EventClass {
         this._index = -1;
         this.trigger(this.createEvent('clear', this._index));
     }
+    /**
+     * Create event
+     * @param type Type
+     * @param index Current index
+     */
+    createEvent(type, index) {
+        return new EHistoryEvent(this, type, { index });
+    }
     /**
      * Forward to the next state
      */
     forward() {
         this.go(1);
     }
+    /**
+     * Get [undo, redo] status
+     */
+    getStatus() {
+        if (this.length < 2)
+            return [false, false];
+        if (this._index <= 0)
+            return [false, true];
+        if (this._index + 1 >= this.length)
+            return [true, false];
+        return [true, true];
+    }
     /**
      * Go to the specific state
      * @param delta A negative value moves backwards, a positive value moves forwards

package/lib/mjs/index.d.ts

@@ -1,5 +1,7 @@
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
+export * from './types/EHistory';
+export * from './types/EventClass';
 export * from './types/FormData';
 export * from './storage/IStorage';
 export * from './storage/WindowStorage';

package/lib/mjs/index.js

@@ -1,5 +1,7 @@
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
+export * from './types/EHistory';
+export * from './types/EventClass';
 export * from './types/FormData';
 export * from './storage/IStorage';
 export * from './storage/WindowStorage';

package/lib/mjs/types/EHistory.d.ts

@@ -12,10 +12,15 @@ export interface EHistoryEventData {
      */
     index: number;
 }
+/**
+ * ETSOO Extended history event
+ */
+export declare class EHistoryEvent extends EventBase<EHistoryEventType, EHistoryEventData> {
+}
 /**
  * ETSOO Extended abstract history class
  */
-export declare abstract class EHistory<T, D extends EHistoryEventData> extends EventClass<EHistoryEventType, D> {
+export declare abstract class EHistory<T> extends EventClass<EHistoryEventType, EHistoryEventData> {
     private _index;
     /**
      * States
@@ -46,11 +51,15 @@ export declare abstract class EHistory<T, D extends EHistoryEventData> extends E
      * @param type Type
      * @param index Current index
      */
-    protected abstract createEvent(type: EHistoryEventType, index: number): EventBase<EHistoryEventType, D>;
+    protected createEvent(type: EHistoryEventType, index: number): EHistoryEvent;
     /**
      * Forward to the next state
      */
     forward(): void;
+    /**
+     * Get [undo, redo] status
+     */
+    getStatus(): [boolean, boolean];
     /**
      * Go to the specific state
      * @param delta A negative value moves backwards, a positive value moves forwards

package/lib/mjs/types/EHistory.js

@@ -1,4 +1,9 @@
-import { EventClass } from './EventClass';
+import { EventBase, EventClass } from './EventClass';
+/**
+ * ETSOO Extended history event
+ */
+export class EHistoryEvent extends EventBase {
+}
 /**
  * ETSOO Extended abstract history class
  */
@@ -47,12 +52,32 @@ export class EHistory extends EventClass {
         this._index = -1;
         this.trigger(this.createEvent('clear', this._index));
     }
+    /**
+     * Create event
+     * @param type Type
+     * @param index Current index
+     */
+    createEvent(type, index) {
+        return new EHistoryEvent(this, type, { index });
+    }
     /**
      * Forward to the next state
      */
     forward() {
         this.go(1);
     }
+    /**
+     * Get [undo, redo] status
+     */
+    getStatus() {
+        if (this.length < 2)
+            return [false, false];
+        if (this._index <= 0)
+            return [false, true];
+        if (this._index + 1 >= this.length)
+            return [true, false];
+        return [true, true];
+    }
     /**
      * Go to the specific state
      * @param delta A negative value moves backwards, a positive value moves forwards

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.29",
+    "version": "1.1.32",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/index.ts

@@ -1,5 +1,7 @@
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
+export * from './types/EHistory';
+export * from './types/EventClass';
 export * from './types/FormData';
 
 export * from './storage/IStorage';

package/src/types/EHistory.ts

@@ -15,13 +15,21 @@ export interface EHistoryEventData {
     index: number;
 }
 
+/**
+ * ETSOO Extended history event
+ */
+export class EHistoryEvent extends EventBase<
+    EHistoryEventType,
+    EHistoryEventData
+> {}
+
 /**
  * ETSOO Extended abstract history class
  */
-export abstract class EHistory<
-    T,
-    D extends EHistoryEventData
-> extends EventClass<EHistoryEventType, D> {
+export abstract class EHistory<T> extends EventClass<
+    EHistoryEventType,
+    EHistoryEventData
+> {
     // Index
     private _index: number = -1;
 
@@ -74,10 +82,9 @@ export abstract class EHistory<
      * @param type Type
      * @param index Current index
      */
-    protected abstract createEvent(
-        type: EHistoryEventType,
-        index: number
-    ): EventBase<EHistoryEventType, D>;
+    protected createEvent(type: EHistoryEventType, index: number) {
+        return new EHistoryEvent(this, type, { index });
+    }
 
     /**
      * Forward to the next state
@@ -86,6 +93,16 @@ export abstract class EHistory<
         this.go(1);
     }
 
+    /**
+     * Get [undo, redo] status
+     */
+    getStatus(): [boolean, boolean] {
+        if (this.length < 2) return [false, false];
+        if (this._index <= 0) return [false, true];
+        if (this._index + 1 >= this.length) return [true, false];
+        return [true, true];
+    }
+
     /**
      * Go to the specific state
      * @param delta A negative value moves backwards, a positive value moves forwards