@stacksjs/types 0.72.103 → 0.73.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.
- package/dist/cli.d.ts +33 -4
- package/dist/cron-jobs.d.ts +2 -1
- package/dist/docs.d.ts +1 -0
- package/dist/errors.d.ts +1 -0
- package/dist/file-systems.d.ts +8 -5
- package/dist/helpers.d.ts +1 -1
- package/dist/library.d.ts +35 -0
- package/dist/payments.d.ts +14 -1
- package/dist/queue.d.ts +5 -4
- package/dist/services.d.ts +2 -0
- package/dist/ui.d.ts +1 -0
- package/package.json +4 -4
package/dist/cli.d.ts
CHANGED
|
@@ -174,12 +174,15 @@ export type ActionOptions = {
|
|
|
174
174
|
domains?: boolean
|
|
175
175
|
count?: number
|
|
176
176
|
dryRun?: boolean // used in buddy release
|
|
177
|
+
/** The job or record an action targets, used by `queue:retry` / `queue:inspect`. */
|
|
178
|
+
id?: string | number
|
|
177
179
|
} & CliOptions &
|
|
178
180
|
DomainsOptions;
|
|
179
181
|
export type BuildOption = | 'components'
|
|
180
182
|
| 'webComponents'
|
|
181
183
|
| 'elements'
|
|
182
184
|
| 'functions'
|
|
185
|
+
| 'libs'
|
|
183
186
|
| 'desktop'
|
|
184
187
|
| 'mobile'
|
|
185
188
|
| 'android'
|
|
@@ -220,12 +223,23 @@ export type DevOption = | 'components'
|
|
|
220
223
|
| 'all'
|
|
221
224
|
| 'email'
|
|
222
225
|
| 'system-tray'
|
|
226
|
+
/** The camel spelling the parser also supplies, read alongside the kebab. */
|
|
227
|
+
| 'systemTray'
|
|
228
|
+
/** `buddy dev dashboard`, which the handler dispatches on. */
|
|
229
|
+
| 'dashboard'
|
|
223
230
|
| 'interactive'
|
|
224
231
|
| 'browser'
|
|
225
232
|
| 'site'
|
|
226
233
|
| 'verbose';
|
|
234
|
+
/**
|
|
235
|
+
* The flags `buddy dev` accepts.
|
|
236
|
+
*
|
|
237
|
+
* Optional, like every CLI flag: the parsed object carries only what was
|
|
238
|
+
* typed. Declared required, no real options object satisfied it, so the
|
|
239
|
+
* handler read its own flags through casts.
|
|
240
|
+
*/
|
|
227
241
|
export type DevOptions = {
|
|
228
|
-
[key in DevOption]
|
|
242
|
+
[key in DevOption]?: boolean
|
|
229
243
|
} & CliOptions;
|
|
230
244
|
export type GeneratorOption = | 'types'
|
|
231
245
|
| 'entries'
|
|
@@ -247,7 +261,13 @@ export type LintOptions = {
|
|
|
247
261
|
[key in LintOption]: boolean
|
|
248
262
|
} & CliOptions;
|
|
249
263
|
export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
|
|
250
|
-
export type MakeBooleanOption = | '
|
|
264
|
+
export type MakeBooleanOption = | 'dry-run'
|
|
265
|
+
/** `make:policy --register`, which adds the policy to app/Gates.ts. */
|
|
266
|
+
| 'register'
|
|
267
|
+
/** Kebab spellings read alongside `withValidation` / `withAuth`. */
|
|
268
|
+
| 'with-validation'
|
|
269
|
+
| 'with-auth'
|
|
270
|
+
| 'component'
|
|
251
271
|
| 'page'
|
|
252
272
|
| 'function'
|
|
253
273
|
| 'language'
|
|
@@ -260,10 +280,19 @@ export type MakeBooleanOption = | 'component'
|
|
|
260
280
|
| 'dryRun'
|
|
261
281
|
| 'withValidation'
|
|
262
282
|
| 'withAuth';
|
|
283
|
+
/**
|
|
284
|
+
* The flags `buddy make:*` accepts.
|
|
285
|
+
*
|
|
286
|
+
* Every key optional, because that is what a CLI flag is: the parsed object
|
|
287
|
+
* carries only what the user typed. Declared as required, no real options
|
|
288
|
+
* object ever satisfied it, so `make.ts` reached for `(options).dryRun`
|
|
289
|
+
* and handed `options` to every make* function - which also meant a
|
|
290
|
+
* flag that is genuinely absent read as `boolean` rather than `undefined`.
|
|
291
|
+
*/
|
|
263
292
|
export type MakeOptions = {
|
|
264
|
-
[key in MakeBooleanOption]
|
|
293
|
+
[key in MakeBooleanOption]?: boolean
|
|
265
294
|
} & {
|
|
266
|
-
[key in MakeStringOption]
|
|
295
|
+
[key in MakeStringOption]?: string
|
|
267
296
|
} & CliOptions;
|
|
268
297
|
export type UpgradeBoolean = 'framework' | 'dependencies' | 'bun' | 'shell' | 'binary' | 'all' | 'force' | 'canary' | 'stable' | 'noPostinstall' | 'postinstall';
|
|
269
298
|
export type UpgradeString = 'version' | 'from';
|
package/dist/cron-jobs.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { DeepPartial } from './utils';
|
|
1
2
|
import type { IntRange } from '@stacksjs/cron';
|
|
2
3
|
export declare interface JitterConfig {
|
|
3
4
|
enabled: boolean
|
|
@@ -21,7 +22,7 @@ export declare interface JobOptions<T = unknown> {
|
|
|
21
22
|
timezone?: string
|
|
22
23
|
tries?: IntRange<0, 185>
|
|
23
24
|
backoff?: number | number[]
|
|
24
|
-
backoffConfig?: BackoffConfig
|
|
25
|
+
backoffConfig?: DeepPartial<BackoffConfig>
|
|
25
26
|
rate?: string | Every
|
|
26
27
|
enabled?: boolean
|
|
27
28
|
timeout?: number
|
package/dist/docs.d.ts
CHANGED
package/dist/errors.d.ts
CHANGED
package/dist/file-systems.d.ts
CHANGED
|
@@ -18,12 +18,15 @@ export declare interface JsonFile {
|
|
|
18
18
|
* Describes a package.json file.
|
|
19
19
|
*/
|
|
20
20
|
export declare interface PackageJson {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
21
|
+
name?: string
|
|
22
|
+
description?: string
|
|
23
|
+
engines?: {
|
|
24
|
+
node?: string
|
|
25
|
+
pnpm?: string
|
|
24
26
|
}
|
|
25
|
-
version
|
|
26
|
-
packageManager
|
|
27
|
+
version?: string
|
|
28
|
+
packageManager?: string
|
|
29
|
+
[key: string]: unknown
|
|
27
30
|
}
|
|
28
31
|
export declare interface FileSystemOptions {
|
|
29
32
|
default: string
|
package/dist/helpers.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare function getTypeName(v:
|
|
1
|
+
export declare function getTypeName(v: unknown): string;
|
package/dist/library.d.ts
CHANGED
|
@@ -18,6 +18,30 @@ export declare interface LibraryOptions {
|
|
|
18
18
|
defaultLanguage: LanguageCode
|
|
19
19
|
webComponents: LibraryBuildOptions
|
|
20
20
|
functions: LibraryBuildOptions
|
|
21
|
+
packages: LibraryPackageOptions[]
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* One releasable package built out of `resources/`.
|
|
25
|
+
*/
|
|
26
|
+
export declare interface LibraryPackageOptions {
|
|
27
|
+
name: string
|
|
28
|
+
kind?: LibraryPackageKind
|
|
29
|
+
dir?: string
|
|
30
|
+
description?: string
|
|
31
|
+
keywords?: string[]
|
|
32
|
+
license?: LicenseType
|
|
33
|
+
version?: string
|
|
34
|
+
private?: boolean
|
|
35
|
+
access?: 'public' | 'restricted'
|
|
36
|
+
shouldGenerateSourcemap?: boolean
|
|
37
|
+
include?: string[]
|
|
38
|
+
exclude?: string[]
|
|
39
|
+
files?: string[]
|
|
40
|
+
tags?: TagsOptions
|
|
41
|
+
prefix?: string
|
|
42
|
+
runtime?: 'standalone' | 'stx'
|
|
43
|
+
dependencies?: Record<string, string>
|
|
44
|
+
peerDependencies?: Record<string, string>
|
|
21
45
|
}
|
|
22
46
|
/**
|
|
23
47
|
* The list of available options to build your library.
|
|
@@ -30,6 +54,17 @@ export declare interface LibraryBuildOptions {
|
|
|
30
54
|
files?: string[]
|
|
31
55
|
tags?: TagsOptions
|
|
32
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* What a library package ships.
|
|
59
|
+
*
|
|
60
|
+
* - `functions` bundles TypeScript from `resources/functions` into an ESM
|
|
61
|
+
* package with declarations.
|
|
62
|
+
* - `components` compiles `.stx` files from `resources/components` into a
|
|
63
|
+
* progressive custom-element library (the stx component-library build).
|
|
64
|
+
* - `web-components` emits a self-registering `customElements.define(...)`
|
|
65
|
+
* bundle for the same sources - the drop-in-a-script-tag flavor.
|
|
66
|
+
*/
|
|
67
|
+
export type LibraryPackageKind = 'functions' | 'components' | 'web-components';
|
|
33
68
|
export type LibraryConfig = Partial<LibraryOptions>;
|
|
34
69
|
/**
|
|
35
70
|
* The name of your "Stack" which generally is your library name
|
package/dist/payments.d.ts
CHANGED
|
@@ -7,6 +7,12 @@ export declare interface PaymentOptions {
|
|
|
7
7
|
stripe: StripeConfig
|
|
8
8
|
currency?: string
|
|
9
9
|
webhook?: WebhookConfig
|
|
10
|
+
connect?: ConnectConfig
|
|
11
|
+
}
|
|
12
|
+
export declare interface ConnectConfig {
|
|
13
|
+
enabled: boolean
|
|
14
|
+
platformFeePercent?: number
|
|
15
|
+
webhookSecret?: string
|
|
10
16
|
}
|
|
11
17
|
export declare interface StripeConfig {
|
|
12
18
|
publishableKey: string
|
|
@@ -319,4 +325,11 @@ export type WebhookEventType = | 'payment_intent.succeeded'
|
|
|
319
325
|
| 'payment_method.attached'
|
|
320
326
|
| 'payment_method.detached'
|
|
321
327
|
| 'setup_intent.succeeded'
|
|
322
|
-
| 'setup_intent.setup_failed'
|
|
328
|
+
| 'setup_intent.setup_failed'
|
|
329
|
+
// Connect. Delivered to the platform's Connect endpoint, not the account
|
|
330
|
+
// endpoint, and each carries `event.account` naming the connected account.
|
|
331
|
+
| 'account.updated'
|
|
332
|
+
| 'account.application.deauthorized'
|
|
333
|
+
| 'payout.created'
|
|
334
|
+
| 'payout.paid'
|
|
335
|
+
| 'payout.failed';
|
package/dist/queue.d.ts
CHANGED
|
@@ -192,6 +192,8 @@ export declare interface QueueJobOptions {
|
|
|
192
192
|
*/
|
|
193
193
|
export declare interface RedisConnectionConfig {
|
|
194
194
|
driver: 'redis'
|
|
195
|
+
retryAfter?: number
|
|
196
|
+
queue?: string
|
|
195
197
|
redis?: QueueRedisConfig
|
|
196
198
|
prefix?: string
|
|
197
199
|
defaultJobOptions?: QueueJobOptions
|
|
@@ -275,17 +277,16 @@ export declare interface QueueOptions {
|
|
|
275
277
|
shutdownTimeout?: number
|
|
276
278
|
}
|
|
277
279
|
}
|
|
278
|
-
// @ts-ignore - QueueOption extends JobOptions with compatible overrides
|
|
279
280
|
export declare interface QueueOption extends JobOptions {
|
|
280
281
|
delay?: number
|
|
281
|
-
payload?:
|
|
282
|
-
afterResponse?:
|
|
282
|
+
payload?: unknown
|
|
283
|
+
afterResponse?: unknown
|
|
283
284
|
context?: string
|
|
284
285
|
maxTries?: number
|
|
285
286
|
chainedJobs?: Dispatchable[]
|
|
286
287
|
queue?: string
|
|
287
288
|
priority?: number
|
|
288
|
-
backoff?: number
|
|
289
|
+
backoff?: number | number[]
|
|
289
290
|
timeout?: number
|
|
290
291
|
immediate?: boolean
|
|
291
292
|
}
|
package/dist/services.d.ts
CHANGED
package/dist/ui.d.ts
CHANGED
|
@@ -27,6 +27,7 @@ export declare interface WebFontMeta {
|
|
|
27
27
|
* have any questions, feel free to reach out via Discord or GitHub Discussions.
|
|
28
28
|
*/
|
|
29
29
|
export declare interface UiOptions {
|
|
30
|
+
defaultViews?: boolean | string[]
|
|
30
31
|
shortcuts: Shortcuts
|
|
31
32
|
safelist: string
|
|
32
33
|
trigger?: string
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacksjs/types",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.73.1",
|
|
5
5
|
"description": "The Stacks framework types.",
|
|
6
6
|
"author": "Chris Breuer",
|
|
7
7
|
"contributors": [
|
|
@@ -57,9 +57,9 @@
|
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
59
|
"@stacksjs/bunpress": "^0.2.8",
|
|
60
|
-
"@stacksjs/events": "0.
|
|
60
|
+
"@stacksjs/events": "0.73.1",
|
|
61
61
|
"@stacksjs/clapp": "^0.2.12",
|
|
62
|
-
"@stacksjs/stx": "^0.2.
|
|
62
|
+
"@stacksjs/stx": "^0.2.246",
|
|
63
63
|
"@stacksjs/ts-validation": "^0.5.6",
|
|
64
64
|
"bun-query-builder": "^0.2.53"
|
|
65
65
|
},
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
}
|
|
73
73
|
},
|
|
74
74
|
"devDependencies": {
|
|
75
|
-
"@stacksjs/validation": "0.
|
|
75
|
+
"@stacksjs/validation": "0.73.1",
|
|
76
76
|
"better-dx": "^0.2.24",
|
|
77
77
|
"meilisearch": "^0.59.0"
|
|
78
78
|
},
|