signify-ts 0.2.1 → 0.3.0-rc2

package/README.md

@@ -9,7 +9,7 @@ Project Name: signify-ts
 
 ## Signify - KERI Signing at the Edge
 
-Of the five functions in a KERI agent, 
+Of the five functions in a KERI agent,
 
 1. Key generation
 2. Encrypted key storage
@@ -19,33 +19,66 @@ Of the five functions in a KERI agent,
 
 Signify-TS splits off two, key generation and event signing into a TypeScript library to provide "signing at the edge".
 It accomplishes this by using [libsodium](https://doc.libsodium.org/) to generate ed25519 key pairs for signing and x25519 key pairs for encrypting the
-private keys, next public keys and salts used to generate the private keys.  The encrypted private key and salts are then stored on a
-remote cloud agent that never has access to the decryption keys.  New key pair sets (current and next) will be generated 
+private keys, next public keys and salts used to generate the private keys. The encrypted private key and salts are then stored on a
+remote cloud agent that never has access to the decryption keys. New key pair sets (current and next) will be generated
 for inception and rotation events with only the public keys and blake3 hash of the next keys made available to the agent.
 
 The communication protocol between a Signify client and [KERI](https://github.com/WebOfTrust/keri) agent will encode all cryptographic primitives as CESR base64
-encoded strings for the initial implementation.  Support for binary CESR can be added in the future.
-
+encoded strings for the initial implementation. Support for binary CESR can be added in the future.
 
 ### Environment Setup
 
 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:
+- Generate types:
+
+    To generate TypeScript types from KERIA OpenAPI docs dynamically
+
+    ```
+    npm run generate:types
+    ```
+
+    We can specify KERIA spec url by this command:
+
+    ```
+    SPEC_URL=http://localhost:3902/spec.yaml npm run generate:types
+    ```
+
+- Build:
+
     ```bash
     npm run build
     ```
 
+- ready() must be called before library is useable. Example minimum viable client code.
+
+    ```javascript
+    import { randomPasscode, ready, SignifyClient, Tier } from 'signify-ts';
+
+    await ready();
+
+    const bran = randomPasscode();
+    const url = 'http://127.0.0.1:3901';
+    const boot_url = 'http://127.0.0.1:3903';
+    const actualSignifyClient = new SignifyClient(
+        url,
+        bran,
+        Tier.low,
+        boot_url
+    );
+
+    console.log(actualSignifyClient);
+    ```
+
 ### Unit testing
 
 To run unit tests
@@ -59,28 +92,34 @@ npm test
 The integration tests depends on a local instance of KERIA, vLEI-Server and Witness Demo. These are specified in the [Docker Compose](./docker-compose.yaml) file. To start the dependencies, use docker compose:
 
 ```bash
-docker compose up deps
+docker compose up --wait
 ```
 
-If successful, it should print someting like this:
+If successful, it should print something like this:
 
 ```bash
-$ docker compose up deps
-[+] Running 5/4
+$ docker compose up --wait
+[+] Running 4/4
  ✔ Network signify-ts_default           Created                                           0.0s
- ✔ Container signify-ts-vlei-server-1   Created                                           0.1s
- ✔ Container signify-ts-keria-1         Created                                           0.1s
- ✔ Container signify-ts-witness-demo-1  Created                                           0.1s
- ✔ Container signify-ts-deps-1          Created                                           0.0s
-Attaching to signify-ts-deps-1
-signify-ts-deps-1  | Dependencies running
-signify-ts-deps-1 exited with code 0
+ ✔ Container signify-ts-vlei-server-1   Healthy                                           5.7s
+ ✔ Container signify-ts-keria-1         Healthy                                           6.2s
+ ✔ Container signify-ts-witness-demo-1  Healthy                                           6.2s
+```
+
+It is possible to change the keria image by using environment variables. For example, to use weboftrust/keria:0.1.3, do:
+
+```bash
+export KERIA_IMAGE_TAG=0.1.3
+docker compose pull
+docker compose up --wait
 ```
 
-**Important!** The integration tests runs on the build output in `dist/` directory. Make sure to run build before running the integration tests.
+To use another repository, you can do:
 
 ```bash
-npm run build
+export KERIA_IMAGE=gleif/keria
+docker compose pull
+docker compose up --wait
 ```
 
 Use the npm script "test:integration" to run all integration tests in sequence:
@@ -89,33 +128,64 @@ 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 -- 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 test-integration/credentials.test.ts
 ```
 
 This changes the discovery urls to use `localhost` instead of the hostnames inside the docker network.
 
-### Old integration scripts
-
-To run any of the old integration scripts that has not yet been converted to an integration test. Use `ts-node-esm`
-
-```bash
-npx ts-node-esm examples/integration-scripts/challenge.ts
-```
-
 # Diagrams
 
 Account Creation Workflow
 
 ![Account Creation](/diagrams/account-creation-workflow.png)
 
-
 ![Account Creation Webpage](/diagrams/account-creation-webpage-workflow.png)
+
+# Publishing
+
+This package is published on npm: https://www.npmjs.com/package/signify-ts.
+
+If you need to publish a version under your own scope, you can use the [publish script](./publish.sh). This enables you to create development packages. For example:
+
+```bash
+NPM_PACKAGE_SCOPE=@myorg DRY_RUN=1 ./publish.sh
+npm notice Tarball Details
+npm notice name: @myorg/signify-ts
+npm notice version: 0.3.0-rc1-dev.8fa9919
+npm notice filename: myorg-signify-ts-0.3.0-rc1-dev.8fa9919.tgz
+npm notice package size: 81.0 kB
+npm notice unpacked size: 370.0 kB
+npm notice shasum: 8c160bc99d9ec552e6c478c20922cae3388a8ace
+npm notice integrity: sha512-WRuD5PKFN3WBl[...]xVieCIS0UpVeg==
+npm notice total files: 96
+npm notice
+npm notice Publishing to https://registry.npmjs.org/ with tag dev and default access (dry-run)
++ @myorg/signify-ts@0.3.0-rc1-dev.8fa9919
+```
+
+Set the `NPM_PUBLISH_TAG` to `latest` to skip the commit hash suffix in the version:
+
+```bash
+NPM_PUBLISH_TAG=latest NPM_PACKAGE_SCOPE=@myorg DRY_RUN=1 ./publish.sh
+npm notice Tarball Details
+npm notice name: @myorg/signify-ts
+npm notice version: 0.3.0-rc1
+npm notice filename: myorg-signify-ts-0.3.0-rc1.tgz
+npm notice package size: 80.9 kB
+npm notice unpacked size: 370.0 kB
+npm notice shasum: 8c9e4edcf19802e8acaf5996a36061a9c335b1c4
+npm notice integrity: sha512-V1y2W3zs4Ccsn[...]vKY3WWgalcuBQ==
+npm notice total files: 96
+npm notice
+npm notice Publishing to https://registry.npmjs.org/ with tag latest and default access (dry-run)
++ @myorg/signify-ts@0.3.0-rc1
+```

package/dist/exports.d.ts

@@ -1,40 +1,40 @@
-export * from './ready';
-export * from './math';
-export * from './keri/app/habery';
-export * from './keri/app/controller';
-export * from './keri/app/aiding';
-export * from './keri/app/clienting';
-export * from './keri/app/contacting';
-export * from './keri/app/coring';
-export * from './keri/app/credentialing';
-export * from './keri/app/escrowing';
-export * from './keri/app/exchanging';
-export * from './keri/app/grouping';
-export * from './keri/app/notifying';
-export * from './keri/core/authing';
-export * from './keri/core/cigar';
-export * from './keri/core/cipher';
-export * from './keri/core/core';
-export * from './keri/core/counter';
-export * from './keri/core/decrypter';
-export * from './keri/core/diger';
-export * from './keri/core/encrypter';
-export * from './keri/core/eventing';
-export * from './keri/core/httping';
-export * from './keri/core/indexer';
-export * from './keri/core/keeping';
-export * from './keri/core/kering';
-export * from './keri/core/manager';
-export * from './keri/core/matter';
-export * from './keri/core/number';
-export * from './keri/core/prefixer';
-export * from './keri/core/saider';
-export * from './keri/core/salter';
-export * from './keri/core/seqner';
-export * from './keri/core/serder';
-export * from './keri/core/siger';
-export * from './keri/core/signer';
-export * from './keri/core/tholder';
-export * from './keri/core/utils';
-export * from './keri/core/verfer';
-export * from './keri/end/ending';
+export * from './ready.ts';
+export * from './keri/app/habery.ts';
+export * from './keri/app/controller.ts';
+export * from './keri/app/aiding.ts';
+export * from './keri/app/clienting.ts';
+export * from './keri/app/contacting.ts';
+export * from './keri/app/coring.ts';
+export * from './keri/app/credentialing.ts';
+export * from './keri/app/escrowing.ts';
+export * from './keri/app/exchanging.ts';
+export * from './keri/app/grouping.ts';
+export * from './keri/app/notifying.ts';
+export * from './keri/core/authing.ts';
+export * from './keri/core/cigar.ts';
+export * from './keri/core/cipher.ts';
+export * from './keri/core/core.ts';
+export * from './keri/core/counter.ts';
+export * from './keri/core/decrypter.ts';
+export * from './keri/core/diger.ts';
+export * from './keri/core/encrypter.ts';
+export * from './keri/core/eventing.ts';
+export * from './keri/core/httping.ts';
+export * from './keri/core/indexer.ts';
+export * from './keri/core/keeping.ts';
+export * from './keri/core/kering.ts';
+export * from './keri/core/manager.ts';
+export * from './keri/core/matter.ts';
+export * from './keri/core/number.ts';
+export * from './keri/core/prefixer.ts';
+export * from './keri/core/saider.ts';
+export * from './keri/core/salter.ts';
+export * from './keri/core/seqner.ts';
+export * from './keri/core/serder.ts';
+export * from './keri/core/siger.ts';
+export * from './keri/core/signer.ts';
+export * from './keri/core/tholder.ts';
+export * from './keri/core/utils.ts';
+export * from './keri/core/verfer.ts';
+export * from './keri/core/keyState.ts';
+export * from './keri/end/ending.ts';

package/dist/exports.js

@@ -0,0 +1,40 @@
+export * from "./ready.js";
+export * from "./keri/app/habery.js";
+export * from "./keri/app/controller.js";
+export * from "./keri/app/aiding.js";
+export * from "./keri/app/clienting.js";
+export * from "./keri/app/contacting.js";
+export * from "./keri/app/coring.js";
+export * from "./keri/app/credentialing.js";
+export * from "./keri/app/escrowing.js";
+export * from "./keri/app/exchanging.js";
+export * from "./keri/app/grouping.js";
+export * from "./keri/app/notifying.js";
+export * from "./keri/core/authing.js";
+export * from "./keri/core/cigar.js";
+export * from "./keri/core/cipher.js";
+export * from "./keri/core/core.js";
+export * from "./keri/core/counter.js";
+export * from "./keri/core/decrypter.js";
+export * from "./keri/core/diger.js";
+export * from "./keri/core/encrypter.js";
+export * from "./keri/core/eventing.js";
+export * from "./keri/core/httping.js";
+export * from "./keri/core/indexer.js";
+export * from "./keri/core/keeping.js";
+export * from "./keri/core/kering.js";
+export * from "./keri/core/manager.js";
+export * from "./keri/core/matter.js";
+export * from "./keri/core/number.js";
+export * from "./keri/core/prefixer.js";
+export * from "./keri/core/saider.js";
+export * from "./keri/core/salter.js";
+export * from "./keri/core/seqner.js";
+export * from "./keri/core/serder.js";
+export * from "./keri/core/siger.js";
+export * from "./keri/core/signer.js";
+export * from "./keri/core/tholder.js";
+export * from "./keri/core/utils.js";
+export * from "./keri/core/verfer.js";
+export * from "./keri/core/keyState.js";
+export * from "./keri/end/ending.js";

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import './buffer-polyfill';
-import * as exp from './exports';
-export * from './exports';
+import * as exp from './exports.ts';
+export * from './exports.ts';
 export default exp;

package/dist/index.js

@@ -1,8 +1,3 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./signify-ts.cjs.production.min.js')
-} else {
-  module.exports = require('./signify-ts.cjs.development.js')
-}
+import * as exp from "./exports.js";
+export * from "./exports.js";
+export default exp;

package/dist/keri/app/aiding.d.ts

@@ -1,7 +1,8 @@
-import { Tier } from '../core/salter';
-import { Algos } from '../core/manager';
-import { Serder } from '../core/serder';
-import { KeyManager } from '../core/keeping';
+import { Tier } from '../core/salter.ts';
+import { Algos } from '../core/manager.ts';
+import { Serder } from '../core/serder.ts';
+import { IdentifierManagerFactory } from '../core/keeping.ts';
+import { HabState } from '../core/keyState.ts';
 /** Arguments required to create an identfier */
 export interface CreateIdentiferArgs {
     transferable?: boolean;
@@ -19,9 +20,9 @@ export interface CreateIdentiferArgs {
     rstates?: any[];
     prxs?: any[];
     nxts?: any[];
-    mhab?: any;
-    keys?: any[];
-    ndigs?: any[];
+    mhab?: HabState;
+    keys?: string[];
+    ndigs?: string[];
     bran?: string;
     count?: number;
     ncount?: number;
@@ -49,7 +50,13 @@ export interface RotateIdentifierArgs {
 export interface IdentifierDeps {
     fetch(pathname: string, method: string, body: unknown, headers?: Headers): Promise<Response>;
     pidx: number;
-    manager: KeyManager | null;
+    manager: IdentifierManagerFactory | null;
+}
+/**
+ * Updatable information for a managed identifier
+ */
+export interface IdentifierInfo {
+    name: string;
 }
 /** Identifier */
 export declare class Identifier {
@@ -70,10 +77,18 @@ export declare class Identifier {
     /**
      * Get information for a managed identifier
      * @async
-     * @param {string} name Name or alias of the identifier
-     * @returns {Promise<any>} A promise to the identifier information
+     * @param {string} name Prefix or alias of the identifier
+     * @returns {Promise<HabState>} A promise to the identifier information
      */
-    get(name: string): Promise<any>;
+    get(name: string): Promise<HabState>;
+    /**
+     * Update managed identifier
+     * @async
+     * @param {string} name Prefix or alias of the identifier
+     * @param {IdentifierInfo} info Information to update for the given identifier
+     * @returns {Promise<HabState>} A promise to the identifier information after updating
+     */
+    update(name: string, info: IdentifierInfo): Promise<HabState>;
     /**
      * Create a managed identifier
      * @async
@@ -85,11 +100,16 @@ export declare class Identifier {
     /**
      * Generate an interaction event in a managed identifier
      * @async
-     * @param {string} name Name or alias of the identifier
+     * @param {string} name Prefix or alias of the identifier
      * @param {any} [data] Option data to be anchored in the interaction event
      * @returns {Promise<EventResult>} A promise to the interaction event result
      */
     interact(name: string, data?: any): Promise<EventResult>;
+    createInteract(name: string, data?: any): Promise<{
+        serder: any;
+        sigs: any;
+        jsondata: any;
+    }>;
     /**
      * Generate a rotation event in a managed identifier
      * @param {string} name Name or alias of the identifier
@@ -130,8 +150,8 @@ export declare class Identifier {
 export declare class EventResult {
     private readonly _serder;
     private readonly _sigs;
-    private readonly promise;
-    constructor(serder: Serder, sigs: string[], promise: Promise<Response> | Response);
+    private readonly response;
+    constructor(serder: Serder, sigs: string[], response: Response);
     get serder(): Serder;
     get sigs(): string[];
     op(): Promise<any>;