@stacksjs/types 0.58.48 → 0.58.50

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.58.48",
+  "version": "0.58.50",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -36,7 +36,8 @@
   ],
   "files": [
     "README.md",
-    "dist"
+    "dist",
+    "src"
   ],
   "scripts": {
     "build": "bun --bun build.ts",
@@ -61,7 +62,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/markdown-it-link-attributes": "^3.0.4",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^20.11.13",
+    "@types/node": "^20.11.16",
     "@types/nprogress": "^0.2.3",
     "@vinejs/vine": "^1.7.1",
     "cac": "^6.7.14",
@@ -76,11 +77,11 @@
     "vite-plugin-inspect": "^0.8.3",
     "vite-plugin-pwa": "^0.17.5",
     "vite-ssg": "^0.23.6",
-    "vitepress": "1.0.0-rc.40",
+    "vitepress": "1.0.0-rc.41",
     "vue": "^3.4.15"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.124.0",
+    "aws-cdk-lib": "^2.126.0",
     "typescript": "^5.3.3"
   }
 }

package/src/ai.ts

@@ -0,0 +1,25 @@
+type AiModel = 'amazon.titan-embed-text-v1'
+  | 'amazon.titan-text-lite-v1'
+  | 'amazon.titan-text-express-v1'
+  | 'amazon.titan-embed-image-v1'
+  | 'amazon.titan-image-generator-v1'
+  | 'anthropic.claude-v1'
+  | 'anthropic.claude-v2'
+  | 'anthropic.claude-v2:1'
+  | 'anthropic.claude-instant-v1'
+  | 'meta.llama2-13b-chat-v1'
+  | 'meta.llama2-70b-chat-v1'
+
+/**
+ * **AI Options**
+ *
+ * This configuration defines all of your AI 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 AiOptions {
+  default: AiModel
+  models: AiModel[]
+}
+
+export type AiConfig = Partial<AiOptions>

package/src/analytics.ts

@@ -0,0 +1,21 @@
+/**
+ * **Analytics Options**
+ *
+ * This configuration defines all of your Analytics 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 AnalyticsOptions {
+  driver: 'google-analytics' | 'fathom'
+
+  drivers: {
+    googleAnalytics?: {
+      trackingId: string
+    }
+    fathom?: {
+      siteId: string
+    }
+  }
+}
+
+export type AnalyticsConfig = Partial<AnalyticsOptions>

package/src/api.ts

@@ -0,0 +1,65 @@
+/**
+ * **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
+
+  deploy: boolean
+}
+
+export type ApiConfig = Partial<ApiOptions>

package/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/src/auto-imports.ts

@@ -0,0 +1 @@
+export type { Options as AutoImportsOptions } from 'unplugin-auto-import/types'

package/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/src/build.ts

@@ -0,0 +1,2 @@
+export type { UserConfig as ViteConfig } from 'vite'
+export type { ViteSSGContext } from 'vite-ssg'

package/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/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/src/chat.ts

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