@stacksjs/types 0.58.72 → 0.59.1

package/dist/router.d.ts

@@ -0,0 +1,78 @@
+import type { Action } from '@stacksjs/actions';
+import type { ActionPath } from '~/storage/framework/types/actions';
+export interface NitroEventHandler {
+    /**
+     * Path prefix or route
+     *
+     * If an empty string used, will be used as a middleware
+     */
+    route?: string;
+    /**
+     * Specifies this is a middleware handler.
+     * Middleware are called on every route and should normally return nothing to pass to the next handlers
+     */
+    middleware?: boolean;
+    /**
+     * Use lazy loading to import handler
+     */
+    lazy?: boolean;
+    /**
+     * Path to event handler
+     *
+     */
+    handler: string;
+    /**
+     * Router method matcher
+     */
+    method?: string;
+}
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'before' | 'after' | 'view';
+export type RouteCallback = (params?: Record<string, any>) => any | string | object;
+export interface Route {
+    name: string;
+    uri: string;
+    url: string;
+    method: HttpMethod;
+    pattern: RegExp;
+    callback: RouteCallback | ActionPath | Action | Promise<any>;
+    paramNames: string[];
+    middleware?: string | string[];
+    statusCode?: StatusCode;
+}
+export interface MiddlewareOptions {
+    name: string;
+    description?: string;
+    priority: number;
+    handle: Function;
+}
+export type StatusCode = 200 | 201 | 202 | 204 | 301 | 302 | 304 | 400 | 401 | 403 | 404 | 500;
+export type RedirectCode = Extract<StatusCode, 301 | 302>;
+export type MiddlewareFn = () => void;
+export interface Middlewares {
+    logger: MiddlewareFn;
+    auth: MiddlewareFn;
+    [key: string]: MiddlewareFn;
+}
+export interface RouteGroupOptions {
+    prefix?: string;
+    middleware?: Route['middleware'];
+}
+type Prefix = string;
+export interface RouterInterface {
+    get: (url: Route['url'], callback: Route['callback']) => Promise<this>;
+    post: (url: Route['url'], callback: Route['callback']) => this;
+    view: (url: Route['url'], callback: Route['callback']) => this;
+    redirect: (url: Route['url'], callback: Route['callback'], status?: RedirectCode) => this;
+    delete: (url: Route['url'], callback: Route['callback']) => this;
+    patch: (url: Route['url'], callback: Route['callback']) => this;
+    put: (url: Route['url'], callback: Route['callback']) => this;
+    email: (url: Route['url']) => Promise<this>;
+    health: () => Promise<this>;
+    job: (url: Route['url']) => Promise<this>;
+    action: (url: Route['url']) => Promise<this>;
+    group: (options: Prefix | RouteGroupOptions, callback: () => void) => this;
+    name: (name: string) => this;
+    middleware: (middleware: Route['middleware']) => this;
+    getRoutes: () => Promise<Route[]>;
+}
+export {};

package/dist/scheduler.d.ts

@@ -0,0 +1 @@
+export type { Schedule } from '@stacksjs/scheduler';

package/dist/search-engine.d.ts

@@ -0,0 +1,118 @@
+import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchEngineSettings, 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 'meilisearch'
+     * @see https://stacksjs.org/docs/search-engine
+     */
+    driver: 'meilisearch' | 'algolia' | 'opensearch';
+    meilisearch?: {
+        host: string;
+        apiKey: string;
+    };
+    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;
+}
+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: SearchEngineSettings) => 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 interface MeiliSearchOptions {
+    apiKey: string;
+    host: string;
+}
+export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchEngineSettings, SearchParams, SearchResponse };

package/dist/security.d.ts

@@ -0,0 +1,18 @@
+import type { DeepPartial } from './utils';
+import type { CountryCode } from './cloud';
+export 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 type SecurityConfig = DeepPartial<SecurityOptions>;

package/dist/services.d.ts

@@ -0,0 +1,33 @@
+export interface ServicesOptions {
+    algolia?: {
+        appId: string;
+        apiKey: string;
+    };
+    godaddy?: {
+        apiKey: string;
+        apiSecret: string;
+    };
+    meilisearch?: {
+        appId: string;
+        apiKey: string;
+    };
+    stripe?: {
+        appId: string;
+        apiKey: string;
+    };
+    planetscale?: {
+        appId: string;
+        apiKey: string;
+    };
+    supabase?: {
+        appId: string;
+        apiKey: string;
+    };
+    aws?: {
+        accountId: string;
+        appId: string;
+        apiKey: string;
+        region: string;
+    };
+}
+export type ServicesConfig = Partial<ServicesOptions>;

package/dist/sms.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/ssg.d.ts

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

package/dist/stacks.d.ts

@@ -0,0 +1,196 @@
+import type { AiConfig, AnalyticsConfig, AppConfig, BinaryConfig, CacheConfig, CloudConfig, DatabaseConfig, DnsConfig, DocsConfig, EmailConfig, GitConfig, HashingConfig, LibraryConfig, LoggerConfig, 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;
+    /**
+     * **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;
+    /**
+     * **Logger Options**
+     *
+     * This configuration defines all of your Logger 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.
+     */
+    logger: LoggerConfig;
+    /**
+     * **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 type StacksConfig = Partial<StacksOptions>;

package/dist/storage.d.ts

@@ -0,0 +1,12 @@
+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>;

package/dist/tables.d.ts

@@ -0,0 +1,52 @@
+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;
+}

package/dist/team.d.ts

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

package/dist/ui.d.ts

@@ -0,0 +1,165 @@
+import type { UserShortcuts } from 'unocss';
+import type { UserConfig } from '@unocss/core';
+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;
+}
+export 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 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;