@nymphjs/guid 1.0.0-beta.0

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/jest.config.js

@@ -0,0 +1,6 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  rootDir: 'src/',
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@nymphjs/guid",
+  "version": "1.0.0-beta.0",
+  "description": "NymphJS - GUID and Unique Code Generators",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "nymph",
+    "ORM",
+    "object relational mapper",
+    "guid"
+  ],
+  "scripts": {
+    "clean": "test -d dist && rm -r dist || true",
+    "build": "rollup -c",
+    "watch": "rollup -c --watch",
+    "prepare": "npm run clean && npm run build",
+    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --watch"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sciactive/nymphjs.git"
+  },
+  "author": "Hunter Perrin <hperrin@gmail.com>",
+  "bugs": {
+    "url": "https://github.com/sciactive/nymphjs/issues"
+  },
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-typescript": "^9.0.2",
+    "@tsconfig/recommended": "^1.0.1",
+    "@types/jest": "^29.2.3",
+    "@types/luxon": "^3.1.0",
+    "@types/nanoid-dictionary": "^4.2.0",
+    "@types/sha1": "^1.1.3",
+    "jest": "^29.3.1",
+    "luxon": "^3.1.0",
+    "nanoid": "^4.0.0",
+    "nanoid-dictionary": "^4.3.0",
+    "rollup": "^3.3.0",
+    "sha1": "^1.1.1",
+    "ts-jest": "^29.0.3",
+    "tslib": "^2.4.1",
+    "typescript": "^4.9.3"
+  },
+  "gitHead": "80622ad09351ad12519208e7edb0b0db412fae50"
+}

package/rollup.config.mjs

@@ -0,0 +1,12 @@
+import typescript from '@rollup/plugin-typescript';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+
+export default {
+  input: 'src/index.ts',
+  output: {
+    file: 'dist/index.js',
+    format: 'cjs',
+  },
+  plugins: [nodeResolve(), commonjs(), typescript()],
+};

package/src/index.test.ts

@@ -0,0 +1,47 @@
+import {
+  nanoid as realNanoid,
+  customAlphabet as realCustomAlphabet,
+} from 'nanoid';
+
+import {
+  guid,
+  makeTableSuffix,
+  humanSecret,
+  nanoid,
+  customAlphabet,
+} from './index';
+
+describe('GUID', () => {
+  it('exports nanoid and customAlphabet', () => {
+    expect(nanoid).toBe(realNanoid);
+    expect(customAlphabet).toBe(realCustomAlphabet);
+  });
+
+  it('generates GUIDs', () => {
+    let guid1 = guid();
+    let guid2 = guid();
+
+    expect(guid1.length).toBe(24);
+    expect(guid2.length).toBe(24);
+    expect(guid1).not.toEqual(guid2);
+    expect(guid1.substring(0, 4)).toEqual(guid2.substring(0, 4));
+  });
+
+  it('generates table suffixes', () => {
+    let tableSuffix1 = makeTableSuffix();
+    let tableSuffix2 = makeTableSuffix();
+
+    expect(tableSuffix1.length).toBe(20);
+    expect(tableSuffix2.length).toBe(20);
+    expect(tableSuffix1).not.toEqual(tableSuffix2);
+  });
+
+  it('generates human readable secrets', () => {
+    let secret1 = humanSecret();
+    let secret2 = humanSecret();
+
+    expect(secret1.length).toBe(10);
+    expect(secret2.length).toBe(10);
+    expect(secret1).not.toEqual(secret2);
+  });
+});

package/src/index.ts

@@ -0,0 +1,22 @@
+import { nanoid, customAlphabet } from 'nanoid';
+import { DateTime } from 'luxon';
+import sha1 from 'sha1';
+import dictionary from 'nanoid-dictionary';
+
+const { nolookalikesSafe } = dictionary;
+
+const guidSuffix = customAlphabet('0123456789abcdef', 20);
+export function guid() {
+  return `${sha1(
+    `${DateTime.now().weekYear}${DateTime.now().weekNumber}`
+  ).slice(0, 4)}${guidSuffix()}`;
+}
+
+export const makeTableSuffix = customAlphabet(
+  '0123456789abcdefghijklmnopqrstuvwxyz',
+  20
+);
+
+export const humanSecret = customAlphabet(nolookalikesSafe, 10);
+
+export { nanoid, customAlphabet };

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "@tsconfig/recommended/tsconfig.json",
+
+  "compilerOptions": {
+    "noImplicitAny": true,
+    "removeComments": true,
+    "sourceMap": true,
+    "outDir": "dist",
+    "resolveJsonModule": true,
+    "rootDir": "src/",
+    "declaration": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}