signify-ts 0.3.0-rc1 → 0.3.0

package/README.md

@@ -30,22 +30,36 @@ 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:
+- 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.
+- ready() must be called before library is useable. Example minimum viable client code.
 
     ```javascript
     import { randomPasscode, ready, SignifyClient, Tier } from 'signify-ts';
@@ -81,7 +95,7 @@ The integration tests depends on a local instance of KERIA, vLEI-Server and Witn
 docker compose up --wait
 ```
 
-If successful, it should print someting like this:
+If successful, it should print something like this:
 
 ```bash
 $ docker compose up --wait
@@ -108,28 +122,22 @@ 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.
-
-```bash
-npm run build
-```
-
 Use the npm script "test:integration" to run all integration tests in sequence:
 
 ```bash
 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.
@@ -141,3 +149,43 @@ 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 './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/core/state';
-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,3 +1,3 @@
-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

@@ -0,0 +1,3 @@
+import * as exp from "./exports.js";
+export * from "./exports.js";
+export default exp;

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

@@ -1,13 +1,14 @@
-import { Tier } from '../core/salter';
-import { Algos } from '../core/manager';
-import { Serder } from '../core/serder';
-import { KeyManager } from '../core/keeping';
-import { HabState } from '../core/state';
+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';
+import { components } from '../../types/keria-api-schema.ts';
 /** Arguments required to create an identfier */
 export interface CreateIdentiferArgs {
     transferable?: boolean;
-    isith?: string | number | string[];
-    nsith?: string | number | string[];
+    isith?: string | number | string[] | string[][];
+    nsith?: string | number | string[] | string[][];
     wits?: string[];
     toad?: number;
     proxy?: string;
@@ -50,7 +51,7 @@ 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
@@ -58,6 +59,13 @@ export interface IdentifierDeps {
 export interface IdentifierInfo {
     name: string;
 }
+export interface LocSchemeArgs {
+    url: string;
+    scheme?: string;
+    eid?: string;
+    stamp?: string;
+}
+export type GroupMembers = components['schemas']['GroupMember'];
 /** Identifier */
 export declare class Identifier {
     client: IdentifierDeps;
@@ -138,13 +146,21 @@ export declare class Identifier {
      * @returns {Serder} The reply message
      */
     private makeEndRole;
+    /**
+     * Authorises a new location scheme (endpoint) for a particular endpoint identifier.
+     * @param {LocSchemeArgs} args
+     * @param name Name or alias of the identifier to sign reply message
+     * @param args Arguments to create authorising reply message from
+     * @returns A promise to the result of the authorization
+     */
+    addLocScheme(name: string, args: LocSchemeArgs): Promise<EventResult>;
     /**
      * Get the members of a group identifier
      * @async
      * @param {string} name - Name or alias of the identifier
-     * @returns {Promise<any>} - A promise to the list of members
+     * @returns {Promise<GroupMembers>} - A promise to the list of members
      */
-    members(name: string): Promise<any>;
+    members(name: string): Promise<GroupMembers>;
 }
 /** Event Result */
 export declare class EventResult {