mlcl 1.0.0

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

@@ -0,0 +1,131 @@
+/**
+ * User type definitions.
+ * 
+ * @module
+ */
+
+import * as resourceTypes from '../types.js'
+import { PlanKey } from '../payment/types.js'
+
+// Internal reference for easier default type arguments within this module.
+type UserProps = Props
+
+/**
+ * The user's properties returned by the API.
+ */
+export interface Props extends resourceTypes.Props {
+  /**
+   * An alphanumeric username.
+   */
+  username: string
+  /**
+   * The user's given name.
+   */
+  name?: string
+  /**
+   * The user's email address.
+   */
+  email?: string
+  /**
+   * The user's phone number.
+   */
+  phone?: string
+  /**
+   * True when 2FA is enabled.
+   */
+  twoFactorEnabled?: boolean
+  /**
+   * The OAuth server used to authenticate the user.
+   */
+  oauthServer?: OAuthServer
+  /**
+   * Unique identifier for the user retrieved from the OAuth server.
+   */
+  oauthId?: string
+  /**
+   * User data retrieved from the OAuth server.
+   * 
+   * Varies depending on the server.
+   */
+  oauthData?: JSONObject
+  /**
+   * The user's current plan (key).
+   */
+  planKey?: PlanKey
+  /**
+   * When the plan expires.
+   * 
+   * Usually an ISO 8061 timestamp.
+   */
+  planExpiresAt?: string
+  /**
+   * True if the plan will automatically renew.
+   */
+  planAutoRenews?: boolean
+}
+
+/**
+ * The available OAuth servers.
+ */
+export type OAuthServer = undefined
+  | `github`
+  | `gitlab`
+  | `google`
+  | `twitter`
+
+/**
+ * The properties when logging in via the CLI.
+ */
+export interface LogInCLIProps {
+  token?: string
+  deviceIds?: string[]
+  deviceName?: string
+}
+
+/**
+ * The successful user resource response returning either a token when initiating or user props when logged in.
+ */
+export type LogInCLIResponse<Props = UserProps> = {
+  /**
+   * HTTP status code.
+   */
+  statusCode: 200 | 201
+  /**
+   * The response body.
+   */
+  data: {
+    /**
+     * Response data will contain a `token` when initiating.
+     */
+    token?: string
+    /**
+     * Response data will contain `props` when logged in.
+     */
+    props?: Props
+  }
+}
+
+/**
+ * The successful user resource response.
+ */
+export type SuccessResponse<Props = UserProps> = resourceTypes.SuccessResponse<Props>
+
+/**
+ * The successful user resource response returning partial props.
+ */
+export type SuccessPartialResponse<Props = UserProps> = resourceTypes.SuccessPartialResponse<Props>
+
+/**
+ * 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 user resource request.
+ */
+export type ErrorResponse = resourceTypes.ErrorResponse

package/src/API/resource/user/utilities/getPlan.ts

@@ -0,0 +1,16 @@
+import * as types from '../types.js'
+import { plans } from '../../payment/plans.js'
+
+/**
+ * Gets a user's current `plan`.
+ */
+export const getPlan = (user: types.Props) => {
+  const planKey = user.planKey || ``
+  const planExpiresTime = (user.planExpiresAt && new Date(String(user.planExpiresAt)).getTime()) || 0
+
+  if (plans[planKey] && Date.now() < planExpiresTime) {
+    return plans[planKey]
+  }
+
+  return plans['']
+}

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

@@ -0,0 +1,8 @@
+/**
+ * User resource utilities.
+ * 
+ * @module
+ */
+
+export * from './getPlan.js'
+export * from './logIn.js'

package/src/API/resource/user/utilities/logIn.ts

@@ -0,0 +1,71 @@
+import os from 'os'
+import open from 'open'
+import { logInCLI } from '../index.js'
+import { getUserIdsToDeviceIds } from '../../../authorization.js'
+import { logger } from '../../../../logger.js'
+import { getErrorMessage } from '../../../../utilities/getErrorMessage.js'
+import { userConfig } from '../../../../userConfig.js'
+import { writeUserConfig } from '../../../../utilities/writeUserConfig.js'
+
+const CHECK_AFTER = 3000 // 3 seconds
+const MAX_TRIES = 20
+
+export const logIn = async () => {
+  const deviceIds = Object.values(getUserIdsToDeviceIds())
+  const deviceName = `CLI (${os.platform()})`
+  let token = ``
+
+  try {
+    token = (await logInCLI({ deviceIds, deviceName })).data.token || ``
+
+    if (!token) {
+      logger.warn(`No token was returned by the API.`)
+      return
+    }
+  } catch (error) {
+    logger.warn(`Error fetching token: ${getErrorMessage(error)}`)
+    return
+  }
+
+  logger.info(`Opening your browser and waiting for your allowance...`)
+
+  const url = `${process.env.WEB_ORIGIN}/#/allow-auth-token?token=${encodeURIComponent(token)}`
+
+  const childProcess = await open(url)
+
+  childProcess.on(`error`, error => {
+    logger.warn(`Error opening the auth URL: ${getErrorMessage(error)}`)
+    logger.warn(`If your browser didn't open on its own, visit the following URL to continue logging in: ${url}`)
+  })
+
+  childProcess.on(`close`, code => {
+    if (code !== 0) {
+      logger.warn(`If your browser didn't open on its own, visit the following URL to continue logging in: ${url}`)
+    }
+  })
+
+  const check = async (tryCount = 0) => {
+    if (tryCount >= MAX_TRIES) {
+      logger.info(`Reached maximum number of tries.`)
+      return
+    }
+
+    try {
+      await new Promise(resolve => setTimeout(resolve, CHECK_AFTER))
+
+      const user = (await logInCLI({ token, deviceIds, deviceName })).data.props
+
+      if (user) {
+        logger.info(`Hello, ${user.name || user.username}!`)
+        userConfig.user = user
+        writeUserConfig()
+      } else {
+        await check(tryCount + 1)
+      }
+    } catch (error) {
+      await check(tryCount + 1)
+    }
+  }
+
+  await check()
+}

package/src/commands/add-ssh-key.ts

@@ -0,0 +1,30 @@
+import { Command } from 'commander'
+import { userConfig } from '../userConfig.js'
+import { userLoggedIn } from '../utilities/userLoggedIn.js'
+import * as API from '../API/index.js'
+import { logger } from '../logger.js'
+
+/**
+ * Adds the `add-ssh-key` command to the program.
+ */
+export const addSshKey = (program: Command) => {
+  program.command(`add-ssh-key`)
+    .description(`finds or creates \`~/.ssh/id_*.pub\` (using \`ssh-keygen\`) and adds it to your Molecule.dev account for your current CLI device`)
+    .argument(`[path]`, `specify the location of the SSH key`)
+    .action(async (sshKeyPath = ``) => {
+      const user = await userLoggedIn()
+
+      if (!user) {
+        return
+      }
+
+      const deviceId = userConfig.userIdsToDeviceIds?.[user.id] || ``
+
+      if (!deviceId) {
+        logger.warn(`No device ID for the current user. Try logging out and in again.`)
+        return
+      }
+
+      await API.resource.device.utilities.sendSshKey(deviceId, user.username, sshKeyPath)
+    })
+}

package/src/commands/buy.ts

@@ -0,0 +1,83 @@
+import open from 'open'
+import { Command, Argument } from 'commander'
+import { userLoggedIn } from '../utilities/userLoggedIn.js'
+import { repoConfig } from '../repoConfig.js'
+import * as API from '../API/index.js'
+import { logger } from '../logger.js'
+import { getErrorMessage } from '../utilities/getErrorMessage.js'
+import { plans } from '../API/resource/payment/plans.js'
+import { PlanKey } from '../API/resource/payment/types.js'
+
+/**
+ * Adds the `buy` command to the program.
+ */
+ export const buy = (program: Command) => {
+  program.command(`buy`)
+    .description(`purchase a license for your Molecule`)
+    .addArgument(new Argument(`[license]`, `the type of license`).choices([`single`, `unlimited`, `business`]))
+    .addArgument(new Argument(`[quantity]`, `the quantity for the business license (at least ${plans.stripeBusinessMolecule.minimumQuantity})`))
+    .action(async (license?: `single` | `unlimited` | `business`, quantity = 1) => {
+      if (!license) {
+        logger.info(`Usage:`)
+        logger.info(`  mlcl buy single - one app with this Molecule`)
+        logger.info(`  mlcl buy unlimited - unlimited apps with this Molecule`)
+        logger.info(`  mlcl buy business <quantity> - at least 10 apps with any Molecule`)
+        return
+      }
+
+      const user = await userLoggedIn()
+
+      if (!user) {
+        return
+      }
+
+      if (!repoConfig?.id) {
+        logger.warn(`Not within a Molecule repository or \`.mlclrc.json\` not found.`)
+        return
+      }
+
+      const planKey = ({
+        single: `stripeSingleUseMolecule`,
+        unlimited: `stripeUnlimitedUseMolecule`,
+        business: `stripeBusinessMolecule`,
+      })[license || ``] as PlanKey
+
+      if (!planKey || !plans[planKey]) {
+        logger.warn(`Unknown license option.`)
+        return
+      }
+
+      try {
+        quantity = Math.max(plans[planKey]?.minimumQuantity || 1, Math.round(Number(quantity) || 1))
+
+        const molecule = (await API.resource.molecule.read(repoConfig.id)).data.props
+
+        if (!molecule) {
+          throw new Error(`Failed to fetch Molecule by ID ${repoConfig.id}.`)
+        }
+
+        const { checkoutUrl } = (await API.resource.molecule.updatePlan(molecule.id, { planKey, quantity })).data
+
+        if (checkoutUrl) {
+          logger.info(`Opening your browser to complete checkout via Stripe...`)
+
+          const childProcess = await open(checkoutUrl)
+
+          childProcess.on(`error`, error => {
+            logger.warn(`Error opening the checkout URL: ${getErrorMessage(error)}`)
+            logger.warn(`If your browser didn't open on its own, visit the following URL: ${checkoutUrl}`)
+          })
+
+          childProcess.on(`close`, code => {
+            if (code !== 0) {
+              logger.warn(`If your browser didn't open on its own, visit the following URL: ${checkoutUrl}`)
+            }
+          })
+        } else {
+          throw new Error(`Unexpected response. Please contact developer-support@molecule.dev so we can fix this.`)
+        }
+      } catch (error) {
+        logger.warn(`Something went wrong. ${getErrorMessage(error)}`)
+      }
+    })
+}