@stacksjs/types 0.67.0 → 0.68.0

package/dist/storage.d.ts

@@ -1,37 +1,30 @@
-import type { ChecksumOptions, DirectoryListing, FileContents, MimeTypeOptions, PublicUrlOptions, StatEntry, TemporaryUrlOptions } from "@flystorage/file-storage";
-import type { Buffer } from "node:buffer";
-export interface StorageOptions {
-	/**
-	* **Storage Driver**
-	*
-	* The storage driver to utilize.
-	*
-	* @default string 's3'
-	* @see https://stacksjs.org/docs/storage
-	*/
-	driver: "s3" | "efs" | "local";
-}
-export type StorageConfig = Partial<StorageOptions>;
-export interface StorageDriver {
-	list: (path: string, options?: any) => DirectoryListing;
-	changeVisibility: (path: string, visibility: string) => Promise<void>;
-	visibility: (path: string) => Promise<string>;
-	fileExists: (path: string) => Promise<boolean>;
-	directoryExists: (path: string) => Promise<boolean>;
-	publicUrl: (path: string, options: PublicUrlOptions) => Promise<string>;
-	temporaryUrl: (path: string, options: TemporaryUrlOptions) => Promise<string>;
-	checksum: (path: string, options: ChecksumOptions) => Promise<string>;
-	mimeType: (path: string, options: MimeTypeOptions) => Promise<string>;
-	lastModified: (path: string) => Promise<number>;
-	fileSize: (path: string) => Promise<number>;
-	read: (path: string) => Promise<FileContents>;
-	readToString: (path: string) => Promise<string>;
-	readToBuffer: (path: string) => Promise<Buffer>;
-	readToUint8Array: (path: string) => Promise<Uint8Array>;
-	deleteFile: (path: string) => Promise<void>;
-	copyFile: (from: string, to: string) => Promise<void>;
-	moveFile: (from: string, to: string) => Promise<void>;
-	stat: (path: string) => Promise<StatEntry>;
-	createDirectory: (path: string) => Promise<void>;
-	write: (path: string, contents: FileContents) => Promise<void>;
+import type { Buffer } from 'node:buffer';
+import type { ChecksumOptions, DirectoryListing, FileContents, MimeTypeOptions, PublicUrlOptions, StatEntry, TemporaryUrlOptions } from '@flystorage/file-storage';
+
+export declare interface StorageOptions {
+  driver: 's3' | 'efs' | 'local'
 }
+export declare type StorageConfig = Partial<StorageOptions>
+export declare interface StorageDriver {
+  list: (path: string, options?: any) => DirectoryListing
+  changeVisibility: (path: string, visibility: string) => Promise<void>
+  visibility: (path: string) => Promise<string>
+  fileExists: (path: string) => Promise<boolean>
+  directoryExists: (path: string) => Promise<boolean>
+  publicUrl: (path: string, options: PublicUrlOptions) => Promise<string>
+  temporaryUrl: (path: string, options: TemporaryUrlOptions) => Promise<string>
+  checksum: (path: string, options: ChecksumOptions) => Promise<string>
+  mimeType: (path: string, options: MimeTypeOptions) => Promise<string>
+  lastModified: (path: string) => Promise<number>
+  fileSize: (path: string) => Promise<number>
+  read: (path: string) => Promise<FileContents>
+  readToString: (path: string) => Promise<string>
+  readToBuffer: (path: string) => Promise<Buffer>
+  readToUint8Array: (path: string) => Promise<Uint8Array>
+  deleteFile: (path: string) => Promise<void>
+  copyFile: (from: string, to: string) => Promise<void>
+  moveFile: (from: string, to: string) => Promise<void>
+  stat: (path: string) => Promise<StatEntry>
+  createDirectory: (path: string) => Promise<void>
+  write: (path: string, contents: FileContents) => Promise<void>
+}

package/dist/tables.d.ts

@@ -1,52 +1,34 @@
-import type { Hits, SearchResponse } from "meilisearch";
-/**
-* the TableStore interface is primarily used to unify the persisting of data to localStorage
-*/
-export interface TableStore {
-	/**
-	* The search engine index name.
-	* i.e. the type of table, like `users`, `posts`, `products`, etc.
-	*/
-	index: string;
-	/**
-	* The search engine results object.
-	*/
-	results?: SearchResponse<Record<string, any>>;
-	/**
-	* The search engine hits object.
-	*/
-	hits?: Hits;
-	columns: string[];
-	source?: string;
-	password?: string;
-	searchable?: string | boolean;
-	query?: string;
-	sortable?: string | boolean;
-	sort?: string;
-	sorts?: string | string[];
-	filterable?: string | boolean;
-	filters?: string | string[];
-	filterValue?: any[];
-	actionable?: string | boolean;
-	actions?: string | string[];
-	perPage: number;
-	selectable?: string | boolean;
-	selectedRows?: number[] | string[];
-	selectedAll?: boolean;
-	goToNextPage: number;
-	goToPage: number;
-	goToPrevPage: number;
-	lastPageNumber: number;
-	searchFilters?: object;
-	searchParams?: object;
-	setTotalHits: number;
-	/**
-	*
-	* The current page number
-	* @default 1
-	* @type {number}
-	* @memberof TableStore
-	* @example 1
-	*/
-	currentPage: number;
-}
+import type { Hits, SearchResponse } from 'meilisearch';
+
+export declare interface TableStore {
+  index: string
+  results?: SearchResponse<Record<string, any>> 
+  hits?: Hits
+
+  columns: string[] 
+  source?: string 
+  password?: string 
+  searchable?: string | boolean 
+  query?: string 
+  sortable?: string | boolean 
+  sort?: string 
+  sorts?: string | string[] 
+  filterable?: string | boolean 
+  filters?: string | string[] 
+  filterValue?: any[] 
+  actionable?: string | boolean 
+  actions?: string | string[] 
+  perPage: number 
+  selectable?: string | boolean 
+  selectedRows?: number[] | string[] 
+  selectedAll?: boolean 
+  goToNextPage: number
+  goToPage: number
+  goToPrevPage: number
+  lastPageNumber: number
+  searchFilters?: object
+  searchParams?: object
+  setTotalHits: number
+
+  currentPage: number
+}

package/dist/team.d.ts

@@ -1,8 +1,7 @@
-type TeamMemberName = string;
-type Email = string;
-type TeamMembers = Record<TeamMemberName, Email>;
-export interface Team {
-	name: string;
-	members?: TeamMembers;
-}
-export {};
+declare type TeamMemberName = string
+type Email = string
+type TeamMembers = Record<TeamMemberName, Email>
+export declare interface Team {
+  name: string
+  members?: TeamMembers
+}

package/dist/ui.d.ts

@@ -1,165 +1,42 @@
-import type { UserConfig } from "@unocss/core";
-import type { UserShortcuts } from "unocss";
-export type Font = "inter" | "mona" | "hubot";
-export type Icon = "heroicons";
-export type WebFontsProviders = "google" | "bunny" | "fontshare";
-export type Shortcuts = UserShortcuts;
-export interface FontInfo {
-	title: string;
-	text: string;
+import type { UserConfig } from '@unocss/core';
+import type { UserShortcuts } from 'unocss';
+
+export declare type Font = 'inter' | 'mona' | 'hubot'
+export type Icon = 'heroicons'
+export declare type WebFontsProviders = 'google' | 'bunny' | 'fontshare'
+export type Shortcuts = UserShortcuts
+export declare interface FontInfo {
+  title: string
+  text: string
 }
-export interface WebFontMeta {
-	name: string;
-	weights?: (string | number)[];
-	italic?: boolean;
-	provider?: WebFontsProviders;
+export declare interface WebFontMeta {
+  name: string
+  weights?: (string | number)[]
+  italic?: boolean
+  provider?: WebFontsProviders
 }
-/**
-* **UI Engine Options**
-*
-* This type defines all of your UI Engine 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 UiOptions {
-	/**
-	* **Shortcuts**
-	*
-	* Shortcuts provide you with the ability to combine
-	* utility names for reusability purposes.
-	*
-	* @example
-	* ```
-	* config: {
-	*   shortcuts: {
-	*     'btn': 'px-4 py-2 rounded text-white bg-blue-500',
-	*     'btn-lg': 'btn px-6 py-3',
-	*   }
-	* }
-	* ```
-	*/
-	shortcuts: Shortcuts;
-	/**
-	* **Safelist**
-	*
-	* Use the `safelist` option to ensure the generation of
-	* those utility classes. This is useful when certain
-	* class names don’t exist in your content files.
-	*
-	* @example
-	* ```ts
-	* safelist: [
-	*   'btn',
-	*   'btn-lg',
-	*   'btn-blue',
-	*   'btn-blue-500',
-	* ]
-	*/
-	safelist: string;
-	/**
-	* **Trigger String**
-	*
-	* The "trigger string" defines the class name markup
-	* you want to add into your components.
-	*
-	* @default ':stx:'
-	*
-	* @example
-	* ```ts
-	* trigger: ':stx:'
-	* ```
-	*/
-	trigger?: string;
-	/**
-	* **Class Prefix**
-	*
-	* The prefix for the compiled class name. When transforming
-	* all utility classes into a single class, this prefix
-	* will be added to the generated CSS class name.
-	*
-	* @default 'stx-'
-	*
-	* @example
-	* ```ts
-	* prefix: 'stx-'
-	* ```
-	*/
-	classPrefix?: string;
-	/**
-	* **Hash Function**
-	*
-	* The hash function used to generate the class name.
-	*
-	* @example
-	* ```ts
-	* hash: (str: string) => {
-	*   return str
-	*     .split('')
-	*     .reduce((a, b) => {
-	*       a = ((a << 5) - a) + b.charCodeAt(0)
-	*       return a & a
-	*     }, 0)
-	*     .toString(36)
-	* }
-	*/
-	hashFn?: (str: string) => string;
-	/**
-	* **CSS Resets—Preset**
-	*
-	* Define a standard of reset CSS stylesheets. By default, the Tailwind
-	* reset styles are utilized. You may set this value to `null`
-	* if you prefer not applying any default stylesheets.
-	*
-	* @url https://www.npmjs.com/package/@unocss/reset
-	* @todo preset needs to be added via a Vite plugin on development & build
-	* @example
-	* ```ts
-	* reset: 'tailwind'
-	* ```
-	*/
-	reset?: ResetPreset;
-	/**
-	* **Fonts**
-	*
-	* Define the fonts you want to use. By default, Stacks provides support
-	* for several local font providers. You may set this value to
-	* `null` if you prefer not utilize any local fonts.
-	*
-	* @see https://stacksjs.org/docs/fonts
-	* ```
-	*/
-	fonts?: any;
-	useWebFonts?: boolean | WebFontsProviders;
-	/**
-	* **Icon Sets**
-	*
-	* This value defines the icon sets you want to use. When using icons, they
-	* are displayed utilizing a technique called "icons in pure css."
-	* Learn more here https://antfu.me/posts/icons-in-pure-css.
-	*
-	* @see https://stacks.ow3.org/config/icons — list of available icon sets
-	* @todo implement this into Vite build flow
-	* @example
-	* ```ts
-	* icons: ['heroicons']
-	* ```
-	* @example
-	* ```html
-	* <i class="i-heroicons-outline-book-open w-8 h-8 text-gray-500" aria-hidden="true" />
-	* ```
-	*/
-	icons: Icon | Icon[];
-	theme: UserConfig["theme"];
-	variants: UserConfig["variants"];
-	layers: UserConfig["layers"];
+export declare interface UiOptions {
+  shortcuts: Shortcuts
+
+  safelist: string
+
+  trigger?: string
+
+  classPrefix?: string
+
+  hashFn?: (str: string) => string
+
+  reset?: ResetPreset
+
+  fonts?: any
+
+  useWebFonts?: boolean | WebFontsProviders
+
+  icons: Icon | Icon[]
+
+  theme: UserConfig['theme']
+  variants: UserConfig['variants']
+  layers: UserConfig['layers']
 }
-export type UiConfig = Partial<UiOptions>;
-/**
-* **Style Reset — Preset**
-*
-* This value sets the "reset preset." A preset defines certain
-* CSS defaults to be applied.
-*
-* @default "tailwind"
-*/
-export type ResetPreset = "tailwind" | "normalize" | "sanitize" | "eric-meyer" | "antfu" | null;
+export declare type UiConfig = Partial<UiOptions>
+export declare type ResetPreset = 'tailwind' | 'normalize' | 'sanitize' | 'eric-meyer' | 'antfu' | null

package/dist/utils.d.ts

@@ -1,30 +1,20 @@
-/**
-* Null or whatever.
-*/
-export type Nullable<T> = T | null | undefined;
-/**
-* Function
-*/
-export type Fn<T = void> = () => T;
-/**
-* Array, or not yet
-*/
-export type Arrayable<T> = T | Array<T>;
-/**
-* Constructor.
-*/
-export type Constructor<T = void> = new (...args: any[]) => T;
-/**
-* Defines an intersection type of all union items.
-*
-* @param U Union of any types that will be intersected.
-* @returns U items intersected
-* @see https://stackoverflow.com/a/50375286/9259330
-*/
-export type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-export type MergeInsertions<T> = T extends object ? { [K in keyof T] : MergeInsertions<T[K]> } : T;
-export type DeepMerge<
-	F,
-	S
-> = MergeInsertions<{ [K in keyof F | keyof S] : K extends keyof S & keyof F ? DeepMerge<F[K], S[K]> : K extends keyof S ? S[K] : K extends keyof F ? F[K] : never }>;
-export type DeepPartial<T> = { [P in keyof T]? : DeepPartial<T[P]> };
+export declare type Nullable<T> = T | null | undefined
+export declare type Fn<T = void> = () => T
+export declare type Arrayable<T> = T | Array<T>
+export declare type Constructor<T = void> = new (...args: any[]) => T
+export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void
+  ? I
+  : never
+export declare type MergeInsertions<T> = T extends object ? { [K in keyof T]: MergeInsertions<T[K]> } : T
+export declare type DeepMerge<F, S> = MergeInsertions<{
+  [K in keyof F | keyof S]: K extends keyof S & keyof F
+    ? DeepMerge<F[K], S[K]>
+    : K extends keyof S
+      ? S[K]
+      : K extends keyof F
+        ? F[K]
+        : never
+}>
+export declare type DeepPartial<T> = {
+  [P in keyof T]?: DeepPartial<T[P]>
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.67.0",
+  "version": "0.68.0",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "contributors": [
@@ -47,10 +47,10 @@
     "@mdit-vue/plugin-component": "^2.1.3",
     "@mdit-vue/plugin-frontmatter": "^2.1.3",
     "@mdit-vue/types": "^2.1.0",
-    "@rollup/pluginutils": "^5.1.2",
+    "@rollup/pluginutils": "^5.1.3",
     "@stacksjs/validation": "0.67.0",
     "@types/aws4": "^1.11.6",
-    "@types/bun": "^1.1.11",
+    "@types/bun": "^1.1.12",
     "@types/crypto-js": "^4.2.2",
     "@types/fs-extra": "^11.0.4",
     "@types/markdown-it-link-attributes": "^3.0.5",
@@ -60,20 +60,20 @@
     "cac": "^6.7.14",
     "markdown-it": "^14.1.0",
     "meilisearch": "^0.44.1",
-    "neverthrow": "^8.0.0",
+    "neverthrow": "^8.1.1",
     "ora": "^8.1.0",
     "unocss": "0.61.0",
     "unplugin-auto-import": "^0.18.3",
     "unplugin-vue-components": "^0.27.4",
-    "vite": "^5.4.8",
+    "vite": "^5.4.10",
     "vite-plugin-inspect": "^0.8.7",
     "vite-plugin-pwa": "^0.20.5",
     "vite-ssg": "^0.23.8",
-    "vitepress": "1.4.0",
-    "vue": "^3.5.11"
+    "vitepress": "1.4.1",
+    "vue": "^3.5.12"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.161.1",
+    "aws-cdk-lib": "^2.164.1",
     "typescript": "^5.6.3"
   }
 }

package/src/cli.ts

@@ -362,6 +362,8 @@ export type DomainsOptions = CliOptions & {
 }
 
 export interface CleanOptions extends CliOptions {}
+
+export interface SaasOptions extends CliOptions {}
 export interface CloudCliOptions extends CliOptions {
   ssh?: boolean
   connect?: boolean

package/src/cloud.ts

@@ -254,13 +254,15 @@ export type CountryCode =
 
 type Environment = 'development' | 'staging' | 'production'
 
-export interface CloudOptions {
-  type: 'serverless' // | 'server' coming soon
+interface SiteConfig {
+  domain: string
+  path: string
+}
 
+type InfrastuctureOptions = Partial<{
+  type: 'serverless' // | 'server' coming soon
   driver: 'aws'
-
   api: ApiConfig
-
   storage: object
 
   /**
@@ -325,6 +327,16 @@ export interface CloudOptions {
   cli: boolean
   docs: boolean
   fileSystem: boolean
+}>
+
+export interface CloudOptions {
+  sites: {
+    root: string
+    path: string
+    [site: string]: string | SiteConfig
+  }
+
+  infrastructure: InfrastuctureOptions
 }
 
 export type CloudConfig = Partial<CloudOptions>

package/src/errors.ts

@@ -9,6 +9,14 @@
 
 export type CommandError = Error
 
+export interface ErrorResponse {
+  status: number // HTTP status code
+  errors: string | object // Error message(s), which can be a string or an object
+  stack?: string // Optional stack trace
+  name: string
+  message: string
+}
+
 export interface ErrorOptions {
   messages: {
     'string': string

package/src/index.ts

@@ -46,6 +46,7 @@ export * from './queue'
 export * from './reactivity'
 export * from './request'
 export * from './router'
+export * from './saas'
 export * from './scheduler'
 export * from './search-engine'
 export * from './security'

package/src/model-names.ts

@@ -1 +1 @@
-export type ModelNames = 'Project' | 'SubscriberEmail' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'Release' | 'User' | 'Post'
+export type ModelNames = 'Project' | 'SubscriberEmail' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'Release' | 'User' | 'Post' | 'Subscription' | 'Error'

package/src/model.ts

@@ -110,6 +110,7 @@ export interface ModelOptions extends Base {
     searchable?: boolean | SearchOptions // useSearch alias
     useApi?: ApiOptions | boolean
     observe?: string[] | boolean
+    billable?: boolean
     useActivityLog?: boolean | ActivityLogOption
   }
 
@@ -146,6 +147,10 @@ export interface ModelOptions extends Base {
     relationName?: string
   }[]
 
+  scopes?: {
+    [key: string]: (value: any) => any
+  }
+
   get?: {
     [key: string]: (value: any) => any
   }
@@ -181,6 +186,7 @@ export interface RelationConfig {
   relationModel?: string
   relationTable?: string
   foreignKey: string
+  modelKey: string
   relationName?: string
   throughModel?: string
   throughForeignKey?: string

package/src/payments.ts

@@ -1,5 +1,12 @@
+import type Stripe from 'stripe'
+
 export interface PaymentOptions {
   driver: 'stripe'
+
+  stripe: {
+    publishableKey: string
+    secretKey: string
+  }
 }
 
 export type PaymentConfig = Partial<PaymentOptions>
@@ -17,6 +24,21 @@ export interface ChargeOptions {
   }
 }
 
+export interface StripeCustomerOptions {
+  address?: {
+    line1?: string
+    city?: string
+    state?: string
+    postal_code?: string
+    country?: string
+  }
+  name?: string
+  phone?: string
+  metadata?: Stripe.Emptyable<Stripe.MetadataParam>
+  email?: string
+  preferred_locales?: string[]
+}
+
 export interface CustomerOptions {
   description?: string
   address?: string
@@ -63,3 +85,13 @@ export interface EventOptions {
     type?: string
   }
 }
+
+export interface CheckoutLineItem {
+  priceId: string
+  quantity: number
+}
+
+export interface CheckoutOptions extends Partial<Stripe.Checkout.SessionCreateParams> {
+  enableTax?: boolean
+  allowPromotions?: boolean
+}

package/src/saas.ts

@@ -0,0 +1,33 @@
+export interface SaasOption {
+  plans: {
+    productName: string
+    description: string
+    pricing: {
+      key: string
+      price: number
+      interval: 'day' | 'month' | 'week' | 'year'
+      currency: string
+    }[]
+    metadata: {
+      createdBy: string
+      version: string
+    }
+  }[]
+  webhook: {
+    endpoint: string
+    secret: string
+  }
+  currencies: string[]
+  coupons: {
+    code: string
+    amountOff: number
+    duration: 'once' | 'repeating' | 'forever'
+  }[]
+  products: {
+    name: string
+    description: string
+    images: string[]
+  }[]
+}
+
+export type SaasConfig = Partial<SaasOption>