feat(core): add Uid primitive and its tests

Author: binier

packages/core/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('../../jest.project')({ dirname: __dirname });

packages/core/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@dgraphium/core",
+  "license": "MIT",
+  "version": "0.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/binier/dgraphium.git",
+    "directory": "packages/core"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean:dist": "rimraf dist",
+    "compile": "tsc -b tsconfig.build.json",
+    "build": "yarn clean:dist && yarn compile",
+    "test": "jest --coverage",
+    "test:watch": "jest --coverage --watch",
+    "test:prod": "yarn test -- --no-cache",
+    "report-coverage": "cat ./coverage/lcov.info | coveralls",
+    "prepublishOnly": "yarn build"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.2.1",
+    "@types/node": "^13.13.0",
+    "coveralls": "^3.0.2",
+    "jest": "^25.4.0",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^25.4.0",
+    "ts-node": "^8.8.2",
+    "typescript": "^3.0.3"
+  }
+}

packages/core/src/index.ts

@@ -0,0 +1 @@
+export * from './uid';

packages/core/src/uid.ts

@@ -0,0 +1,32 @@
+export type UidLike = Uid | string | number;
+
+const uidRegex = new RegExp(/^(0x)?[0-9a-f]{1,16}$/, 'i');
+
+export function isValidUid(uid: UidLike) {
+  switch (typeof uid) {
+    case 'string': return uidRegex.test(uid);
+    case 'number': return uid > 0 && Number.isSafeInteger(uid);
+    default: return false;
+  }
+}
+
+export class Uid {
+  private val: string;
+
+  constructor(uid: UidLike) {
+    if (uid instanceof Uid)
+      return new Uid(uid.val);
+
+    if (!isValidUid(uid))
+      throw Error('invalid_uid');
+
+    if (typeof uid === 'number')
+      this.val = '0x' + uid.toString(16);
+    else
+      this.val = uid.startsWith('0x') ? uid : ('0x' + uid);
+  }
+
+  toString() {
+    return this.val;
+  }
+}

packages/core/test/uid.test.ts

@@ -0,0 +1,37 @@
+import { Uid, UidLike, isValidUid } from '../src/uid';
+
+const attachValOnFail = (uid: UidLike, fn: () => any) => {
+  try { fn(); }
+  catch (err) {
+    err.message = `${err.message}\n\nPassed Uid: ${uid}`;
+    throw err;
+  }
+};
+
+const shouldBeInvalid = (val: UidLike) => attachValOnFail(val, () => {
+  expect(isValidUid(val)).toBeFalsy();
+  expect(() => new Uid(val)).toThrow();
+});
+
+const shouldBeValid = (val: UidLike) => attachValOnFail(val, () => {
+  expect(isValidUid(val)).toBeTruthy();
+  expect(() => new Uid(val)).not.toThrow();
+});
+
+describe('Uid test', () => {
+  it('should throw if uid: number and is negative', () => {
+    shouldBeInvalid(-1);
+  });
+
+  it('should throw if uid: string and is invalid', () => {
+    shouldBeInvalid('0xg');
+    shouldBeInvalid('xf');
+    shouldBeInvalid('');
+    shouldBeInvalid(' ');
+  });
+
+  it('should allow uid: string without "0x" prefix', () => {
+    shouldBeValid('0');
+    shouldBeValid('f');
+  });
+});

packages/core/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.build.json",
+
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+
+  "include": [
+    "src/**/*"
+  ]
+}

packages/core/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.json",
+
+  "compilerOptions": {
+  }
+}