@bitblit/ratchet-warden-common 4.0.84-alpha

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Notes]
+Alpha releases are exactly what they sound like - places where I am trying out new things that aren't ready for prime
+time, but I need published to see how they interact with the rest of my software ecosystem.  If you use an alpha
+package without knowing why it is alpha you'll get exactly what you deserve.
+
+## [Unreleased]
+
+## In Flight
+
+## [0.0.x] - 2018-03-23
+### Initial Release
+- Basic support for Warden, email and text messaging, and a simplified interface for bootstrapping over GraphQL
+

package/License.txt

@@ -0,0 +1,13 @@
+Copyright 2022-2023 Christopher Weiss
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,38 @@
+# @bitblit/Warden
+
+Typescript library to simplify using simplewebauthn and secondary auth methods over GraphQL.
+
+## Introduction
+
+I really like using the [SimpleWebAuthn](https://simplewebauthn.dev/) library for Authentication but it has a couple
+pieces of code that I still end up re-writing over and over - adding the secondary login methods (like single-use
+code sent to email/text) and setting it up to run over GraphQL, which I use regularly and don't really want to 
+add a bunch of special methods when they are boilerplate inside anyway once I nail down storage.
+
+So, Warden handles that stuff for me.  Relies heavily on my [Ratchet](https://github.com/bitblit/Ratchet) library
+for supporting code.
+
+You may wish to read [the changelog](CHANGELOG.md)
+
+## Installation
+
+`yarn install @bitblit/warden`
+
+## Usage
+
+TBD
+
+### Barrel Files
+A Note on barrel files - All of Warden's barrel files are one level down. This is because otherwise everything
+I said above about transitive dependencies gets thrown out the window if you put them all in one big barrel file
+
+# Testing
+
+Ha! No, seriously - all testing is done using Jest.  To run them:
+
+`yarn test`
+
+# Contributing
+
+Pull requests are welcome, although I'm not sure why you'd be interested!
+

package/dist/cjs/build/ratchet-warden-common-info.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RatchetWardenCommonInfo = void 0;
+class RatchetWardenCommonInfo {
+    constructor() { }
+    static buildInformation() {
+        const val = {
+            version: '84',
+            hash: 'f4d435f9dba4b8b2eaefb31582fcf44290522d7f',
+            branch: 'alpha-2023-03-12-7',
+            tag: 'alpha-2023-03-12-7',
+            timeBuiltISO: '2023-03-12T22:04:40-0700',
+            notes: '',
+        };
+        return val;
+    }
+}
+exports.RatchetWardenCommonInfo = RatchetWardenCommonInfo;

package/dist/cjs/client/provider/warden-client-abstract-recent-login-provider.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenClientAbstractRecentLoginProvider = void 0;
+const ratchet_common_1 = require("@bitblit/ratchet-common");
+const warden_utils_1 = require("../../common/util/warden-utils");
+class WardenClientAbstractRecentLoginProvider {
+    saveRecentLogin(entry) {
+        if (entry === null || entry === void 0 ? void 0 : entry.userId) {
+            ratchet_common_1.Logger.info('Saving recent login : %j', entry);
+            let list = this.fetchCache();
+            list = list.filter((s) => s.user.userId !== entry.userId);
+            list.push({
+                user: entry,
+                lastLoginEpochMS: Date.now(),
+            });
+            this.updateCache(list);
+        }
+        else {
+            ratchet_common_1.Logger.warn('Cannot save recent login - no login provided :  %s', entry);
+        }
+    }
+    saveNewUser(userId, label, contact) {
+        if (ratchet_common_1.StringRatchet.trimToNull(userId) && warden_utils_1.WardenUtils.validContact(contact)) {
+            this.saveRecentLogin({
+                userId: userId,
+                contactMethods: [contact],
+                webAuthnAuthenticatorIds: [],
+                userLabel: label,
+            });
+        }
+        else {
+            ratchet_common_1.Logger.warn('Cannot save new user - invalid data : %s : %j', userId, contact);
+        }
+    }
+    removeUser(userId) {
+        let list = this.fetchCache();
+        list = list.filter((c) => c.user.userId !== userId);
+        this.updateCache(list);
+    }
+    fetchAllLogins() {
+        return Object.assign([], this.fetchCache());
+    }
+    clearAllLogins() {
+        this.updateCache([]);
+    }
+}
+exports.WardenClientAbstractRecentLoginProvider = WardenClientAbstractRecentLoginProvider;

package/dist/cjs/client/provider/warden-client-current-logged-in-jwt-token-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/provider/warden-client-local-storage-logged-in-user-provider.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenClientLocalStorageLoggedInUserProvider = void 0;
+const ratchet_common_1 = require("@bitblit/ratchet-common");
+class WardenClientLocalStorageLoggedInUserProvider {
+    constructor(localStorageKey) {
+        this.localStorageKey = localStorageKey;
+        ratchet_common_1.RequireRatchet.notNullUndefinedOrOnlyWhitespaceString(this.localStorageKey, 'localStorageKey');
+        if (!localStorage) {
+            ratchet_common_1.ErrorRatchet.throwFormattedErr('Local storage not available on this platform');
+        }
+    }
+    fetchLoggedInUserWrapper() {
+        const asString = localStorage.getItem(this.localStorageKey);
+        const rval = ratchet_common_1.StringRatchet.trimToNull(asString) ? JSON.parse(asString) : null;
+        return rval;
+    }
+    logOutUser() {
+        this.setLoggedInUserWrapper(null);
+    }
+    setLoggedInUserWrapper(wrapper) {
+        if (wrapper) {
+            localStorage.setItem(this.localStorageKey, JSON.stringify(wrapper));
+        }
+        else {
+            localStorage.removeItem(this.localStorageKey);
+        }
+    }
+}
+exports.WardenClientLocalStorageLoggedInUserProvider = WardenClientLocalStorageLoggedInUserProvider;

package/dist/cjs/client/provider/warden-client-local-storage-recent-login-provider.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenClientLocalStorageRecentLoginProvider = void 0;
+const ratchet_common_1 = require("@bitblit/ratchet-common");
+const warden_client_abstract_recent_login_provider_1 = require("./warden-client-abstract-recent-login-provider");
+class WardenClientLocalStorageRecentLoginProvider extends warden_client_abstract_recent_login_provider_1.WardenClientAbstractRecentLoginProvider {
+    constructor(localStorageKey) {
+        super();
+        this.localStorageKey = localStorageKey;
+        ratchet_common_1.RequireRatchet.notNullUndefinedOrOnlyWhitespaceString(this.localStorageKey, 'localStorageKey');
+        if (!localStorage) {
+            ratchet_common_1.ErrorRatchet.throwFormattedErr('Local storage not available on this platform');
+        }
+    }
+    fetchCache() {
+        const asString = ratchet_common_1.StringRatchet.trimToNull(localStorage.getItem(ratchet_common_1.StringRatchet.trimToNull(this.localStorageKey)));
+        return asString ? JSON.parse(asString) : [];
+    }
+    updateCache(newValue) {
+        const asString = newValue ? JSON.stringify(newValue) : '[]';
+        localStorage.setItem(ratchet_common_1.StringRatchet.trimToNull(this.localStorageKey), asString);
+    }
+}
+exports.WardenClientLocalStorageRecentLoginProvider = WardenClientLocalStorageRecentLoginProvider;

package/dist/cjs/client/provider/warden-client-recent-login-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/provider/warden-client-transient-memory-logged-in-user-provider.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenClientTransientMemoryLoggedInUserProvider = void 0;
+class WardenClientTransientMemoryLoggedInUserProvider {
+    fetchLoggedInUserWrapper() {
+        return this.wrapper;
+    }
+    logOutUser() {
+        this.wrapper = null;
+    }
+    setLoggedInUserWrapper(wrapper) {
+        this.wrapper = wrapper;
+    }
+}
+exports.WardenClientTransientMemoryLoggedInUserProvider = WardenClientTransientMemoryLoggedInUserProvider;

package/dist/cjs/client/provider/warden-client-transient-memory-recent-login-provider.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenClientTransientMemoryRecentLoginProvider = void 0;
+const warden_client_abstract_recent_login_provider_1 = require("./warden-client-abstract-recent-login-provider");
+class WardenClientTransientMemoryRecentLoginProvider extends warden_client_abstract_recent_login_provider_1.WardenClientAbstractRecentLoginProvider {
+    constructor() {
+        super(...arguments);
+        this._cache = [];
+    }
+    fetchCache() {
+        return this._cache;
+    }
+    updateCache(newValue) {
+        this._cache = newValue;
+    }
+}
+exports.WardenClientTransientMemoryRecentLoginProvider = WardenClientTransientMemoryRecentLoginProvider;

package/dist/cjs/client/provider/warden-command-exchange-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/provider/warden-logged-in-user-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/provider/warden-logged-in-user-wrapper.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/provider/warden-recent-login-descriptor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/provider/warden-user-service-event-processing-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/provider/warden-user-service-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/warden-client.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenClient = void 0;
+const ratchet_common_1 = require("@bitblit/ratchet-common");
+class WardenClient {
+    constructor(commandSender, jwtProvider) {
+        this.commandSender = commandSender;
+        this.jwtProvider = jwtProvider;
+        ratchet_common_1.RequireRatchet.notNullOrUndefined(commandSender, 'commandSender');
+        ratchet_common_1.RequireRatchet.notNullOrUndefined(jwtProvider, 'jwtProvider');
+    }
+    async exchangeCommand(cmd, returnErrors) {
+        const asString = JSON.stringify(cmd);
+        const resp = await this.commandSender.sendCommand(asString, this.jwtProvider.fetchCurrentLoggedInJwtToken());
+        const parsed = JSON.parse(resp);
+        if ((parsed === null || parsed === void 0 ? void 0 : parsed.error) && !returnErrors) {
+            ratchet_common_1.ErrorRatchet.throwFormattedErr('%s', parsed.error);
+        }
+        return parsed;
+    }
+    async createAccount(contact, sendCode, label, tags) {
+        const cmd = {
+            createAccount: {
+                contact: contact,
+                sendCode: sendCode,
+                label: label,
+                tags: tags,
+            },
+        };
+        const rval = await this.exchangeCommand(cmd);
+        return rval.createAccount;
+    }
+    async generateWebAuthnAuthenticationChallengeForUserId(userId) {
+        const cmd = {
+            generateWebAuthnAuthenticationChallengeForUserId: userId,
+        };
+        const rval = await this.exchangeCommand(cmd);
+        const parsed = JSON.parse(rval.generateWebAuthnAuthenticationChallengeForUserId.dataAsJson);
+        return parsed;
+    }
+    async generateWebAuthnRegistrationChallengeForLoggedInUser() {
+        const cmd = {
+            generateWebAuthnRegistrationChallengeForLoggedInUser: true,
+        };
+        const rval = await this.exchangeCommand(cmd);
+        const parsed = JSON.parse(rval.generateWebAuthnRegistrationChallengeForLoggedInUser.dataAsJson);
+        return parsed;
+    }
+    async removeWebAuthnRegistration(userId, credId) {
+        const cmd = {
+            removeWebAuthnRegistration: {
+                userId: userId,
+                credentialId: credId,
+            },
+        };
+        const rval = await this.exchangeCommand(cmd);
+        return rval.removeWebAuthnRegistration;
+    }
+    async removeWebAuthnRegistrationFromLoggedInUser(input) {
+        const cmd = {
+            removeWebAuthnRegistrationFromLoggedInUser: input,
+        };
+        const rval = await this.exchangeCommand(cmd);
+        return rval.removeWebAuthnRegistrationFromLoggedInUser;
+    }
+    async removeContactFromLoggedInUser(input) {
+        const cmd = {
+            removeContactFromLoggedInUser: input,
+        };
+        const rval = await this.exchangeCommand(cmd);
+        return rval.removeContactFromLoggedInUser;
+    }
+    async sendExpiringValidationToken(contact) {
+        const cmd = {
+            sendExpiringValidationToken: contact,
+        };
+        const rval = await this.exchangeCommand(cmd);
+        return rval.sendExpiringValidationToken;
+    }
+    async addContactToLoggedInUser(contact) {
+        const cmd = {
+            addContactToLoggedInUser: contact,
+        };
+        const rval = await this.exchangeCommand(cmd);
+        return rval.addContactToLoggedInUser;
+    }
+    async addWebAuthnRegistrationToLoggedInUser(data) {
+        const cmd = {
+            addWebAuthnRegistrationToLoggedInUser: {
+                dataAsJson: JSON.stringify(data),
+            },
+        };
+        const rval = await this.exchangeCommand(cmd);
+        return rval.addWebAuthnRegistrationToLoggedInUser;
+    }
+    async performLoginCmd(login) {
+        const loginCmd = {
+            performLogin: login,
+        };
+        const cmdResponse = await this.exchangeCommand(loginCmd);
+        return cmdResponse.performLogin;
+    }
+    async refreshJwtToken(oldJwtToken) {
+        let rval = null;
+        if (ratchet_common_1.StringRatchet.trimToNull(oldJwtToken)) {
+            try {
+                const resp = await this.exchangeCommand({ refreshJwtToken: oldJwtToken });
+                rval = resp.refreshJwtToken;
+            }
+            catch (err) {
+                ratchet_common_1.Logger.error('JwtRefresh Failed : %s', err);
+            }
+        }
+        return rval;
+    }
+    async executeExpiringTokenBasedLogin(contact, expiringToken) {
+        let rval = null;
+        try {
+            const loginCmd = {
+                contact: contact,
+                expiringToken: expiringToken,
+            };
+            rval = await this.performLoginCmd(loginCmd);
+            if (rval === null || rval === void 0 ? void 0 : rval.jwtToken) {
+            }
+        }
+        catch (err) {
+            ratchet_common_1.Logger.error('ExpiringToken login Failed : %s', err);
+        }
+        return rval;
+    }
+}
+exports.WardenClient = WardenClient;

package/dist/cjs/client/warden-delegating-current-user-providing-user-service-event-processing-provider.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenDelegatingCurrentUserProvidingUserServiceEventProcessingProvider = void 0;
+const rxjs_1 = require("rxjs");
+class WardenDelegatingCurrentUserProvidingUserServiceEventProcessingProvider {
+    constructor(wrapped) {
+        this.wrapped = wrapped;
+        this._currentUserSubject = new rxjs_1.BehaviorSubject(null);
+    }
+    fetchCurrentLoggedInJwtToken() {
+        var _a, _b;
+        return (_b = (_a = this === null || this === void 0 ? void 0 : this._currentUserSubject) === null || _a === void 0 ? void 0 : _a.getValue()) === null || _b === void 0 ? void 0 : _b.jwtToken;
+    }
+    get currentUserSubject() {
+        return this._currentUserSubject;
+    }
+    onAutomaticLogout() {
+        if (this.wrapped) {
+            this.wrapped.onAutomaticLogout();
+        }
+    }
+    onAutomaticTokenRefresh(refreshUser) {
+        if (this.wrapped) {
+            this.wrapped.onAutomaticTokenRefresh(refreshUser);
+        }
+    }
+    onLoginFailure(reason) {
+        if (this.wrapped) {
+            this.wrapped.onLoginFailure(reason);
+        }
+    }
+    onLogout() {
+        if (this.wrapped) {
+            this.wrapped.onLogout();
+        }
+        this.currentUserSubject.next(null);
+    }
+    onSuccessfulLogin(newUser) {
+        if (this.wrapped) {
+            this.wrapped.onSuccessfulLogin(newUser);
+        }
+        this.currentUserSubject.next(newUser);
+    }
+}
+exports.WardenDelegatingCurrentUserProvidingUserServiceEventProcessingProvider = WardenDelegatingCurrentUserProvidingUserServiceEventProcessingProvider;