@pocket-architect/core 0.1.12 → 0.1.13

package/build/EntityId.d.ts

@@ -2,6 +2,10 @@ export declare class EntityId<T> {
     protected _recordId: T | null;
     protected _uuid: string;
     constructor(recordId?: T, uuid?: string);
+    private createUUID;
+    get hashOptions(): [string, number];
+    toHash(): string;
+    fromHash(hash: string): EntityId<T>;
     toPrimitive(): T;
     toString(): string;
     equals(id: EntityId<T>): boolean;

package/build/EntityId.js

@@ -4,6 +4,7 @@ exports.EntityId = void 0;
 var tslib_1 = require("tslib");
 var uuid_by_string_1 = tslib_1.__importDefault(require("uuid-by-string"));
 var cuid2_1 = require("@paralleldrive/cuid2");
+var hashids_1 = tslib_1.__importDefault(require("hashids"));
 var EntityId = /** @class */ (function () {
     function EntityId(recordId, uuid) {
         if (recordId === void 0) { recordId = null; }
@@ -12,9 +13,36 @@ var EntityId = /** @class */ (function () {
         this._uuid = null;
         this._recordId = recordId ? recordId : null;
         if (!uuid) {
-            this._uuid = (0, uuid_by_string_1.default)(recordId ? recordId.toString() : (0, cuid2_1.createId)(), (0, uuid_by_string_1.default)(this.constructor.name));
+            this.createUUID();
         }
     }
+    EntityId.prototype.createUUID = function () {
+        this._uuid = (0, uuid_by_string_1.default)(this._recordId ? this._recordId.toString() : (0, cuid2_1.createId)(), (0, uuid_by_string_1.default)(this.constructor.name));
+    };
+    Object.defineProperty(EntityId.prototype, "hashOptions", {
+        get: function () {
+            return [this.constructor.name, 5];
+        },
+        enumerable: false,
+        configurable: true
+    });
+    EntityId.prototype.toHash = function () {
+        if (!this._recordId) {
+            throw new Error('Cannot hash an empty recordId');
+        }
+        var hashids = new (hashids_1.default.bind.apply(hashids_1.default, tslib_1.__spreadArray([void 0], this.hashOptions, false)))();
+        return hashids.encode(this.toPrimitive().toString());
+    };
+    EntityId.prototype.fromHash = function (hash) {
+        if (!this._recordId) {
+            throw new Error('Cannot hash an empty recordId');
+        }
+        var hashids = new (hashids_1.default.bind.apply(hashids_1.default, tslib_1.__spreadArray([void 0], this.hashOptions, false)))();
+        var num = hashids.decode(hash)[0];
+        this._recordId = (typeof this._recordId === 'string' ? num.toString() : num);
+        this.createUUID();
+        return this;
+    };
     EntityId.prototype.toPrimitive = function () {
         return this._recordId;
     };

package/build/EntityId.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityId.js","sourceRoot":"","sources":["../src/EntityId.ts"],"names":[],"mappings":";;;;AAAA,0EAAuC;AACvC,8CAA+C;AAE/C;IAIE,kBAAY,QAAkB,EAAE,IAAmB;QAAvC,yBAAA,EAAA,eAAkB;QAAE,qBAAA,EAAA,WAAmB;QAHzC,cAAS,GAAW,IAAI,CAAC;QACzB,UAAK,GAAW,IAAI,CAAC;QAG7B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAA,gBAAQ,GAAE,EAAE,IAAA,wBAAU,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1G,CAAC;IACH,CAAC;IAED,8BAAW,GAAX;QACE,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,2BAAQ,GAAR;QACE,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,yBAAM,GAAN,UAAO,EAAe;QACpB,OAAO,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK,CAAC;IACjC,CAAC;IACH,eAAC;AAAD,CAAC,AAtBD,IAsBC;AAtBY,4BAAQ"}
+{"version":3,"file":"EntityId.js","sourceRoot":"","sources":["../src/EntityId.ts"],"names":[],"mappings":";;;;AAAA,0EAAuC;AACvC,8CAA+C;AAC/C,4DAA8B;AAE9B;IAIE,kBAAY,QAAkB,EAAE,IAAmB;QAAvC,yBAAA,EAAA,eAAkB;QAAE,qBAAA,EAAA,WAAmB;QAHzC,cAAS,GAAW,IAAI,CAAC;QACzB,UAAK,GAAW,IAAI,CAAC;QAG7B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;IAEO,6BAAU,GAAlB;QACE,IAAI,CAAC,KAAK,GAAG,IAAA,wBAAU,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAA,gBAAQ,GAAE,EAAE,IAAA,wBAAU,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACtH,CAAC;IAED,sBAAI,iCAAW;aAAf;YACE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACpC,CAAC;;;OAAA;IAED,yBAAM,GAAN;QACE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,IAAM,OAAO,QAAO,iBAAO,YAAP,iBAAO,kCAAI,IAAI,CAAC,WAAW,YAAC,CAAC;QACjD,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,2BAAQ,GAAR,UAAS,IAAY;QACnB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,IAAM,OAAO,QAAO,iBAAO,YAAP,iBAAO,kCAAI,IAAI,CAAC,WAAW,YAAC,CAAC;QACjD,IAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,SAAS,GAAM,CAAC,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChF,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8BAAW,GAAX;QACE,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,2BAAQ,GAAR;QACE,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,yBAAM,GAAN,UAAO,EAAe;QACpB,OAAO,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK,CAAC;IACjC,CAAC;IACH,eAAC;AAAD,CAAC,AAjDD,IAiDC;AAjDY,4BAAQ"}

package/build/EntityId.spec.js

@@ -9,6 +9,13 @@ var TestId = /** @class */ (function (_super) {
     }
     return TestId;
 }(EntityId_1.EntityId));
+var Test2Id = /** @class */ (function (_super) {
+    tslib_1.__extends(Test2Id, _super);
+    function Test2Id() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return Test2Id;
+}(EntityId_1.EntityId));
 describe('ValueObject', function () {
     test('base', function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
         var id, id2, id3;
@@ -21,5 +28,22 @@ describe('ValueObject', function () {
             return [2 /*return*/];
         });
     }); });
+    test('toHash', function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+        var id, id2, id3;
+        return tslib_1.__generator(this, function (_a) {
+            id = new Test2Id('123');
+            expect(id.toHash()).toEqual('9KdMR');
+            expect(id.fromHash('VLoxm').toPrimitive()).toEqual('1');
+            expect(id.toPrimitive()).toEqual('1');
+            expect(id.toString()).toEqual('090bb5d1-267b-5967-84c8-95bc1bda380f');
+            id2 = new TestId(123);
+            expect(id2.toHash()).toEqual('BJejP');
+            expect(id2.fromHash('BJejP').toPrimitive()).toEqual(123);
+            id3 = new Test2Id();
+            expect(function () { return id3.toHash(); }).toThrow('Cannot hash an empty recordId');
+            expect(function () { return id3.fromHash('123'); }).toThrow('Cannot hash an empty recordId');
+            return [2 /*return*/];
+        });
+    }); });
 });
 //# sourceMappingURL=EntityId.spec.js.map

package/build/EntityId.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityId.spec.js","sourceRoot":"","sources":["../src/EntityId.spec.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAEtC;IAAqB,kCAAgB;IAArC;;IACA,CAAC;IAAD,aAAC;AAAD,CAAC,AADD,CAAqB,mBAAQ,GAC5B;AAED,QAAQ,CAAC,aAAa,EAAE;IACtB,IAAI,CAAC,MAAM,EAAE;;;YACL,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YACnB,GAAG,GAAG,IAAI,mBAAQ,CAAC,GAAG,CAAC,CAAC;YACxB,GAAG,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxB,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;;;SAC7B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"EntityId.spec.js","sourceRoot":"","sources":["../src/EntityId.spec.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAEtC;IAAqB,kCAAgB;IAArC;;IACA,CAAC;IAAD,aAAC;AAAD,CAAC,AADD,CAAqB,mBAAQ,GAC5B;AAED;IAAsB,mCAAgB;IAAtC;;IACA,CAAC;IAAD,cAAC;AAAD,CAAC,AADD,CAAsB,mBAAQ,GAC7B;AAED,QAAQ,CAAC,aAAa,EAAE;IACtB,IAAI,CAAC,MAAM,EAAE;;;YACL,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YACnB,GAAG,GAAG,IAAI,mBAAQ,CAAC,GAAG,CAAC,CAAC;YACxB,GAAG,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxB,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;;;SAC7B,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,EAAE;;;YACP,EAAE,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxD,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC;YAEhE,GAAG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACtC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAEnD,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAM,OAAA,GAAG,CAAC,MAAM,EAAE,EAAZ,CAAY,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;YACpE,MAAM,CAAC,cAAM,OAAA,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAnB,CAAmB,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;;;SAC5E,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pocket-architect/core",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "",
   "main": "build/index.js",
   "scripts": {
@@ -17,6 +17,7 @@
   },
   "dependencies": {
     "@paralleldrive/cuid2": "^2.2.2",
+    "hashids": "^2.3.0",
     "shallow-equal-object": "^1.1.1",
     "uuid-by-string": "^4.0.0"
   },

package/src/EntityId.spec.ts

@@ -3,6 +3,9 @@ import { EntityId } from './EntityId';
 class TestId extends EntityId<number> {
 }
 
+class Test2Id extends EntityId<string> {
+}
+
 describe('ValueObject', () => {
   test('base', async () => {
     const id = new TestId(1);
@@ -11,4 +14,20 @@ describe('ValueObject', () => {
     expect(id).toEqual(id3);
     expect(id).not.toEqual(id2);
   });
+
+  test('toHash', async () => {
+    const id = new Test2Id('123');
+    expect(id.toHash()).toEqual('9KdMR');
+    expect(id.fromHash('VLoxm').toPrimitive()).toEqual('1');
+    expect(id.toPrimitive()).toEqual('1');
+    expect(id.toString()).toEqual('090bb5d1-267b-5967-84c8-95bc1bda380f');
+
+    const id2 = new TestId(123);
+    expect(id2.toHash()).toEqual('BJejP');
+    expect(id2.fromHash('BJejP').toPrimitive()).toEqual(123);
+
+    const id3 = new Test2Id();
+    expect(() => id3.toHash()).toThrow('Cannot hash an empty recordId');
+    expect(() => id3.fromHash('123')).toThrow('Cannot hash an empty recordId');
+  });
 });

package/src/EntityId.ts

@@ -1,5 +1,6 @@
 import createUUID from 'uuid-by-string'
 import { createId } from '@paralleldrive/cuid2'
+import Hashids from 'hashids';
 
 export class EntityId<T> {
   protected _recordId: T|null = null;
@@ -8,10 +9,37 @@ export class EntityId<T> {
   constructor(recordId: T = null, uuid: string = null) {
     this._recordId = recordId ? recordId : null;
     if (!uuid) {
-      this._uuid = createUUID(recordId ? recordId.toString() : createId(), createUUID(this.constructor.name));
+      this.createUUID();
     }
   }
 
+  private createUUID():void {
+    this._uuid = createUUID(this._recordId ? this._recordId.toString() : createId(), createUUID(this.constructor.name));
+  }
+
+  get hashOptions() : [string, number] {
+    return [this.constructor.name, 5];
+  }
+
+  toHash(): string {
+    if (!this._recordId) {
+      throw new Error('Cannot hash an empty recordId');
+    }
+    const hashids = new Hashids(...this.hashOptions);
+    return hashids.encode(this.toPrimitive().toString());
+  }
+
+  fromHash(hash: string) : EntityId<T> {
+    if (!this._recordId) {
+      throw new Error('Cannot hash an empty recordId');
+    }
+    const hashids = new Hashids(...this.hashOptions);
+    const num = hashids.decode(hash)[0];
+    this._recordId = <T>(typeof this._recordId === 'string' ? num.toString() : num);
+    this.createUUID();
+    return this;
+  }
+
   toPrimitive(): T {
     return this._recordId;
   }