chore: upgrade typescript and old dependencies (#316)

* chore: remove jest-fetch-mock dependency

* chore: remove jsdoc since the docs are generated from typedoc

* chore: run npm audit

* chore: remove unused dependency

* upgrade typescript

* chore: upgrade typescript

* upgrade eslint

* add coverate dependency

* remove commonjs build, it does not work anyway

* remove esm subdir

**Note** this only outputs esm output. It should be easy enough to add CJS output if anyone actually needs it.

Author: lenkan

.eslintrc

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         os: [macOS-latest, ubuntu-latest]
-        node-version: ['18', '20']
+        node-version: ['18', '20', '22']
 
     steps:
       - name: Checkout repo
@@ -39,12 +39,12 @@ jobs:
 
       - name: Lint
         run: npm run lint
-      
-      - name: Test
-        run: npm test -- --coverage=true
-      
+
       - name: Build
         run: npm run build
+ 
+      - name: Test
+        run: npm test -- --coverage=true
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4

.github/workflows/main.yml

@@ -30,22 +30,22 @@ encoded strings for the initial implementation. Support for binary CESR can be a
 
 The code is built using Typescript and running code locally requires a Mac or Linux OS.
 
--   Install [Node.js](https://nodejs.org)
+- Install [Node.js](https://nodejs.org)
 
--   Install dependencies:
+- Install dependencies:
     ```bash
     npm install
     ```
 
 Typescript source files needs to be transpiled before running scripts or integration tests
 
--   Build:
+- Build:
 
     ```bash
     npm run build
     ```
 
--   ready() must be called before library is useable. Example minimum viable client code.
+- ready() must be called before library is useable. Example minimum viable client code.
 
     ```javascript
     import { randomPasscode, ready, SignifyClient, Tier } from 'signify-ts';
@@ -120,16 +120,16 @@ Use the npm script "test:integration" to run all integration tests in sequence:
 npm run test:integration
 ```
 
-Or, use execute `jest` directly to run a specific integration test, for example:
+To execute a specific integration test, you can use:
 
 ```bash
-npx jest examples/integration-scripts/credentials.test.ts
+npm run test:integration -- credentials.test.ts
 ```
 
 It is also possible to run the tests using local instances of vLEI, Keria, and witness network. Set the environment variable `TEST_ENVIRONMENT` to `local`, e.g:
 
 ```
-TEST_ENVIRONMENT=local npx jest examples/integration-scripts/credentials.test.ts
+TEST_ENVIRONMENT=local npm run test:integration credentials.test.ts
 ```
 
 This changes the discovery urls to use `localhost` instead of the hostnames inside the docker network.

.jsdoc.json

@@ -0,0 +1,33 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import prettier from 'eslint-config-prettier';
+
+export default tseslint.config(
+    eslint.configs.recommended,
+    tseslint.configs.recommended,
+    { rules: prettier.rules },
+    {
+        // These are files with more lenient lint config because they have not been "fixed" yet
+        // Once a directory here is fixed, it should be removed from here so the strict rules applies
+        files: [
+            'src/keri/app/**',
+            'src/keri/core/**',
+            'examples/integration-scripts/**',
+        ],
+        rules: {
+            'prefer-const': 'warn',
+            'no-var': 'warn',
+            'no-self-assign': 'warn',
+            'no-case-declarations': 'warn',
+            'no-constant-condition': 'warn',
+            'no-empty': 'warn',
+            '@typescript-eslint/no-non-null-asserted-optional-chain': 'warn',
+            '@typescript-eslint/no-explicit-any': 'warn',
+            '@typescript-eslint/no-namespace': 'warn',
+            // '@typescript-eslint/ban-types': 'warn',
+            '@typescript-eslint/no-unused-vars': 'warn',
+        },
+    }
+);

README.md

@@ -1,11 +1,11 @@
-import { strict as assert } from 'assert';
+import { assert, test } from 'vitest';
 import signify, { Serder } from 'signify-ts';
-import { resolveEnvironment } from './utils/resolve-env';
+import { resolveEnvironment } from './utils/resolve-env.ts';
 import {
     assertOperations,
     resolveOobi,
     waitOperation,
-} from './utils/test-util';
+} from './utils/test-util.ts';
 
 const { url, bootUrl } = resolveEnvironment();
 
@@ -98,8 +98,9 @@ test('challenge', async () => {
     // List Client 1 contacts
     let contacts1 = await client1.contacts().list();
     let bobContact = contacts1.find((contact) => contact.alias === 'bob');
-    expect(bobContact?.alias).toEqual('bob');
-    expect(bobContact?.challenges).toHaveLength(0);
+    assert.equal(bobContact?.alias, 'bob');
+    assert(Array.isArray(bobContact?.challenges));
+    assert.strictEqual(bobContact.challenges.length, 0);
 
     // Bob responds to Alice challenge
     await client2.challenges().respond('bob', aid1.i, challenge1_small.words);
@@ -126,7 +127,7 @@ test('challenge', async () => {
     bobContact = contacts1.find((contact) => contact.alias === 'bob');
 
     assert(Array.isArray(bobContact?.challenges));
-    expect(bobContact?.challenges[0].authenticated).toBe(true);
+    assert.strictEqual(bobContact?.challenges[0].authenticated, true);
 
     await assertOperations(client1, client2);
 }, 30000);

eslint.config.mjs

@@ -1,6 +1,6 @@
-import { strict as assert } from 'assert';
+import { assert, beforeAll, afterAll, test, expect } from 'vitest';
 import { Ilks, Saider, Serder, SignifyClient } from 'signify-ts';
-import { resolveEnvironment } from './utils/resolve-env';
+import { resolveEnvironment } from './utils/resolve-env.ts';
 import {
     assertNotifications,
     assertOperations,
@@ -11,10 +11,10 @@ import {
     resolveOobi,
     waitForNotifications,
     waitOperation,
-} from './utils/test-util';
-import { retry } from './utils/retry';
-import { randomUUID } from 'crypto';
-import { step } from './utils/test-step';
+} from './utils/test-util.ts';
+import { retry } from './utils/retry.ts';
+import { randomUUID } from 'node:crypto';
+import { step } from './utils/test-step.ts';
 
 const { vleiServerUrl } = resolveEnvironment();
 
@@ -90,7 +90,7 @@ afterAll(async () => {
     );
 });
 
-test('single signature credentials', async () => {
+test('single signature credentials', { timeout: 90000 }, async () => {
     await step('Resolve schema oobis', async () => {
         await Promise.all([
             resolveOobi(issuerClient, QVI_SCHEMA_URL),
@@ -174,44 +174,55 @@ test('single signature credentials', async () => {
         assert.equal(issuerCredentials[0].status.s, '0');
     });
 
+    function assertLength(obj: unknown, length: number) {
+        assert(obj);
+        assert(typeof obj === 'object');
+        assert('length' in obj);
+        assert.strictEqual(obj.length, length);
+    }
     await step('issuer list credentials with filter', async () => {
-        expect(
+        assertLength(
             await issuerClient
                 .credentials()
-                .list({ filter: { '-i': issuerAid.prefix } })
-        ).toHaveLength(1);
+                .list({ filter: { '-i': issuerAid.prefix } }),
+            1
+        );
 
-        expect(
+        assertLength(
             await issuerClient
                 .credentials()
-                .list({ filter: { '-s': QVI_SCHEMA_SAID } })
-        ).toHaveLength(1);
+                .list({ filter: { '-s': QVI_SCHEMA_SAID } }),
+            1
+        );
 
-        expect(
+        assertLength(
             await issuerClient
                 .credentials()
-                .list({ filter: { '-a-i': holderAid.prefix } })
-        ).toHaveLength(1);
+                .list({ filter: { '-a-i': holderAid.prefix } }),
+            1
+        );
 
-        expect(
+        assertLength(
             await issuerClient.credentials().list({
                 filter: {
                     '-i': issuerAid.prefix,
                     '-s': QVI_SCHEMA_SAID,
                     '-a-i': holderAid.prefix,
                 },
-            })
-        ).toHaveLength(1);
+            }),
+            1
+        );
 
-        expect(
+        assertLength(
             await issuerClient.credentials().list({
                 filter: {
                     '-i': randomUUID(),
                     '-s': QVI_SCHEMA_SAID,
                     '-a-i': holderAid.prefix,
                 },
-            })
-        ).toHaveLength(0);
+            }),
+            0
+        );
     });
 
     await step('issuer get credential by id', async () => {
@@ -331,13 +342,13 @@ test('single signature credentials', async () => {
         const apply = await holderClient.exchanges().get(holderApplyNote.a.d);
         applySaid = apply.exn.d;
 
-        let filter: { [x: string]: any } = { '-s': apply.exn.a.s };
+        const filter: { [x: string]: any } = { '-s': apply.exn.a.s };
         for (const key in apply.exn.a.a) {
             filter[`-a-${key}`] = apply.exn.a.a[key];
         }
 
         const matchingCreds = await holderClient.credentials().list({ filter });
-        expect(matchingCreds).toHaveLength(1);
+        assert.strictEqual(matchingCreds.length, 1);
 
         await markAndRemoveNotification(holderClient, holderNotifications[0]);
 
@@ -371,8 +382,8 @@ test('single signature credentials', async () => {
             .get(verifierOfferNote.a.d);
         offerSaid = offer.exn.d;
 
-        expect(offer.exn.p).toBe(applySaid);
-        expect(offer.exn.e.acdc.a.LEI).toBe('5493001KJTIIGC8Y1R17');
+        assert.strictEqual(offer.exn.p, applySaid);
+        assert.strictEqual(offer.exn.e.acdc.a.LEI, '5493001KJTIIGC8Y1R17');
 
         await markAndRemoveNotification(verifierClient, verifierOfferNote);
 
@@ -401,7 +412,7 @@ test('single signature credentials', async () => {
         const agree = await holderClient.exchanges().get(holderAgreeNote.a.d);
         agreeSaid = agree.exn.d;
 
-        expect(agree.exn.p).toBe(offerSaid);
+        assert.strictEqual(agree.exn.p, offerSaid);
 
         await markAndRemoveNotification(holderClient, holderAgreeNote);
 
@@ -440,7 +451,7 @@ test('single signature credentials', async () => {
         assert(verifierGrantNote.a.d);
 
         const grant = await holderClient.exchanges().get(verifierGrantNote.a.d);
-        expect(grant.exn.p).toBe(agreeSaid);
+        assert.strictEqual(grant.exn.p, agreeSaid);
 
         const [admit3, sigs3, aend3] = await verifierClient.ipex().admit({
             senderName: verifierAid.name,
@@ -619,15 +630,12 @@ test('single signature credentials', async () => {
 
     await step('Holder deletes LE credential', async () => {
         await holderClient.credentials().delete(leCredentialId);
-        await assert.rejects(
-            async () => {
-                await holderClient.credentials().get(leCredentialId);
-            },
-            {
-                name: 'Error',
-                message: `HTTP GET /credentials/${leCredentialId} - 404 Not Found - {"title": "404 Not Found", "description": "credential for said ${leCredentialId} not found."}`,
-            }
+        await expect(async () => {
+            await holderClient.credentials().get(leCredentialId);
+        }).rejects.toThrowError(
+            `HTTP GET /credentials/${leCredentialId} - 404 Not Found - {"title": "404 Not Found", "description": "credential for said ${leCredentialId} not found."}`
         );
+
         assert.equal((await holderClient.credentials().list()).length, 1);
     });
-}, 90000);
+});

examples/integration-scripts/challenge.test.ts

@@ -1,4 +1,4 @@
-import { strict as assert } from 'assert';
+import { assert, test } from 'vitest';
 import signify from 'signify-ts';
 import {
     assertNotifications,
@@ -12,14 +12,14 @@ import {
     waitAndMarkNotification,
     waitForNotifications,
     waitOperation,
-} from './utils/test-util';
+} from './utils/test-util.ts';
 import {
     acceptMultisigIncept,
     addEndRoleMultisig,
     delegateMultisig,
     startMultisigIncept,
-} from './utils/multisig-utils';
-import { step } from './utils/test-step';
+} from './utils/multisig-utils.ts';
+import { step } from './utils/test-step.ts';
 
 const delegatorGroupName = 'delegator_group';
 const delegateeGroupName = 'delegatee_group';