mlcl 1.0.0

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

@@ -0,0 +1,10 @@
+/**
+ * All available payment platforms.
+ *
+ * @module
+ */
+
+export {}
+export * from './stripe/index.js'
+export * from './google/index.js'
+export * from './apple/index.js'

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * Every available Stripe plan.
+ * 
+ * @module
+ */
+
+export * from './stripeBusinessMolecule.js'
+export * from './stripeMonthly.js'
+export * from './stripeMonthlyMolecule.js'
+export * from './stripeSingleUseMolecule.js'
+export * from './stripeUnlimitedUseMolecule.js'
+export * from './stripeYearly.js'

package/src/API/resource/payment/platforms/stripe/plans/stripeBusinessMolecule.ts

@@ -0,0 +1,23 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The business Stripe plan for molecules.
+ */
+export const stripeBusinessMolecule: Plan = {
+  planKey: `stripeBusinessMolecule`,
+  platformKey: `stripe`,
+  platformProductId: ``,
+  alias: `businessMolecule`,
+  period: ``,
+  price: `$449`,
+  allowMultiple: true,
+  minimumQuantity: 10,
+  autoRenews: false,
+  title: `Business Molecule`,
+  description: `Includes all of the core functionality available for full-stack applications.`,
+  capabilities: {
+    forMolecules: true,
+    premium: true,
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/stripe/plans/stripeMonthly.ts

@@ -0,0 +1,20 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The monthly Stripe plan.
+ */
+export const stripeMonthly: Plan = {
+  planKey: `stripeMonthly`,
+  platformKey: `stripe`,
+  platformProductId: ``,
+  alias: `monthly`,
+  period: `month`,
+  price: `$5`,
+  autoRenews: true,
+  title: `Monthly`,
+  description: `Create and view attachments.`,
+  capabilities: {
+    forUsers: true,
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/stripe/plans/stripeMonthlyMolecule.ts

@@ -0,0 +1,20 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The monthly Stripe plan for molecules.
+ */
+export const stripeMonthlyMolecule: Plan = {
+  planKey: `stripeMonthlyMolecule`,
+  platformKey: `stripe`,
+  platformProductId: ``,
+  alias: `monthlyMolecule`,
+  period: `month`,
+  price: `$19`,
+  autoRenews: true,
+  title: `Monthly Molecule`,
+  description: `Includes all of the core functionality you've selected for your full-stack application.`,
+  capabilities: {
+    forMolecules: true,
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/stripe/plans/stripeSingleUseMolecule.ts

@@ -0,0 +1,21 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The single use Stripe plan for molecules.
+ */
+export const stripeSingleUseMolecule: Plan = {
+  planKey: `stripeSingleUseMolecule`,
+  platformKey: `stripe`,
+  platformProductId: ``,
+  alias: `singleUseMolecule`,
+  period: ``,
+  price: `$499`,
+  autoRenews: false,
+  title: `Single Use Molecule`,
+  description: `Includes all of the core functionality you've selected for your full-stack application.`,
+  capabilities: {
+    forMolecules: true,
+    premium: true,
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/stripe/plans/stripeUnlimitedUseMolecule.ts

@@ -0,0 +1,21 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The unlimited use Stripe plan for molecules.
+ */
+export const stripeUnlimitedUseMolecule: Plan = {
+  planKey: `stripeUnlimitedUseMolecule`,
+  platformKey: `stripe`,
+  platformProductId: ``,
+  alias: `unlimitedUseMolecule`,
+  period: ``,
+  price: `$1499`,
+  autoRenews: false,
+  title: `Unlimited Use Molecule`,
+  description: `Includes all of the core functionality you've selected for your full-stack application.`,
+  capabilities: {
+    forMolecules: true,
+    premium: true,
+    attachments: true,
+  }
+}

package/src/API/resource/payment/platforms/stripe/plans/stripeYearly.ts

@@ -0,0 +1,21 @@
+import { Plan } from '../../../types.js'
+
+/**
+ * The yearly Stripe plan.
+ */
+export const stripeYearly: Plan = {
+  planKey: `stripeYearly`,
+  platformKey: `stripe`,
+  platformProductId: ``,
+  alias: `yearly`,
+  period: `year`,
+  price: `$55`,
+  autoRenews: true,
+  title: `Yearly`,
+  description: `Create and view attachments.`,
+  highlightedDescription: `Get one month free, every year.`,
+  capabilities: {
+    forUsers: true,
+    attachments: true,
+  }
+}

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

@@ -0,0 +1,201 @@
+/**
+ * Payment type definitions.
+ * 
+ * @module
+ */
+
+import * as resourceTypes from '../types'
+import * as platforms from './platforms'
+
+/**
+ * Every available platform.
+ */
+export type PlatformKey = `` | keyof typeof platforms
+
+/**
+ * Every available plan key.
+ */
+export type PlanKey = ``
+  | keyof typeof platforms.stripe.plans
+  | keyof typeof platforms.apple.plans
+  | keyof typeof platforms.google.plans
+
+/**
+ * Every available plan alias.
+ */
+export type PlanAlias = ``
+  | `monthly`
+  | `yearly`
+  | `monthlyMolecule`
+  | `singleUseMolecule`
+  | `unlimitedUseMolecule`
+  | `businessMolecule`
+
+/**
+ * Every available plan period.
+ */
+export type PlanPeriod = ``
+  | `month`
+  | `year`
+
+/**
+ * Available platforms.
+ */
+export type PlanPlatform = `` | `stripe` | `apple` | `google`
+
+/**
+ * Map of all available plans by unique keys.
+ */
+export type Plans = { [planKey in PlanKey]: Plan }
+
+/**
+ * Map of plan aliases to available plans, which may vary depending on platform and/or user.
+ */
+export type PlansByAlias = { [alias in PlanAlias]?: Plan }
+
+/**
+ * The payment's properties to be stored in the database.
+ */
+export interface Props extends resourceTypes.Props {
+  /**
+   * The payment owner's `userId`.
+   */
+  userId: string
+  /**
+   * The payment's associated `moleculeId`, if any.
+   */
+  moleculeId?: string
+  /**
+   * The platform through which the product was purchased.
+   */
+  platformKey: PlatformKey
+  /**
+   * The transaction ID returned by the platform.
+   */
+  transactionId?: string
+  /**
+   * The purchased product ID.
+   * 
+   * Possibly varies for each platform.
+   */
+  productId: string
+  /**
+   * Information describing things like session IDs, confirmations, purchase dates, renewal dates and expiration dates.
+   * 
+   * Varies for each platform.
+   */
+  data?: JSONObject
+  /**
+   * The `transaction.appStoreReceipt` (from Apple) or the `transaction.purchaseToken` (from Google).
+   */
+  receipt?: string
+}
+
+/**
+ * Properties and methods used for managing purchases for some platform.
+ */
+export interface Platform<Plans extends Record<string, Plan> = Record<string, Plan>> {
+  /**
+   * An array of app platforms the payment platform is compatible with.
+   */
+  appPlatforms?: Array<
+    undefined
+    | `ios`
+    | `android`
+    | `mac`
+    | `windows`
+    | `linux`
+    | `cli`
+  >
+  /**
+   * A map of unique plan keys to plans.
+   */
+  plans: Plans
+}
+
+/**
+ * A plan's properties, used for determining renewals and user restrictions.
+ * 
+ * You will probably need to customize this.
+ */
+ export interface Plan {
+  /**
+   * The unique key used for this plan.
+   */
+  planKey: PlanKey
+  /**
+   * The platform the plan is for.
+   */
+  platformKey: PlatformKey
+  /**
+   * The platform product ID.
+   * 
+   * Likely varies for each platform.
+   */
+  platformProductId: string
+  /**
+   * The plan's alias, typically the same for each platform.
+   */
+  alias: PlanAlias
+  /**
+   * How long the plan will be active.
+   */
+  period: PlanPeriod
+  /**
+   * `true` if the user is still in their free trial period.
+   */
+  inTrialPeriod?: boolean
+  /**
+   * The plan's price as a string with the currency - e.g., '$5'.
+   */
+  price: string
+  /**
+   * `true` if more than one can be purchased at a time.
+   */
+  allowMultiple?: boolean
+  /**
+   * A minimum quantity if more than one can be purchased.
+   */
+  minimumQuantity?: number
+  /**
+   * `true` if the plan will automatically renew.
+   */
+  autoRenews?: boolean
+  /**
+   * The plan title.
+   */
+  title: string
+  /**
+   * The plan description.
+   */
+  description: string
+  /**
+   * An optional short plan description.
+   */
+  shortDescription?: string
+  /**
+   * An optional highlighted bit of text about the plan.
+   */
+  highlightedDescription?: string
+  /**
+   * The features enabled by the plan.
+   */
+  capabilities: {
+    /**
+     * `true` if the plan is for users.
+     */
+    forUsers?: boolean
+    /**
+     * `true` if the plan is for molecules.
+     */
+    forMolecules?: boolean
+    /**
+     * Allows the user to access premium (private) repositories.
+     */
+    premium?: boolean
+    /**
+     * Allows the user to create and view attachments.
+     */
+    attachments?: boolean
+  }
+}

package/src/API/resource/types.ts

@@ -0,0 +1,169 @@
+/**
+ * Resource type definitions.
+ * 
+ * @module
+ */
+
+// Internal reference for easier default type arguments within this module.
+type ResourceProps = Props
+
+/**
+ * The resource's properties.
+ */
+export interface Props {
+  /**
+   * Usually a UUID.
+   */
+  id: string
+  /**
+   * When the resource was created.
+   * 
+   * Usually an ISO 8601 timestamp.
+   */
+  createdAt: string
+  /**
+   * When the resource was last updated.
+   * 
+   * Usually an ISO 8601 timestamp.
+   */
+  updatedAt: string
+}
+
+/**
+ * The successful resource response.
+ */
+export interface SuccessResponse<Props = ResourceProps> {
+  /**
+   * HTTP status code.
+   */
+  statusCode: 200 | 201
+  /**
+   * The response body.
+   */
+  data: {
+    /**
+     * The resource's props.
+     */
+    props: Props
+  }
+}
+
+/**
+ * The successful resource response returning partial props.
+ */
+export interface SuccessPartialResponse<Props = ResourceProps> {
+  /**
+   * HTTP status code.
+   */
+  statusCode: 200 | 201
+  /**
+   * The response body.
+   */
+  data: {
+    /**
+     * The resource's partial props.
+     */
+    props: Partial<Props>
+  }
+}
+
+/**
+ * Options used when querying resources.
+ */
+export interface QueryOptions {
+  /**
+   * Usually derived from a URL like '/messages?before[updatedAt]=2021-01-01T00:00:00.000Z'.
+   */
+  before: {
+    createdAt?: string
+    updatedAt?: string
+  }
+  /**
+   * Usually derived from a URL like '/messages?after[updatedAt]=2021-01-01T00:00:00.000Z'.
+   */
+  after: {
+    createdAt?: string
+    updatedAt?: string
+  }
+  /**
+   * You should limit this to indexed property keys.
+   * 
+   * Usually derived from a URL like '/messages?orderBy=updatedAt'.
+   * 
+   * @default updatedAt
+   */
+  orderBy: `createdAt` | `updatedAt`
+  /**
+   * Usually derived from a URL like '/messages?orderDirection=updatedAt'.
+   * 
+   * @default desc
+   */
+  orderDirection: 'desc' | 'asc'
+  /**
+   * Usually derived from a URL like '/messages?limit=100'.
+   * 
+   * @default 100
+   */
+  limit: number
+}
+
+/**
+ * The response when querying resources.
+ */
+export interface QueryResponse<Props = ResourceProps> {
+  /**
+   * HTTP status code.
+   */
+  statusCode: 200
+  /**
+   * The response body containing the query results.
+   */
+  data: Props[]
+}
+
+/**
+ * Generic response with an optional body.
+ */
+export interface GenericResponse {
+  /**
+   * HTTP status code.
+   */
+  statusCode: number
+  /**
+   * The optional response body.
+   */
+  data?: JSONValue
+}
+
+/**
+ * The response containing a message.
+ */
+export interface MessageResponse {
+  /**
+   * HTTP status code.
+   */
+  statusCode: number
+  /**
+   * The response body.
+   */
+  data: {
+    /**
+     * The message.
+     */
+    message: string
+  }
+}
+
+/**
+ * The response when an error has occurred when handling a resource request.
+ */
+export interface ErrorResponse {
+  /**
+   * HTTP status code.
+   */
+  statusCode: number
+  /**
+   * The response body containing an error message.
+   */
+  data: { error: string }
+}

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

@@ -0,0 +1,29 @@
+/**
+ * The user API resource.
+ * 
+ * @module
+ */
+
+import { client } from '../../client.js'
+import * as authorization from '../../authorization.js'
+import * as types from './types.js'
+
+export * as utilities from './utilities/index.js'
+export * as types from './types.js'
+
+export const logInCLI = ({
+  token,
+  deviceIds,
+  deviceName
+}: types.LogInCLIProps): Promise<types.LogInCLIResponse> => (
+  client.post(`users/log-in/cli`, { token, deviceIds, deviceName })
+)
+
+export const logOut = async (): Promise<null> => {
+  authorization.removeHeader()
+  return null
+}
+
+export const read = (id: string): Promise<types.SuccessResponse> => (
+  client.get(`users/${id}`)
+)