stacks 0.56.24 → 0.58.18

package/core/src/types/src/api.ts

@@ -0,0 +1,63 @@
+/**
+ * **API Options**
+ *
+ * This configuration defines all of your API options. Because Stacks is fully-typed, you
+ * may hover any of the options below and the definitions will be provided. In case you
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export interface ApiOptions {
+  /**
+   * **API Description**
+   *
+   * This value defines the description for your API.
+   *
+   * @default "Stacks API"
+   */
+  description: string
+
+  /**
+   * **API Prefix**
+   *
+   * This value defines the prefix for all of your API routes. For example, if you set
+   * this value to `api`, all of your API routes will be prefixed with `/api`. This
+   * value is useful for when you want to version your API.
+   *
+   * @default string "api"
+   * @example string "api/v1"
+   */
+  prefix: string
+
+  /**
+   * **API Prewarm**
+   *
+   * This configuration determines the prewarming behavior of your API. Prewarming eliminates
+   * cold starts in your API. If this value is set to `true`, the API will be prewarmed
+   * every 5 minutes. If you provide a number, Stacks will prewarm the
+   * specified number of containers every 5 minutes.
+   *
+   * @default true
+   * @example false
+   * @example 10
+   */
+  prewarm: boolean | number
+
+  /**
+   * **API Memory Size**
+   *
+   * This value defines the memory size for your API.
+   *
+   * @default 512
+   */
+  memorySize: number
+
+  /**
+   * **API Timeout**
+   *
+   * This value defines the timeout for your API.
+   *
+   * @default 30
+   */
+  timeout: number
+}
+
+export type ApiConfig = Partial<ApiOptions>

package/core/src/types/src/app.ts

@@ -0,0 +1,172 @@
+export type AppEnvType = 'production' | 'development' | 'staging' | 'local' | 'stage' | 'dev' | 'prod'
+
+interface Ports {
+  frontend: number
+  backend: number // proxies api
+  api: number // the Bun server
+  admin: number
+  library: number
+  desktop: number
+  email: number
+  docs: number
+  inspect: number
+}
+
+/**
+ * **Application Options**
+ *
+ * This configuration defines all of your application options. Because Stacks is fully-typed,
+ * you may hover any of the options below and the definitions will be provided. In case
+ * you have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export interface AppOptions {
+  /**
+   * **Application Name**
+   *
+   * This value is the name of your application. This value is used when the
+   * framework needs to place the application's name in a log or any
+   * other location as required by the application or its packages.
+   *
+   * @default string "Stacks"
+   */
+  name: string
+
+  /**
+   * **Application Description**
+   *
+   * This value is the description of your application. This value is used when the
+   * framework generates meta tags for the frontend.
+   */
+  description: string
+
+  /**
+   * **Application Environment**
+   *
+   * This value determines the "environment" your application is currently
+   * running in. This may determine how you prefer to configure various
+   * services the application utilizes. Set this in your ".env" file
+   *
+   * @default "development"
+   */
+  env: AppEnvType
+
+  /**
+   * **Application URL**
+   *
+   * This URL is used by the console to properly generate URLs when using
+   * the Buddy command line tool. You should set this to the root of
+   * your application so that it is used when running Buddy tasks.
+   *
+   * @default string "stacks.localhost"
+   * @example "my-project.test"
+   */
+  url: string
+
+  /**
+   * **Redirect URLs**
+   *
+   * A Redirect URL is a URL that permanently redirects to the Application URL.
+   * This is useful for when you have multiple domains that you want to redirect
+   * to your application. You can set this to a string or an array of strings.
+   *
+   * @default []
+   * @example "['stacksjs.com', 'stacksjs.dev']"
+   */
+  redirectUrls: string | string[]
+
+  /**
+   * **Application Debug Mode**
+   *
+   * When your application is in debug mode, detailed error messages with
+   * stack traces will be shown on every error that occurs within your
+   * application. If disabled, a simple generic error page is shown.
+   *
+   * @default true
+   */
+  debug: boolean
+
+  /**
+   * **Maintenance Mode**
+   *
+   * When your application is in maintenance mode, a simple maintenance
+   * page will be shown on every request into your application.
+   *
+   * @default false
+   */
+  maintenanceMode: boolean
+
+  /**
+   * **Encryption Key**
+   *
+   * This key is used by the Stacks encrypter service and should be set to
+   * a random, 32 character string, otherwise these encrypted strings will
+   * not be safe. Please do this before deploying an application!
+   */
+  key: string
+
+  /**
+   * **Application Ports**
+   *
+   * This port is used by the Stacks servers when running your application, library, email services,
+   * and other services. You may change this port to any other port that is free
+   * on your machine, as long as the following 6 ports are also available.
+   */
+  ports: Ports
+
+  /**
+   * **Application Timezone**
+   *
+   * Here you may specify the default timezone for your application, which
+   * will be used by Stacks and date-time functions. We have gone ahead
+   * and set this to a sensible default for you out of the box.
+   *
+   * @default string "UTC"
+   */
+  timezone: string
+
+  /**
+   * **Application Locale Configuration**
+   *
+   * The application locale determines the default locale that will be used
+   * by the translation service provider. You are free to set this value
+   * to any of the locales which will be supported by the application.
+   *
+   * @default string "en"
+   * @example
+   * de // ./lang/de.yml needs to be present for this
+   */
+  locale: string
+
+  /**
+   * **Application Fallback Locale**
+   *
+   * The fallback locale determines the locale to use when the current one
+   * is not available. You may change the value to correspond to any of
+   * the language folders that are provided through your application.
+   *
+   * @default string "en"
+   */
+  fallbackLocale: 'en'
+
+  /**
+   * **Cipher**
+   *
+   * Description WIP.
+   *
+   * @default string "aes-256-cbc"
+   */
+  cipher: string
+
+  // inspect: <InspectOptions>{},
+
+  /**
+   * **Documentation Mode**
+   *
+   * $appUrl becomes your Documentation URL.
+   *
+   * @default false
+   */
+  docMode: boolean
+}
+
+export type AppConfig = Partial<AppOptions>

package/core/src/types/src/binary.ts

@@ -0,0 +1,12 @@
+/**
+ * The Binary/CLI Options used in `./config/cli.ts`.
+ */
+export interface BinaryOptions {
+  name: string
+  command: string
+  description: string
+  source: string
+  // path: string // TODO: add this for a configurable path where the commands are located
+}
+
+export type BinaryConfig = Partial<BinaryOptions>

package/core/src/types/src/cache.ts

@@ -0,0 +1,98 @@
+export interface CacheOptions {
+  /**
+   * **Cache Driver**
+   *
+   * This value determines the cache driver that will be used by your application to store
+   * cached data. By default, Stacks uses the "redis" driver, which stores cached data in
+   * in a self-configufed Redis instance. You may use any of the other drivers provided
+   * by Stacks or write your own custom driver.
+   *
+   * @default "redis"
+   * @example "redis"
+   * @example "memcached"
+   * @example "dynamodb"
+   *
+   * @see https://stacks.js.org/docs/cache
+   */
+  driver: string
+
+  /**
+   * **Cache Prefix**
+   *
+   * This value determines the prefix that will be used when storing items in the cache. This
+   * prefix may be useful when multiple applications are sharing the same cache driver so that
+   * they may avoid collisions when attempting to retrieve items from the cache.
+   *
+   * @default string "stacks"
+   * @example "stacks"
+   *
+   * @see https://stacks.js.org/docs/cache
+   */
+  prefix: string
+
+  /**
+   * **Cache TTL**
+   *
+   * This value determines the default time to live for items stored in the cache. This value
+   * may be overridden when storing items in the cache. If no value is specified, the cache
+   * driver will default to a reasonable time to live for the given item.
+   *
+   * @default number 3600
+   * @example 3600
+   * @example 3600 * 24
+   * @example -1 (never expires)
+   */
+  ttl: number
+
+  drivers: {
+    redis?: {
+      connection: string
+
+      /**
+       * **Redis Host**
+       *
+       * This value determines the host that will be used to connect to the Redis server.
+       *
+       * @default string "localhost"
+       * @example "localhost"
+       */
+      host: string
+
+      /**
+       * **Redis Port**
+       *
+       * This value determines the port that will be used to connect to the Redis server.
+       *
+       * @default number 6379
+       * @example 6379
+       */
+      port: number
+
+      /**
+       * **Redis Username**
+       *
+       * This value determines the username that will be used to connect to the Redis server.
+       *
+       * @default string ""
+       * @example "admin"
+       */
+      username: string
+
+      /**
+       * **Redis Password**
+       *
+       * This value determines the password that will be used to connect to the Redis server.
+       *
+       * @default string ""
+       * @example "password"
+       */
+      password: string
+    }
+
+    memcached?: object
+
+    dynamodb?: object
+  }
+}
+
+export type CacheConfig = Partial<CacheOptions>

package/core/src/types/src/cdn.ts

@@ -0,0 +1,17 @@
+export interface CdnOptions {
+  /**
+   * **CDN Driver**
+   *
+   * This value determines the default CDN driver that will be used when interacting with the
+   * CDN service. This value may be overridden when interacting with the CDN service.
+   *
+   * @default "cloudfront"
+   * @example "cloudfront"
+   * @example "fastly" wip
+   *
+   * @see https://stacks.js.org/docs/cdn
+   */
+  driver: string
+}
+
+export type CdnConfig = Partial<CdnOptions>

package/core/src/types/src/chat.ts

@@ -0,0 +1,5 @@
+import type { IChatOptions as ChatOptions } from '@novu/stateless'
+
+export type { ChatOptions }
+
+export type ChatConfig = ChatOptions

package/core/src/types/src/cli.ts

@@ -0,0 +1,305 @@
+import type { BunFile } from 'bun'
+
+type ArrayBufferView = TypedArray | DataView
+
+export type { Subprocess, SyncSubprocess } from 'bun'
+export type Readable =
+  | 'pipe'
+  | 'inherit'
+  | 'ignore'
+  | null // equivalent to 'ignore'
+  | undefined // to use default
+  | BunFile
+  | ArrayBufferView
+  | number
+
+export type Writable =
+  | 'pipe'
+  | 'inherit'
+  | 'ignore'
+  | null // equivalent to 'ignore'
+  | undefined // to use default
+  | BunFile
+  | ArrayBufferView
+  | number
+  | ReadableStream
+  | Blob
+  | Response
+  | Request
+
+export type In = Readable
+export type Out = Writable
+export type Err = Writable
+
+/**
+ * The file descriptor for the standard input. It may be:
+ *
+ * - `"ignore"`, `null`, `undefined`: The process will have no standard input
+ * - `"pipe"`: The process will have a new {@link FileSink} for standard input
+ * - `"inherit"`: The process will inherit the standard input of the current process
+ * - `ArrayBufferView`, `Blob`: The process will read from the buffer
+ * - `number`: The process will read from the file descriptor
+ *
+ * @default "ignore"
+ */
+export type stdin = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number | null | undefined
+
+/**
+ * The file descriptor for the standard output. It may be:
+ *
+ * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+ * - `"ignore"`, `null`: The process will have no standard output/error
+ * - `"inherit"`: The process will inherit the standard output/error of the current process
+ * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
+ * - `number`: The process will write to the file descriptor
+ *
+ * @default "pipe"
+ */
+export type stdout = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number
+
+/**
+ * The file descriptor for the standard error. It may be:
+ *
+ * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+ * - `"ignore"`, `null`: The process will have no standard output/error
+ * - `"inherit"`: The process will inherit the standard output/error of the current process
+ * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
+ * - `number`: The process will write to the file descriptor
+ *
+ * @default "inherit" for `spawn`
+ * "pipe" for `spawnSync`
+ */
+export type stderr = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number
+
+export interface OutroOptions extends CliOptions {
+  type?: 'success' | 'error' | 'warning' | 'info'
+  startTime?: number
+  useSeconds?: boolean
+  quiet?: boolean
+  message?: string
+}
+
+export interface IntroOptions {
+  /**
+   * @default true
+   */
+  showPerformance?: boolean
+
+  /**
+   * @default false
+   */
+  quiet: boolean
+}
+
+// type SpinnerOptions = Ora
+
+export type CliOptionsKeys = keyof CliOptions
+
+/**
+ * The options to pass to the CLI.
+ */
+export interface CliOptions {
+  /**
+   * **Verbose Output**
+   *
+   * When your application is in "verbose"-mode, a different level of,
+   * information like useful outputs for debugging reasons, will be
+   * shown. When disabled, it defaults to the "normal experience."
+   *
+   * @default false
+   */
+  verbose?: boolean
+
+  /**
+   * **Silent Mode**
+   *
+   * When you are using "silent"-mode, the CLI will not output anything
+   * to the console. This is useful when you want to run the CLI in
+   * the background.
+   *
+   * @default false
+   */
+  silent?: boolean
+
+  /**
+   * **Current Work Directory**
+   *
+   * Based on the `cwd` value, that's where the command...
+   *
+   * @default projectPath()
+   */
+  cwd?: string
+
+  /**
+   * @default 'pipe'
+   */
+  stdin?: stdin
+
+  /**
+   * @default 'pipe'
+   */
+  stdout?: stdout
+
+  /**
+   * @default 'inherit'
+   */
+  stderr?: stderr
+
+  env?: Record<string, string | undefined>
+
+  /**
+   * Runs the action in interactive/detached mode.
+   * @default false
+   */
+  background?: boolean
+
+  startTime?: number
+
+  /**
+   * Include the localhost URL in the output.
+   * @default false
+   */
+  withLocalhost?: boolean
+}
+
+export type CliConfig = CliOptions
+
+// export type { Ora as SpinnerOptions } from 'ora'
+
+// the `domains` option is only available for the `deploy` command
+// the `count` option is only available for the `seed` command
+export type ActionOption = 'types' | 'domains' | 'count'
+
+/**
+ * The options to pass to the Action.
+ */
+export type ActionOptions = {
+  'types'?: boolean
+  'domains'?: boolean
+  'count'?: number
+} & CliOptions & DomainsOptions
+
+export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'pages' | 'stacks' | 'all'
+export type BuildOptions = {
+  [key in BuildOption]: boolean;
+} & CliOptions
+
+export type AddOption = 'table' | 'calendar' | 'all'
+export type AddOptions = {
+  [key in AddOption]?: boolean;
+} & CliOptions
+
+export type CreateStringOption = 'name'
+export type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'pages' | 'functions' | 'api' | 'database'
+export type CreateOptions = {
+  [key in CreateBooleanOption]: boolean
+} & {
+  [key in CreateStringOption]: string
+} & CliOptions
+
+export type DevOption = 'components' | 'docs' | 'frontend' | 'api' | 'desktop' | 'all' | 'email' | 'interactive' | 'verbose'
+export type DevOptions = {
+  [key in DevOption]: boolean;
+} & CliOptions
+
+export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'vueCompatibility' | 'componentMeta'
+export type GeneratorOptions = {
+  [key in GeneratorOption]?: boolean;
+} & CliOptions
+
+export type LintOption = 'fix'
+export type LintOptions = {
+  [key in LintOption]: boolean;
+} & CliOptions
+
+export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env'
+export type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'model' | 'notification' | 'stack'
+export type MakeOptions = {
+  [key in MakeBooleanOption]: boolean
+} & {
+  [key in MakeStringOption]: string
+} & CliOptions
+
+export type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force'
+export type UpgradeString = 'version'
+
+export type UpgradeOptions = {
+  [key in UpgradeBoolean]: boolean;
+} & {
+  [key in UpgradeString]: string;
+} & CliOptions
+
+export type ExamplesString = 'version'
+export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force'
+export type ExamplesOption = ExamplesString & ExamplesBoolean | void
+export type ExamplesOptions = {
+  [key in ExamplesString]: string;
+} & {
+  [key in ExamplesBoolean]: boolean;
+} & CliOptions
+export type TestOptions = CliOptions & {
+  showReport?: boolean
+}
+export type DomainsOptions = CliOptions & {
+  domain?: string
+  yes?: boolean
+  years?: number
+  privacy?: boolean
+  autoRenew?: boolean
+  registrantFirstName?: string
+  registrantLastName?: string
+  registrantOrganization?: string
+  registrantAddress?: string
+  registrantCity?: string
+  registrantState?: string
+  registrantCountry?: string
+  registrantZip?: string
+  registrantPhone?: string
+  registrantEmail?: string
+  adminFirstName?: string
+  adminLastName?: string
+  adminOrganization?: string
+  adminAddress?: string
+  adminCity?: string
+  adminState?: string
+  adminCountry?: string
+  adminZip?: string
+  adminPhone?: string
+  adminEmail?: string
+  techFirstName?: string
+  techLastName?: string
+  techOrganization?: string
+  techAddress?: string
+  techCity?: string
+  techState?: string
+  techCountry?: string
+  techZip?: string
+  techPhone?: string
+  techEmail?: string
+  privacyAdmin?: boolean
+  privacyTech?: boolean
+  privacyRegistrant?: boolean
+  contactType?: string
+}
+
+export interface CleanOptions extends CliOptions { }
+export interface CloudCliOptions extends CliOptions {
+  ssh?: boolean
+  connect?: boolean
+  jumpBox?: boolean
+}
+export interface CommitOptions extends CliOptions { }
+export interface KeyOptions extends CliOptions { }
+export interface FreshOptions extends CliOptions { }
+export interface MigrateOptions extends CliOptions { }
+export interface InspireOptions extends CliOptions { }
+export interface InstallOptions extends CliOptions { }
+export interface ReleaseOptions extends CliOptions { }
+export interface PreinstallOptions extends CliOptions { }
+export interface PrepublishOptions extends CliOptions { }
+export interface TinkerOptions extends CliOptions { }
+export interface TypesOptions extends CliOptions { }
+
+export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all'
+
+export type { CAC as CLI } from 'cac'