@stacksjs/types 0.67.0 → 0.68.0

package/dist/cloud.d.ts

@@ -1,69 +1,306 @@
-import type { ApiConfig } from "./api";
-import type { FirewallConfig } from "./security";
-export type CountryCode = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
-type Environment = "development" | "staging" | "production";
-export interface CloudOptions {
-	type: "serverless";
-	driver: "aws";
-	api: ApiConfig;
-	storage: object;
-	/**
-	* **Firewall Settings**
-	*
-	* These settings are used to configure the firewall.
-	*
-	* @see https://stacksjs.org/docs/cloud#firewall
-	*
-	* @example
-	* ```ts
-	* firewall: {
-	*   enabled: true, // default: true
-	*   countryCodes: ['RU', 'IN'], // default: []
-	*   ipAddresses: ['56.123.456.789'], // default: []
-	*   queryString: ['foo', 'bar'], // default: []
-	*   httpHeaders: ['x-foo', 'x-bar'], // default: []
-	*   rateLimitPerMinute: 1000, // default: 1000
-	*   useIpReputationLists: true, // default: true
-	*   useKnownBadInputsRuleSet: true // default: true
-	* },
-	* ```
-	*/
-	firewall: FirewallConfig;
-	/**
-	* **Environments**
-	*
-	* These are the environments that your cloud will deploy.
-	*
-	* @example
-	* ```ts
-	* environments: ['production', 'staging', 'development']
-	* ```
-	*/
-	environments: Environment[];
-	cdn: {
-		allowedMethods: "GET_HEAD" | "GET_HEAD_OPTIONS" | "ALL";
-		cachedMethods: "GET_HEAD" | "GET_HEAD_OPTIONS";
-		minTtl: number;
-		defaultTtl: number;
-		maxTtl: number;
-		compress: boolean;
-		priceClass?: "PriceClass_100" | "PriceClass_200" | "PriceClass_All";
-		originShieldRegion: string;
-		cookieBehavior: "none" | "allowList" | "all";
-		allowList: {
-			cookies: string[];
-			headers: string[];
-			queryStrings: string[];
-		};
-		realtimeLogs: {
-			enabled: boolean;
-			samplingRate: number;
-		};
-	};
-	ai: boolean;
-	cli: boolean;
-	docs: boolean;
-	fileSystem: boolean;
+import type { ApiConfig } from './api';
+import type { FirewallConfig } from './security';
+
+export declare type CountryCode =
+  | 'AD'
+  | 'AE'
+  | 'AF'
+  | 'AG'
+  | 'AI'
+  | 'AL'
+  | 'AM'
+  | 'AO'
+  | 'AQ'
+  | 'AR'
+  | 'AS'
+  | 'AT'
+  | 'AU'
+  | 'AW'
+  | 'AX'
+  | 'AZ'
+  | 'BA'
+  | 'BB'
+  | 'BD'
+  | 'BE'
+  | 'BF'
+  | 'BG'
+  | 'BH'
+  | 'BI'
+  | 'BJ'
+  | 'BL'
+  | 'BM'
+  | 'BN'
+  | 'BO'
+  | 'BQ'
+  | 'BR'
+  | 'BS'
+  | 'BT'
+  | 'BV'
+  | 'BW'
+  | 'BY'
+  | 'BZ'
+  | 'CA'
+  | 'CC'
+  | 'CD'
+  | 'CF'
+  | 'CG'
+  | 'CH'
+  | 'CI'
+  | 'CK'
+  | 'CL'
+  | 'CM'
+  | 'CN'
+  | 'CO'
+  | 'CR'
+  | 'CU'
+  | 'CV'
+  | 'CW'
+  | 'CX'
+  | 'CY'
+  | 'CZ'
+  | 'DE'
+  | 'DJ'
+  | 'DK'
+  | 'DM'
+  | 'DO'
+  | 'DZ'
+  | 'EC'
+  | 'EE'
+  | 'EG'
+  | 'EH'
+  | 'ER'
+  | 'ES'
+  | 'ET'
+  | 'FI'
+  | 'FJ'
+  | 'FK'
+  | 'FM'
+  | 'FO'
+  | 'FR'
+  | 'GA'
+  | 'GB'
+  | 'GD'
+  | 'GE'
+  | 'GF'
+  | 'GG'
+  | 'GH'
+  | 'GI'
+  | 'GL'
+  | 'GM'
+  | 'GN'
+  | 'GP'
+  | 'GQ'
+  | 'GR'
+  | 'GS'
+  | 'GT'
+  | 'GU'
+  | 'GW'
+  | 'GY'
+  | 'HK'
+  | 'HM'
+  | 'HN'
+  | 'HR'
+  | 'HT'
+  | 'HU'
+  | 'ID'
+  | 'IE'
+  | 'IL'
+  | 'IM'
+  | 'IN'
+  | 'IO'
+  | 'IQ'
+  | 'IR'
+  | 'IS'
+  | 'IT'
+  | 'JE'
+  | 'JM'
+  | 'JO'
+  | 'JP'
+  | 'KE'
+  | 'KG'
+  | 'KH'
+  | 'KI'
+  | 'KM'
+  | 'KN'
+  | 'KP'
+  | 'KR'
+  | 'KW'
+  | 'KY'
+  | 'KZ'
+  | 'LA'
+  | 'LB'
+  | 'LC'
+  | 'LI'
+  | 'LK'
+  | 'LR'
+  | 'LS'
+  | 'LT'
+  | 'LU'
+  | 'LV'
+  | 'LY'
+  | 'MA'
+  | 'MC'
+  | 'MD'
+  | 'ME'
+  | 'MF'
+  | 'MG'
+  | 'MH'
+  | 'MK'
+  | 'ML'
+  | 'MM'
+  | 'MN'
+  | 'MO'
+  | 'MP'
+  | 'MQ'
+  | 'MR'
+  | 'MS'
+  | 'MT'
+  | 'MU'
+  | 'MV'
+  | 'MW'
+  | 'MX'
+  | 'MY'
+  | 'MZ'
+  | 'NA'
+  | 'NC'
+  | 'NE'
+  | 'NF'
+  | 'NG'
+  | 'NI'
+  | 'NL'
+  | 'NO'
+  | 'NP'
+  | 'NR'
+  | 'NU'
+  | 'NZ'
+  | 'OM'
+  | 'PA'
+  | 'PE'
+  | 'PF'
+  | 'PG'
+  | 'PH'
+  | 'PK'
+  | 'PL'
+  | 'PM'
+  | 'PN'
+  | 'PR'
+  | 'PS'
+  | 'PT'
+  | 'PW'
+  | 'PY'
+  | 'QA'
+  | 'RE'
+  | 'RO'
+  | 'RS'
+  | 'RU'
+  | 'RW'
+  | 'SA'
+  | 'SB'
+  | 'SC'
+  | 'SD'
+  | 'SE'
+  | 'SG'
+  | 'SH'
+  | 'SI'
+  | 'SJ'
+  | 'SK'
+  | 'SL'
+  | 'SM'
+  | 'SN'
+  | 'SO'
+  | 'SR'
+  | 'SS'
+  | 'ST'
+  | 'SV'
+  | 'SX'
+  | 'SY'
+  | 'SZ'
+  | 'TC'
+  | 'TD'
+  | 'TF'
+  | 'TG'
+  | 'TH'
+  | 'TJ'
+  | 'TK'
+  | 'TL'
+  | 'TM'
+  | 'TN'
+  | 'TO'
+  | 'TR'
+  | 'TT'
+  | 'TV'
+  | 'TW'
+  | 'TZ'
+  | 'UA'
+  | 'UG'
+  | 'UM'
+  | 'US'
+  | 'UY'
+  | 'UZ'
+  | 'VA'
+  | 'VC'
+  | 'VE'
+  | 'VG'
+  | 'VI'
+  | 'VN'
+  | 'VU'
+  | 'WF'
+  | 'WS'
+  | 'YE'
+  | 'YT'
+  | 'ZA'
+  | 'ZM'
+  | 'ZW'
+declare type Environment = 'development' | 'staging' | 'production'
+declare interface SiteConfig {
+  domain: string
+  path: string
 }
-export type CloudConfig = Partial<CloudOptions>;
-export {};
+declare type InfrastuctureOptions = Partial<{
+  type: 'serverless' 
+  driver: 'aws'
+  api: ApiConfig
+  storage: object
+
+  firewall: FirewallConfig
+
+  environments: Environment[]
+
+  cdn: {
+    allowedMethods: 'GET_HEAD' | 'GET_HEAD_OPTIONS' | 'ALL'
+    cachedMethods: 'GET_HEAD' | 'GET_HEAD_OPTIONS'
+    minTtl: number
+    defaultTtl: number
+    maxTtl: number
+    compress: boolean
+    priceClass?: 'PriceClass_100' | 'PriceClass_200' | 'PriceClass_All'
+    originShieldRegion: string
+    cookieBehavior: 'none' | 'allowList' | 'all'
+
+    allowList: {
+      cookies: string[]
+      headers: string[]
+      queryStrings: string[]
+    }
+
+    realtimeLogs: {
+      enabled: boolean
+      samplingRate: number
+    }
+  }
+
+  ai: boolean
+  cli: boolean
+  docs: boolean
+  fileSystem: boolean
+}>
+export declare interface CloudOptions {
+  sites: {
+    root: string
+    path: string
+    [site: string]: string | SiteConfig
+  }
+
+  infrastructure: InfrastuctureOptions
+}
+export declare type CloudConfig = Partial<CloudOptions>

package/dist/components.d.ts

@@ -1,60 +1,12 @@
-export type { Options as ComponentOptions } from "unplugin-vue-components";
-export interface TagOption {
-	/**
-	* **Tag Name**
-	*
-	* This is the name of the component to be included in your library build.
-	* When defining a tag, ensure that the name corresponds to a file within
-	* root component directory.
-	*
-	* @example
-	* {
-	*   tags: [{
-	*     name: 'HelloWorld' // results in `<HelloWorld />`
-	*   }]
-	* }
-	*
-	* @example
-	* {
-	*   tags: [{
-	*     name: ['HelloWorld', 'AppHelloWorld'] // results in `<AppHelloWorld />`
-	*   }]
-	* }
-	* @see https://stacksjs.org/docs/components
-	*/
-	name: string | string[];
-	/**
-	* **Tag Description**
-	*
-	* This is the description of your component. This value is
-	* used when to provide additional information to IDEs.
-	*
-	* @example
-	* {
-	*   name: 'HelloWorld' // results in `<HelloWorld />`
-	* }
-	* @see https://stacksjs.org/docs/components
-	*/
-	description?: string;
-	/**
-	* **Tag Attributes**
-	*
-	* These are your component's attributes. While it’s an optional field, you should aim
-	* to define all of your component attributes here, to provide as much context
-	* to your IDEs as possible, when actually using the library as an end-user.
-	*
-	* @example
-	* {
-	*   attributes: {
-	*     name: 'greeting',
-	*     description: 'The way to greet the user.',
-	*   }
-	* }
-	* @see https://stacksjs.org/docs/components
-	*/
-	attributes?: {
-		name: string;
-		description: string;
-	}[];
+export type { Options as ComponentOptions } from 'unplugin-vue-components';
+export declare interface TagOption {
+  name: string | string[]
+
+  description?: string
+
+  attributes?: {
+    name: string
+    description: string
+  }[]
 }
-export type TagsOptions = TagOption[];
+export declare type TagsOptions = TagOption[]

package/dist/configure.d.ts

@@ -1,12 +1,12 @@
-export interface ConfigureOptions {
-	aws: boolean;
-	profile: string;
-	project: boolean;
-	verbose: boolean;
-	accessKeyId: string;
-	secretAccessKey: string;
-	region: string;
-	output: string;
-	quiet: boolean;
+export declare interface ConfigureOptions {
+  aws: boolean
+  profile: string
+  project: boolean
+  verbose: boolean
+  accessKeyId: string
+  secretAccessKey: string
+  region: string
+  output: string
+  quiet: boolean
 }
-export type ConfigureConfig = Partial<ConfigureOptions>;
+export declare type ConfigureConfig = Partial<ConfigureOptions>

package/dist/cron-jobs.d.ts

@@ -1,43 +1,36 @@
-import type { IntRange } from "@stacksjs/scheduler";
-/**
-* Cron Job Options.
-*/
-export interface JobOptions {
-	/**
-	* The name of the job.
-	*/
-	name?: string;
-	handle?: string | Function;
-	action?: string;
-	description?: string;
-	queue?: string;
-	timezone?: string;
-	/**
-	* Number of tries. Must be between 0 and 185.
-	*/
-	tries?: IntRange<0, 185>;
-	backoff?: number | number[];
-	rate?: string | Every;
-	enabled?: boolean;
+import type { IntRange } from '@stacksjs/scheduler';
+
+export declare interface JobOptions {
+  name?: string
+
+  handle?: string | Function
+  action?: string
+  description?: string
+  queue?: string
+  timezone?: string
+  tries?: IntRange<0, 185>
+  backoff?: number | number[]
+  rate?: string | Every
+  enabled?: boolean
 }
-export type JobConfig = JobOptions;
-export type Job = JobOptions;
-export type Jobs = Job[];
-export type CronJob = Job;
-export type CronJobs = Jobs;
+export declare type JobConfig = JobOptions
+export type Job = JobOptions
+export declare type Jobs = Job[]
+export type CronJob = Job
+export declare type CronJobs = Jobs
 export declare enum Every {
-	Minute = "* * * * *",
-	TwoMinutes = "*/2 * * * *",
-	FiveMinutes = "*/5 * * * *",
-	TenMinutes = "*/10 * * * *",
-	FifteenMinutes = "*/15 * * * *",
-	ThirtyMinutes = "*/30 * * * *",
-	Hour = "0 * * * *",
-	HalfHour = "0,30 * * * *",
-	Day = "0 0 * * *",
-	Week = "0 0 * * 0",
-	Weekday = "0 0 * * 1-5",
-	Weekend = "0 0 * * 0,6",
-	Month = "0 0 1 * *",
-	Year = "0 0 1 1 *",
-}
+  Minute = '* * * * *',
+  TwoMinutes = '*/2 * * * *',
+  FiveMinutes = '*/5 * * * *',
+  TenMinutes = '*/10 * * * *',
+  FifteenMinutes = '*/15 * * * *',
+  ThirtyMinutes = '*/30 * * * *',
+  Hour = '0 * * * *',
+  HalfHour = '0,30 * * * *',
+  Day = '0 0 * * *',
+  Week = '0 0 * * 0',
+  Weekday = '0 0 * * 1-5',
+  Weekend = '0 0 * * 0,6',
+  Month = '0 0 1 * *',
+  Year = '0 0 1 1 *',
+}

package/dist/database.d.ts

@@ -1,47 +1,52 @@
-export interface DatabaseOptions {
-	default: string;
-	connections: {
-		mysql?: {
-			url?: string;
-			host?: string;
-			port?: number;
-			name?: string;
-			username?: string;
-			password?: string;
-			prefix?: string;
-		};
-		sqlite: {
-			url?: string;
-			database?: string;
-			prefix?: string;
-		};
-		dynamodb?: {
-			key?: string;
-			secret?: string;
-			region?: string;
-			prefix?: string;
-			endpoint?: string;
-		};
-		postgres?: {
-			url?: string;
-			host?: string;
-			port?: number;
-			name?: string;
-			username?: string;
-			password?: string;
-			prefix?: string;
-		};
-	};
-	migrations: string;
-	migrationLocks: string;
+export declare interface DatabaseOptions {
+  default: string
+
+  connections: {
+    mysql?: {
+      url?: string
+      host?: string
+      port?: number
+      name?: string
+      username?: string
+      password?: string
+      prefix?: string
+    }
+
+    sqlite: {
+      url?: string
+      database?: string
+      prefix?: string
+    }
+
+    dynamodb?: {
+      key?: string
+      secret?: string
+      region?: string
+      prefix?: string
+      endpoint?: string
+    }
+
+    postgres?: {
+      url?: string
+      host?: string
+      port?: number
+      name?: string
+      username?: string
+      password?: string
+      prefix?: string
+    }
+  }
+
+  migrations: string
+  migrationLocks: string
 }
-export type DatabaseConfig = Partial<DatabaseOptions>;
-export interface FactoryOptions {
-	name: string;
-	count?: number;
-	items: object;
-	columns: object;
-}
-export interface SchemaOptions {
-	database: string;
+export declare type DatabaseConfig = Partial<DatabaseOptions>
+export declare interface FactoryOptions {
+  name: string
+  count?: number
+  items: object
+  columns: object
 }
+export declare interface SchemaOptions {
+  database: string
+}