stacks 0.50.0 → 0.52.0

package/core/types/src/components.ts

@@ -1,4 +1,4 @@
-import type { Options } from 'unplugin-vue-components'
+export type { Options as ComponentOptions } from 'unplugin-vue-components'
 
 export interface TagOption {
   /**
@@ -62,5 +62,3 @@ export interface TagOption {
 }
 
 export type TagsOptions = TagOption[]
-
-export type ComponentOptions = Options

package/core/types/src/cron-jobs.ts

@@ -0,0 +1,17 @@
+/**
+ * Cron Job Options.
+ */
+export interface CronJobOptions {
+  /**
+   * The name of the cron job.
+   */
+  name?: string
+  function: string
+  schedule: string
+  description?: string
+  enabled?: boolean
+  timezone?: string
+}
+
+export type CronJob = CronJobOptions
+export type CronJobs = CronJob[]

package/core/types/src/database.ts

@@ -1,3 +1,40 @@
-import type { PrismaClient } from '@prisma/client'
+import type { Model } from './model'
 
-export type DatabaseClient = PrismaClient
+export type DatabaseClient = any
+
+export interface DatabaseOptions {
+  driver: string
+
+  drivers: {
+    mysql: {
+      url?: string
+      host?: string
+      port?: number
+      client?: DatabaseClient
+      name: string
+      username?: string
+      password?: string
+    }
+
+    planetscale: {}
+    postgres: {}
+  }
+}
+
+export interface FactoryOptions {
+  name: string
+  count?: number
+  items: object
+  columns: object
+}
+
+export interface SchemaOptions {
+  database: string
+}
+
+export interface DatabaseDriver {
+  client: DatabaseClient
+  migrate: (models: Model[], path: string, options?: SchemaOptions) => Promise<void>
+  // seed: (modelName: string, data: SeedData) => Promise<void>
+  factory: (modelName: string, fileName: string, path: string) => Promise<void>
+}

package/core/types/src/deploy.ts

@@ -1,11 +1,8 @@
-export interface DeployOptions {
-  /**
-   * **Deployment Host**
-   *
-   * The host to deploy to.
-   *
-   * @default string 'netlify'
-   * @see https://stacksjs.dev/docs/components
-   */
-  driver: 'netlify' | 'vercel'
-}
+/**
+ * **Deploy Options**
+ *
+ * This configuration defines all of your deployment 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 DeployOptions {}

package/core/types/src/dns.ts

@@ -0,0 +1,49 @@
+export interface ARecord {
+  name: string | '@' | '*'
+  address: string // IPv4
+  ttl?: number | 'auto'
+}
+
+export interface CNameRecord {
+  name: string
+  target: string
+  ttl: number | 'auto'
+}
+
+export interface MXRecord {
+  name: string | '@'
+  mailServer: string
+  ttl: number | 'auto'
+  priority: number // 0-65535
+}
+
+export interface TxtRecord {
+  name: string | '@'
+  ttl: number | 'auto'
+  content: string
+}
+
+export interface AAAARecord {
+  name: string | '@' | '*'
+  address: string // IPv6
+  ttl: number | 'auto'
+}
+
+export type DnsRecord = ARecord | CNameRecord | MXRecord | TxtRecord | AAAARecord
+
+/**
+   * **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.
+   *
+   * @see https://stacksjs.dev/docs/dns
+   */
+export interface DnsOptions {
+  a?: ARecord[]
+  aaaa?: AAAARecord[]
+  cname?: CNameRecord[]
+  mx?: MXRecord[]
+  txt?: TxtRecord[]
+}

package/core/types/src/docs.ts

@@ -1,3 +1,5 @@
 import type { UserConfig } from 'vitepress'
 
 export type DocsConfig = UserConfig
+
+export type DocsOptions = DocsConfig

package/core/types/src/events.ts

@@ -1,7 +1,7 @@
 /**
  * **Events**
  *
- * This configuration defines all of your events. Because Stacks is full-typed, you may
+ * This configuration defines all of your events. 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.
  *

package/core/types/src/git.ts

@@ -1,7 +1,7 @@
 /**
  * **Git Options**
  *
- * This configuration defines all of your git options. Because Stacks is full-typed, you may
+ * 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.
  */

package/core/types/src/index.ts

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

package/core/types/src/library.ts

@@ -1,9 +1,9 @@
-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.
  */
@@ -18,6 +18,11 @@ export interface LibraryOptions {
    */
   parentName: string | null
 
+  /**
+   * The package registry to use.
+   */
+  packageRegistry: 'npm'
+
   /**
    * The path of your repository.
    *

package/core/types/src/model.ts

@@ -0,0 +1,46 @@
+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 // defaults to 'created_at'
+  updatedAt?: string
+  deletedAt?: string
+}
+
+/**
+ * Model.
+ */
+export interface Model {
+  name?: string // defaults to the file name of the model
+  table?: string // defaults to the lowercase, plural name of the model
+  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
+  // useSoftDeletes?: boolean | SoftDeleteOptions
+}
+
+export interface Fields {
+  [key: string]: {
+    type: string
+    default?: boolean
+    unique?: boolean
+    required?: boolean
+    factory?: () => any
+    validation?: String | Number | Boolean | Date
+  }
+}

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/pages.ts

@@ -1,8 +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/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
+}