mlcl 1.0.0

package/build/utilities/index.js

@@ -0,0 +1,13 @@
+/**
+ * Various utilities used throughout the application.
+ *
+ * @module
+ */
+export * from './checkVersion.js';
+export * from './getErrorMessage.js';
+export * from './readRepoConfig.js';
+export * from './readUserConfig.js';
+export * from './synchronizeUserConfig.js';
+export * from './timeAgo.js';
+export * from './writeRepoConfig.js';
+export * from './writeUserConfig.js';

package/build/utilities/readConfig.js

@@ -0,0 +1,19 @@
+import fs from 'fs';
+/**
+ * Reads and returns the current repo's config.
+ */
+export const readConfig = (path = `.mlclrc.json`) => {
+    try {
+        if (fs.existsSync(path)) {
+            const config = JSON.parse(fs.readFileSync(path, `utf8`));
+            return config;
+        }
+        else {
+            console.warn(`Config file (${path}) does not exist.`);
+        }
+    }
+    catch (error) {
+        console.error(error);
+    }
+    return {};
+};

package/build/utilities/readRepoConfig copy.js

@@ -0,0 +1,20 @@
+import fs from 'fs';
+import { getRepoRootPath } from '../commands/utilities/getRepoRootPath.js';
+/**
+ * Reads and returns the current repo's config.
+ */
+export const readRepoConfig = (path = `${getRepoRootPath()}/.mlclrc.json`) => {
+    try {
+        if (fs.existsSync(path)) {
+            const config = JSON.parse(fs.readFileSync(path, `utf8`));
+            return config;
+        }
+        else {
+            console.warn(`Config file (${path}) does not exist.`);
+        }
+    }
+    catch (error) {
+        console.error(error);
+    }
+    return {};
+};

package/build/utilities/readRepoConfig.js

@@ -0,0 +1,19 @@
+import fs from 'fs';
+import path from 'path';
+import { getRepoRootPathSync } from '../commands/utilities/getRepoRootPathSync.js';
+import { logger } from '../logger.js';
+/**
+ * Reads and returns the current repo's config.
+ */
+export const readRepoConfig = (repoConfigPath = path.join(getRepoRootPathSync(), `.mlclrc.json`)) => {
+    try {
+        if (fs.existsSync(repoConfigPath)) {
+            const config = JSON.parse(fs.readFileSync(repoConfigPath, `utf8`));
+            return config;
+        }
+    }
+    catch (error) {
+        logger.error(error);
+    }
+    return {};
+};

package/build/utilities/readUserConfig.js

@@ -0,0 +1,20 @@
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import { logger } from '../logger.js';
+const homeDir = os.homedir();
+/**
+ * Reads and returns the current user's config.
+ */
+export const readUserConfig = (userConfigPath = path.join(homeDir, `.mlclrc.json`)) => {
+    try {
+        if (fs.existsSync(userConfigPath)) {
+            const config = JSON.parse(fs.readFileSync(userConfigPath, `utf8`));
+            return config;
+        }
+    }
+    catch (error) {
+        logger.error(error);
+    }
+    return {};
+};

package/build/utilities/synchronizeUserConfig.js

@@ -0,0 +1,25 @@
+import { read as readUser } from '../API/resource/user/index.js';
+import { userConfig } from '../userConfig.js';
+import { writeUserConfig } from '../utilities/writeUserConfig.js';
+import { logger } from '../logger.js';
+import { getErrorMessage } from '../utilities/getErrorMessage.js';
+export const synchronizeUserConfig = async () => {
+    if (userConfig.user) {
+        try {
+            const { props: user } = (await readUser(userConfig.user.id)).data;
+            if (!user) {
+                throw new Error(`No user was returned by the Molecule.dev API.`);
+            }
+            if (userConfig.user?.id === user.id) {
+                userConfig.user = user;
+                writeUserConfig();
+            }
+            else {
+                logger.warn(`The Molecule.dev API returned an unexpected response when synchronizing the user.`);
+            }
+        }
+        catch (error) {
+            logger.warn(`Error fetching user: ${getErrorMessage(error) || `Unknown error`}`);
+        }
+    }
+};

package/build/utilities/timeAgo.js

@@ -0,0 +1,42 @@
+const MINUTE = 60000;
+const HOUR = 3600000;
+const DAY = 86400000;
+const WEEK = 604800000;
+const YEAR = 31557600000;
+/**
+ * Returns how long ago some time (date) was.
+ */
+export const timeAgo = (time, abbreviate) => {
+    if (typeof time !== `number`) {
+        try {
+            time = new Date(time).getTime();
+        }
+        catch (error) {
+        }
+    }
+    const diff = Math.max(0, Date.now() - Number(time));
+    let count = 0;
+    if (diff < MINUTE) {
+        return `just now`;
+    }
+    else if (diff < HOUR) {
+        count = Math.round(diff / MINUTE);
+        return `${count}${abbreviate ? `m` : ` minute${count === 1 ? `` : `s`}`} ago`;
+    }
+    else if (diff < DAY) {
+        count = Math.round(diff / HOUR);
+        return `${count}${abbreviate ? `h` : ` hour${count === 1 ? `` : `s`}`} ago`;
+    }
+    else if (diff < WEEK) {
+        count = Math.round(diff / DAY);
+        return `${count}${abbreviate ? `d` : ` day${count === 1 ? `` : `s`}`} ago`;
+    }
+    else if (diff < YEAR) {
+        count = Math.round(diff / WEEK);
+        return `${count}${abbreviate ? `w` : ` week${count === 1 ? `` : `s`}`} ago`;
+    }
+    else {
+        count = Math.round(diff / YEAR);
+        return `${count}${abbreviate ? `y` : ` year${count === 1 ? `` : `s`}`} ago`;
+    }
+};

package/build/utilities/userLoggedIn.js

@@ -0,0 +1,24 @@
+import { userConfig } from '../userConfig.js';
+import { synchronizeUserConfig } from './synchronizeUserConfig.js';
+import * as API from '../API/index.js';
+import { logger } from '../logger.js';
+/**
+ * Ensures the user is logged in before continuing.
+ *
+ * If the user is not logged in, automatically runs the `login` command.
+ */
+export const userLoggedIn = async () => {
+    await synchronizeUserConfig();
+    if (userConfig?.user?.id) {
+        logger.info(`Hello, ${userConfig.user.name || userConfig.user.username}!`);
+    }
+    else {
+        logger.info(`Not logged into \`mlcl\`. Logging in...`);
+        await API.resource.user.utilities.logIn();
+        if (!userConfig.user?.id) {
+            logger.warn(`Not logged in. Run \`mlcl login\` first.`);
+            return null;
+        }
+    }
+    return userConfig.user;
+};

package/build/utilities/writeConfig.js

@@ -0,0 +1,8 @@
+import fs from 'fs';
+import { config as currentConfig } from '../config.js';
+/**
+ * Writes the current repo's config to disk.
+ */
+export const writeConfig = (config = currentConfig, path = `.mlclrc.json`) => {
+    fs.writeFileSync(path, JSON.stringify(config, null, 2));
+};

package/build/utilities/writeRepoConfig copy.js

@@ -0,0 +1,9 @@
+import fs from 'fs';
+import { repoConfig as currentRepoConfig } from '../repoConfig.js';
+import { getRepoRootPath } from '../commands/utilities/getRepoRootPath.js';
+/**
+ * Writes the current repo's config to disk.
+ */
+export const writeRepoConfig = (repoConfig = currentRepoConfig, path = `${getRepoRootPath()}/.mlclrc.json`) => {
+    fs.writeFileSync(path, JSON.stringify(repoConfig, null, 2));
+};

package/build/utilities/writeRepoConfig.js

@@ -0,0 +1,10 @@
+import fs from 'fs';
+import path from 'path';
+import { repoConfig as currentRepoConfig } from '../repoConfig.js';
+import { getRepoRootPathSync } from '../commands/utilities/getRepoRootPathSync.js';
+/**
+ * Writes the current repo's config to disk.
+ */
+export const writeRepoConfig = (repoConfig = currentRepoConfig, repoConfigPath = path.join(getRepoRootPathSync(), `.mlclrc.json`)) => {
+    fs.writeFileSync(repoConfigPath, JSON.stringify(repoConfig, null, 2));
+};

package/build/utilities/writeUserConfig.js

@@ -0,0 +1,11 @@
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import { userConfig as currentUserConfig } from '../userConfig.js';
+const homeDir = os.homedir();
+/**
+ * Writes the current user's config to disk.
+ */
+export const writeUserConfig = (userConfig = currentUserConfig, userConfigPath = path.join(homeDir, `.mlclrc.json`)) => {
+    fs.writeFileSync(userConfigPath, JSON.stringify(userConfig, null, 2));
+};

package/jest.config.json

@@ -0,0 +1,11 @@
+{
+  "roots": [
+    "<rootDir>/src/"
+  ],
+  "setupFiles": [
+    "<rootDir>/src/environment.ts"
+  ],
+  "moduleNameMapper": {
+    "^(\\.{1,2}/.*)\\.jsx?$": "$1"
+  }
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "mlcl",
+  "version": "1.0.0",
+  "description": "CLI (Command Line Interface) for Molecule.dev.",
+  "author": "molecule.dev",
+  "license": "Apache-2.0",
+  "type": "module",
+  "engines": {
+    "node": ">=16 <17"
+  },
+  "bin": {
+    "mlcl": "./build/index.js"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.17.5",
+    "@babel/plugin-transform-runtime": "^7.17.0",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-typescript": "^7.16.7",
+    "@types/jest": "^27.4.1",
+    "@types/node": "^17.0.21",
+    "@types/semver": "^7.3.9",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
+    "babel-jest": "^27.5.1",
+    "babel-plugin-transform-import-meta": "^2.1.1",
+    "eslint": "^8.10.0",
+    "eslint-plugin-jest": "^26.1.1",
+    "jest": "^27.5.1",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.2"
+  },
+  "dependencies": {
+    "@types/glob": "^7.2.0",
+    "axios": "^0.26.1",
+    "commander": "^9.0.0",
+    "detect-indent": "^7.0.0",
+    "dotenv": "^16.0.0",
+    "env-cmd": "^10.1.0",
+    "glob": "^8.0.1",
+    "jwt-decode": "^3.1.2",
+    "loglevel": "^1.8.0",
+    "open": "^8.4.0",
+    "prettier": "^2.6.2",
+    "semver": "^7.3.7",
+    "xdiff": "^0.2.11"
+  },
+  "scripts": {
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "lint-autofix": "eslint . --ext .js,.jsx,.ts,.tsx --fix",
+    "test": "jest",
+    "test-watch": "jest --watch",
+    "dev": "tsc --watch",
+    "build": "tsc",
+    "start": "node build/cli.js"
+  }
+}

package/src/API/authorization.ts

@@ -0,0 +1,143 @@
+/**
+ * Methods for API authorization management.
+ * 
+ * @module
+ */
+
+import { AxiosError, AxiosResponse } from 'axios'
+import jwtDecode, { JwtPayload } from 'jwt-decode'
+import { client } from './client.js'
+import { userConfig } from '../userConfig.js'
+import { writeUserConfig } from '../utilities/writeUserConfig.js'
+import { logger } from '../logger.js'
+
+/**
+ * Sets the `Authorization` header on the API client (`axios` instance)
+ * and saves it within the user config.
+ */
+export const setHeader = (authorizationHeader = userConfig.authorizationHeader || ``) => {
+  if (authorizationHeader) {
+    client.defaults.headers.common.Authorization = authorizationHeader
+    userConfig.authorizationHeader = authorizationHeader
+    writeUserConfig()
+  }
+}
+
+/**
+ * Removes the `Authorization` header from the API client (`axios` instance)
+ * and removes it from the user config.
+ */
+export const removeHeader = () => {
+  if (client.defaults.headers) {
+    delete client.defaults.headers.common.Authorization
+  }
+
+  delete userConfig.authorizationHeader
+  writeUserConfig()
+}
+
+/**
+ * If multiple users log into the same device, we use this map of user IDs to device IDs
+ * to allow users to properly reidentify the device when switching between users.
+ */
+export const getUserIdsToDeviceIds = (): { [userId: string]: string } => {
+  if (!userConfig.userIdsToDeviceIds) {
+    userConfig.userIdsToDeviceIds = {}
+  }
+
+  return userConfig.userIdsToDeviceIds
+}
+
+/**
+ * Gets the `userId` and `deviceId` from the decoded `Authorization` header
+ * and saves it within the config as a map of user IDs to device IDs.
+ */
+export const setUserIdToDeviceId = (authorizationHeader: string) => {
+  try {
+    const [ bearer = ``, authorizationToken = `` ] = authorizationHeader.split(` `)
+    const { session } = jwtDecode<JwtPayload & { session: { userId: string; deviceId: string } }>(authorizationToken)
+    const { userId, deviceId } = session
+    const userIdsToDeviceIds = getUserIdsToDeviceIds()
+
+    if (bearer && userId && deviceId) {
+      userIdsToDeviceIds[userId] = deviceId
+      writeUserConfig()
+    }
+  } catch (error) {
+    logger.error(error)
+  }
+}
+
+export type interceptResponseProps = {
+  /**
+   * Called when the `Authorization` header is set.
+   */
+  onSet?: () => void
+}
+
+/**
+ * If the `Set-Authorization` header is included in the response,
+ * sets the header and user ID to device ID.
+ */
+export const interceptResponse = ({ onSet }: interceptResponseProps = {}) => (response: AxiosResponse): AxiosResponse => {
+  if (response.headers[`set-authorization`]) {
+    setHeader(response.headers[`set-authorization`])
+    setUserIdToDeviceId(response.headers[`set-authorization`])
+
+    if (onSet) {
+      onSet()
+    }
+  }
+
+  return response
+}
+
+export type interceptErrorProps = {
+  /**
+   * Called when the `Authorization` header is set.
+   */
+  onSet?: () => void
+  /**
+   * Called when the `Authorization` header is removed.
+   */
+  onRemove?: () => void
+}
+
+/**
+ * Removes the `Authorization` header if the response status code is `401`,
+ * or if the `Set-Authorization` header is included in the error response,
+ * sets the header and user ID to device ID.
+ */
+export const interceptError = ({ onSet, onRemove }: interceptErrorProps = {}) => (error: AxiosError): Promise<AxiosError> => {
+  if (error?.response?.status === 401) {
+    removeHeader()
+
+    if (onRemove) {
+      onRemove()
+    }
+  } else if (error?.response?.headers[`set-authorization`]) {
+    setHeader(error.response.headers[`set-authorization`])
+    setUserIdToDeviceId(error.response.headers[`set-authorization`])
+
+    if (onSet) {
+      onSet()
+    }
+  }
+
+  return Promise.reject(error)
+}
+
+// Set the locally stored authorization header, if it exists.
+setHeader()
+
+// Intercept all requests to set and/or remove the authorization header.
+client.interceptors.response.use(
+  interceptResponse(), // Locally store authorization headers when provided.
+  interceptError({
+    onRemove: () => {
+      // Log out when authorization removed.
+      delete userConfig.user
+      writeUserConfig()
+    }
+  })
+)

package/src/API/client.ts

@@ -0,0 +1,12 @@
+import axios from 'axios'
+
+/**
+ * The API client (`axios` instance).
+ * 
+ * @see https://www.npmjs.com/package/axios 
+ */
+export const client = axios.create({
+  baseURL: `${process.env.API_ORIGIN || ``}/api`,
+  headers: process.env.APP_ID ? { 'X-Requested-With': process.env.APP_ID } : {},
+  withCredentials: true
+})

package/src/API/index.ts

@@ -0,0 +1,10 @@
+/**
+ * API client resources with authorization.
+ * 
+ * @module
+ */
+
+export * as resource from './resource/index.js'
+
+export * as authorization from './authorization.js'
+export * from './client.js'

package/src/API/resource/device/index.ts

@@ -0,0 +1,27 @@
+/**
+ * The device API resource.
+ * 
+ * @module
+ */
+
+import { client } from '../../client.js'
+import * as types from './types.js'
+
+export * as utilities from './utilities/index.js'
+export * as types from './types.js'
+
+export const query = (): Promise<types.QueryResponse> => (
+  client.get(`devices`)
+)
+
+export const read = (id: string): Promise<types.SuccessResponse> => (
+  client.get(`devices/${id}`)
+)
+
+export const update = (id: string, props: types.UpdateProps): Promise<types.SuccessPartialResponse> => (
+  client.patch(`devices/${id}`, props)
+)
+
+export const del = (id: string): Promise<types.SuccessPartialResponse> => (
+  client.delete(`devices/${id}`)
+)

package/src/API/resource/device/types.ts

@@ -0,0 +1,80 @@
+/**
+ * Device type definitions.
+ * 
+ * @module
+ */
+
+import * as resourceTypes from '../types.js'
+
+// Internal reference for easier default type arguments within this module.
+type DeviceProps = Props
+
+/**
+ * The device's properties returned by the API.
+ */
+export interface Props extends resourceTypes.Props {
+  /**
+   * The device owner's `userId`.
+   */
+  userId: string
+  /**
+   * The name of the device.
+   * 
+   * Usually determined using `navigator.userAgent`, `navigator.appVersion`, and `navigator.appName`, but user editable.
+   */
+  name?: string
+  /**
+   * An optional SSH key the device can use to access `git.molecule.dev`.
+   */
+  sshKey?: string
+  /**
+   * The platform when pushing notifications.
+   * 
+   * No platform means the push subscription was set up via a service worker registration's `PushManager`, either via web browser or Electron app.
+   */
+  pushPlatform?: `fcm` | `apn`
+  /**
+   * True when the user has push notifications enabled for the device.
+   */
+  hasPushSubscription?: boolean
+}
+
+/**
+ * The properties when updating a device. 
+ */
+export interface UpdateProps {
+  name?: Props['name']
+  sshKey?: Props['sshKey']
+}
+
+/**
+ * The successful device resource response.
+ */
+export type SuccessResponse<Props = DeviceProps> = resourceTypes.SuccessResponse<Props>
+
+/**
+ * The successful device resource response returning partial props.
+ */
+export type SuccessPartialResponse<Props = DeviceProps> = resourceTypes.SuccessPartialResponse<Props>
+
+/**
+ * The response when querying devices.
+ * 
+ * An extra `isCurrent` property is set to `true` when the device in the list matches the `session.deviceId`.
+ */
+export type QueryResponse<Props = DeviceProps> = resourceTypes.QueryResponse<Props & { isCurrent?: boolean }>
+
+/**
+ * Generic response with an optional body.
+ */
+export type GenericResponse = resourceTypes.GenericResponse
+
+/**
+ * The response containing a message.
+ */
+export type MessageResponse = resourceTypes.MessageResponse
+
+/**
+ * The response when an error has occurred when handling a device resource request.
+ */
+export type ErrorResponse = resourceTypes.ErrorResponse

package/src/API/resource/device/utilities/confirmSshKey.ts

@@ -0,0 +1,25 @@
+import { read } from '../index.js'
+import { sendSshKey } from './sendSshKey.js'
+import { logger } from '../../../../logger.js'
+
+export const confirmSshKey = async (deviceId: string, name: string) => {
+  try {
+    const device = (await read(deviceId)).data.props
+
+    if (device.sshKey) {
+      return true
+    }
+
+    const sshKeyConfirmed = await sendSshKey(deviceId, name)
+
+    if (sshKeyConfirmed) {
+      return true
+    }
+  } catch (error) {
+  }
+
+  logger.warn(`The Molecule.dev API could not confirm your device SSH key.`)
+  logger.warn(`Use \`mlcl add-ssh-key\` or try logging out and in again.`)
+
+  return false
+}

package/src/API/resource/device/utilities/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Device resource utilities.
+ * 
+ * @module
+ */
+
+export * from './confirmSshKey.js'
+export * from './sendSshKey.js'