Merge pull request #48 from simple-ssi/jrayback_240605_misc-cleanup

made small improvements on latest release

README.md

@@ -114,3 +114,9 @@ Run all tests, format the code, transpile for ECMAScript and CommonJS, and write
 ```bash
 npm run full-build
 ```
+
+Three files that serve as a good starting point for developers becoming familiar with the project.
+
+`src/api/encode/text.ts`
+`src/api/transform/transformers/transformTextToRaw.ts`
+`src/implementation/make.ts`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simple-ssi/simple-cesr",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "A simple, limited, true-to-spec implementation of the CESR protocol.",
   "type": "module",
   "access": "public",

src/api/transform/steps/readCodeFromText.ts

@@ -9,13 +9,13 @@ const readTwoCharCode = (text: Text): Code => text.substring(0, 2) as Code
 const readFourCharCode = (text: Text): Code => text.substring(0, 4) as Code
 
 // reads the code characters from the Text
-export const readCodeFromText = (textDomain: Text): Code => {
-  const selector = textDomain[0] as Selector
+export const readCodeFromText = (text: Text): Code => {
+  const selector = text[0] as Selector
   return selector !== '0' && selector !== '1'
-    ? readOneCharCode(textDomain)
+    ? readOneCharCode(text)
     : selector === '0'
-      ? readTwoCharCode(textDomain)
+      ? readTwoCharCode(text)
       : selector === '1'
-        ? readFourCharCode(textDomain)
+        ? readFourCharCode(text)
         : exhaustive(selector)
 }

src/lib/util/exhaustive.ts

@@ -1,5 +1,11 @@
 // TypeScript exhaustiveness check
 // see https://www.typescriptlang.org/docs/handbook/2/narrowing.html#exhaustiveness-checking
 export const exhaustive = (x: never): never => {
-  throw new Error("Didn't expect to get here")
+  throw new ExhuastivenessCheckFailure()
+}
+export class ExhuastivenessCheckFailure extends Error {
+  constructor () {
+    super('Exhaustiveness check failed. Should not have been able to get here.')
+    this.name = 'EXHAUSTIVENESS_CHECK_FAILURE'
+  }
 }