@stacksjs/types 0.72.102 → 0.73.0

package/dist/app.d.ts

@@ -26,5 +26,9 @@ export declare interface AppOptions {
   primaryColor: string
   supportEmail: string
 }
-export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | 'testing' | string;
+// `(string & {})` rather than a bare `string`, which would absorb every
+// literal beside it and collapse the union to `string` - erasing the named
+// environments from completions while claiming to list them.
+// eslint-disable-next-line ts/ban-types -- keeps literal completions alive
+export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | 'testing' | (string & {});
 export type AppConfig = Partial<AppOptions>;

package/dist/cli.d.ts

@@ -174,12 +174,15 @@ export type ActionOptions = {
   domains?: boolean
   count?: number
   dryRun?: boolean // used in buddy release
+  /** The job or record an action targets, used by `queue:retry` / `queue:inspect`. */
+  id?: string | number
 } & CliOptions &
 DomainsOptions;
 export type BuildOption = | 'components'
   | 'webComponents'
   | 'elements'
   | 'functions'
+  | 'libs'
   | 'desktop'
   | 'mobile'
   | 'android'
@@ -220,12 +223,23 @@ export type DevOption = | 'components'
   | 'all'
   | 'email'
   | 'system-tray'
+  /** The camel spelling the parser also supplies, read alongside the kebab. */
+  | 'systemTray'
+  /** `buddy dev dashboard`, which the handler dispatches on. */
+  | 'dashboard'
   | 'interactive'
   | 'browser'
   | 'site'
   | 'verbose';
+/**
+ * The flags `buddy dev` accepts.
+ *
+ * Optional, like every CLI flag: the parsed object carries only what was
+ * typed. Declared required, no real options object satisfied it, so the
+ * handler read its own flags through casts.
+ */
 export type DevOptions = {
-  [key in DevOption]: boolean
+  [key in DevOption]?: boolean
 } & CliOptions;
 export type GeneratorOption = | 'types'
   | 'entries'
@@ -247,7 +261,13 @@ export type LintOptions = {
   [key in LintOption]: boolean
 } & CliOptions;
 export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
-export type MakeBooleanOption = | 'component'
+export type MakeBooleanOption = | 'dry-run'
+  /** `make:policy --register`, which adds the policy to app/Gates.ts. */
+  | 'register'
+  /** Kebab spellings read alongside `withValidation` / `withAuth`. */
+  | 'with-validation'
+  | 'with-auth'
+  | 'component'
   | 'page'
   | 'function'
   | 'language'
@@ -260,10 +280,19 @@ export type MakeBooleanOption = | 'component'
   | 'dryRun'
   | 'withValidation'
   | 'withAuth';
+/**
+ * The flags `buddy make:*` accepts.
+ *
+ * Every key optional, because that is what a CLI flag is: the parsed object
+ * carries only what the user typed. Declared as required, no real options
+ * object ever satisfied it, so `make.ts` reached for `(options).dryRun`
+ * and handed `options` to every make* function - which also meant a
+ * flag that is genuinely absent read as `boolean` rather than `undefined`.
+ */
 export type MakeOptions = {
-  [key in MakeBooleanOption]: boolean
+  [key in MakeBooleanOption]?: boolean
 } & {
-  [key in MakeStringOption]: string
+  [key in MakeStringOption]?: string
 } & CliOptions;
 export type UpgradeBoolean = 'framework' | 'dependencies' | 'bun' | 'shell' | 'binary' | 'all' | 'force' | 'canary' | 'stable' | 'noPostinstall' | 'postinstall';
 export type UpgradeString = 'version' | 'from';

package/dist/cron-jobs.d.ts

@@ -1,3 +1,4 @@
+import type { DeepPartial } from './utils';
 import type { IntRange } from '@stacksjs/cron';
 export declare interface JitterConfig {
   enabled: boolean
@@ -12,16 +13,16 @@ export declare interface BackoffConfig {
   maxDelay?: number
   jitter?: JitterConfig
 }
-export declare interface JobOptions {
+export declare interface JobOptions<T = unknown> {
   name?: string
-  handle?: string | JobHandler
+  handle?: string | JobHandler<T>
   action?: string
   description?: string
   queue?: string
   timezone?: string
   tries?: IntRange<0, 185>
   backoff?: number | number[]
-  backoffConfig?: BackoffConfig
+  backoffConfig?: DeepPartial<BackoffConfig>
   rate?: string | Every
   enabled?: boolean
   timeout?: number
@@ -34,7 +35,16 @@ export type Job = JobOptions;
 export type Jobs = Job[];
 export type CronJob = Job;
 export type CronJobs = Jobs;
-export type JobHandler = (_data?: any) => Promise<any> | any;
+/**
+ * A job's handler, carrying the shape of the payload it expects.
+ *
+ * The parameter used to be `_data?: any`, which meant a job could declare
+ * `handle(payload: { email: string, name: string })` and have nothing enforce
+ * it: `dispatch` took its own unrelated generic, so `dispatch({ emial: … })`,
+ * `dispatch('a bare string')` and even `dispatch()` all compiled against a
+ * job that requires an address. The declared payload was decorative.
+ */
+export type JobHandler<T = unknown> = (_data: T) => Promise<any> | any;
 /**
  * Represents different backoff strategies for job retries
  */

package/dist/docs.d.ts

@@ -1,5 +1,6 @@
 import type { BunPressOptions } from '@stacksjs/bunpress';
 export declare interface DocsUserConfig extends BunPressOptions {
+  lastUpdated?: boolean
   deploy?: boolean
 }
 export declare interface SocialLink {

package/dist/errors.d.ts

@@ -14,6 +14,7 @@ export declare interface ErrorOptions {
     'activeUrl': string
     'alpha': string
     'alphaNumeric': string
+    'minLength': string
     'maxLength': string
     'fixedLength': string
     'confirmed': string

package/dist/file-systems.d.ts

@@ -18,12 +18,15 @@ export declare interface JsonFile {
  * Describes a package.json file.
  */
 export declare interface PackageJson {
-  engines: {
-    node: string
-    pnpm: string
+  name?: string
+  description?: string
+  engines?: {
+    node?: string
+    pnpm?: string
   }
-  version: string
-  packageManager: string
+  version?: string
+  packageManager?: string
+  [key: string]: unknown
 }
 export declare interface FileSystemOptions {
   default: string

package/dist/helpers.d.ts

@@ -1 +1 @@
-export declare function getTypeName(v: any): string;
+export declare function getTypeName(v: unknown): string;

package/dist/index.js

@@ -1,2 +1,2 @@
 // @bun
-function a(e){return typeof e==="object"&&e!==null&&"id"in e&&"userId"in e&&"clientId"in e&&"scopes"in e}function c(e){return a(e)&&"abilities"in e}function d(e){return typeof e==="object"&&e!==null&&"id"in e&&"name"in e&&"secret"in e&&"redirect"in e}var i;((t)=>{t.Second="* * * * * *";t.FiveSeconds="*/5 * * * * *";t.TenSeconds="*/10 * * * * *";t.ThirtySeconds="*/30 * * * * *";t.Minute="* * * * *";t.TwoMinutes="*/2 * * * *";t.FiveMinutes="*/5 * * * *";t.TenMinutes="*/10 * * * *";t.FifteenMinutes="*/15 * * * *";t.ThirtyMinutes="*/30 * * * *";t.Hour="0 * * * *";t.HalfHour="0,30 * * * *";t.Day="0 0 * * *";t.Week="0 0 * * 0";t.Weekday="0 0 * * 1-5";t.Weekend="0 0 * * 0,6";t.Month="0 0 1 * *";t.Year="0 0 1 1 *"})(i||={});var s;((r)=>{r.Bluesky="bluesky";r.Discord="discord";r.Facebook="facebook";r.GitHub="github";r.Instagram="instagram";r.LinkedIn="linkedin";r.Mastodon="mastodon";r.Slack="slack";r.Twitter="twitter";r.YouTube="youtube"})(s||={});var l;((n)=>{n[n.Success=0]="Success";n[n.FatalError=1]="FatalError";n[n.InvalidArgument=9]="InvalidArgument"})(l||={});import{toString as p}from"@stacksjs/strings";function y(e){if(e===null)return"null";let o=p(e).slice(8,-1).toLowerCase();return typeof e==="object"||typeof e==="function"?o:typeof e}function h(e){return e}function T(e){return e}var C={development:{default:"sync",connections:{sync:{driver:"sync"}},failed:{driver:"database",table:"failed_jobs"}},production:{default:"redis",connections:{redis:{driver:"redis",prefix:"stacks:queue",concurrency:5,distributedLock:!0,metrics:{enabled:!0},defaultDeadLetterOptions:{enabled:!0,maxRetries:3}}},failed:{driver:"redis",prefix:"stacks:failed"},worker:{concurrency:5,shutdownTimeout:30000}},highPerformance:{default:"redis",connections:{redis:{driver:"redis",prefix:"stacks:queue",concurrency:20,distributedLock:!0,metrics:{enabled:!0,collectInterval:5000},horizontalScaling:{enabled:!0,maxWorkersPerInstance:20,jobsPerWorker:50},defaultDeadLetterOptions:{enabled:!0,maxRetries:5}}},failed:{driver:"redis",prefix:"stacks:failed"},worker:{concurrency:20,shutdownTimeout:60000}},database:{default:"database",connections:{database:{driver:"database",table:"jobs",queue:"default",retryAfter:90}},failed:{driver:"database",table:"failed_jobs"}}};var M={server:{development:{enabled:!0,mode:"server",debug:!0,server:{host:"localhost",port:6001,scheme:"ws",driver:"bun",rateLimit:{enabled:!1},healthCheck:{enabled:!0,path:"/health"}},channels:{public:!0,private:!0,presence:!0}},production:{enabled:!0,mode:"server",debug:!1,server:{host:"0.0.0.0",port:6001,scheme:"wss",driver:"bun",redis:{enabled:!0,prefix:"stacks:realtime:"},rateLimit:{enabled:!0,maxConnectionsPerIp:100,maxMessagesPerSecond:50,maxPayloadSize:65536},loadManagement:{maxConnections:1e4,backpressureThreshold:1000,messageQueueSize:1e4,gracefulShutdownTimeout:30000},autoScaling:{min:2,max:10,targetCPU:70},healthCheck:{enabled:!0,path:"/health",interval:30},metrics:{enabled:!0,port:9090,path:"/metrics"}},channels:{public:!0,private:!0,presence:!0}},highPerformance:{enabled:!0,mode:"server",server:{driver:"bun",redis:{enabled:!0,cluster:!0},rateLimit:{enabled:!0,maxConnectionsPerIp:500,maxMessagesPerSecond:200,maxPayloadSize:131072},loadManagement:{maxConnections:1e5,backpressureThreshold:5000,messageQueueSize:50000,gracefulShutdownTimeout:60000},autoScaling:{min:4,max:50,targetCPU:60}}},chat:{enabled:!0,mode:"server",server:{driver:"bun",redis:{enabled:!0},rateLimit:{enabled:!0,maxConnectionsPerIp:10,maxMessagesPerSecond:20},loadManagement:{maxConnections:50000}},channels:{public:!0,private:!0,presence:{enabled:!0,maxMembersPerChannel:500,memberInfoTtl:60}}},gaming:{enabled:!0,mode:"server",server:{driver:"bun",redis:{enabled:!0,cluster:!0},rateLimit:{enabled:!0,maxConnectionsPerIp:50,maxMessagesPerSecond:100},loadManagement:{maxConnections:50000,backpressureThreshold:2000,messageQueueSize:20000},autoScaling:{min:2,max:20,targetCPU:50}},channels:{public:!0,private:!0,presence:!0}}},serverless:{development:{enabled:!0,mode:"serverless",debug:!0,serverless:{connectionTimeout:3600,idleTimeout:600,stageName:"dev",memorySize:256,timeout:30},channels:{public:!0,private:!0,presence:!0}},production:{enabled:!0,mode:"serverless",debug:!1,serverless:{connectionTimeout:3600,idleTimeout:600,stageName:"production",memorySize:512,timeout:30,provisionedConcurrency:2},channels:{public:!0,private:!0,presence:!0}},notifications:{enabled:!0,mode:"serverless",serverless:{connectionTimeout:7200,idleTimeout:1800,memorySize:256,timeout:15},channels:{public:!0,private:!0,presence:!1}}}};var S={calendar:{github:"stacksjs/calendar",package:"@stacksjs/calendar",description:"Calendar links, ICS generation, and an STX calendar component"},table:{github:"stacksjs/table",package:"@stacksjs/table",description:"Typed table drivers and an STX data table component"}};export{i as Every,l as ExitCode,C as QueuePresets,M as RealtimePresets,s as SocialLinkIcon,h as defineModel,T as defineModels,y as getTypeName,a as isAccessToken,d as isOAuthClient,c as isPersonalAccessToken,S as stackExtensionRegistry};
+function a(e){return typeof e==="object"&&e!==null&&"id"in e&&"userId"in e&&"clientId"in e&&"scopes"in e}function c(e){return a(e)&&"abilities"in e}function d(e){return typeof e==="object"&&e!==null&&"id"in e&&"name"in e&&"secret"in e&&"redirect"in e}var i;((t)=>{t.Second="* * * * * *";t.FiveSeconds="*/5 * * * * *";t.TenSeconds="*/10 * * * * *";t.ThirtySeconds="*/30 * * * * *";t.Minute="* * * * *";t.TwoMinutes="*/2 * * * *";t.FiveMinutes="*/5 * * * *";t.TenMinutes="*/10 * * * *";t.FifteenMinutes="*/15 * * * *";t.ThirtyMinutes="*/30 * * * *";t.Hour="0 * * * *";t.HalfHour="0,30 * * * *";t.Day="0 0 * * *";t.Week="0 0 * * 0";t.Weekday="0 0 * * 1-5";t.Weekend="0 0 * * 0,6";t.Month="0 0 1 * *";t.Year="0 0 1 1 *"})(i||={});var s;((r)=>{r.Bluesky="bluesky";r.Discord="discord";r.Facebook="facebook";r.GitHub="github";r.Instagram="instagram";r.LinkedIn="linkedin";r.Mastodon="mastodon";r.Slack="slack";r.Twitter="twitter";r.YouTube="youtube"})(s||={});var l;((n)=>{n[n.Success=0]="Success";n[n.FatalError=1]="FatalError";n[n.InvalidArgument=9]="InvalidArgument"})(l||={});import{toString as p}from"@stacksjs/strings";function x(e){if(e===null)return"null";let o=p(e).slice(8,-1).toLowerCase();return typeof e==="object"||typeof e==="function"?o:typeof e}function h(e){return e}function T(e){return e}var C={development:{default:"sync",connections:{sync:{driver:"sync"}},failed:{driver:"database",table:"failed_jobs"}},production:{default:"redis",connections:{redis:{driver:"redis",prefix:"stacks:queue",concurrency:5,distributedLock:!0,metrics:{enabled:!0},defaultDeadLetterOptions:{enabled:!0,maxRetries:3}}},failed:{driver:"redis",prefix:"stacks:failed"},worker:{concurrency:5,shutdownTimeout:30000}},highPerformance:{default:"redis",connections:{redis:{driver:"redis",prefix:"stacks:queue",concurrency:20,distributedLock:!0,metrics:{enabled:!0,collectInterval:5000},horizontalScaling:{enabled:!0,maxWorkersPerInstance:20,jobsPerWorker:50},defaultDeadLetterOptions:{enabled:!0,maxRetries:5}}},failed:{driver:"redis",prefix:"stacks:failed"},worker:{concurrency:20,shutdownTimeout:60000}},database:{default:"database",connections:{database:{driver:"database",table:"jobs",queue:"default",retryAfter:90}},failed:{driver:"database",table:"failed_jobs"}}};var M={server:{development:{enabled:!0,mode:"server",debug:!0,server:{host:"localhost",port:6001,scheme:"ws",driver:"bun",rateLimit:{enabled:!1},healthCheck:{enabled:!0,path:"/health"}},channels:{public:!0,private:!0,presence:!0}},production:{enabled:!0,mode:"server",debug:!1,server:{host:"0.0.0.0",port:6001,scheme:"wss",driver:"bun",redis:{enabled:!0,prefix:"stacks:realtime:"},rateLimit:{enabled:!0,maxConnectionsPerIp:100,maxMessagesPerSecond:50,maxPayloadSize:65536},loadManagement:{maxConnections:1e4,backpressureThreshold:1000,messageQueueSize:1e4,gracefulShutdownTimeout:30000},autoScaling:{min:2,max:10,targetCPU:70},healthCheck:{enabled:!0,path:"/health",interval:30},metrics:{enabled:!0,port:9090,path:"/metrics"}},channels:{public:!0,private:!0,presence:!0}},highPerformance:{enabled:!0,mode:"server",server:{driver:"bun",redis:{enabled:!0,cluster:!0},rateLimit:{enabled:!0,maxConnectionsPerIp:500,maxMessagesPerSecond:200,maxPayloadSize:131072},loadManagement:{maxConnections:1e5,backpressureThreshold:5000,messageQueueSize:50000,gracefulShutdownTimeout:60000},autoScaling:{min:4,max:50,targetCPU:60}}},chat:{enabled:!0,mode:"server",server:{driver:"bun",redis:{enabled:!0},rateLimit:{enabled:!0,maxConnectionsPerIp:10,maxMessagesPerSecond:20},loadManagement:{maxConnections:50000}},channels:{public:!0,private:!0,presence:{enabled:!0,maxMembersPerChannel:500,memberInfoTtl:60}}},gaming:{enabled:!0,mode:"server",server:{driver:"bun",redis:{enabled:!0,cluster:!0},rateLimit:{enabled:!0,maxConnectionsPerIp:50,maxMessagesPerSecond:100},loadManagement:{maxConnections:50000,backpressureThreshold:2000,messageQueueSize:20000},autoScaling:{min:2,max:20,targetCPU:50}},channels:{public:!0,private:!0,presence:!0}}},serverless:{development:{enabled:!0,mode:"serverless",debug:!0,serverless:{connectionTimeout:3600,idleTimeout:600,stageName:"dev",memorySize:256,timeout:30},channels:{public:!0,private:!0,presence:!0}},production:{enabled:!0,mode:"serverless",debug:!1,serverless:{connectionTimeout:3600,idleTimeout:600,stageName:"production",memorySize:512,timeout:30,provisionedConcurrency:2},channels:{public:!0,private:!0,presence:!0}},notifications:{enabled:!0,mode:"serverless",serverless:{connectionTimeout:7200,idleTimeout:1800,memorySize:256,timeout:15},channels:{public:!0,private:!0,presence:!1}}}};var S={calendar:{github:"stacksjs/calendar",package:"@stacksjs/calendar",description:"Calendar links, ICS generation, and an STX calendar component"},table:{github:"stacksjs/table",package:"@stacksjs/table",description:"Typed table drivers and an STX data table component"}};export{i as Every,l as ExitCode,C as QueuePresets,M as RealtimePresets,s as SocialLinkIcon,h as defineModel,T as defineModels,x as getTypeName,a as isAccessToken,d as isOAuthClient,c as isPersonalAccessToken,S as stackExtensionRegistry};

package/dist/library.d.ts

@@ -18,6 +18,30 @@ export declare interface LibraryOptions {
   defaultLanguage: LanguageCode
   webComponents: LibraryBuildOptions
   functions: LibraryBuildOptions
+  packages: LibraryPackageOptions[]
+}
+/**
+ * One releasable package built out of `resources/`.
+ */
+export declare interface LibraryPackageOptions {
+  name: string
+  kind?: LibraryPackageKind
+  dir?: string
+  description?: string
+  keywords?: string[]
+  license?: LicenseType
+  version?: string
+  private?: boolean
+  access?: 'public' | 'restricted'
+  shouldGenerateSourcemap?: boolean
+  include?: string[]
+  exclude?: string[]
+  files?: string[]
+  tags?: TagsOptions
+  prefix?: string
+  runtime?: 'standalone' | 'stx'
+  dependencies?: Record<string, string>
+  peerDependencies?: Record<string, string>
 }
 /**
  * The list of available options to build your library.
@@ -30,6 +54,17 @@ export declare interface LibraryBuildOptions {
   files?: string[]
   tags?: TagsOptions
 }
+/**
+ * What a library package ships.
+ *
+ * - `functions` bundles TypeScript from `resources/functions` into an ESM
+ *   package with declarations.
+ * - `components` compiles `.stx` files from `resources/components` into a
+ *   progressive custom-element library (the stx component-library build).
+ * - `web-components` emits a self-registering `customElements.define(...)`
+ *   bundle for the same sources - the drop-in-a-script-tag flavor.
+ */
+export type LibraryPackageKind = 'functions' | 'components' | 'web-components';
 export type LibraryConfig = Partial<LibraryOptions>;
 /**
  * The name of your "Stack" which generally is your library name

package/dist/payments.d.ts

@@ -7,6 +7,12 @@ export declare interface PaymentOptions {
   stripe: StripeConfig
   currency?: string
   webhook?: WebhookConfig
+  connect?: ConnectConfig
+}
+export declare interface ConnectConfig {
+  enabled: boolean
+  platformFeePercent?: number
+  webhookSecret?: string
 }
 export declare interface StripeConfig {
   publishableKey: string
@@ -319,4 +325,11 @@ export type WebhookEventType = | 'payment_intent.succeeded'
   | 'payment_method.attached'
   | 'payment_method.detached'
   | 'setup_intent.succeeded'
-  | 'setup_intent.setup_failed';
+  | 'setup_intent.setup_failed'
+  // Connect. Delivered to the platform's Connect endpoint, not the account
+  // endpoint, and each carries `event.account` naming the connected account.
+  | 'account.updated'
+  | 'account.application.deauthorized'
+  | 'payout.created'
+  | 'payout.paid'
+  | 'payout.failed';

package/dist/queue.d.ts

@@ -192,6 +192,8 @@ export declare interface QueueJobOptions {
  */
 export declare interface RedisConnectionConfig {
   driver: 'redis'
+  retryAfter?: number
+  queue?: string
   redis?: QueueRedisConfig
   prefix?: string
   defaultJobOptions?: QueueJobOptions
@@ -275,17 +277,16 @@ export declare interface QueueOptions {
     shutdownTimeout?: number
   }
 }
-// @ts-ignore - QueueOption extends JobOptions with compatible overrides
 export declare interface QueueOption extends JobOptions {
   delay?: number
-  payload?: any
-  afterResponse?: any
+  payload?: unknown
+  afterResponse?: unknown
   context?: string
   maxTries?: number
   chainedJobs?: Dispatchable[]
   queue?: string
   priority?: number
-  backoff?: number[] | QueueBackoff
+  backoff?: number | number[]
   timeout?: number
   immediate?: boolean
 }

package/dist/services.d.ts

@@ -143,6 +143,8 @@ export declare interface ServicesOptions {
     secretKey?: string
     publicKey?: string
     webhookSecret?: string
+    appId?: string
+    apiKey?: string
     apiVersion?: string
   }
 }

package/dist/ui.d.ts

@@ -27,6 +27,7 @@ export declare interface WebFontMeta {
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
 export declare interface UiOptions {
+  defaultViews?: boolean | string[]
   shortcuts: Shortcuts
   safelist: string
   trigger?: string

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.72.102",
+  "version": "0.73.0",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "contributors": [
@@ -57,9 +57,9 @@
   },
   "dependencies": {
     "@stacksjs/bunpress": "^0.2.8",
-    "@stacksjs/events": "0.72.102",
+    "@stacksjs/events": "0.73.0",
     "@stacksjs/clapp": "^0.2.12",
-    "@stacksjs/stx": "^0.2.245",
+    "@stacksjs/stx": "^0.2.246",
     "@stacksjs/ts-validation": "^0.5.6",
     "bun-query-builder": "^0.2.53"
   },
@@ -72,7 +72,7 @@
     }
   },
   "devDependencies": {
-    "@stacksjs/validation": "0.72.102",
+    "@stacksjs/validation": "0.73.0",
     "better-dx": "^0.2.24",
     "meilisearch": "^0.59.0"
   },