@bitblit/ratchet-warden-server 4.0.84-alpha

package/dist/types/build/ratchet-warden-server-info.d.ts

@@ -0,0 +1,5 @@
+import { BuildInformation } from '@bitblit/ratchet-common';
+export declare class RatchetWardenServerInfo {
+    private constructor();
+    static buildInformation(): BuildInformation;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from './build/ratchet-warden-server-info';
+export * from './server/warden-service-options';
+export * from './server/warden-service';
+export * from './server/provider/warden-default-user-decoration-provider';
+export * from './server/provider/warden-event-processing-provider';
+export * from './server/provider/warden-mailer-message-sending-provider-options';
+export * from './server/provider/warden-mailer-message-sending-provider';
+export * from './server/provider/warden-message-sending-provider';
+export * from './server/provider/warden-no-op-event-processing-provider';
+export * from './server/provider/warden-s3-single-file-storage-provider-options';
+export * from './server/provider/warden-s3-single-file-storage-provider';
+export * from './server/provider/warden-storage-provider';
+export * from './server/provider/warden-twilio-text-message-sending-provider-options';
+export * from './server/provider/warden-twilio-text-message-sending-provider';
+export * from './server/provider/warden-user-decoration-provider';

package/dist/types/server/provider/warden-default-user-decoration-provider.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The user details gets jammed into the JWT token upon login.  If one is not provided,
+ * the default only puts the WardenEntrySummary in there
+ */
+import { WardenEntry, WardenEntrySummary, WardenUserDecoration } from '@bitblit/ratchet-warden-common';
+import { WardenUserDecorationProvider } from './warden-user-decoration-provider';
+export declare class WardenDefaultUserDecorationProvider implements WardenUserDecorationProvider<WardenEntrySummary> {
+    fetchDecoration(wardenUser: WardenEntry): Promise<WardenUserDecoration<WardenEntrySummary>>;
+}

package/dist/types/server/provider/warden-event-processing-provider.d.ts

@@ -0,0 +1,8 @@
+import { WardenEntry } from '@bitblit/ratchet-warden-common';
+/**
+ * Notifies the containing system when significant events happen
+ */
+export interface WardenEventProcessingProvider {
+    userCreated(entry: WardenEntry): Promise<void>;
+    userRemoved(entry: WardenEntry): Promise<void>;
+}

package/dist/types/server/provider/warden-mailer-message-sending-provider-options.d.ts

@@ -0,0 +1,5 @@
+export interface WardenMailerMessageSendingProviderOptions {
+    emailBaseLayoutName?: string;
+    expiringTokenHtmlTemplateName: string;
+    expiringTokenTxtTemplateName: string;
+}

package/dist/types/server/provider/warden-mailer-message-sending-provider.d.ts

@@ -0,0 +1,13 @@
+import { WardenMessageSendingProvider } from './warden-message-sending-provider';
+import { WardenContact, WardenContactType, WardenCustomerMessageType } from '@bitblit/ratchet-warden-common';
+import { WardenMailerMessageSendingProviderOptions } from './warden-mailer-message-sending-provider-options';
+import { MailerLike, ReadyToSendEmail } from '@bitblit/ratchet-aws';
+export declare class WardenMailerMessageSendingProvider implements WardenMessageSendingProvider<ReadyToSendEmail> {
+    private mailer;
+    private options;
+    private static defaultOptions;
+    constructor(mailer: MailerLike, options?: WardenMailerMessageSendingProviderOptions);
+    formatMessage(contact: WardenContact, messageType: WardenCustomerMessageType, context: Record<string, any>): Promise<ReadyToSendEmail>;
+    handlesContactType(type: WardenContactType): boolean;
+    sendMessage(contact: WardenContact, message: ReadyToSendEmail): Promise<boolean>;
+}

package/dist/types/server/provider/warden-message-sending-provider.d.ts

@@ -0,0 +1,10 @@
+import { WardenContact, WardenContactType, WardenCustomerMessageType } from '@bitblit/ratchet-warden-common';
+/**
+ * Classes implementing WardenMessageSendingProvider are able to
+ * send expiring, single
+ */
+export interface WardenMessageSendingProvider<T> {
+    handlesContactType(type: WardenContactType): boolean;
+    sendMessage(contact: WardenContact, message: T): Promise<boolean>;
+    formatMessage(contact: WardenContact, messageType: WardenCustomerMessageType, context: Record<string, any>): Promise<T>;
+}

package/dist/types/server/provider/warden-no-op-event-processing-provider.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Default implementation of the event processing provider - does nothing
+ */
+import { WardenEntry } from '@bitblit/ratchet-warden-common';
+import { WardenEventProcessingProvider } from './warden-event-processing-provider';
+export declare class WardenNoOpEventProcessingProvider implements WardenEventProcessingProvider {
+    userCreated(entry: WardenEntry): Promise<void>;
+    userRemoved(entry: WardenEntry): Promise<void>;
+}

package/dist/types/server/provider/warden-s3-single-file-storage-provider-options.d.ts

@@ -0,0 +1,4 @@
+export interface WardenS3SingleFileStorageProviderOptions {
+    bucket: string;
+    dataFileKey: string;
+}

package/dist/types/server/provider/warden-s3-single-file-storage-provider.d.ts

@@ -0,0 +1,29 @@
+import { WardenContact, WardenEntry, WardenEntrySummary } from '@bitblit/ratchet-warden-common';
+import { WardenStorageProvider } from './warden-storage-provider';
+import { WardenS3SingleFileStorageProviderOptions } from './warden-s3-single-file-storage-provider-options';
+import { PutObjectOutput, S3Client } from '@aws-sdk/client-s3';
+export declare class WardenS3SingleFileStorageProvider implements WardenStorageProvider {
+    private s3;
+    private options;
+    private ratchet;
+    constructor(s3: S3Client, options: WardenS3SingleFileStorageProviderOptions);
+    listUserSummaries(): Promise<WardenEntrySummary[]>;
+    fetchDataFile(): Promise<WardenS3SingleFileStorageProviderDataFile>;
+    storeDataFile(file: WardenS3SingleFileStorageProviderDataFile): Promise<PutObjectOutput>;
+    fetchCurrentUserChallenge(userId: string, relyingPartyId: string): Promise<string>;
+    findEntryByContact(contact: WardenContact): Promise<WardenEntry>;
+    findEntryById(userId: string): Promise<WardenEntry>;
+    removeEntry(userId: string): Promise<boolean>;
+    saveEntry(entry: WardenEntry): Promise<WardenEntry>;
+    updateUserChallenge(userId: string, relyingPartyId: string, challenge: string): Promise<boolean>;
+}
+export interface WardenS3SingleFileStorageProviderChallengeRecord {
+    userId: string;
+    relyingPartyId: string;
+    challenge: string;
+    updatedEpochMS: number;
+}
+export interface WardenS3SingleFileStorageProviderDataFile {
+    entries: WardenEntry[];
+    challenges: WardenS3SingleFileStorageProviderChallengeRecord[];
+}

package/dist/types/server/provider/warden-storage-provider.d.ts

@@ -0,0 +1,14 @@
+import { WardenContact, WardenEntry, WardenEntrySummary } from '@bitblit/ratchet-warden-common';
+/**
+ * Classes implementing WardenStorageProvider perform store and
+ * retrieval functions for the SimpleAuthenticationProvider
+ */
+export interface WardenStorageProvider {
+    findEntryById(userId: string): Promise<WardenEntry>;
+    findEntryByContact(contact: WardenContact): Promise<WardenEntry>;
+    saveEntry(entry: WardenEntry): Promise<WardenEntry>;
+    removeEntry(userId: string): Promise<boolean>;
+    updateUserChallenge(userId: string, relyingPartyId: string, challenge: string): Promise<boolean>;
+    fetchCurrentUserChallenge(userId: string, relyingPartyId: string): Promise<string>;
+    listUserSummaries(): Promise<WardenEntrySummary[]>;
+}

package/dist/types/server/provider/warden-twilio-text-message-sending-provider-options.d.ts

@@ -0,0 +1,5 @@
+export interface WardenTwilioTextMessageSendingProviderOptions {
+    accountSID: string;
+    authToken: string;
+    outBoundNumber: string;
+}

package/dist/types/server/provider/warden-twilio-text-message-sending-provider.d.ts

@@ -0,0 +1,10 @@
+import { WardenMessageSendingProvider } from './warden-message-sending-provider';
+import { WardenContact, WardenContactType, WardenCustomerMessageType } from '@bitblit/ratchet-warden-common';
+import { WardenTwilioTextMessageSendingProviderOptions } from './warden-twilio-text-message-sending-provider-options';
+export declare class WardenTwilioTextMessageSendingProvider implements WardenMessageSendingProvider<string> {
+    private optsPromise;
+    constructor(optsPromise: Promise<WardenTwilioTextMessageSendingProviderOptions>);
+    formatMessage(contact: WardenContact, messageType: WardenCustomerMessageType, context: Record<string, any>): Promise<string>;
+    handlesContactType(type: WardenContactType): boolean;
+    sendMessage(contact: WardenContact, message: string): Promise<boolean>;
+}

package/dist/types/server/provider/warden-user-decoration-provider.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The user details gets jammed into the JWT token upon login.  If one is not provided,
+ * the default only puts the user id and label in there
+ */
+import { WardenEntry, WardenUserDecoration } from '@bitblit/ratchet-warden-common';
+export interface WardenUserDecorationProvider<T> {
+    fetchDecoration(wardenUser: WardenEntry): Promise<WardenUserDecoration<T>>;
+}

package/dist/types/server/warden-service-options.d.ts

@@ -0,0 +1,16 @@
+import { WardenStorageProvider } from './provider/warden-storage-provider';
+import { WardenMessageSendingProvider } from './provider/warden-message-sending-provider';
+import { ExpiringCodeProvider } from '@bitblit/ratchet-aws';
+import { JwtRatchetLike } from '@bitblit/ratchet-common';
+import { WardenUserDecorationProvider } from './provider/warden-user-decoration-provider';
+import { WardenEventProcessingProvider } from './provider/warden-event-processing-provider';
+export interface WardenServiceOptions {
+    relyingPartyName: string;
+    allowedOrigins: string[];
+    storageProvider: WardenStorageProvider;
+    messageSendingProviders: WardenMessageSendingProvider<any>[];
+    expiringCodeProvider: ExpiringCodeProvider;
+    jwtRatchet: JwtRatchetLike;
+    userDecorationProvider?: WardenUserDecorationProvider<any>;
+    eventProcessor?: WardenEventProcessingProvider;
+}

package/dist/types/server/warden-service.d.ts

@@ -0,0 +1,27 @@
+import { AuthenticationResponseJSON, PublicKeyCredentialCreationOptionsJSON, PublicKeyCredentialRequestOptionsJSON, RegistrationResponseJSON } from '@simplewebauthn/typescript-types';
+import { WardenServiceOptions } from './warden-service-options';
+import { WardenCommand, WardenCommandResponse, WardenContact, WardenEntry, WardenLoginRequest, WardenStoreRegistrationResponse } from '@bitblit/ratchet-warden-common';
+import { WardenMessageSendingProvider } from './provider/warden-message-sending-provider';
+export declare class WardenService {
+    private inOptions;
+    private opts;
+    private expiringCodeRatchet;
+    constructor(inOptions: WardenServiceOptions);
+    get options(): WardenServiceOptions;
+    findEntryByContact(contact: WardenContact): Promise<WardenEntry>;
+    processCommandStringToString(cmdString: string, origin: string, loggedInUserId: string): Promise<string>;
+    processCommandToResponse(cmd: WardenCommand, origin: string, loggedInUserId: string): Promise<WardenCommandResponse>;
+    createAccount(contact: WardenContact, sendCode?: boolean, label?: string, tags?: string[]): Promise<string>;
+    addContactMethodToUser(userId: string, contact: WardenContact): Promise<boolean>;
+    removeContactMethodFromUser(userId: string, contact: WardenContact): Promise<WardenEntry>;
+    generateWebAuthnRegistrationChallengeForLoggedInUser(userId: string, origin: string): Promise<PublicKeyCredentialCreationOptionsJSON>;
+    storeAuthnRegistration(userId: string, origin: string, data: RegistrationResponseJSON): Promise<WardenStoreRegistrationResponse>;
+    generateWebAuthnAuthenticationChallengeForUserId(userId: string, origin: string): Promise<PublicKeyCredentialRequestOptionsJSON>;
+    generateWebAuthnAuthenticationChallenge(user: WardenEntry, origin: string): Promise<PublicKeyCredentialRequestOptionsJSON>;
+    senderForContact(contact: WardenContact): WardenMessageSendingProvider<any>;
+    sendExpiringValidationToken(request: WardenContact): Promise<boolean>;
+    processLogin(request: WardenLoginRequest, origin: string): Promise<boolean>;
+    loginWithWebAuthnRequest(user: WardenEntry, origin: string, data: AuthenticationResponseJSON): Promise<boolean>;
+    removeSingleWebAuthnRegistration(userId: string, key: string): Promise<WardenEntry>;
+    removeUser(userId: string): Promise<boolean>;
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@bitblit/ratchet-warden-server",
+  "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": {
+    "@aws-sdk/client-s3": "3.289.0",
+    "@aws-sdk/client-ses": "3.289.0",
+    "@bitblit/ratchet-aws": "*",
+    "@bitblit/ratchet-common": "*",
+    "@bitblit/ratchet-warden-common": "*",
+    "@simplewebauthn/browser": "7.1.0",
+    "@simplewebauthn/server": "7.0.1",
+    "@simplewebauthn/typescript-types": "7.0.0",
+    "jwt-decode": "3.1.2"
+  },
+  "devDependencies": {
+    "@bitblit/ratchet-jest": "*"
+  }
+}