@stacksjs/types 0.53.1 → 0.56.21

package/dist/search-engine.d.ts

@@ -1,143 +0,0 @@
-import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchIndexSettings, 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.dev/docs/search-engine
-     */
-    driver: 'meilisearch' | 'algolia';
-    meilisearch?: {
-        host: string;
-        apiKey: string;
-    };
-}
-export interface ServicesOptions {
-    algolia?: {
-        appId: string;
-        apiKey: string;
-    };
-    meilisearch?: {
-        appId: string;
-        apiKey: string;
-    };
-    stripe?: {
-        appId: string;
-        apiKey: string;
-    };
-    planetscale?: {
-        appId: string;
-        apiKey: string;
-    };
-    supabase?: {
-        appId: string;
-        apiKey: string;
-    };
-    aws?: {
-        appId: string;
-        apiKey: string;
-    };
-    novu?: {
-        key: string;
-    };
-}
-export interface StorageOptions {
-    /**
-     * **Storage Driver**
-     *
-     * The storage driver to utilize.
-     *
-     * @default string 's3'
-     * @see https://stacksjs.dev/docs/storage
-     */
-    driver: 's3' | 'local';
-}
-export interface MeiliSearchOptions {
-    apiKey: string;
-    host: string;
-}
-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: SearchIndexSettings) => 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 type SearchEngineDriverFactory<T> = (opts?: T) => SearchEngineDriver;
-/**
- * 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 type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchIndexSettings, SearchParams, SearchResponse };

package/dist/ssg.d.ts

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

package/dist/stacks.d.ts

@@ -1,163 +0,0 @@
-import type { AppOptions, CacheOptions, CdnOptions, DatabaseOptions, DebugOptions, DnsOptions, DocsOptions, EmailOptions, EventOptions, GitOptions, HashingOptions, LibraryOptions, NotificationOptions, PaymentOptions, SearchEngineOptions, ServicesOptions, StorageOptions, UiOptions, UserCliOptions } 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 {
-    /**
-     * **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: Partial<AppOptions>;
-    /**
-     * **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: Partial<CacheOptions>;
-    /**
-     * **CDN Options**
-     *
-     * This configuration defines all of your CDN 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.
-     */
-    cdn: Partial<CdnOptions>;
-    /**
-     * **CLI Options**
-     *
-     * This configuration defines all of your CLI 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: Partial<UserCliOptions>;
-    /**
-     * **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: Partial<DatabaseOptions>;
-    /**
-     * **Debug Options**
-     *
-     * This configuration defines all of your Debug 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.
-     */
-    debug: Partial<DebugOptions>;
-    /**
-     * **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: Partial<DnsOptions>;
-    /**
-     * **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: Partial<DocsOptions>;
-    /**
-     * **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: Partial<EmailOptions>;
-    /**
-     * **Event Options**
-     *
-     * This configuration defines all of your Event 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.
-     */
-    event: Partial<EventOptions>;
-    /**
-     * **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: Partial<GitOptions>;
-    /**
-     * **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: Partial<HashingOptions>;
-    /**
-     * **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: Partial<LibraryOptions>;
-    /**
-     * **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: Partial<NotificationOptions>;
-    /**
-     * **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: Partial<PaymentOptions>;
-    /**
-     * **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: Partial<SearchEngineOptions>;
-    /**
-     * **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: Partial<ServicesOptions>;
-    /**
-     * **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: Partial<StorageOptions>;
-    /**
-     * **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: Partial<UiOptions>;
-}
-export type ResolvedStacksOptions = Required<StacksOptions>;

package/dist/tables.d.ts

@@ -1,52 +0,0 @@
-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/ui.d.ts

@@ -1,180 +0,0 @@
-import type { UserShortcuts } from 'unocss';
-export type Font = 'inter' | 'mona' | 'hubot';
-export type Icon = 'heroicon-outline' | 'heroicon-solid';
-export type WebFontsProviders = 'google' | 'bunny' | 'fontshare';
-export interface FontInfo {
-    title: string;
-    text: string;
-}
-export type FontFor = 'email' | 'desktop' | 'mobile' | 'web';
-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
-     * ```
-     * 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://stacks.ow3.org/fonts
-     * @example applies the same font for all platforms _(web, email, desktop, and mobile)_
-     * ```ts
-     * fonts: {
-     *   title: 'Mona',
-     *   text: 'Hubot'
-     * }
-     * ```
-     * @example
-     * ```ts
-     * fonts: {
-     *   web: {
-     *     title: 'Inter',
-     *     text: 'Mona'
-     *   },
-     *   desktop: {
-     *     title: 'Mona',
-     *     text: 'Inter'
-     *   },
-     * }
-     * ```
-     */
-    fonts?: Record<FontFor, FontInfo> | {
-        [key in FontFor]: FontInfo;
-    };
-    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[];
-}
-export type Shortcuts = UserShortcuts;
-/**
- * **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;

package/dist/utils.d.ts

@@ -1,30 +0,0 @@
-/**
- * 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;
-}>;