@stacksjs/types 0.66.0 → 0.68.0

package/dist/ai.d.ts

@@ -1,15 +1,18 @@
-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[];
-	deploy: boolean;
+declare 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'
+export declare interface AiOptions {
+  default: AiModel
+  models: AiModel[]
+  deploy: boolean
 }
-export type AiConfig = Partial<AiOptions>;
-export {};
+export declare type AiConfig = Partial<AiOptions>

package/dist/analytics.d.ts

@@ -1,15 +1,13 @@
-/**
-* **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 declare interface AnalyticsOptions {
+  driver: 'google-analytics' | 'fathom'
+
+  drivers: {
+    googleAnalytics?: {
+      trackingId: string
+    }
+    fathom?: {
+      siteId: string
+    }
+  }
 }
-export type AnalyticsConfig = Partial<AnalyticsOptions>;
+export declare type AnalyticsConfig = Partial<AnalyticsOptions>

package/dist/api.d.ts

@@ -1,67 +1,26 @@
-/**
-* **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;
-	middleware: string[];
-	routes: {
-		index: boolean;
-		show: boolean;
-		store: boolean;
-		update: boolean;
-		destroy: boolean;
-	} | boolean;
-	/**
-	* **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 declare interface ApiOptions {
+  description: string
+
+  prefix: string
+
+  middleware: string[]
+
+  routes:
+    | {
+      index: boolean
+      show: boolean
+      store: boolean
+      update: boolean
+      destroy: boolean
+    }
+    | boolean
+
+  prewarm: boolean | number
+
+  memorySize: number
+
+  timeout: number
+
+  deploy: boolean
 }
-export type ApiConfig = Partial<ApiOptions>;
+export declare type ApiConfig = Partial<ApiOptions>

package/dist/app.d.ts

@@ -1,135 +1,30 @@
-export type AppEnvType = "local" | "dev" | "stage" | "prod" | "testing" | string;
-/**
-* **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 "local"
-	*/
-	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 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;
-	/**
-	* **Documentation Mode**
-	*
-	* $appUrl becomes your Documentation URL.
-	*
-	* @default false
-	*/
-	docMode: boolean;
+export declare type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | 'testing' | string
+export declare interface AppOptions {
+  name: string
+
+  description: string
+
+  env: AppEnvType
+
+  url: string
+
+  redirectUrls: string | string[]
+
+  debug: boolean
+
+  maintenanceMode: boolean
+
+  key: string
+
+  timezone: string
+
+  locale: string
+
+  fallbackLocale: 'en'
+
+  cipher: string
+
+
+  docMode: boolean
 }
-export type AppConfig = Partial<AppOptions>;
+export declare type AppConfig = Partial<AppOptions>

package/dist/auto-imports.d.ts

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

package/dist/binary.d.ts

@@ -1,11 +1,8 @@
-/**
-* The Binary/CLI Options used in `./config/cli.ts`.
-*/
-export interface BinaryOptions {
-	name: string;
-	command: string;
-	description: string;
-	source: string;
-	deploy: boolean;
+export declare interface BinaryOptions {
+  name: string
+  command: string
+  description: string
+  source: string
+  deploy: boolean
 }
-export type BinaryConfig = Partial<BinaryOptions>;
+export declare type BinaryConfig = Partial<BinaryOptions>

package/dist/build.d.ts

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

package/dist/cache.d.ts

@@ -1,62 +1,49 @@
-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;
-			host: string;
-			port: number;
-			username: string;
-			password: string;
-		};
-		memcached?: object;
-		dynamodb?: {
-			key: string;
-			secret: string;
-			region: string;
-			table: string;
-			endpoint: string;
-		};
-	};
+import type { BentoCache } from 'bentocache';
+
+export declare interface CacheOptions {
+  driver: string
+
+  prefix: string
+
+  ttl: number
+
+  drivers: {
+    redis?: {
+      connection: string
+
+      host: string
+
+      port: number
+
+      username: string
+
+      password: string
+    }
+
+    memcached?: object
+
+    dynamodb?: {
+      key: string
+      secret: string
+      region: string
+      table: string
+      endpoint: string
+    }
+  }
 }
-export type CacheConfig = Partial<CacheOptions>;
+export declare type CacheConfig = Partial<CacheOptions>
+export declare interface CacheDriver {
+  set: (key: string, value: string, ttl?: number) => Promise<void>
+  setForever: (key: string, value: string, ttl?: number) => Promise<void>
+  get: (key: string) => Promise<string | undefined | null>
+  getOrSet: (key: string, value: string) => Promise<string | undefined | null>
+  remove: (key: string) => Promise<void>
+  has: (key: string) => Promise<boolean>
+  missing: (key: string) => Promise<boolean>
+  del: (key: string) => Promise<void>
+  deleteMany: (keys: string[]) => Promise<void>
+  clear: () => Promise<void>
+  deleteAll: () => Promise<void>
+  disconnect: () => Promise<void>
+  client: BentoCache<Record<string, any>>
+}

package/dist/cdn.d.ts

@@ -1,16 +1,4 @@
-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 declare interface CdnOptions {
+  driver: string
 }
-export type CdnConfig = Partial<CdnOptions>;
+export declare type CdnConfig = Partial<CdnOptions>

package/dist/chat.d.ts

@@ -1,3 +1,3 @@
-interface ChatOptions {}
 export type { ChatOptions };
-export type ChatConfig = ChatOptions;
+declare interface ChatOptions {}
+export declare type ChatConfig = ChatOptions