mlcl 1.0.0

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

@@ -0,0 +1,80 @@
+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: string) => /^id_(.+)\.pub$/.test(filename)
+
+export const sendSshKey = async (deviceId: string, name: string, sshKeyPath?: string) => {
+  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/src/API/resource/index.ts

@@ -0,0 +1,12 @@
+/**
+ * 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'

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

@@ -0,0 +1,30 @@
+/**
+ * The `molecule` API resource.
+ * 
+ * @module
+ */
+
+import { client } from '../../client.js'
+import * as types from './types.js'
+
+export * as types from './types.js'
+
+export const read = (id: string): Promise<types.SuccessResponse> => (
+  client.get(`molecules/${id}`)
+)
+
+export const readClone = (id: string): Promise<types.CloneResponse> => (
+  client.get(`molecules/${id}/clone`)
+)
+
+export const create = (props: types.CreateProps): Promise<types.SuccessResponse | types.MessageResponse> => (
+  client.post(`molecules`, props)
+)
+
+export const update = (id: string, props: types.UpdateProps): Promise<types.SuccessPartialResponse> => (
+  client.patch(`molecules/${id}`, props)
+)
+
+export const updatePlan = (id: string, { planKey, receipt, quantity }: types.UpdatePlanProps): Promise<types.UpdatePlanResponse> => (
+  client.patch(`molecules/${id}/plan`, { planKey, receipt, quantity })
+)

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

@@ -0,0 +1,332 @@
+/**
+ * Molecule type definitions.
+ * 
+ * @module
+ */
+
+import { Commit } from '../../../types/index.js'
+import { PlanKey } from '../payment/types.js'
+import * as resourceTypes from '../types.js'
+
+// Internal reference for easier default type arguments within this module.
+type MoleculeProps = Props
+
+/**
+ * The molecule's properties returned by the API.
+ */
+export interface Props extends resourceTypes.Props {
+  /**
+   * The name of the molecule, chosen by the user.
+   */
+  name?: string
+  /**
+   * The customer's user ID.
+   */
+  userId: string
+  /**
+   * The object hash of the selected options relevant to the frontend app.
+   * 
+   * Set only when the selection is valid and implemented.
+   */
+  appSelectionHash?: string
+  /**
+   * The object hash of the selected options relevant to the backend API.
+   * 
+   * Set only when the selection is valid and implemented.
+   */
+  apiSelectionHash?: string
+  /**
+   * The selected options.
+   */
+  selection: {
+    appLanguage?: `TypeScript`
+      | `JavaScript`
+      | `Dart`
+      | `Other`
+    appPackageManager?: `NPM`
+      | `Yarn`
+      | `Other`
+    appRenderer?: `React`
+      | `Vue`
+      | `Angular`
+      | `Flutter`
+      | `Other`
+    appDocs?: `TypeDoc`
+      | `JSDoc`
+      | `Other`
+    appTesting?: `Jest`
+      | `Mocha`
+      | `Other`
+    appLogging?: `Console`
+      | `Loglevel`
+      | `Other`
+    appPlatformSupport?: `Capacitor`
+      | `Cordova`
+      | `React Native`
+      | `Flutter`
+      | `Other`
+    appPlatforms?: Array<
+      `Web`
+      | `Android`
+      | `iOS`
+      | `macOS`
+      | `Windows`
+      | `Linux`
+    >
+    appUi?: `Styled Components`
+      | `Ionic`
+      | `Tailwind`
+      | `Other`
+    appThemes?: Array<
+      `Light`
+      | `Dark`
+      | `Other`
+    >
+    userAuthentication?: Array<
+      `Typical`
+      | `OAuth`
+      | `WebAuthn`
+      | `Other`
+    >
+    oauthServers?: Array<
+      `Google`
+      | `Twitter`
+      | `GitHub`
+      | `GitLab`
+      | `Other`
+    >
+    pushNotifications?: `Enabled`
+      | `Disabled`
+    paymentPlatforms?: Array<
+      `Stripe`
+      | `Apple Pay`
+      | `Google Pay`
+      | `PayPal`
+      | `Other`
+    >
+    appDeployment?: `Netlify`
+      | `Render`
+      | `Digital Ocean`
+      | `Vercel`
+      | `Cloudflare`
+      | `AWS`
+      | `Other`
+    apiLanguage?: `TypeScript`
+      | `JavaScript`
+      | `Python`
+      | `Go`
+      | `Other`
+    apiPackageManager?: `NPM`
+      | `Yarn`
+      | `Other`
+    apiDocs?: `TypeDoc`
+      | `JSDoc`
+      | `Other`
+    apiTesting?: `Jest`
+      | `Mocha`
+      | `Other`
+    apiLogging?: `Console`
+      | `Loglevel`
+      | `Winston`
+      | `Other`
+    apiDatabase?: `PostgreSQL`
+      | `SQLite`
+      | `Firebase`
+      | `MongoDB`
+      | `Other`
+    apiEmails?: `Sendmail`
+      | `Mailgun`
+      | `SendGrid`
+      | `SES`
+      | `Other`
+    apiUploads?: `S3`
+      | `File System`
+      | `Other`
+    apiDeployment?: `Heroku`
+      | `Render`
+      | `Digital Ocean`
+      | `AWS`
+      | `Other`
+  }
+  /**
+   * Other custom options requested by the customer.
+   */
+  other: {
+    appLanguage?: string
+    appPackageManager?: string
+    appRenderer?: string
+    appDocs?: string
+    appTesting?: string
+    appLogging?: string
+    appPlatformSupport?: string
+    appPlatforms?: string
+    appUi?: string
+    appThemes?: string
+    userAuthentication?: string
+    oauthServers?: string
+    pushNotifications?: string
+    paymentPlatforms?: string
+    appDeployment?: string
+    apiLanguage?: string
+    apiPackageManager?: string
+    apiDocs?: string
+    apiTesting?: string
+    apiLogging?: string
+    apiDatabase?: string
+    apiEmails?: string
+    apiUploads?: string
+    apiDeployment?: string
+    additionalInfo?: string
+    questions?: string
+    discountCode?: string
+  }
+  /**
+   * The plan the user has selected for the molecule.
+   */
+  plan?: `Free Trial`
+    | `Subscription`
+    | `Single Use`
+    | `Unlimited Use`
+    | `Business`
+  /**
+   * The molecule's current plan as a key of the `plans` object.
+   */
+  planKey?: PlanKey
+  /**
+   * When the plan expires.
+   * 
+   * Usually an ISO 8061 timestamp.
+   */
+  planExpiresAt?: string
+  /**
+   * True if the plan will automatically renew.
+   */
+  planAutoRenews?: boolean
+  /**
+   * The checkout URL through which the user can subscribe or buy a license.
+   */
+  checkoutUrl?: string
+  /**
+   * The number of emails sent through the molecule within the last 24 hours.
+   */
+  emailCount?: number
+  /**
+   * The time at which the email count was last reset to 0.
+   */
+  emailCountResetAt?: string
+}
+
+/**
+ * The properties when creating a molecule. 
+ */
+export interface CreateProps {
+  selection: Props['selection']
+  other: Props['other']
+  plan: Props['plan']
+  quantity?: number | string
+  name?: string
+}
+
+/**
+ * The properties when updating a molecule.
+ */
+export type UpdateProps = Pick<Props,
+  `name`
+>
+
+/**
+ * The properties when updating the molecule's plan.
+ */
+ export interface UpdatePlanProps {
+  planKey: PlanKey
+  receipt?: string
+  quantity?: number
+}
+
+/**
+ * The successful molecule resource response returning either partial props or a checkout URL.
+ */
+export type UpdatePlanResponse<Props = MoleculeProps> = {
+  /**
+   * HTTP status code.
+   */
+  statusCode: 200 | 201
+  /**
+   * The response body.
+   */
+  data: {
+    /**
+     * Response data will contain updated `props` if the molecule's plan was updated. 
+     */
+    props?: Partial<Props>
+    /**
+     * Response data will contain a `checkoutUrl` if the user should be redirected to a URL to complete checkout.
+     */
+    checkoutUrl?: string
+  }
+}
+
+/**
+ * A response containing the necessary information to clone the Molecule.
+ */
+export type CloneResponse = {
+  /**
+   * HTTP status code.
+   */
+  statusCode: 200
+  /**
+   * The response body.
+   */
+  data: {
+    /**
+     * The Molecule's props.
+     */
+    props: Props
+    /**
+     * Response data will contain `apiRepoUrl` if the selection is relevant to the Molecule's API.
+     */
+    apiRepoUrl?: string
+    /**
+     * Response data will contain an array of commit hashes if the Molecule's API selection does not yet exist in our repositories.
+     */
+    apiCommits?: Array<Commit>
+    /**
+     * Response data will contain `appRepoUrl` if the selection is relevant to the Molecule's API.
+     */
+    appRepoUrl?: string
+    /**
+     * Response data will contain an array of commit hashes if the Molecule's API selection does not yet exist in our repositories.
+     */
+    appCommits?: Array<Commit>
+  }
+}
+
+/**
+ * The successful molecule resource response.
+ */
+export type SuccessResponse<Props = MoleculeProps> = resourceTypes.SuccessResponse<Props>
+
+/**
+ * The successful molecule resource response returning partial props.
+ */
+export type SuccessPartialResponse<Props = MoleculeProps> = resourceTypes.SuccessPartialResponse<Props>
+
+/**
+ * The response when querying molecules.
+ */
+export type QueryResponse<Props = MoleculeProps> = resourceTypes.QueryResponse<Props>
+
+/**
+ * Generic response with an optional body.
+ */
+export type GenericResponse = resourceTypes.GenericResponse
+
+/**
+ * The response containing a molecule.
+ */
+export type MessageResponse = resourceTypes.MessageResponse
+
+/**
+ * The response when an error has occurred when handling a molecule resource request.
+ */
+export type ErrorResponse = resourceTypes.ErrorResponse

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * Molecule resource utilities.
+ * 
+ * @module
+ */
+
+export * from './getPlan.js'

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

@@ -0,0 +1,12 @@
+/**
+ * The `payment` resource properties.
+ * 
+ * @module
+ */
+
+export * as platforms from './platforms/index.js'
+
+export * from './plans.js'
+export * from './platform.js'
+
+export * as types from './types.js'

package/src/API/resource/payment/plans.ts

@@ -0,0 +1,32 @@
+import * as platforms from './platforms/index.js'
+import * as types from './types.js'
+
+const defaultPlan: types.Plan = { // No plan AKA free plan.
+  planKey: ``,
+  platformKey: ``,
+  platformProductId: ``,
+  alias: ``,
+  period: ``,
+  price: ``,
+  title: `Free`,
+  description: `Certain features are limited. Upgrade your plan to unlock premium features.`,
+  shortDescription: `Limited features and usage.`,
+  capabilities: {
+  },
+}
+
+/**
+ * A map of every available `planKey` to `plan`.
+ *
+ * Every plan key for every platform should be unique.
+ * E.g., `appleMonthly` and `appleYearly` vs `googleMonthly` and `googleYearly`.
+ *
+ * You'll need to customize the `Plan` type, adding properties and logic surrounding it
+ * as necessary for your particular application.
+ */
+export const plans = {
+  '': defaultPlan,
+  ...platforms.stripe.plans,
+  ...platforms.google.plans,
+  ...platforms.apple.plans,
+}

package/src/API/resource/payment/platform.ts

@@ -0,0 +1,11 @@
+import * as platforms from './platforms/index.js'
+import * as types from './types.js'
+
+/**
+ * The payment platform for the current app platform.
+ */
+export const platform = Object.values<types.Platform>(platforms).find(platform => (
+  Array.isArray(platform.appPlatforms)
+    ? platform.appPlatforms.includes(process.env.APP_PLATFORM || undefined)
+    : (platform.appPlatforms || undefined) === (process.env.APP_PLATFORM || undefined)
+))

package/src/API/resource/payment/platforms/apple/index.ts

@@ -0,0 +1,25 @@
+/**
+ * Properties and methods for handling payments through Apple.
+ *
+ * @module
+ */
+
+import * as plans from './plans/index.js'
+import * as types from '../../types.js'
+
+/**
+ * The Apple Pay payment platform.
+ */
+export const apple: types.Platform<typeof plans> = {
+  /**
+   * An array of app platforms compatible with Apple Pay.
+   */
+  appPlatforms: [
+    `ios`,
+  ],
+
+  /**
+   * A map of Apple plan keys to plan properties.
+   */
+  plans,
+}

package/src/API/resource/payment/platforms/apple/plans/appleMonthly.ts

@@ -0,0 +1,19 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The monthly Apple Pay plan.
+ */
+export const appleMonthly: Plan = {
+  planKey: `appleMonthly`,
+  platformKey: `apple`,
+  platformProductId: `molecule_monthly_early_adopter`,
+  alias: `monthly`,
+  period: `month`,
+  price: `$5.99`,
+  autoRenews: true,
+  title: `Monthly`,
+  description: `Create and view attachments.`,
+  capabilities: {
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/apple/plans/appleYearly.ts

@@ -0,0 +1,20 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The yearly Apple Pay plan.
+ */
+export const appleYearly: Plan = {
+  planKey: `appleYearly`,
+  platformKey: `apple`,
+  platformProductId: `molecule_yearly_early_adopter`,
+  alias: `yearly`,
+  period: `year`,
+  price: `$64.99`,
+  autoRenews: true,
+  title: `Yearly`,
+  description: `Create and view attachments.`,
+  highlightedDescription: `Get one month free, every year.`,
+  capabilities: {
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/apple/plans/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Every available Apple Pay plan.
+ *
+ * @module
+ */
+
+export {}
+export * from './appleMonthly.js'
+export * from './appleYearly.js'

package/src/API/resource/payment/platforms/google/index.ts

@@ -0,0 +1,25 @@
+/**
+ * Properties and methods for handling payments through Google.
+ * 
+ * @module
+ */
+
+import * as plans from './plans/index.js'
+import * as types from '../../types.js'
+
+/**
+ * The Google Pay payment platform.
+ */
+export const google: types.Platform<typeof plans> = {
+  /**
+   * An array of app platforms compatible with Google Pay.
+   */
+  appPlatforms: [
+    `android`,
+  ],
+
+  /**
+   * A map of Google plan keys to plan properties.
+   */
+  plans,
+}

package/src/API/resource/payment/platforms/google/plans/googleMonthly.ts

@@ -0,0 +1,19 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The monthly Google Pay plan.
+ */
+export const googleMonthly: Plan = {
+  planKey: `googleMonthly`,
+  platformKey: `google`,
+  platformProductId: `monthly_early_adopter`,
+  alias: `monthly`,
+  period: `month`,
+  price: `$5.99`,
+  autoRenews: true,
+  title: `Monthly`,
+  description: `Create and view attachments.`,
+  capabilities: {
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/google/plans/googleYearly.ts

@@ -0,0 +1,20 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The yearly Google Pay plan.
+ */
+export const googleYearly: Plan = {
+  planKey: `googleYearly`,
+  platformKey: `google`,
+  platformProductId: `yearly_early_adopter`,
+  alias: `yearly`,
+  period: `year`,
+  price: `$64.99`,
+  autoRenews: true,
+  title: `Yearly`,
+  description: `Create and view attachments.`,
+  highlightedDescription: `Get one month free, every year.`,
+  capabilities: {
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/google/plans/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Every available Google Pay plan.
+ *
+ * @module
+ */
+
+export {}
+export * from './googleMonthly.js'
+export * from './googleYearly.js'