mlcl 1.0.0

package/.eslintignore

@@ -0,0 +1,31 @@
+# This file currently mirrors .gitignore as we only care about linting code committed to git,
+# Feel free to modify it to suit your needs.
+
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# the build
+/build
+
+# autogenerated docs
+/docs
+
+# testing
+/coverage
+
+# misc
+.DS_Store
+.env*
+.eslintcache
+.vscode
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# keys
+.keys

package/.eslintrc.json

@@ -0,0 +1,54 @@
+{
+  "root": true,
+  "env": {
+    "node": true,
+    "es2021": true,
+    "jest/globals": true
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "jest"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "sourceType": "module"
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:jest/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "semi": "off",
+    "@typescript-eslint/semi": [
+      "warn",
+      "never"
+    ],
+    "@typescript-eslint/member-delimiter-style": [
+      "warn",
+      {
+        "multiline": {
+          "delimiter": "none",
+          "requireLast": false
+        },
+        "singleline": {
+          "delimiter": "semi",
+          "requireLast": false
+        },
+        "multilineDetection": "brackets"
+      }
+    ],
+    "no-trailing-spaces": [
+      "warn",
+      {
+        "ignoreComments": true
+      }
+    ],
+    "no-empty": [
+      "warn",
+      {
+        "allowEmptyCatch": true
+      }
+    ]
+  }
+}

package/LICENSE

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, replacing "Molecule.dev" with your own
+      identifying information. The text should be enclosed in the
+      appropriate comment syntax for the file format. We also recommend
+      that a file or class name and description of purpose be included
+      on the same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Molecule.dev
+
+   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,101 @@
+# mlcl
+
+This package contains command line tools to help with managing full-stack, cross-platform apps assembled with [Molecule.dev](https://www.molecule.dev).
+
+
+## Usage
+
+You will need SSH, [Git](https://git-scm.com/), and [Node.js 16](https://nodejs.org/) installed on your machine.
+
+The recommended way to use `mlcl` is via [`npx`](https://nodejs.dev/learn/the-npx-nodejs-package-runner) by passing `mlcl` commands to `npx`.
+
+Example:
+
+```sh
+npx mlcl --help
+```
+
+You can also install it globally if you'd rather not use `npx`:
+
+```sh
+npm install mlcl --global
+mlcl --help
+```
+
+
+## User commands
+
+- **`mlcl login`**
+
+    Opens your default web browser where you'll be asked for permission to log into your Molecule.dev account within your terminal.
+
+
+- **`mlcl logout`**
+
+    Logs you out of your Molecule.dev account by deleting the authorization headers, usually stored within `.mlclrc.json` within your home directory.
+
+
+- **`mlcl add-ssh-key [path]`**
+
+    For licensed users only. Looks for your current device's public SSH key, defaulting to a path of `~/.ssh/id_*.pub`, and sends it to our servers to allow you to access premium (private) repositories. If a key cannot be found, it will attempt to generate a new one using `ssh-keygen`.
+
+
+- **`mlcl remove-ssh-key`**
+
+    For licensed users only. Removes your current device's public SSH key from our servers.
+
+
+## Molecule commands
+
+These commands (with the exception of `clone`) must be run within a directory containing a Molecule repository, determined by the presence of a valid `.mlclrc.json` file.
+
+
+- **`mlcl info`**
+
+    Opens your Molecule's information page in your default web browser.
+
+
+- **`mlcl clone <moleculeId> [projectName]`**
+
+    Clones your Molecule's relevant repositories into `project-name-api` and/or `project-name-app` directories. Adds the necessary `.mlclrc.json` file to each directory.
+
+    If you are not logged in, it will attempt to log you in.
+
+    If you are a licensed user, it will attempt to add your SSH key if not already added, and your repositories will be cloned using Molecule.dev's premium (private) repositories.
+
+    If you are a free or subscribed user, your repositories will be cloned using Molecule.dev's public repositories [available on GitHub](https://github.com/molecule-dev).
+
+
+- **`mlcl subscribe`**
+
+    Enables a monthly subscription for your Molecule.
+
+    If you have previously subscribed, it will attempt to reactivate your Stripe subscription. Otherwise, a Stripe checkout page will be opened in your default web browser.
+
+
+- **`mlcl unsubscribe`**
+
+    Disables your Molecule's monthly subscription. You will be able to continue using subscribers' features until the monthly period ends.
+
+
+- **`mlcl buy single`**
+
+    Opens a Stripe checkout page in your default web browser where you can purchase a single license for your current Molecule.
+
+
+- **`mlcl buy unlimited`**
+
+    Opens a Stripe checkout page in your default web browser where you can purchase an unlimited license for your current Molecule.
+
+
+- **`mlcl buy business <number>`**
+
+    Requires at least 10. Opens a Stripe checkout page in your default web browser where you can purchase a business license, allowing you to assemble any Molecule as needed.
+
+
+## Other commands
+
+- **`mlcl x-merge-json`**
+
+    A [custom git merge driver](https://git-scm.com/docs/gitattributes#_defining_a_custom_merge_driver) used for automatically resolving merge conflicts for JSON files when assembling Molecules.
+

package/babel.config.json

@@ -0,0 +1,10 @@
+{
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-typescript"
+  ],
+  "plugins": [
+    "@babel/transform-runtime",
+    "babel-plugin-transform-import-meta"
+  ]
+}

package/build/API/authorization.js

@@ -0,0 +1,107 @@
+/**
+ * Methods for API authorization management.
+ *
+ * @module
+ */
+import jwtDecode 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 = () => {
+    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) => {
+    try {
+        const [bearer = ``, authorizationToken = ``] = authorizationHeader.split(` `);
+        const { session } = jwtDecode(authorizationToken);
+        const { userId, deviceId } = session;
+        const userIdsToDeviceIds = getUserIdsToDeviceIds();
+        if (bearer && userId && deviceId) {
+            userIdsToDeviceIds[userId] = deviceId;
+            writeUserConfig();
+        }
+    }
+    catch (error) {
+        logger.error(error);
+    }
+};
+/**
+ * If the `Set-Authorization` header is included in the response,
+ * sets the header and user ID to device ID.
+ */
+export const interceptResponse = ({ onSet } = {}) => (response) => {
+    if (response.headers[`set-authorization`]) {
+        setHeader(response.headers[`set-authorization`]);
+        setUserIdToDeviceId(response.headers[`set-authorization`]);
+        if (onSet) {
+            onSet();
+        }
+    }
+    return response;
+};
+/**
+ * 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 } = {}) => (error) => {
+    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/build/API/client.js

@@ -0,0 +1,11 @@
+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/build/API/index.js

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

package/build/API/molecule/index.js

@@ -0,0 +1,11 @@
+/**
+ * The `molecule` API resource.
+ *
+ * @module
+ */
+import { client } from '../../client';
+export * as types from './types';
+export const read = (id) => (client.get(`molecules/${id}`));
+export const create = (props) => (client.post(`molecules`, props));
+export const update = (id, props) => (client.patch(`molecules/${id}`, props));
+export const updatePlan = (id, { planKey, receipt, quantity }) => (client.patch(`molecules/${id}/plan`, { planKey, receipt, quantity }));

package/build/API/molecule/types.js

@@ -0,0 +1,6 @@
+/**
+ * Molecule type definitions.
+ *
+ * @module
+ */
+export {};

package/build/API/resource/device/index.js

@@ -0,0 +1,12 @@
+/**
+ * The device API resource.
+ *
+ * @module
+ */
+import { client } from '../../client.js';
+export * as utilities from './utilities/index.js';
+export * as types from './types.js';
+export const query = () => (client.get(`devices`));
+export const read = (id) => (client.get(`devices/${id}`));
+export const update = (id, props) => (client.patch(`devices/${id}`, props));
+export const del = (id) => (client.delete(`devices/${id}`));

package/build/API/resource/device/types.js

@@ -0,0 +1,6 @@
+/**
+ * Device type definitions.
+ *
+ * @module
+ */
+export {};

package/build/API/resource/device/utilities/confirmSshKey.js

@@ -0,0 +1,20 @@
+import { read } from '../index.js';
+import { sendSshKey } from './sendSshKey.js';
+import { logger } from '../../../../logger.js';
+export const confirmSshKey = async (deviceId, name) => {
+    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/build/API/resource/device/utilities/index.js

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

package/build/API/resource/device/utilities/sendSshKey.js

@@ -0,0 +1,64 @@
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { execSync } from 'child_process';
+import { update } from '../index.js';
+import { logger } from '../../../../logger.js';
+import { getErrorMessage } from '../../../../utilities/getErrorMessage.js';
+const homeDir = os.homedir();
+const sshDir = path.join(homeDir, `.ssh`);
+const findPubKey = (filename) => /^id_(.+)\.pub$/.test(filename);
+export const sendSshKey = async (deviceId, name, sshKeyPath) => {
+    if (!sshKeyPath) {
+        if (!fs.existsSync(sshDir)) {
+            fs.mkdirSync(sshDir, { recursive: true });
+        }
+        logger.info(`Looking for ~/.ssh/id_*.pub...`);
+        sshKeyPath = fs.readdirSync(sshDir).find(findPubKey);
+        if (sshKeyPath) {
+            logger.info(`Found ~/.ssh/${sshKeyPath}.`);
+        }
+    }
+    if (!sshKeyPath) {
+        logger.info(`Public SSH key not found. Using \`ssh-keygen\` to create one.`);
+        try {
+            execSync(`ssh-keygen -t ed25519 -C "${name}" -f id_ed25519`, { encoding: `utf8`, stdio: [0, 1, 2] });
+            fs.renameSync(`id_ed25519`, path.join(sshDir, `id_ed25519`));
+            fs.renameSync(`id_ed25519.pub`, path.join(sshDir, `id_ed25519.pub`));
+        }
+        catch (error) {
+            logger.warn(`Error: ${getErrorMessage(error)}`);
+        }
+        sshKeyPath = fs.readdirSync(sshDir).find(findPubKey);
+        if (sshKeyPath) {
+            logger.info(`Created ~/.ssh/${sshKeyPath}.`);
+        }
+    }
+    if (!sshKeyPath) {
+        logger.warn(`No public SSH key to add.`);
+        return false;
+    }
+    const sshKey = fs.readFileSync(path.join(sshDir, sshKeyPath), `utf8`);
+    if (!sshKey) {
+        logger.warn(`SSH key file is empty.`);
+        return false;
+    }
+    logger.info(`Sending public SSH key to the API...`);
+    const timeout = setTimeout(() => {
+        logger.info(`This may take a moment...`);
+    }, 2000);
+    try {
+        const { props } = (await update(deviceId, { sshKey })).data;
+        if (!props.sshKey) {
+            throw new Error(`The Molecule.dev API did not confirm the SSH key.`);
+        }
+        clearTimeout(timeout);
+        logger.info(`SSH key successfully added!`);
+        return true;
+    }
+    catch (error) {
+        clearTimeout(timeout);
+        logger.warn(`Failed to add SSH key. ${getErrorMessage(error)}`);
+    }
+    return false;
+};

package/build/API/resource/index.js

@@ -0,0 +1,10 @@
+/**
+ * Every available API resource.
+ *
+ * @module
+ */
+export * as device from './device/index.js';
+export * as molecule from './molecule/index.js';
+export * as payment from './payment/index.js';
+export * as user from './user/index.js';
+export * as types from './types.js';