@stacksjs/types 0.53.1 → 0.56.3

package/dist/notifications.d.ts

@@ -1,164 +0,0 @@
-import type { IEmailOptions } from '@novu/stateless';
-export interface NotificationOptions {
-    default: 'email' | 'sms' | 'chat' | string;
-    email: {
-        default: 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'netcore' | 'nodemailer' | 'postmark' | 'sendgrid' | 'ses' | string;
-        from: string;
-        to: string;
-        drivers: {
-            smtp: {
-                host: string;
-                port: number;
-                secure: boolean;
-                auth: {
-                    user: string;
-                    pass: string;
-                };
-            };
-            sendgrid: {
-                key: string;
-                senderName: string;
-            };
-            emailjs: {
-                host: string;
-                user: string;
-                password: string;
-                port: number;
-                secure: boolean;
-            };
-            mailgun: {
-                key: string;
-                domain: string;
-                username: string;
-            };
-            mailjet: {
-                key: string;
-                secret: string;
-            };
-            mandrill: {
-                key: string;
-            };
-            netcore: {
-                key: string;
-            };
-            nodemailer: {
-                host: string;
-                user: string;
-                password: string;
-                port: number;
-                secure: boolean;
-            };
-            postmark: {
-                key: string;
-            };
-            ses: {
-                region: string;
-                key: string;
-                secret: string;
-            };
-        };
-    };
-    sms: {
-        default: 'twilio' | 'nexmo' | 'gupshup' | 'plivo' | 'sms77' | 'sns' | 'telnyx' | 'termii' | string;
-        from: string;
-        to: string;
-        drivers: {
-            twilio: {
-                sid: string;
-                authToken: string;
-            };
-            nexmo: {
-                key: string;
-                secret: string;
-            };
-            gupshup: {
-                user: string;
-                password: string;
-            };
-            plivo: {
-                sid: string;
-                authToken: string;
-            };
-            sms77: {
-                key: string;
-            };
-            sns: {
-                region: string;
-                key: string;
-                secret: string;
-            };
-            telnyx: {
-                key: string;
-                messageProfileId: string;
-            };
-            termii: {
-                key: string;
-            };
-        };
-    };
-    chat: {
-        default: 'slack' | 'msTeams' | 'discord' | string;
-        from: string;
-        to: string;
-        drivers: {
-            slack?: {
-                appId: string;
-                clientId: string;
-                secret: string;
-            };
-            msTeams?: {
-                appId: string;
-                clientId: string;
-                secret: string;
-            };
-            discord?: {};
-        };
-    };
-}
-export interface FCMPushNotificationOptions {
-    eventName: string;
-    to: {
-        subscriberId: string;
-    };
-    payload: {
-        deviceTokens: Array<string>;
-        badge: boolean;
-        clickAction: string;
-        color: string;
-        icon: string;
-        sound: string;
-    };
-}
-export interface ExpoPushNotificationOptions {
-    eventName: string;
-    to: {
-        subscriberId: string;
-    };
-    payload: {
-        to: string[];
-        data: Object;
-        title: string;
-        body: string;
-        ttl: number;
-        expiration: number;
-        priority: 'default' | 'normal' | 'high';
-        subtitle: string;
-        sound: 'default' | null;
-        badge: number;
-        channelId: string;
-        categoryId: string;
-        mutableContent: boolean;
-    };
-}
-export type { IChatOptions as ChatOptions, ISendMessageSuccessResponse as SendMessageSuccessResponse, ISmsOptions as SmsOptions, } from '@novu/stateless';
-export type EmailOptions = Omit<IEmailOptions, 'from'> & {
-    from: {
-        name?: string;
-        address?: string;
-    };
-    domain?: string;
-    mailboxes?: {
-        'username': string;
-        'forwardTo': string;
-    }[];
-};

package/dist/pages.d.ts

@@ -1,10 +0,0 @@
-export interface PagesOption {
-    onboarding: {
-        path: string;
-        pages: string[];
-    };
-    settings: {
-        path: string;
-        pages: string[];
-    };
-}

package/dist/payments.d.ts

@@ -1,59 +0,0 @@
-export interface PaymentOptions {
-    driver: 'stripe';
-}
-export interface ChargeOptions {
-    currency?: string;
-    source?: string;
-    description?: string;
-    chargeId?: string;
-    limit?: number;
-    metadata?: object;
-    searchOptions: {
-        query?: string;
-        limit?: number;
-    };
-}
-export interface CustomerOptions {
-    description?: string;
-    address?: string;
-    email?: string;
-    metadata?: object;
-    name?: string;
-    payment_method?: string;
-    shipping: string;
-    listOptions?: {
-        created?: object;
-        ending_before?: string;
-        limit?: number;
-        starting_after?: string;
-        test_clock?: string;
-    };
-    searchOptions?: {
-        query?: string;
-        limit?: number;
-        page?: number;
-    };
-}
-export interface DisputeOptions {
-    dp_id?: string;
-    metadata?: object;
-    listOptions?: {
-        charge?: string;
-        payment_intent?: string;
-        created?: string;
-        ending_before?: string;
-        limit?: number;
-        starting_after?: string;
-    };
-}
-export interface EventOptions {
-    event_id?: string;
-    listOptions?: {
-        created?: object;
-        delivery_success?: boolean;
-        ending_before?: string;
-        limit?: number;
-        starting_after?: string;
-        type?: string;
-    };
-}

package/dist/promise.d.ts

@@ -1 +0,0 @@
-export type MaybePromise<T> = T | Promise<T>;

package/dist/pwa.d.ts

@@ -1,7 +0,0 @@
-import type { Options } from 'vite-plugin-pwa';
-/**
- * **PWA Options**
- *
- * The PWA options.
- */
-export type PwaOptions = Options;

package/dist/reactivity.d.ts

@@ -1 +0,0 @@
-export type { Ref } from 'vue';

package/dist/router.d.ts

@@ -1,42 +0,0 @@
-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;
-export interface Route {
-    method: HttpMethod;
-    pattern: RegExp;
-    callback: RouteCallback;
-    paramNames: string[];
-}
-export interface Middleware {
-    before?: RouteCallback;
-    after?: RouteCallback;
-}
-export interface RouteGroupOptions {
-    prefix?: string;
-    middleware?: Middleware[];
-}

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;
-}