stacks 0.51.0 → 0.52.0

package/core/types/src/notifications.ts

@@ -1,136 +1,150 @@
-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?: {
+        // appId: string
+        // clientId: string
+        // secret: string
+      }
     }
   }
 }
 
-export type EmailOptions = IEmailOptions
-
-export type SendMessageSuccessResponse = ISendMessageSuccessResponse
-
-export type ChatOptions = IChatOptions
-
-export type SmsOptions = ISmsOptions
 export interface FCMPushNotificationOptions {
   eventName: string
   to: {
@@ -167,3 +181,23 @@ 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/core/types/src/payments.ts

@@ -0,0 +1,63 @@
+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/core/types/src/reactivity.ts

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

package/core/types/src/router.ts

@@ -0,0 +1,30 @@
+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/core/types/src/search-engine.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
@@ -30,6 +30,54 @@ export interface SearchEngineOptions {
   }
 }
 
+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
@@ -43,17 +91,17 @@ 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[]>> // alternatives plural spelling
 
   // Records (MeiliSearch uses the term "documents")
-  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>
@@ -115,4 +163,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/core/types/src/ssg.ts

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

package/core/types/src/stacks.ts

@@ -0,0 +1,203 @@
+import {
+  AppOptions,
+  CacheOptions,
+  CdnOptions,
+  UserCliOptions,
+  DatabaseOptions,
+  DebugOptions,
+  DnsOptions,
+  DocsOptions,
+  EmailOptions,
+  EventOptions,
+  GitOptions,
+  HashingOptions,
+  LibraryOptions,
+  NotificationOptions,
+  PaymentOptions,
+  SearchEngineOptions,
+  ServicesOptions,
+  StorageOptions,
+  UiOptions,
+} 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>