@bitblit/ratchet-warden-common 4.0.84-alpha

package/dist/types/common/model/warden-entry-summary.d.ts

@@ -0,0 +1,7 @@
+import { WardenContact } from './warden-contact';
+export interface WardenEntrySummary {
+    userId: string;
+    userLabel: string;
+    contactMethods: WardenContact[];
+    webAuthnAuthenticatorIds: string[];
+}

package/dist/types/common/model/warden-entry.d.ts

@@ -0,0 +1,11 @@
+import { WardenWebAuthnEntry } from './warden-web-authn-entry';
+import { WardenContact } from './warden-contact';
+export interface WardenEntry {
+    userId: string;
+    userLabel: string;
+    contactMethods: WardenContact[];
+    tags: string[];
+    webAuthnAuthenticators: WardenWebAuthnEntry[];
+    createdEpochMS: number;
+    updatedEpochMS: number;
+}

package/dist/types/common/model/warden-jwt-token.d.ts

@@ -0,0 +1,5 @@
+import { CommonJwtToken } from '@bitblit/ratchet-common';
+import { WardenEntrySummary } from './warden-entry-summary';
+export interface WardenJwtToken<T> extends CommonJwtToken<T> {
+    loginData: WardenEntrySummary;
+}

package/dist/types/common/model/warden-login-request.d.ts

@@ -0,0 +1,9 @@
+import { WardenContact } from './warden-contact';
+import { AuthenticationResponseJSON } from '@simplewebauthn/typescript-types';
+export interface WardenLoginRequest {
+    userId?: string;
+    contact?: WardenContact;
+    webAuthn?: AuthenticationResponseJSON;
+    expiringToken?: string;
+    jwtTokenToRefresh?: string;
+}

package/dist/types/common/model/warden-login-results.d.ts

@@ -0,0 +1,7 @@
+import { WardenLoginRequest } from './warden-login-request';
+export interface WardenLoginResults {
+    request: WardenLoginRequest;
+    userId?: string;
+    jwtToken?: string;
+    error?: string;
+}

package/dist/types/common/model/warden-store-registration-response-type.d.ts

@@ -0,0 +1,5 @@
+export declare enum WardenStoreRegistrationResponseType {
+    Verified = "Verified",
+    Failed = "Failed",
+    Error = "Error"
+}

package/dist/types/common/model/warden-store-registration-response.d.ts

@@ -0,0 +1,8 @@
+import { WardenStoreRegistrationResponseType } from './warden-store-registration-response-type';
+import { WardenEntry } from './warden-entry';
+export interface WardenStoreRegistrationResponse {
+    updatedEntry?: WardenEntry;
+    registrationResponseId: string;
+    result: WardenStoreRegistrationResponseType;
+    error?: string;
+}

package/dist/types/common/model/warden-team-role.d.ts

@@ -0,0 +1,4 @@
+export interface WardenTeamRole {
+    team: string;
+    role: string;
+}

package/dist/types/common/model/warden-user-decoration.d.ts

@@ -0,0 +1,6 @@
+import { WardenTeamRole } from './warden-team-role';
+export interface WardenUserDecoration<T> {
+    userTokenData: T;
+    userTokenExpirationSeconds: number;
+    userTeamRoles: WardenTeamRole[];
+}

package/dist/types/common/model/warden-web-authn-entry.d.ts

@@ -0,0 +1,9 @@
+import { WardenWebAuthnTransportFutureType } from './warden-web-authn-transport-future-type';
+export interface WardenWebAuthnEntry {
+    credentialIdBase64: string;
+    credentialPublicKeyBase64: string;
+    counter: number;
+    credentialBackedUp: boolean;
+    credentialDeviceType: string;
+    transports?: WardenWebAuthnTransportFutureType[];
+}

package/dist/types/common/model/warden-web-authn-transport-future-type.d.ts

@@ -0,0 +1,8 @@
+export declare enum WardenWebAuthnTransportFutureType {
+    ble = "ble",
+    internal = "internal",
+    nfc = "nfc",
+    usb = "usb",
+    cable = "cable",
+    hybrid = "hybrid"
+}

package/dist/types/common/util/warden-utils.d.ts

@@ -0,0 +1,21 @@
+import { WardenContact } from '../model/warden-contact';
+import { WardenContactType } from '../model/warden-contact-type';
+import { WardenEntrySummary } from '../model/warden-entry-summary';
+import { WardenEntry } from '../model/warden-entry';
+import { WardenLoginRequest } from '../model/warden-login-request';
+import { WardenTeamRole } from '../model/warden-team-role';
+export declare class WardenUtils {
+    constructor();
+    static extractContactsOfType(req: WardenEntry | WardenEntrySummary, type: WardenContactType): string[];
+    static validLoginRequest(req: WardenLoginRequest): boolean;
+    static stringToWardenContact(input: string): WardenContact;
+    static teamRolesToRoles(teamRoles: WardenTeamRole[]): string[];
+    static roleStringsToTeamRoles(roles: string[]): WardenTeamRole[];
+    static roleStringToTeamRole(role: string): WardenTeamRole;
+    static teamRoleToRoleString(tr: WardenTeamRole): string;
+    static stringToContactType(input: string): WardenContactType;
+    static validContact(contact: WardenContact): boolean;
+    static stringIsEmailAddress(value: string): boolean;
+    static stringIsPhoneNumber(value: string): boolean;
+    static stripWardenEntryToSummary(we: WardenEntry): WardenEntrySummary;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from './build/ratchet-warden-common-info';
+export * from './client/warden-client';
+export * from './client/warden-delegating-current-user-providing-user-service-event-processing-provider';
+export * from './client/warden-user-service';
+export * from './client/provider/warden-client-abstract-recent-login-provider';
+export * from './client/provider/warden-client-current-logged-in-jwt-token-provider';
+export * from './client/provider/warden-client-local-storage-logged-in-user-provider';
+export * from './client/provider/warden-client-local-storage-recent-login-provider';
+export * from './client/provider/warden-client-recent-login-provider';
+export * from './client/provider/warden-client-transient-memory-logged-in-user-provider';
+export * from './client/provider/warden-client-transient-memory-recent-login-provider';
+export * from './client/provider/warden-command-exchange-provider';
+export * from './client/provider/warden-logged-in-user-provider';
+export * from './client/provider/warden-logged-in-user-wrapper';
+export * from './client/provider/warden-recent-login-descriptor';
+export * from './client/provider/warden-user-service-event-processing-provider';
+export * from './client/provider/warden-user-service-options';
+export * from './common/command/create-account';
+export * from './common/command/remove-web-authn-registration';
+export * from './common/command/warden-command-response';
+export * from './common/command/warden-command';
+export * from './common/command/web-authn-object-wrapper';
+export * from './common/model/warden-contact-type';
+export * from './common/model/warden-contact';
+export * from './common/model/warden-customer-message-type';
+export * from './common/model/warden-entry-summary';
+export * from './common/model/warden-entry';
+export * from './common/model/warden-jwt-token';
+export * from './common/model/warden-login-request';
+export * from './common/model/warden-login-results';
+export * from './common/model/warden-store-registration-response-type';
+export * from './common/model/warden-store-registration-response';
+export * from './common/model/warden-team-role';
+export * from './common/model/warden-user-decoration';
+export * from './common/model/warden-web-authn-entry';
+export * from './common/model/warden-web-authn-transport-future-type';
+export * from './common/util/warden-utils';

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@bitblit/ratchet-warden-common",
+  "version": "4.0.84-alpha",
+  "description": "Typescript library to simplify using simplewebauthn and secondary auth methods over GraphQL",
+  "sideEffects": false,
+  "bin": {},
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist/*",
+    "includes/*"
+  ],
+  "contributors": [
+    "Christopher Weiss <bitblit@gmail.com>"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged"
+    }
+  },
+  "prettier": {
+    "printWidth": 140,
+    "singleQuote": true,
+    "arrowParens": "always"
+  },
+  "config": {},
+  "scripts": {
+    "watch": "tsc-watch",
+    "clean": "shx rm -Rf dist",
+    "test": "jest",
+    "docs": "typedoc",
+    "lint": "eslint src/**/*.ts",
+    "lint-fix": "eslint --fix src/**/*.ts",
+    "generate-barrels": "barrelsby -q --delete -d src -e .*\\.spec\\.ts",
+    "build": "yarn run generate-barrels && concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:es": "tsc -p tsconfig.es.json",
+    "build:types": "tsc -p tsconfig.types.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bitblit/Ratchet"
+  },
+  "keywords": [
+    "warden",
+    "simplewebauthn"
+  ],
+  "bugs": {
+    "url": "https://github.com/bitblit/Ratchet/issues"
+  },
+  "homepage": "https://github.com/bitblit/Ratchet#readme",
+  "engines": {
+    "node": ">=14.18"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@bitblit/ratchet-common": "*",
+    "@simplewebauthn/browser": "7.1.0",
+    "@simplewebauthn/typescript-types": "7.0.0",
+    "jwt-decode": "3.1.2"
+  },
+  "devDependencies": {
+    "@bitblit/ratchet-jest": "*"
+  }
+}