@stacksjs/types 0.59.11 → 0.61.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/package.json +22 -25
  2. package/src/ai.ts +2 -1
  3. package/src/api.ts +12 -0
  4. package/src/chat.ts +1 -1
  5. package/src/cli.ts +76 -27
  6. package/src/cloud.ts +250 -27
  7. package/src/database.ts +18 -8
  8. package/src/dns.ts +286 -2
  9. package/src/email.ts +1 -3
  10. package/src/errors.ts +93 -0
  11. package/src/git.ts +1 -1
  12. package/src/hashing.ts +9 -9
  13. package/src/helpers.ts +2 -5
  14. package/src/index.ts +1 -0
  15. package/src/library.ts +765 -5
  16. package/src/model-names.ts +1 -0
  17. package/src/model.ts +92 -33
  18. package/src/notifications.ts +11 -1
  19. package/src/ports.ts +1 -0
  20. package/src/search-engine.ts +38 -13
  21. package/src/security.ts +1 -1
  22. package/src/services.ts +6 -6
  23. package/src/stacks.ts +11 -0
  24. package/src/tables.ts +1 -1
  25. package/src/ui.ts +1 -1
  26. package/src/utils.ts +6 -7
  27. package/dist/ai.d.ts +0 -15
  28. package/dist/analytics.d.ts +0 -19
  29. package/dist/api.d.ts +0 -59
  30. package/dist/app.d.ts +0 -135
  31. package/dist/auto-imports.d.ts +0 -1
  32. package/dist/binary.d.ts +0 -11
  33. package/dist/build.d.ts +0 -2
  34. package/dist/cache.d.ts +0 -88
  35. package/dist/cdn.d.ts +0 -16
  36. package/dist/chat.d.ts +0 -4
  37. package/dist/cli.d.ts +0 -278
  38. package/dist/cloud.d.ts +0 -69
  39. package/dist/components.d.ts +0 -60
  40. package/dist/configure.d.ts +0 -12
  41. package/dist/cron-jobs.d.ts +0 -43
  42. package/dist/database.d.ts +0 -37
  43. package/dist/dependencies.d.ts +0 -62
  44. package/dist/deploy.d.ts +0 -12
  45. package/dist/dns.d.ts +0 -175
  46. package/dist/docs.d.ts +0 -22
  47. package/dist/email.d.ts +0 -14
  48. package/dist/env.d.ts +0 -1
  49. package/dist/errors.d.ts +0 -1
  50. package/dist/events.d.ts +0 -30
  51. package/dist/exit-code.d.ts +0 -10
  52. package/dist/file-systems.d.ts +0 -60
  53. package/dist/git.d.ts +0 -129
  54. package/dist/hashing.d.ts +0 -109
  55. package/dist/helpers.d.ts +0 -1
  56. package/dist/i18n.d.ts +0 -19
  57. package/dist/index.d.ts +0 -58
  58. package/dist/inspect.d.ts +0 -9
  59. package/dist/library.d.ts +0 -134
  60. package/dist/logger.d.ts +0 -49
  61. package/dist/manifest.d.ts +0 -9
  62. package/dist/model.d.ts +0 -70
  63. package/dist/money.d.ts +0 -2
  64. package/dist/notifications.d.ts +0 -117
  65. package/dist/pages.d.ts +0 -10
  66. package/dist/payments.d.ts +0 -60
  67. package/dist/ports.d.ts +0 -19
  68. package/dist/promise.d.ts +0 -1
  69. package/dist/push.d.ts +0 -35
  70. package/dist/pwa.d.ts +0 -7
  71. package/dist/queue.d.ts +0 -36
  72. package/dist/reactivity.d.ts +0 -1
  73. package/dist/router.d.ts +0 -78
  74. package/dist/scheduler.d.ts +0 -1
  75. package/dist/search-engine.d.ts +0 -118
  76. package/dist/security.d.ts +0 -18
  77. package/dist/services.d.ts +0 -33
  78. package/dist/sms.d.ts +0 -1
  79. package/dist/ssg.d.ts +0 -2
  80. package/dist/stacks.d.ts +0 -196
  81. package/dist/storage.d.ts +0 -12
  82. package/dist/tables.d.ts +0 -52
  83. package/dist/team.d.ts +0 -8
  84. package/dist/ui.d.ts +0 -165
  85. package/dist/utils.d.ts +0 -33
package/dist/cache.d.ts DELETED
@@ -1,88 +0,0 @@
1
- export interface CacheOptions {
2
- /**
3
- * **Cache Driver**
4
- *
5
- * This value determines the cache driver that will be used by your application to store
6
- * cached data. By default, Stacks uses the "redis" driver, which stores cached data in
7
- * in a self-configufed Redis instance. You may use any of the other drivers provided
8
- * by Stacks or write your own custom driver.
9
- *
10
- * @default "redis"
11
- * @example "redis"
12
- * @example "memcached"
13
- * @example "dynamodb"
14
- *
15
- * @see https://stacks.js.org/docs/cache
16
- */
17
- driver: string;
18
- /**
19
- * **Cache Prefix**
20
- *
21
- * This value determines the prefix that will be used when storing items in the cache. This
22
- * prefix may be useful when multiple applications are sharing the same cache driver so that
23
- * they may avoid collisions when attempting to retrieve items from the cache.
24
- *
25
- * @default string "stacks"
26
- * @example "stacks"
27
- *
28
- * @see https://stacks.js.org/docs/cache
29
- */
30
- prefix: string;
31
- /**
32
- * **Cache TTL**
33
- *
34
- * This value determines the default time to live for items stored in the cache. This value
35
- * may be overridden when storing items in the cache. If no value is specified, the cache
36
- * driver will default to a reasonable time to live for the given item.
37
- *
38
- * @default number 3600
39
- * @example 3600
40
- * @example 3600 * 24
41
- * @example -1 (never expires)
42
- */
43
- ttl: number;
44
- drivers: {
45
- redis?: {
46
- connection: string;
47
- /**
48
- * **Redis Host**
49
- *
50
- * This value determines the host that will be used to connect to the Redis server.
51
- *
52
- * @default string "localhost"
53
- * @example "localhost"
54
- */
55
- host: string;
56
- /**
57
- * **Redis Port**
58
- *
59
- * This value determines the port that will be used to connect to the Redis server.
60
- *
61
- * @default number 6379
62
- * @example 6379
63
- */
64
- port: number;
65
- /**
66
- * **Redis Username**
67
- *
68
- * This value determines the username that will be used to connect to the Redis server.
69
- *
70
- * @default string ""
71
- * @example "admin"
72
- */
73
- username: string;
74
- /**
75
- * **Redis Password**
76
- *
77
- * This value determines the password that will be used to connect to the Redis server.
78
- *
79
- * @default string ""
80
- * @example "password"
81
- */
82
- password: string;
83
- };
84
- memcached?: object;
85
- dynamodb?: object;
86
- };
87
- }
88
- export type CacheConfig = Partial<CacheOptions>;
package/dist/cdn.d.ts DELETED
@@ -1,16 +0,0 @@
1
- export interface CdnOptions {
2
- /**
3
- * **CDN Driver**
4
- *
5
- * This value determines the default CDN driver that will be used when interacting with the
6
- * CDN service. This value may be overridden when interacting with the CDN service.
7
- *
8
- * @default "cloudfront"
9
- * @example "cloudfront"
10
- * @example "fastly" wip
11
- *
12
- * @see https://stacks.js.org/docs/cdn
13
- */
14
- driver: string;
15
- }
16
- export type CdnConfig = Partial<CdnOptions>;
package/dist/chat.d.ts DELETED
@@ -1,4 +0,0 @@
1
- interface ChatOptions {
2
- }
3
- export type { ChatOptions };
4
- export type ChatConfig = ChatOptions;
package/dist/cli.d.ts DELETED
@@ -1,278 +0,0 @@
1
- /// <reference types="bun-types" />
2
- /// <reference types="bun-types" />
3
- /// <reference types="node" />
4
- import type { BunFile } from 'bun';
5
- import type { Ports } from './ports';
6
- type ArrayBufferView = NodeJS.TypedArray | DataView;
7
- export type { Subprocess, SyncSubprocess } from 'bun';
8
- export type Readable = 'pipe' | 'inherit' | 'ignore' | null | undefined | BunFile | ArrayBufferView | number;
9
- export type Writable = 'pipe' | 'inherit' | 'ignore' | null | undefined | BunFile | ArrayBufferView | number | ReadableStream | Blob | Response | Request;
10
- export type In = Readable;
11
- export type Out = Writable;
12
- /**
13
- * The file descriptor for the standard input. It may be:
14
- *
15
- * - `"ignore"`, `null`, `undefined`: The process will have no standard input
16
- * - `"pipe"`: The process will have a new {@link FileSink} for standard input
17
- * - `"inherit"`: The process will inherit the standard input of the current process
18
- * - `ArrayBufferView`, `Blob`: The process will read from the buffer
19
- * - `number`: The process will read from the file descriptor
20
- *
21
- * @default "ignore"
22
- */
23
- export type stdin = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number | null | undefined;
24
- /**
25
- * The file descriptor for the standard output. It may be:
26
- *
27
- * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
28
- * - `"ignore"`, `null`: The process will have no standard output/error
29
- * - `"inherit"`: The process will inherit the standard output/error of the current process
30
- * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
31
- * - `number`: The process will write to the file descriptor
32
- *
33
- * @default "pipe"
34
- */
35
- export type stdout = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number;
36
- /**
37
- * The file descriptor for the standard error. It may be:
38
- *
39
- * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
40
- * - `"ignore"`, `null`: The process will have no standard output/error
41
- * - `"inherit"`: The process will inherit the standard output/error of the current process
42
- * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
43
- * - `number`: The process will write to the file descriptor
44
- *
45
- * @default "inherit" for `spawn`
46
- * "pipe" for `spawnSync`
47
- */
48
- export type stderr = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number;
49
- export interface OutroOptions extends CliOptions {
50
- type?: 'success' | 'error' | 'warning' | 'info';
51
- startTime?: number;
52
- useSeconds?: boolean;
53
- quiet?: boolean;
54
- message?: string;
55
- }
56
- export interface IntroOptions {
57
- /**
58
- * @default true
59
- */
60
- showPerformance?: boolean;
61
- /**
62
- * @default false
63
- */
64
- quiet: boolean;
65
- }
66
- export type CliOptionsKeys = keyof CliOptions;
67
- /**
68
- * The options to pass to the CLI.
69
- */
70
- export interface CliOptions {
71
- /**
72
- * **Verbose Output**
73
- *
74
- * When your application is in "verbose"-mode, a different level of,
75
- * information like useful outputs for debugging reasons, will be
76
- * shown. When disabled, it defaults to the "normal experience."
77
- *
78
- * @default false
79
- */
80
- verbose?: boolean;
81
- /**
82
- * **Silent Mode**
83
- *
84
- * When you are using "silent"-mode, the CLI will not output anything
85
- * to the console. This is useful when you want to run the CLI in
86
- * the background.
87
- *
88
- * @default false
89
- */
90
- silent?: boolean;
91
- /**
92
- * **Quiet Mode**
93
- *
94
- * When you are using "quiet"-mode, the CLI will output minimally
95
- * to the console.
96
- *
97
- * @default false
98
- */
99
- quiet?: boolean;
100
- /**
101
- * **Current Work Directory**
102
- *
103
- * Based on the `cwd` value, that's where the command...
104
- *
105
- * @default projectPath()
106
- */
107
- cwd?: string;
108
- /**
109
- * @default 'pipe'
110
- */
111
- stdin?: stdin;
112
- /**
113
- * @default 'pipe'
114
- */
115
- stdout?: stdout;
116
- /**
117
- * @default 'inherit'
118
- */
119
- stderr?: stderr;
120
- env?: Record<string, string | undefined>;
121
- /**
122
- * Runs the action in interactive/detached mode.
123
- * @default false
124
- */
125
- background?: boolean;
126
- startTime?: number;
127
- /**
128
- * Include the localhost URL in the output.
129
- * @default false
130
- */
131
- withLocalhost?: boolean;
132
- input?: string | ArrayBufferView | ReadableStream | Blob | Response | Request;
133
- project?: string;
134
- }
135
- export type CliConfig = CliOptions;
136
- export type ActionOption = 'types' | 'domains' | 'count';
137
- /**
138
- * The options to pass to the Action.
139
- */
140
- export type ActionOptions = {
141
- types?: boolean;
142
- domains?: boolean;
143
- count?: number;
144
- dryRun?: boolean;
145
- } & CliOptions & DomainsOptions;
146
- export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'views' | 'stacks' | 'all' | 'buddy' | 'server';
147
- export type BuildOptions = {
148
- [key in BuildOption]: boolean;
149
- } & CliOptions;
150
- export type AddOption = 'table' | 'calendar' | 'all';
151
- export type AddOptions = {
152
- [key in AddOption]?: boolean;
153
- } & CliOptions;
154
- export type CreateStringOption = 'name';
155
- export type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'views' | 'functions' | 'api' | 'database';
156
- export type CreateOptions = {
157
- [key in CreateBooleanOption]: boolean;
158
- } & {
159
- [key in CreateStringOption]: string;
160
- } & CliOptions;
161
- export type DevOption = 'components' | 'docs' | 'frontend' | 'api' | 'desktop' | 'all' | 'email' | 'system-tray' | 'interactive' | 'verbose';
162
- export type DevOptions = {
163
- [key in DevOption]: boolean;
164
- } & CliOptions;
165
- export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'componentMeta' | 'coreSymlink' | 'pkgxConfig';
166
- export type GeneratorOptions = {
167
- [key in GeneratorOption]?: boolean;
168
- } & CliOptions;
169
- export type LintOption = 'fix';
170
- export type LintOptions = {
171
- [key in LintOption]: boolean;
172
- } & CliOptions;
173
- export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
174
- export type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'model' | 'notification' | 'stack';
175
- export type MakeOptions = {
176
- [key in MakeBooleanOption]: boolean;
177
- } & {
178
- [key in MakeStringOption]: string;
179
- } & CliOptions;
180
- export type UpgradeBoolean = 'framework' | 'dependencies' | 'bun' | 'shell' | 'binary' | 'all' | 'force';
181
- export type UpgradeString = 'version';
182
- export type UpgradeOptions = {
183
- [key in UpgradeBoolean]: boolean;
184
- } & {
185
- [key in UpgradeString]: string;
186
- } & CliOptions;
187
- export type ExamplesString = 'version';
188
- export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
189
- export type ExamplesOption = ExamplesString & ExamplesBoolean | void;
190
- export type ExamplesOptions = {
191
- [key in ExamplesString]: string;
192
- } & {
193
- [key in ExamplesBoolean]: boolean;
194
- } & CliOptions;
195
- export type TestOptions = CliOptions & {
196
- showReport?: boolean;
197
- };
198
- export type DomainsOptions = CliOptions & {
199
- domain?: string;
200
- yes?: boolean;
201
- years?: number;
202
- privacy?: boolean;
203
- autoRenew?: boolean;
204
- registrantFirstName?: string;
205
- registrantLastName?: string;
206
- registrantOrganization?: string;
207
- registrantAddress?: string;
208
- registrantCity?: string;
209
- registrantState?: string;
210
- registrantCountry?: string;
211
- registrantZip?: string;
212
- registrantPhone?: string;
213
- registrantEmail?: string;
214
- adminFirstName?: string;
215
- adminLastName?: string;
216
- adminOrganization?: string;
217
- adminAddress?: string;
218
- adminCity?: string;
219
- adminState?: string;
220
- adminCountry?: string;
221
- adminZip?: string;
222
- adminPhone?: string;
223
- adminEmail?: string;
224
- techFirstName?: string;
225
- techLastName?: string;
226
- techOrganization?: string;
227
- techAddress?: string;
228
- techCity?: string;
229
- techState?: string;
230
- techCountry?: string;
231
- techZip?: string;
232
- techPhone?: string;
233
- techEmail?: string;
234
- privacyAdmin?: boolean;
235
- privacyTech?: boolean;
236
- privacyRegistrant?: boolean;
237
- contactType?: string;
238
- };
239
- export interface CleanOptions extends CliOptions {
240
- }
241
- export interface CloudCliOptions extends CliOptions {
242
- ssh?: boolean;
243
- connect?: boolean;
244
- jumpBox?: boolean;
245
- }
246
- export interface CommitOptions extends CliOptions {
247
- }
248
- export interface KeyOptions extends CliOptions {
249
- }
250
- export interface FreshOptions extends CliOptions {
251
- dryRun?: boolean;
252
- quiet?: boolean;
253
- }
254
- export interface MigrateOptions extends CliOptions {
255
- }
256
- export interface InspireOptions extends CliOptions {
257
- }
258
- export interface InstallOptions extends CliOptions {
259
- }
260
- export interface ReleaseOptions extends CliOptions {
261
- dryRun?: boolean;
262
- }
263
- export interface ProjectsOptions extends CliOptions {
264
- list?: boolean;
265
- }
266
- export interface PreinstallOptions extends CliOptions {
267
- }
268
- export interface PrepublishOptions extends CliOptions {
269
- }
270
- export interface PortsOptions extends CliOptions {
271
- ports?: Partial<Ports>;
272
- }
273
- export interface TinkerOptions extends CliOptions {
274
- }
275
- export interface TypesOptions extends CliOptions {
276
- }
277
- export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all';
278
- export type { CAC as CLI } from 'cac';
package/dist/cloud.d.ts DELETED
@@ -1,69 +0,0 @@
1
- import type { ApiOptions } from './api';
2
- import type { FirewallConfig } from './security';
3
- 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';
4
- type Environment = 'development' | 'staging' | 'production';
5
- export interface CloudOptions {
6
- type: 'serverless';
7
- driver: 'aws';
8
- storage: {};
9
- /**
10
- * **Firewall Settings**
11
- *
12
- * These settings are used to configure the firewall.
13
- *
14
- * @see https://stacksjs.org/docs/cloud#firewall
15
- *
16
- * @example
17
- * ```ts
18
- * firewall: {
19
- * enabled: true, // default: true
20
- * countryCodes: ['RU', 'IN'], // default: []
21
- * ipAddresses: ['56.123.456.789'], // default: []
22
- * queryString: ['foo', 'bar'], // default: []
23
- * httpHeaders: ['x-foo', 'x-bar'], // default: []
24
- * rateLimitPerMinute: 1000, // default: 1000
25
- * useIpReputationLists: true, // default: true
26
- * useKnownBadInputsRuleSet: true // default: true
27
- * },
28
- * ```
29
- */
30
- firewall: FirewallConfig;
31
- /**
32
- * **Environments**
33
- *
34
- * These are the environments that your cloud will deploy.
35
- *
36
- * @example
37
- * ```ts
38
- * environments: ['production', 'staging', 'development']
39
- * ```
40
- */
41
- environments: Environment[];
42
- cdn: {
43
- allowedMethods: 'GET_HEAD' | 'GET_HEAD_OPTIONS' | 'ALL';
44
- cachedMethods: 'GET_HEAD' | 'GET_HEAD_OPTIONS';
45
- minTtl: number;
46
- defaultTtl: number;
47
- maxTtl: number;
48
- compress: boolean;
49
- priceClass?: 'PriceClass_100' | 'PriceClass_200' | 'PriceClass_All';
50
- originShieldRegion: string;
51
- cookieBehavior: 'none' | 'allowList' | 'all';
52
- allowList: {
53
- cookies: string[];
54
- headers: string[];
55
- queryStrings: string[];
56
- };
57
- realtimeLogs: {
58
- enabled: boolean;
59
- samplingRate: number;
60
- };
61
- };
62
- api: ApiOptions;
63
- ai: boolean;
64
- cli: boolean;
65
- docs: boolean;
66
- fileSystem: boolean;
67
- }
68
- export type CloudConfig = Partial<CloudOptions>;
69
- export {};
@@ -1,60 +0,0 @@
1
- export type { Options as ComponentOptions } from 'unplugin-vue-components';
2
- export interface TagOption {
3
- /**
4
- * **Tag Name**
5
- *
6
- * This is the name of the component to be included in your library build.
7
- * When defining a tag, ensure that the name corresponds to a file within
8
- * root component directory.
9
- *
10
- * @example
11
- * {
12
- * tags: [{
13
- * name: 'HelloWorld' // results in `<HelloWorld />`
14
- * }]
15
- * }
16
- *
17
- * @example
18
- * {
19
- * tags: [{
20
- * name: ['HelloWorld', 'AppHelloWorld'] // results in `<AppHelloWorld />`
21
- * }]
22
- * }
23
- * @see https://stacksjs.org/docs/components
24
- */
25
- name: string | string[];
26
- /**
27
- * **Tag Description**
28
- *
29
- * This is the description of your component. This value is
30
- * used when to provide additional information to IDEs.
31
- *
32
- * @example
33
- * {
34
- * name: 'HelloWorld' // results in `<HelloWorld />`
35
- * }
36
- * @see https://stacksjs.org/docs/components
37
- */
38
- description?: string;
39
- /**
40
- * **Tag Attributes**
41
- *
42
- * These are your component's attributes. While it’s an optional field, you should aim
43
- * to define all of your component attributes here, to provide as much context
44
- * to your IDEs as possible, when actually using the library as an end-user.
45
- *
46
- * @example
47
- * {
48
- * attributes: {
49
- * name: 'greeting',
50
- * description: 'The way to greet the user.',
51
- * }
52
- * }
53
- * @see https://stacksjs.org/docs/components
54
- */
55
- attributes?: {
56
- name: string;
57
- description: string;
58
- }[];
59
- }
60
- export type TagsOptions = TagOption[];
@@ -1,12 +0,0 @@
1
- export interface ConfigureOptions {
2
- aws: boolean;
3
- profile: string;
4
- project: boolean;
5
- verbose: boolean;
6
- accessKeyId: string;
7
- secretAccessKey: string;
8
- region: string;
9
- output: string;
10
- quiet: boolean;
11
- }
12
- export type ConfigureConfig = Partial<ConfigureOptions>;
@@ -1,43 +0,0 @@
1
- import type { IntRange } from '@stacksjs/scheduler';
2
- /**
3
- * Cron Job Options.
4
- */
5
- export interface JobOptions {
6
- /**
7
- * The name of the job.
8
- */
9
- name?: string;
10
- handle?: string | Function;
11
- action?: string;
12
- description?: string;
13
- queue?: string;
14
- timezone?: string;
15
- /**
16
- * Number of tries. Must be between 0 and 185.
17
- */
18
- tries?: IntRange<0, 185>;
19
- backoff?: number | number[];
20
- rate?: string | Every;
21
- enabled?: boolean;
22
- }
23
- export type JobConfig = JobOptions;
24
- export type Job = JobOptions;
25
- export type Jobs = Job[];
26
- export type CronJob = Job;
27
- export type CronJobs = Jobs;
28
- export declare enum Every {
29
- Minute = "* * * * *",
30
- TwoMinutes = "*/2 * * * *",
31
- FiveMinutes = "*/5 * * * *",
32
- TenMinutes = "*/10 * * * *",
33
- FifteenMinutes = "*/15 * * * *",
34
- ThirtyMinutes = "*/30 * * * *",
35
- Hour = "0 * * * *",
36
- HalfHour = "0,30 * * * *",
37
- Day = "0 0 * * *",
38
- Week = "0 0 * * 0",
39
- Weekday = "0 0 * * 1-5",
40
- Weekend = "0 0 * * 0,6",
41
- Month = "0 0 1 * *",
42
- Year = "0 0 1 1 *"
43
- }
@@ -1,37 +0,0 @@
1
- export interface DatabaseOptions {
2
- default: string;
3
- /**
4
- * The name of the database to use.
5
- * @default stacks
6
- */
7
- name: string;
8
- connections: {
9
- mysql?: {
10
- url?: string;
11
- host?: string;
12
- port?: number;
13
- name?: string;
14
- username?: string;
15
- password?: string;
16
- prefix?: string;
17
- };
18
- sqlite: {
19
- url?: string;
20
- database?: string;
21
- prefix?: string;
22
- };
23
- planetscale?: object;
24
- postgres?: object;
25
- };
26
- migrations: string;
27
- }
28
- export type DatabaseConfig = Partial<DatabaseOptions>;
29
- export interface FactoryOptions {
30
- name: string;
31
- count?: number;
32
- items: object;
33
- columns: object;
34
- }
35
- export interface SchemaOptions {
36
- database: string;
37
- }
@@ -1,62 +0,0 @@
1
- /**
2
- * **Dependencies Manager**
3
- *
4
- * This configuration defines all of your dependencies options. Because Stacks is fully-typed,
5
- * you may hover any of the options below and the definitions will be provided. In case
6
- * you have any questions, feel free to reach out via Discord or GitHub Discussions.
7
- */
8
- export interface DependenciesOptions {
9
- /**
10
- * **Bun**
11
- *
12
- * @default '0.7.1'
13
- * @link https://bun.sh
14
- */
15
- 'bun.sh': string | '0.7.1';
16
- /**
17
- * **SQLite**
18
- *
19
- * @default '^3.42.0'
20
- * @link https://sqlite.org
21
- */
22
- 'sqlite.org'?: string | '^3.42.0';
23
- /**
24
- * **MySQL**
25
- *
26
- * @default '^8.0.33'
27
- * @link https://mysql.org
28
- */
29
- 'mysql.com'?: string | '^8.0.33';
30
- /**
31
- * **MariaDB**
32
- *
33
- * @default '^10.6.5'
34
- * @link https://mariadb.org
35
- */
36
- 'mariadb.org'?: string | '^10.6.5';
37
- /**
38
- * **PostgreSQL**
39
- *
40
- * @default '^14.1'
41
- * @link https://postgresql.org
42
- */
43
- 'postgresql.org'?: string | '^14.1';
44
- /**
45
- * **Redis**
46
- *
47
- * @default '^7.0.11'
48
- * @link https://redis.io
49
- */
50
- 'redis.io'?: string | '^7.0.11';
51
- /**
52
- * **AWS CLI**
53
- *
54
- * This dependency is only required if you are making use of the AWS driver
55
- * (i.e. the Stacks generated cloud may make use of it).
56
- *
57
- * @default '^2.12.7'
58
- * @link https://aws.amazon.com/cli
59
- */
60
- 'aws.amazon.com/cli'?: string | '^2.12.7';
61
- }
62
- export type DependenciesConfig = DependenciesOptions;