@stacksjs/types 0.66.0 → 0.68.0

package/dist/search-engine.d.ts

@@ -1,114 +1,88 @@
-import type { EnqueuedTask, Hits, Index, IndexesResults, IndexOptions, MeiliSearch, Settings as MeilisearchOptions, DocumentOptions as RecordOptions, SearchParams, SearchResponse } from "meilisearch";
-import type { MaybePromise } from ".";
-type Search = any;
-type Page = any;
-type Pages = Page[];
-type Filter = any;
-type Filters = Filter[];
-type Result = any;
-type Results = Result[];
-type SearchFilter = any;
-type SearchFilters = SearchFilter[];
-type Sorts = any;
-type Sort = any;
-export interface SearchEngineOptions {
-	/**
-	* **Search Engine Driver**
-	*
-	* The search engine to utilize.
-	*
-	* @default string 'opensearch'
-	* @see https://stacksjs.org/docs/search-engine
-	*/
-	driver: "opensearch";
-	opensearch?: {
-		host: string;
-		protocol: number;
-		port: number;
-		auth: string;
-	};
-	filters?: { [key: string]: string };
-	/**
-	* The number of hits to be returned per page.
-	*
-	* @default number 20
-	*/
-	perPage?: number;
+import type { MaybePromise } from '.';
+
+export type {;
+declare type Search = any
+type Page = any
+type Pages = Page[]
+type Filter = any
+type Filters = Filter[]
+type Result = any
+type Results = Result[]
+type SearchFilter = any
+type SearchFilters = SearchFilter[]
+type Sorts = any
+type Sort = any
+export declare interface SearchEngineOptions {
+  driver: 'opensearch'
+
+
+  opensearch?: {
+    host: string
+    protocol: number
+    port: number
+    auth: string
+  }
+
+  filters?: {
+    [key: string]: string
+  }
+
+  perPage?: number
 }
-export type SearchEngineConfig = Partial<SearchEngineOptions>;
-export interface SearchEngineDriver {
-	client: MeiliSearch;
-	createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>;
-	getIndex: (name: string) => MaybePromise<Index>;
-	updateIndex: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>;
-	deleteIndex: (name: string) => MaybePromise<EnqueuedTask>;
-	updateIndexSettings: (name: string, settings: SearchEngineOptions) => MaybePromise<EnqueuedTask>;
-	listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>;
-	listAllIndices: () => MaybePromise<IndexesResults<Index[]>>;
-	getRecord: (key: string) => MaybePromise<any>;
-	getRecords: (key: string) => MaybePromise<RecordOptions>;
-	createRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
-	createRecords: (records: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
-	createOrReplaceRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
-	createOrUpdateRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
-	deleteRecord: (recordId: string | number, indexName: string) => MaybePromise<EnqueuedTask>;
-	deleteAllRecords: (indexName: string) => MaybePromise<EnqueuedTask>;
-	batchDeleteRecords: (recordIds: string[] | number[], indexName: string) => MaybePromise<EnqueuedTask>;
-	search: (query: string, indexName: string, options: SearchParams) => MaybePromise<Search>;
-	calculatePagination: Pages;
-	currentPage: Page;
-	filterName: string;
-	filters: Filters;
-	goToNextPage: () => Page;
-	goToPage: (pageNumber: number) => Page;
-	goToPrevPage: () => Page;
-	hits: Hits;
-	index: Index;
-	lastPage: Page;
-	perPage: number;
-	query: string;
-	results: Results;
-	searchFilters: SearchFilters;
-	searchParams: SearchParams;
-	setTotalHits: number;
-	sort: Sort;
-	sorts: Sorts;
-	totalPages: number;
+export declare type SearchEngineConfig = Partial<SearchEngineOptions>
+export declare interface SearchEngineDriver {
+  client: MeiliSearch
+
+  createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>
+  getIndex: (name: string) => MaybePromise<Index>
+  updateIndex: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>
+  deleteIndex: (name: string) => MaybePromise<EnqueuedTask>
+  updateIndexSettings: (name: string, settings: SearchEngineOptions) => MaybePromise<EnqueuedTask>
+  listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
+  listAllIndices: () => MaybePromise<IndexesResults<Index[]>> 
+
+  getRecord: (key: string) => MaybePromise<any>
+  getRecords: (key: string) => MaybePromise<RecordOptions>
+  createRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
+  createRecords: (records: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
+  createOrReplaceRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
+  createOrUpdateRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
+  deleteRecord: (recordId: string | number, indexName: string) => MaybePromise<EnqueuedTask>
+  deleteAllRecords: (indexName: string) => MaybePromise<EnqueuedTask>
+  batchDeleteRecords: (recordIds: string[] | number[], indexName: string) => MaybePromise<EnqueuedTask>
+
+  search: (query: string, indexName: string, options: SearchParams) => MaybePromise<Search>
+
+  calculatePagination: Pages
+  currentPage: Page
+  filterName: string
+  filters: Filters
+  goToNextPage: () => Page
+  goToPage: (pageNumber: number) => Page
+  goToPrevPage: () => Page
+  hits: Hits
+  index: Index
+  lastPage: Page
+  perPage: number
+  query: string
+  results: Results 
+  searchFilters: SearchFilters
+  searchParams: SearchParams
+  setTotalHits: number
+  sort: Sort
+  sorts: Sorts
+  totalPages: number
 }
-/**
-* This interface is used to unify the persisting of data to localStorage
-*/
-export interface SearchEngineStorage {
-	/**
-	* 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;
-	/**
-	* The search engine hits object.
-	*/
-	hits?: Hits;
-	/**
-	* The number of hits to be returned per page.
-	*
-	* @default number 20
-	*/
-	perPage: number;
-	/**
-	* The current page number.
-	*
-	* @default number 1
-	*/
-	currentPage: number;
+export declare interface SearchEngineStorage {
+  index?: string
+  results?: SearchResponse
+  hits?: Hits
+  perPage: number
+  currentPage: number
 }
-export interface SearchOptions {
-	searchable: string[];
-	sortable: string[];
-	filterable: string[];
-	options?: SearchEngineOptions;
-}
-export type { EnqueuedTask, Hits, Index, IndexesResults, IndexOptions, MeiliSearch, MeilisearchOptions, RecordOptions, SearchParams, SearchResponse };
+export declare interface SearchOptions {
+  searchable: string[]
+  sortable: string[]
+  filterable: string[]
+  options?: SearchEngineOptions
+}

package/dist/security.d.ts

@@ -1,18 +1,20 @@
-import type { CountryCode } from "./cloud";
-import type { DeepPartial } from "./utils";
-export interface FirewallOptions {
-	enabled: boolean;
-	countryCodes: CountryCode[];
-	ipAddresses: string[];
-	queryString: string[];
-	httpHeaders: string[];
-	rateLimitPerMinute: number;
-	useIpReputationLists: boolean;
-	useKnownBadInputsRuleSet: boolean;
+import type { CountryCode } from './cloud';
+import type { DeepPartial } from './utils';
+
+export declare interface FirewallOptions {
+  enabled: boolean 
+  countryCodes: CountryCode[]
+  ipAddresses: string[]
+  queryString: string[]
+  httpHeaders: string[]
+  rateLimitPerMinute: number
+  useIpReputationLists: boolean
+  useKnownBadInputsRuleSet: boolean
 }
-export type FirewallConfig = Partial<FirewallOptions>;
-export interface SecurityOptions {
-	driver: "aws";
-	firewall: FirewallOptions;
+export declare type FirewallConfig = Partial<FirewallOptions>
+export declare interface SecurityOptions {
+  driver: 'aws'
+
+  firewall: FirewallOptions
 }
-export type SecurityConfig = DeepPartial<SecurityOptions>;
+export declare type SecurityConfig = DeepPartial<SecurityOptions>

package/dist/server.d.ts

@@ -1,6 +1,16 @@
-export interface ServerOptions {
-	type?: "frontend" | "backend" | "api" | "library" | "desktop" | "docs" | "email" | "admin" | "system-tray" | "database";
-	host?: string;
-	port?: number;
-	open?: boolean;
-}
+export declare interface ServerOptions {
+  type?:
+    | 'frontend'
+    | 'backend'
+    | 'api'
+    | 'library'
+    | 'desktop'
+    | 'docs'
+    | 'email'
+    | 'admin'
+    | 'system-tray'
+    | 'database'
+  host?: string
+  port?: number
+  open?: boolean
+}

package/dist/services.d.ts

@@ -1,29 +1,35 @@
-export interface ServicesOptions {
-	algolia?: {
-		appId: string;
-		apiKey: string;
-	};
-	godaddy?: {
-		apiKey: string;
-		apiSecret: string;
-	};
-	meilisearch?: {
-		appId: string;
-		apiKey: string;
-	};
-	lemonSqueezy?: {
-		appId: string;
-		apiKey: string;
-	};
-	stripe?: {
-		appId: string;
-		apiKey: string;
-	};
-	aws?: {
-		accountId: string;
-		appId: string;
-		apiKey: string;
-		region: string;
-	};
+export declare interface ServicesOptions {
+  algolia?: {
+    appId: string
+    apiKey: string
+  }
+
+  godaddy?: {
+    apiKey: string
+    apiSecret: string
+  }
+
+  meilisearch?: {
+    appId: string
+    apiKey: string
+  }
+
+  lemonSqueezy?: {
+    appId: string
+    apiKey: string
+  }
+
+  stripe?: {
+    appId: string
+    apiKey: string
+  }
+
+
+  aws?: {
+    accountId: string
+    appId: string
+    apiKey: string
+    region: string
+  }
 }
-export type ServicesConfig = Partial<ServicesOptions>;
+export declare type ServicesConfig = Partial<ServicesOptions>

package/dist/settings-config.d.ts

@@ -1,9 +1,9 @@
-export interface SettingsMenuOption {
-	label: string;
-	path: string;
-	icon?: MenuIcon;
-}
-export interface MenuIcon {
-	name?: string;
-	source?: string;
+export declare interface SettingsMenuOption {
+  label: string
+  path: string
+  icon?: MenuIcon
 }
+export declare interface MenuIcon {
+  name?: string
+  source?: string
+}

package/dist/ssg.d.ts

@@ -1,2 +1,3 @@
-import type { ViteSSGContext } from ".";
-export type UserModule = (ctx: ViteSSGContext) => void;
+import type { ViteSSGContext } from '.';
+
+export declare type UserModule = (ctx: ViteSSGContext) => void

package/dist/stacks.d.ts

@@ -1,204 +1,54 @@
-import type { AiConfig, AnalyticsConfig, AppConfig, BinaryConfig, CacheConfig, CloudConfig, DatabaseConfig, DnsConfig, DocsConfig, EmailConfig, ErrorConfig, GitConfig, HashingConfig, LibraryConfig, LoggingConfig, NotificationConfig, PaymentConfig, Ports, QueueConfig, SearchEngineConfig, SecurityConfig, ServicesConfig, StorageConfig, Team, UiConfig } from ".";
-/**
-* **Stacks Options**
-*
-* This configuration defines all of your Stacks 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 StacksOptions {
-	ai: AiConfig;
-	/**
-	* **Analytics Options**
-	*
-	* This configuration defines all of your Analytics 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.
-	*/
-	analytics: AnalyticsConfig;
-	/**
-	* **Application Options**
-	*
-	* This configuration defines all of your Application 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.
-	*/
-	app: AppConfig;
-	/**
-	* **Cache Options**
-	*
-	* This configuration defines all of your Cache 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.
-	*/
-	cache: CacheConfig;
-	/**
-	* **CLI / Binary Options**
-	*
-	* This configuration defines all of your Binary 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.
-	*/
-	cli: BinaryConfig;
-	/**
-	* **Cloud Options**
-	*
-	* This configuration defines all of your Cloud 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.
-	*/
-	cloud: CloudConfig;
-	/**
-	* **Database Options**
-	*
-	* This configuration defines all of your Database 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.
-	*/
-	database: DatabaseConfig;
-	/**
-	* **DNS Options**
-	*
-	* This configuration defines all of your DNS 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.
-	*/
-	dns: DnsConfig;
-	/**
-	* **Docs Options**
-	*
-	* This configuration defines all of your Docs 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.
-	*/
-	docs: DocsConfig;
-	/**
-	* **Email Options**
-	*
-	* This configuration defines all of your Email 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.
-	*/
-	email: EmailConfig;
-	/**
-	* **Errors Options**
-	*
-	* This configuration defines all of your Errors 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.
-	*/
-	errors: ErrorConfig;
-	/**
-	* **Git Options**
-	*
-	* This configuration defines all of your Git 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.
-	*/
-	git: GitConfig;
-	/**
-	* **Hashing Options**
-	*
-	* This configuration defines all of your Hashing 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.
-	*/
-	hashing: HashingConfig;
-	/**
-	* **Library Options**
-	*
-	* This configuration defines all of your Library 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.
-	*/
-	library: LibraryConfig;
-	/**
-	* **Logging Options**
-	*
-	* This configuration defines all of your logging 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.
-	*/
-	logging: LoggingConfig;
-	/**
-	* **Notification Options**
-	*
-	* This configuration defines all of your Notification 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.
-	*/
-	notification: NotificationConfig;
-	/**
-	* **Payment Options**
-	*
-	* This configuration defines all of your Payment 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.
-	*/
-	payment: PaymentConfig;
-	/**
-	* **Ports**
-	*
-	* This configuration defines all of your Ports 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.
-	*/
-	ports: Ports;
-	/**
-	* **Queue Options**
-	*
-	* This configuration defines all of your Queue 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.
-	*/
-	queue: QueueConfig;
-	/**
-	* **Search Engine Options**
-	*
-	* This configuration defines all of your Search 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.
-	*/
-	security: SecurityConfig;
-	/**
-	* **Search Engine Options**
-	*
-	* This configuration defines all of your Search 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.
-	*/
-	searchEngine: SearchEngineConfig;
-	/**
-	* **Services Options**
-	*
-	* This configuration defines all of your Services 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.
-	*/
-	services: ServicesConfig;
-	/**
-	* **Storage Options**
-	*
-	* This configuration defines all of your Storage 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.
-	*/
-	storage: StorageConfig;
-	/**
-	* **Team Members**
-	*
-	* This configuration defines all of your Team members. 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.
-	*/
-	team: Team;
-	/**
-	* **UI Options**
-	*
-	* This configuration defines all of your UI 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.
-	*/
-	ui: UiConfig;
+export declare interface StacksOptions {
+  ai: AiConfig
+
+  analytics: AnalyticsConfig
+
+  app: AppConfig
+
+  cache: CacheConfig
+
+  cli: BinaryConfig
+
+  cloud: CloudConfig
+
+  database: DatabaseConfig
+
+  dns: DnsConfig
+
+  docs: DocsConfig
+
+  email: EmailConfig
+
+  errors: ErrorConfig
+
+  git: GitConfig
+
+  hashing: HashingConfig
+
+  library: LibraryConfig
+
+  logging: LoggingConfig
+
+  notification: NotificationConfig
+
+  payment: PaymentConfig
+
+  ports: Ports
+
+  queue: QueueConfig
+
+  saas: SaasConfig
+
+  security: SecurityConfig
+
+  searchEngine: SearchEngineConfig
+
+  services: ServicesConfig
+
+  storage: StorageConfig
+
+  team: Team
+
+  ui: UiConfig
 }
-export type StacksConfig = Partial<StacksOptions>;
+export declare type StacksConfig = Partial<StacksOptions>

package/dist/storage.d.ts

@@ -1,12 +1,30 @@
-export interface StorageOptions {
-	/**
-	* **Storage Driver**
-	*
-	* The storage driver to utilize.
-	*
-	* @default string 's3'
-	* @see https://stacksjs.org/docs/storage
-	*/
-	driver: "s3" | "efs" | "local";
+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 type StorageConfig = Partial<StorageOptions>;
+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>
+}