@appsemble/node-utils 0.22.1 → 0.22.2

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.22.1/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.22.2/config/assets/logo.svg) Appsemble Node Utilities
 
 > NodeJS utilities used by Appsemble internally.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/node-utils)](https://www.npmjs.com/package/@appsemble/node-utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.22.1/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.22.1)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.22.2/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.22.2)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ compatibility is not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.22.1/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.22.2/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/authentication.d.ts

@@ -0,0 +1,12 @@
+export declare const CREDENTIALS_ENV_VAR = "APPSEMBLE_CLIENT_CREDENTIALS";
+export declare function getService(remote: string): string;
+export declare function getKeytar(): Promise<typeof import('keytar')>;
+/**
+ * Login to the server using OAuth2 client credentials.
+ *
+ * @param remote Host to fetch token from.
+ * @param scope The OAuth2 scope to request. This may be space separated to request
+ *   multiple scopes.
+ * @param inputCredentials Client credentials passed from the command line.
+ */
+export declare function authenticate(remote: string, scope: string, inputCredentials: string): Promise<void>;

package/authentication.js

@@ -0,0 +1,77 @@
+import { AppsembleError, logger } from '@appsemble/node-utils';
+import axios from 'axios';
+import inquirer from 'inquirer';
+export const CREDENTIALS_ENV_VAR = 'APPSEMBLE_CLIENT_CREDENTIALS';
+const authorizedRemotes = new Set();
+export function getService(remote) {
+    return `appsemble://${new URL(remote).host}`;
+}
+export async function getKeytar() {
+    try {
+        const { default: keytar } = await import('keytar');
+        return keytar;
+    }
+    catch {
+        throw new AppsembleError('Couldn’t find module keytar. Either install libsecret and reinstall @appsemble/cli, or pass --client-credentials on the command line.');
+    }
+}
+async function getClientCredentials(remote, inputCredentials) {
+    if (inputCredentials) {
+        return inputCredentials;
+    }
+    const envCredentials = process.env[CREDENTIALS_ENV_VAR];
+    if (envCredentials) {
+        logger.info(`Detected client credentials from ${CREDENTIALS_ENV_VAR} environment variable`);
+        return envCredentials;
+    }
+    const { findCredentials } = await getKeytar();
+    const choices = await findCredentials(getService(remote));
+    if (choices.length === 0) {
+        throw new AppsembleError(`No client credentials found. Register them using:\n\nappsemble login --remote ${remote}`);
+    }
+    let choice;
+    if (choices.length === 1) {
+        [choice] = choices;
+    }
+    else {
+        ({ choice } = await inquirer.prompt([
+            {
+                name: 'choice',
+                message: 'Select client id to use',
+                choices: choices.map((value) => ({ name: value.account, value })),
+                type: 'list',
+            },
+        ]));
+    }
+    return `${choice.account}:${choice.password}`;
+}
+/**
+ * Login to the server using OAuth2 client credentials.
+ *
+ * @param remote Host to fetch token from.
+ * @param scope The OAuth2 scope to request. This may be space separated to request
+ *   multiple scopes.
+ * @param inputCredentials Client credentials passed from the command line.
+ */
+export async function authenticate(remote, scope, inputCredentials) {
+    const credentials = await getClientCredentials(remote, inputCredentials);
+    if (authorizedRemotes.has(remote)) {
+        logger.verbose(`Already logged in to ${remote}`);
+        return;
+    }
+    logger.verbose(`Logging in to ${remote}`);
+    const { data } = await axios.post('/oauth2/token', new URLSearchParams({ grant_type: 'client_credentials', scope }), {
+        headers: { authorization: `Basic ${Buffer.from(credentials).toString('base64')}` },
+        baseURL: remote,
+    });
+    authorizedRemotes.add(remote);
+    axios.interceptors.request.use((config) => {
+        if (config.baseURL === remote) {
+            config.headers.set('authorization', `Bearer ${data.access_token}`);
+        }
+        return config;
+    });
+    logger.info(`Logged in to ${remote} successfully`);
+    logger.verbose(`Login scope: ${scope}`);
+}
+//# sourceMappingURL=authentication.js.map

package/index.d.ts

@@ -32,3 +32,4 @@ export * from './server/types.js';
 export * from './koa.js';
 export { bulmaVersion, faVersion, version } from './versions.cjs';
 export * from './EmailQuotaExceededError.js';
+export * from './authentication.js';

package/index.js

@@ -32,4 +32,5 @@ export * from './server/types.js';
 export * from './koa.js';
 export { bulmaVersion, faVersion, version } from './versions.cjs';
 export * from './EmailQuotaExceededError.js';
+export * from './authentication.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.22.1",
+  "version": "0.22.2",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -37,8 +37,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.22.1",
-    "@appsemble/utils": "0.22.1",
+    "@appsemble/types": "0.22.2",
+    "@appsemble/utils": "0.22.2",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@koa/cors": "^4.0.0",
@@ -87,6 +87,8 @@
     "webpack": "^5.0.0",
     "webpack-dev-middleware": "^6.0.0",
     "winston": "^3.0.0",
+    "keytar": "^7.0.0",
+    "inquirer": "^9.0.0",
     "yaml": "^2.0.0",
     "yargs": "^17.0.0"
   },