@stacksjs/types 0.59.10 → 0.61.0

package/src/model-names.ts

@@ -0,0 +1 @@
+export type ModelNames = 'Project' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'User' | 'Post'

package/src/model.ts

@@ -1,12 +1,24 @@
+import type { ModelNames, Model as ModelType } from '@stacksjs/types'
 import type { VineBoolean, VineNumber, VineString } from '@vinejs/vine'
-import type { Nullable, SearchEngineSettings } from '.'
+import type { DeepPartial, Nullable, SearchOptions } from '.'
 
-export interface AuthOptions {}
+export type AuthOptions = {}
 
+export type ApiRoutes = 'index' | 'show' | 'store' | 'update' | 'destroy'
+
+export type VineType = VineString | VineNumber | VineBoolean | Date | Nullable<any>
 export interface SeedOptions {
   count: number
 }
 
+export interface ApiSettings {
+  uri: string
+  middleware: string[]
+  routes: ApiRoutes[]
+}
+
+type ApiOptions = DeepPartial<ApiSettings>
+
 export interface TimestampOptions {
   createdAt?: string // defaults to 'created_at'
   updatedAt?: string
@@ -17,66 +29,113 @@ export interface SoftDeleteOptions {
   deletedAt?: string // defaults to 'deleted_at' & can be used for localized tables
 }
 
-interface Base {}
+type Base = {}
 
 /**
  * Model.
  */
 export interface ModelOptions extends Base {
   name: string // defaults to the file name of the model
-  table: string // defaults to the lowercase, plural name of the model
+  table: string // defaults to the lowercase, plural name of the model name (or the name of the model file)
   primaryKey?: string // defaults to `id`
   autoIncrement?: boolean // defaults to true
+  dashboard?: {
+    highlight?: boolean | number // defaults to undefined
+  }
 
   traits: {
     useUuid?: boolean // defaults to false
     useTimestamps?: boolean | TimestampOptions // defaults to true
+    timestampable?: boolean | TimestampOptions // useTimestamps alias
     useSoftDeletes?: boolean | SoftDeleteOptions // defaults to false
+    softDeletable?: boolean | SoftDeleteOptions // useSoftDeletes alias
 
     useAuth?: boolean | AuthOptions // defaults to false
     authenticatable?: boolean | AuthOptions // useAuth alias
     useSeeder?: boolean | SeedOptions // defaults to a count of 10
     seedable?: boolean | SeedOptions // useSeeder alias
-    useSearch?: boolean | SearchEngineSettings // defaults to false
-    searchable?: boolean | SearchEngineSettings // useSearch alias
+    useSearch?: boolean | SearchOptions // defaults to false
+    searchable?: boolean | SearchOptions // useSearch alias
+    useApi?: boolean | ApiOptions
   }
 
-  fields: Fields
+  attributes: Attributes
 
   // relationships
-  hasOne: string // hasOne: 'Post'
-  hasMany: {
-    model: string // should be typed as ModelName
+  hasOne:
+    | {
+        model: ModelNames
+        foreignKey?: string
+        relationName?: string
+      }[]
+    | string[]
+  hasMany:
+    | {
+        model: ModelNames // should be typed as ModelName
+        foreignKey?: string
+        relationName?: string
+      }[]
+    | ModelNames[]
+  belongsTo:
+    | {
+        model: ModelNames // should be typed as ModelName
+        foreignKey?: string
+        relationName?: string
+      }[]
+    | ModelNames[] // belongsTo: 'User'
+  belongsToMany:
+    | {
+        model: ModelNames
+        firstForeignKey?: string
+        secondForeignKey?: string
+        pivotTable?: string
+        relationName?: string
+      }
+    | ModelNames[]
+  hasOneThrough: {
+    model: ModelNames
+    through: ModelNames
     foreignKey?: string
-  }
-  belongsTo: string // belongsTo: 'User'
-  belongsToMany: object
-  hasThrough: {
-    model: string // should be typed as ModelName
-    through: string
-    using: string
+    throughForeignKey?: string
+    relationName?: string
+  }[]
+
+  get: {
+    [key: string]: (value: any) => any
   }
 
-  attributes: {
-    [key: string]: {
-      get: (value: any) => any
-      set: (value: any) => any
-    }
+  set: {
+    [key: string]: (value: any) => any
   }
 }
 
-export interface Fields {
-  [key: string]: {
-    default?: string | number | boolean | Date
-    unique?: boolean
-    required?: boolean
-    factory?: () => any
-    validator?: {
-      rule: VineString | VineNumber | VineBoolean | Date | Nullable<any>
-      message: string
-    }
-    // validation?: String | Number | Boolean | Date
+export interface Attribute {
+  default?: string | number | boolean | Date
+  unique?: boolean
+  required?: boolean
+  factory?: () => any
+  validator?: {
+    rule: VineType
+    message: string
   }
+  // validation?: String | Number | Boolean | Date
+}
+
+export interface Attributes {
+  [key: string]: Attribute
 }
 
 export type Model = Partial<ModelOptions>
+
+export interface RelationConfig {
+  relationship: string
+  model: string
+  table?: string
+  relationModel?: string
+  relationTable?: string
+  foreignKey: string
+  relationName: string
+  throughModel: string
+  throughForeignKey: string
+  pivotTable: string
+}

package/src/notifications.ts

@@ -2,7 +2,17 @@ export interface NotificationOptions {
   default: 'email' | 'sms' | 'chat' | string
 
   email: {
-    default: 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'netcore' | 'nodemailer' | 'postmark' | 'sendgrid' | 'ses' | string
+    default:
+      | 'emailjs'
+      | 'mailgun'
+      | 'mailjet'
+      | 'mandrill'
+      | 'netcore'
+      | 'nodemailer'
+      | 'postmark'
+      | 'sendgrid'
+      | 'ses'
+      | string
 
     from: {
       name: string

package/src/ports.ts

@@ -16,4 +16,5 @@ export interface Ports {
   inspect: number
   api: number // the bun server
   systemTray: number
+  database: number // i.e. DynamoDB local
 }

package/src/search-engine.ts

@@ -1,4 +1,15 @@
-import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchEngineSettings, SearchParams, SearchResponse } from 'meilisearch'
+import type {
+  EnqueuedTask,
+  Hits,
+  Index,
+  IndexOptions,
+  IndexesResults,
+  MeiliSearch,
+  Settings as MeilisearchOptions,
+  DocumentOptions as RecordOptions,
+  SearchParams,
+  SearchResponse,
+} from 'meilisearch'
 import type { MaybePromise } from '.'
 
 type Search = any
@@ -19,17 +30,18 @@ export interface SearchEngineOptions {
    *
    * The search engine to utilize.
    *
-   * @default string 'meilisearch'
+   * @default string 'opensearch'
    * @see https://stacksjs.org/docs/search-engine
    */
-  driver: 'meilisearch' | 'algolia' | 'opensearch'
+  driver: 'opensearch'
+  // driver: 'meilisearch' | 'algolia' | 'typesense' | 'opensearch' wip
 
-  meilisearch?: {
-    host: string
-    apiKey: string
-  }
+  // meilisearch?: {
+  //   host: string
+  //   apiKey: string
+  // }
 
-  openSearch?: {
+  opensearch?: {
     host: string
     protocol: number
     port: number
@@ -58,7 +70,7 @@ 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: SearchEngineOptions) => MaybePromise<EnqueuedTask>
   listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
   listAllIndices: () => MaybePromise<IndexesResults<Index[]>> // alternatives plural spelling
 
@@ -128,9 +140,22 @@ export interface SearchEngineStorage {
   currentPage: number
 }
 
-export interface MeiliSearchOptions {
-  apiKey: string
-  host: string
+export interface SearchOptions {
+  searchable: string[]
+  sortable: string[]
+  filterable: string[]
+  options?: SearchEngineOptions
 }
 
-export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchEngineSettings, SearchParams, SearchResponse }
+export type {
+  EnqueuedTask,
+  Hits,
+  Index,
+  IndexOptions,
+  IndexesResults,
+  MeiliSearch,
+  RecordOptions,
+  MeilisearchOptions,
+  SearchParams,
+  SearchResponse,
+}

package/src/security.ts

@@ -1,5 +1,5 @@
-import type { DeepPartial } from './utils'
 import type { CountryCode } from './cloud'
+import type { DeepPartial } from './utils'
 
 export interface FirewallOptions {
   enabled: boolean // default: true

package/src/services.ts

@@ -14,20 +14,20 @@ export interface ServicesOptions {
     apiKey: string
   }
 
-  stripe?: {
+  lemonSqueezy?: {
     appId: string
     apiKey: string
   }
 
-  planetscale?: {
+  stripe?: {
     appId: string
     apiKey: string
   }
 
-  supabase?: {
-    appId: string
-    apiKey: string
-  }
+  // supabase?: {
+  //   appId: string
+  //   apiKey: string
+  // }
 
   aws?: {
     accountId: string

package/src/stacks.ts

@@ -1,6 +1,7 @@
 import type {
   AiConfig,
   AnalyticsConfig,
+  ApiConfig,
   AppConfig,
   BinaryConfig,
   CacheConfig,
@@ -9,6 +10,7 @@ import type {
   DnsConfig,
   DocsConfig,
   EmailConfig,
+  ErrorConfig,
   GitConfig,
   HashingConfig,
   LibraryConfig,
@@ -116,6 +118,15 @@ export interface StacksOptions {
    */
   email: EmailConfig
 
+  /**
+   * **Errors Options**
+   *
+   * This configuration defines all of your Errors 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.
+   */
+  errors: ErrorConfig
+
   /**
    * **Git Options**
    *

package/src/tables.ts

@@ -28,7 +28,7 @@ export interface TableStore {
   sorts?: string | string[] // optional: the specific type of sorts to be applied to the table (defaults: [])
   filterable?: string | boolean // optional: determines whether the table displays the filters component (defaults: true)
   filters?: string | string[] // optional: the specific type of filters to be displayed/utilized in the table (defaults: [])
-  filterValue?: any[]// optional: the specific type of filters to be displayed/utilized in the table (defaults: [])
+  filterValue?: any[] // optional: the specific type of filters to be displayed/utilized in the table (defaults: [])
   actionable?: string | boolean // optional: determines whether the table displays any "action items" (defaults: true)
   actions?: string | string[] // optional: the specific type of actions to be displayed/utilized in the table (defaults: 'Edit, Delete')
   perPage: number // optional: the number of rows (items) to be displayed per page (defaults: 10)

package/src/ui.ts

@@ -1,5 +1,5 @@
-import type { UserShortcuts } from 'unocss'
 import type { UserConfig } from '@unocss/core'
+import type { UserShortcuts } from 'unocss'
 
 export type Font = 'inter' | 'mona' | 'hubot'
 export type Icon = 'heroicons'

package/src/utils.ts

@@ -25,12 +25,11 @@ export type Constructor<T = void> = new (...args: any[]) => T
  * @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 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 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
@@ -39,9 +38,9 @@ export type DeepMerge<F, S> = MergeInsertions<{
       ? S[K]
       : K extends keyof F
         ? F[K]
-        : never;
+        : never
 }>
 
 export type DeepPartial<T> = {
-  [P in keyof T]?: DeepPartial<T[P]>;
+  [P in keyof T]?: DeepPartial<T[P]>
 }

package/dist/ai.d.ts

@@ -1,15 +0,0 @@
-type AiModel = 'amazon.titan-embed-text-v1' | 'amazon.titan-text-lite-v1' | 'amazon.titan-text-express-v1' | 'amazon.titan-embed-image-v1' | 'amazon.titan-image-generator-v1' | 'anthropic.claude-v1' | 'anthropic.claude-v2' | 'anthropic.claude-v2:1' | 'anthropic.claude-instant-v1' | 'meta.llama2-13b-chat-v1' | 'meta.llama2-70b-chat-v1';
-/**
- * **AI Options**
- *
- * This configuration defines all of your AI 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 AiOptions {
-    default: AiModel;
-    models: AiModel[];
-    deploy: boolean;
-}
-export type AiConfig = Partial<AiOptions>;
-export {};

package/dist/analytics.d.ts

@@ -1,19 +0,0 @@
-/**
- * **Analytics Options**
- *
- * This configuration defines all of your Analytics 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 AnalyticsOptions {
-    driver: 'google-analytics' | 'fathom';
-    drivers: {
-        googleAnalytics?: {
-            trackingId: string;
-        };
-        fathom?: {
-            siteId: string;
-        };
-    };
-}
-export type AnalyticsConfig = Partial<AnalyticsOptions>;

package/dist/api.d.ts

@@ -1,59 +0,0 @@
-/**
- * **API Options**
- *
- * This configuration defines all of your API 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 ApiOptions {
-    /**
-     * **API Description**
-     *
-     * This value defines the description for your API.
-     *
-     * @default "Stacks API"
-     */
-    description: string;
-    /**
-     * **API Prefix**
-     *
-     * This value defines the prefix for all of your API routes. For example, if you set
-     * this value to `api`, all of your API routes will be prefixed with `/api`. This
-     * value is useful for when you want to version your API.
-     *
-     * @default string "api"
-     * @example string "api/v1"
-     */
-    prefix: string;
-    /**
-     * **API Prewarm**
-     *
-     * This configuration determines the prewarming behavior of your API. Prewarming eliminates
-     * cold starts in your API. If this value is set to `true`, the API will be prewarmed
-     * every 5 minutes. If you provide a number, Stacks will prewarm the
-     * specified number of containers every 5 minutes.
-     *
-     * @default true
-     * @example false
-     * @example 10
-     */
-    prewarm: boolean | number;
-    /**
-     * **API Memory Size**
-     *
-     * This value defines the memory size for your API.
-     *
-     * @default 512
-     */
-    memorySize: number;
-    /**
-     * **API Timeout**
-     *
-     * This value defines the timeout for your API.
-     *
-     * @default 30
-     */
-    timeout: number;
-    deploy: boolean;
-}
-export type ApiConfig = Partial<ApiOptions>;

package/dist/app.d.ts

@@ -1,135 +0,0 @@
-export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | string;
-/**
- * **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.
- */
-export interface AppOptions {
-    /**
-     * **Application Name**
-     *
-     * This value is the name of your application. This value is used when the
-     * framework needs to place the application's name in a log or any
-     * other location as required by the application or its packages.
-     *
-     * @default string "Stacks"
-     */
-    name: string;
-    /**
-     * **Application Description**
-     *
-     * This value is the description of your application. This value is used when the
-     * framework generates meta tags for the frontend.
-     */
-    description: string;
-    /**
-     * **Application Environment**
-     *
-     * This value determines the "environment" your application is currently
-     * running in. This may determine how you prefer to configure various
-     * services the application utilizes. Set this in your ".env" file
-     *
-     * @default "local"
-     */
-    env: AppEnvType;
-    /**
-     * **Application URL**
-     *
-     * This URL is used by the console to properly generate URLs when using
-     * the Buddy command line tool. You should set this to the root of
-     * your application so that it is used when running Buddy tasks.
-     *
-     * @default string "stacks.localhost"
-     * @example "my-project.test"
-     */
-    url: string;
-    /**
-     * **Redirect URLs**
-     *
-     * A Redirect URL is a URL that permanently redirects to the Application URL.
-     * This is useful for when you have multiple domains that you want to redirect
-     * to your application. You can set this to a string or an array of strings.
-     *
-     * @default []
-     * @example "['stacksjs.com', 'stacksjs.dev']"
-     */
-    redirectUrls: string | string[];
-    /**
-     * **Application Debug Mode**
-     *
-     * When your application is in debug mode, detailed error messages with
-     * stack traces will be shown on every error that occurs within your
-     * application. If disabled, a simple generic error page is shown.
-     *
-     * @default true
-     */
-    debug: boolean;
-    /**
-     * **Maintenance Mode**
-     *
-     * When your application is in maintenance mode, a simple maintenance
-     * page will be shown on every request into your application.
-     *
-     * @default false
-     */
-    maintenanceMode: boolean;
-    /**
-     * **Encryption Key**
-     *
-     * This key is used by the Stacks encrypter service and should be set to
-     * a random, 32 character string, otherwise these encrypted strings will
-     * not be safe. Please do this before deploying an application!
-     */
-    key: string;
-    /**
-     * **Application Timezone**
-     *
-     * Here you may specify the default timezone for your application, which
-     * will be used by Stacks and date-time functions. We have gone ahead
-     * and set this to a sensible default for you out of the box.
-     *
-     * @default string "UTC"
-     */
-    timezone: string;
-    /**
-     * **Application Locale Configuration**
-     *
-     * The application locale determines the default locale that will be used
-     * by the translation service provider. You are free to set this value
-     * to any of the locales which will be supported by the application.
-     *
-     * @default string "en"
-     * @example
-     * de // ./lang/de.yml needs to be present for this
-     */
-    locale: string;
-    /**
-     * **Application Fallback Locale**
-     *
-     * The fallback locale determines the locale to use when the current one
-     * is not available. You may change the value to correspond to any of
-     * the language folders that are provided through your application.
-     *
-     * @default string "en"
-     */
-    fallbackLocale: 'en';
-    /**
-     * **Cipher**
-     *
-     * Description WIP.
-     *
-     * @default string "aes-256-cbc"
-     */
-    cipher: string;
-    /**
-     * **Documentation Mode**
-     *
-     * $appUrl becomes your Documentation URL.
-     *
-     * @default false
-     */
-    docMode: boolean;
-}
-export type AppConfig = Partial<AppOptions>;

package/dist/auto-imports.d.ts

@@ -1 +0,0 @@
-export type { Options as AutoImportsOptions } from 'unplugin-auto-import/types';

package/dist/binary.d.ts

@@ -1,11 +0,0 @@
-/**
- * The Binary/CLI Options used in `./config/cli.ts`.
- */
-export interface BinaryOptions {
-    name: string;
-    command: string;
-    description: string;
-    source: string;
-    deploy: boolean;
-}
-export type BinaryConfig = Partial<BinaryOptions>;

package/dist/build.d.ts

@@ -1,2 +0,0 @@
-export type { UserConfig as ViteConfig } from 'vite';
-export type { ViteSSGContext } from 'vite-ssg';