Bound each encoder to return NaN if index oob

Author: dingosky

src/lib/bits.ts

@@ -1,7 +1,7 @@
 import { EntropyByBytes, EntropyByValues, EntropyFunction, PuidBitsMuncher } from '../types/puid'
 
-import encoder from './encoder'
 import { entropyBitsPerChar } from './entropy'
+import puidEncoder from './puidEncoder'
 
 const { ceil, floor, log2, round } = Math
 
@@ -139,7 +139,7 @@ export default (puidLen: number, puidChars: string, entropyFunction: EntropyFunc
   const entropyBuffer = new ArrayBuffer(bufferLen)
   const entropyBytes = new Uint8Array(entropyBuffer)
 
-  const charsEncoder = encoder(puidChars)
+  const charsEncoder = puidEncoder(puidChars)
   const nChars = puidChars.length
   const mapper = new Array(puidLen).fill(0).map((zero, ndx) => zero + ndx)
 

src/lib/chars.spec.ts

@@ -34,6 +34,7 @@ test('valid custom characters', (t) => t.is(validChars('dingosky')[0], true))
 test('invalid characters', (t) => {
   t.regex(invalidChars('dingo sky'), /Invalid/)
   t.regex(invalidChars('dingo sky'), /Invalid/)
+  t.regex(invalidChars('dingo"sky'), /Invalid/)
   t.regex(invalidChars("dingo'sky"), /Invalid/)
   t.regex(invalidChars('dingo\\sky'), /Invalid/)
   t.regex(invalidChars('dingo`sky'), /Invalid/)

src/lib/chars.ts

@@ -17,7 +17,7 @@ export enum Chars {
   Crockford32 = '0123456789ABCDEFGHJKMNPQRSTVWXYZ',
   Decimal = '0123456789',
   Hex = '0123456789abcdef',
-  HexUpper = '0123456789ABCDEF',
+  HexUpper = Base16,
   SafeAscii = '!#$%&()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_abcdefghijklmnopqrstuvwxyz{|}~',
   Safe32 = '2346789bdfghjmnpqrtBDFGHJLMNPQRT',
   Safe64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_',
@@ -38,7 +38,6 @@ export const charsName = (chars: string): string => {
   if (chars === Chars.Base32HexUpper) return 'base32HexUpper'
   if (chars === Chars.Crockford32) return 'crockford32'
   if (chars === Chars.Hex) return 'hex'
-  if (chars === Chars.HexUpper) return 'hexUpper'
   if (chars === Chars.Safe32) return 'safe32'
   if (chars === Chars.Safe64) return 'safe64'
   if (chars === Chars.SafeAscii) return 'safeAscii'
@@ -61,8 +60,6 @@ const validChar = (char: string): boolean => {
   if (codePoint <= codePointOf('~')) return true
   if (codePoint < codePointNonBreakSpace) return false
 
-  if (char.codePointAt(1)) return false
-
   return true
 }
 

src/lib/encoder.spec.ts

@@ -1,8 +1,15 @@
 import { PuidEncoder } from '../../types/puid'
 
+import boundEncoder from './boundEncoder'
+
 export default (): PuidEncoder => {
   const upper = 'A'.charCodeAt(0)
-  const lower = 'a'.charCodeAt(0) - 26
+  const lower = 'a'.charCodeAt(0)
+
+  const puidEncoder = (n: number) => {
+    if (n < 26) return n + upper
+    return n - 26 + lower
+  }
 
-  return (n: number) => n + (n < 26 ? upper : lower)
+  return boundEncoder(puidEncoder, 52)
 }

src/lib/encoder/alpha.ts

@@ -1,7 +1,11 @@
 import { PuidEncoder } from '../../types/puid'
 
+import boundEncoder from './boundEncoder'
+
 export default (uppercase = false): PuidEncoder => {
   const alpha = (uppercase ? 'A' : 'a').charCodeAt(0)
 
-  return (n: number) => n + alpha
+  const puidEncoder = (n: number) => n + alpha
+
+  return boundEncoder(puidEncoder, 26)
 }

src/lib/encoder/alphaCase.ts

@@ -1,13 +1,17 @@
 import { PuidEncoder } from '../../types/puid'
 
+import boundEncoder from './boundEncoder'
+
 export default (): PuidEncoder => {
   const upper = 'A'.charCodeAt(0)
-  const lower = 'a'.charCodeAt(0) - 26
-  const decimal = '0'.charCodeAt(0) - 52
+  const lower = 'a'.charCodeAt(0)
+  const decimal = '0'.charCodeAt(0)
 
-  return (n: number) => {
+  const puidEncoder = (n: number) => {
     if (n < 26) return n + upper
-    if (n < 52) return n + lower
-    return n + decimal
+    if (n < 52) return n - 26 + lower
+    return n - 52 + decimal
   }
+
+  return boundEncoder(puidEncoder, 62)
 }

src/lib/encoder/alphaNum.ts

@@ -1,11 +1,15 @@
 import { PuidEncoder } from '../../types/puid'
 
+import boundEncoder from './boundEncoder'
+
 export default (uppercase = false): PuidEncoder => {
   const decimal = '0'.charCodeAt(0)
-  const alpha = (uppercase ? 'A' : 'a').charCodeAt(0) - 10
+  const alpha = (uppercase ? 'A' : 'a').charCodeAt(0)
 
-  return (n: number) => {
+  const puidEncoder = (n: number) => {
     if (n < 10) return n + decimal
-    return n + alpha
+    return n - 10 + alpha
   }
+
+  return boundEncoder(puidEncoder, 36)
 }

src/lib/encoder/alphaNumCase.ts

@@ -1,8 +1,15 @@
 import { PuidEncoder } from '../../types/puid'
 
+import boundEncoder from './boundEncoder'
+
 export default (): PuidEncoder => {
   const decimal = '0'.charCodeAt(0)
-  const alpha = 'A'.charCodeAt(0) - 10
+  const alpha = 'A'.charCodeAt(0)
+
+  const puidEncoder = (n: number) => {
+    if (n < 10) return n + decimal
+    return n - 10 + alpha
+  }
 
-  return (n: number) => n + (n < 10 ? decimal : alpha)
+  return boundEncoder(puidEncoder, 16)
 }

src/lib/encoder/base16.ts

@@ -1,8 +1,15 @@
 import { PuidEncoder } from '../../types/puid'
 
+import boundEncoder from './boundEncoder'
+
 export default (): PuidEncoder => {
   const alpha = 'A'.charCodeAt(0)
-  const decimal = '2'.charCodeAt(0) - 26
+  const decimal = '2'.charCodeAt(0)
+
+  const puidEncoder = (n: number) => {
+    if (n < 26) return n + alpha
+    return n - 26 + decimal
+  }
 
-  return (n: number) => n + (n < 26 ? alpha : decimal)
+  return boundEncoder(puidEncoder, 32)
 }