@stacksjs/types 0.50.0 → 0.52.0

package/dist/index.mjs

@@ -1,11 +1,15 @@
 export * from "./app.mjs";
 export * from "./auto-imports.mjs";
 export * from "./build.mjs";
-export * from "./components.mjs";
+export * from "./cache.mjs";
+export * from "./cdn.mjs";
 export * from "./cli.mjs";
+export * from "./components.mjs";
+export * from "./cron-jobs.mjs";
 export * from "./database.mjs";
-export * from "./deploy.mjs";
 export * from "./debug.mjs";
+export * from "./deploy.mjs";
+export * from "./dns.mjs";
 export * from "./docs.mjs";
 export * from "./errors.mjs";
 export * from "./events.mjs";
@@ -19,13 +23,17 @@ export * from "./layout.mjs";
 export * from "./library.mjs";
 export * from "./manifest.mjs";
 export * from "./markdown.mjs";
+export * from "./model.mjs";
 export * from "./notifications.mjs";
 export * from "./pages.mjs";
+export * from "./payments.mjs";
 export * from "./promise.mjs";
 export * from "./pwa.mjs";
 export * from "./reactivity.mjs";
+export * from "./router.mjs";
 export * from "./search-engine.mjs";
 export * from "./ssg.mjs";
+export * from "./stacks.mjs";
 export * from "./tables.mjs";
 export * from "./ui.mjs";
 export * from "./utils.mjs";

package/dist/library.d.ts

@@ -1,8 +1,8 @@
-import type { TagsOptions } from '.';
+import type { TagsOptions } from './components';
 /**
  * **Library Options**
  *
- * This configuration defines all of your library options. Because Stacks is full-typed, you
+ * 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.
  */
@@ -15,6 +15,10 @@ export interface LibraryOptions {
      * The name of your organization (parent).
      */
     parentName: string | null;
+    /**
+     * The package registry to use.
+     */
+    packageRegistry: 'npm';
     /**
      * The path of your repository.
      *

package/dist/model.d.ts

@@ -0,0 +1,41 @@
+import type { ZodBoolean as Boolean, ZodDate as Date, ZodNumber as Number, ZodString as String } from 'zod';
+import type { SearchIndexSettings } from './search-engine';
+export interface SeedOptions {
+    count: number;
+}
+export interface TimestampOptions {
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+}
+/**
+ * Model.
+ */
+export interface Model {
+    name?: string;
+    table?: string;
+    fields: Fields;
+    hasOne?: string;
+    hasMany?: string;
+    belongsToMany?: string;
+    hasThrough?: {
+        model: string;
+        through: string;
+        using: string;
+    };
+    seedable?: boolean | SeedOptions;
+    useSeed?: boolean | SeedOptions;
+    searchable?: boolean | SearchIndexSettings;
+    useSearch?: boolean | SearchIndexSettings;
+    useTimestamps?: boolean | TimestampOptions;
+}
+export interface Fields {
+    [key: string]: {
+        type: string;
+        default?: boolean;
+        unique?: boolean;
+        required?: boolean;
+        factory?: () => any;
+        validation?: String | Number | Boolean | Date;
+    };
+}

package/dist/notifications.d.ts

@@ -1,112 +1,120 @@
-import type { IChatOptions, IEmailOptions, ISendMessageSuccessResponse, ISmsOptions } from '@novu/stateless';
+import type { IEmailOptions } from '@novu/stateless';
 export interface NotificationOptions {
-    type?: 'email' | 'sms' | 'chat' | 'push';
-    driver?: 'sendgrid' | 'emailjs' | 'mailjet' | 'mandrill' | 'netcore' | 'nodemailer' | 'postmark' | 'ses' | 'mailgun' | 'twilio' | 'nexmo' | 'gupshup' | 'plivo' | 'sms77' | 'sns';
+    default: 'email' | 'sms' | 'chat' | string;
     email: {
-        purgeCSS: boolean;
-        sendgrid: {
-            key: string;
-            from: string;
-            senderName: string;
-        };
-        emailjs: {
-            from: string;
-            host: string;
-            user: string;
-            password: string;
-            port: number;
-            secure: boolean;
-        };
-        mailgun: {
-            key: string;
-            domain: string;
-            username: string;
-            from: string;
-        };
-        mailjet: {
-            key: string;
-            secret: string;
-            from: string;
-        };
-        mandrill: {
-            key: string;
-            from: string;
-        };
-        netcore: {
-            key: string;
-            from: string;
-        };
-        nodemailer: {
-            from: string;
-            host: string;
-            user: string;
-            password: string;
-            port: number;
-            secure: boolean;
-        };
-        postmark: {
-            key: string;
-            from: string;
-        };
-        ses: {
-            region: string;
-            key: string;
-            secret: string;
-            from: string;
+        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: {
-        twilio: {
-            sid: string;
-            authToken: string;
-            from: string;
-            to: string;
-        };
-        nexmo: {
-            key: string;
-            secret: string;
-            from: string;
-        };
-        gupshup: {
-            user: string;
-            password: string;
-        };
-        plivo: {
-            sid: string;
-            authToken: string;
-            from: string;
-        };
-        sms77: {
-            key: string;
-            from: string;
-        };
-        sns: {
-            region: string;
-            key: string;
-            secret: string;
-        };
-        telnyx: {
-            key: string;
-            messageProfileId: string;
-            from: string;
-        };
-        termii: {
-            key: string;
-            from: string;
+        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: {
-        slack: {
-            appId: string;
-            clientId: string;
-            secret: string;
+        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 type EmailOptions = IEmailOptions;
-export type SendMessageSuccessResponse = ISendMessageSuccessResponse;
-export type ChatOptions = IChatOptions;
-export type SmsOptions = ISmsOptions;
 export interface FCMPushNotificationOptions {
     eventName: string;
     to: {
@@ -142,3 +150,15 @@ export interface ExpoPushNotificationOptions {
         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,7 +1,10 @@
-import type { UserOptions } from 'vite-plugin-pages';
-/**
- * **Pages Options**
- *
- * The pages options.
- */
-export type PagesOptions = UserOptions;
+export interface PagesOption {
+    onboarding: {
+        path: string;
+        pages: string[];
+    };
+    settings: {
+        path: string;
+        pages: string[];
+    };
+}

package/dist/payments.d.ts

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

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

package/dist/router.d.ts

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

package/dist/search-engine.d.ts

@@ -1,4 +1,4 @@
-import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, Document as Record, DocumentOptions as RecordOptions, Documents as Records, DocumentsResults as RecordsResults, Settings as SearchEngineSettings, SearchParams, SearchResponse } from 'meilisearch';
+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;
@@ -26,6 +26,46 @@ export interface SearchEngineOptions {
         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;
@@ -36,15 +76,15 @@ export interface SearchEngineDriver {
     getIndex: (name: string) => MaybePromise<Index>;
     updateIndex?: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>;
     deleteIndex?: (name: string) => MaybePromise<EnqueuedTask>;
-    updateIndexSettings: (name: string, settings: SearchEngineSettings) => MaybePromise<EnqueuedTask>;
+    updateIndexSettings: (name: string, settings: SearchIndexSettings) => MaybePromise<EnqueuedTask>;
     listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>;
     listAllIndices: () => MaybePromise<IndexesResults<Index[]>>;
-    getRecord?: (key: string) => MaybePromise<Record>;
+    getRecord?: (key: string) => MaybePromise<any>;
     getRecords?: (key: string) => MaybePromise<RecordOptions>;
-    createRecord?: (record: Record, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
-    createRecords?: (records: Records, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
-    createOrReplaceRecord?: (record: Record, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
-    createOrUpdateRecord?: (record: Record, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
+    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>;
@@ -100,4 +140,4 @@ export interface SearchEngineStorage {
      */
     currentPage: number;
 }
-export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, Record, RecordOptions, Records, RecordsResults, SearchEngineSettings, SearchParams, SearchResponse };
+export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchIndexSettings, SearchParams, SearchResponse };

package/dist/ssg.d.ts

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