@stacksjs/types 0.67.0 → 0.68.0

package/dist/logging.d.ts

@@ -1,28 +1,6 @@
-/**
-* **Logging Options**
-*
-* This configuration defines all of your logging 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 LoggingOptions {
-	/**
-	* **Log File Path**
-	*
-	* The path to the log file. This will be used to write logs to a file. If you do not want to
-	* write logs to a file, you may set this to `null`.
-	*
-	* @default 'storage/logs/console.log'
-	*/
-	logsPath: string;
-	/**
-	* **Deployments Path**
-	*
-	* The path to the deployments folder. This will be used to write deployment logs to a file.
-	* If you do not want to write deployment logs to a file, you may set this to `null`.
-	*
-	* @default 'storage/logs/deployments.log'
-	*/
-	deploymentsPath: string;
+export declare interface LoggingOptions {
+  logsPath: string
+
+  deploymentsPath: string
 }
-export type LoggingConfig = Partial<LoggingOptions>;
+export declare type LoggingConfig = Partial<LoggingOptions>

package/dist/manifest.d.ts

@@ -1,9 +1,6 @@
-/**
-* The npm package manifest (package.json)
-*/
-export interface Manifest {
-	name: string;
-	version: string;
-	description: string;
-	[key: string]: unknown;
-}
+export declare interface Manifest {
+  name: string
+  version: string
+  description: string
+  [key: string]: unknown
+}

package/dist/model-names.d.ts

@@ -1 +1 @@
-export type ModelNames = "Project" | "SubscriberEmail" | "AccessToken" | "Team" | "Subscriber" | "Deployment" | "Release" | "User" | "Post";
+export declare type ModelNames = 'Project' | 'SubscriberEmail' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'Release' | 'User' | 'Post' | 'Subscription' | 'Error'

package/dist/model.d.ts

@@ -1,144 +1,164 @@
-import type { ModelNames } from "@stacksjs/types";
-import type { VineBoolean, VineNumber, VineString } from "@vinejs/vine";
-import type { DeepPartial, Nullable, SearchOptions } from ".";
-export type Model = Partial<ModelOptions>;
-export interface FieldArrayElement {
-	entity: string;
-	charValue?: string | null;
+import type { DeepPartial, Nullable, SearchOptions } from '.';
+import type { ModelNames } from '@stacksjs/types';
+import type { VineBoolean, VineNumber, VineString } from '@vinejs/vine';
+
+export declare type Model = Partial<ModelOptions>
+export declare interface FieldArrayElement {
+  entity: string
+  charValue?: string | null
 }
-export interface ModelElement {
-	field: string;
-	default: string | number | boolean | Date | undefined | null;
-	unique: boolean;
-	fieldArray: FieldArrayElement | null;
+export declare interface ModelElement {
+  field: string
+  default: string | number | boolean | Date | undefined | null
+  unique: boolean
+  fieldArray: FieldArrayElement | null
 }
-export interface AuthOptions {
-	useTwoFactor?: boolean;
-	usePasskey?: boolean;
+export declare interface AuthOptions {
+  useTwoFactor?: boolean
+  usePasskey?: boolean
 }
-type ActionPath = string;
-type ActionName = string;
-type Action = ActionPath | ActionName | undefined;
-export type ApiRoutes = "index" | "show" | "store" | "update" | "destroy";
-export type VineType = VineString | VineNumber | VineBoolean | Date | Nullable<any>;
+declare type ActionPath = string
+type ActionName = string
+type Action = ActionPath | ActionName | undefined
+export declare type ApiRoutes = 'index' | 'show' | 'store' | 'update' | 'destroy'
+export declare type VineType = VineString | VineNumber | VineBoolean | Date | Nullable<any>
 export interface SeedOptions {
-	count: number;
+  count: number
 }
-type LogAttribute = string;
-interface ActivityLogOption {
-	exclude: LogAttribute[];
-	include: LogAttribute[];
-	logOnly: LogAttribute[];
+declare type LogAttribute = string
+declare interface ActivityLogOption {
+  exclude: LogAttribute[]
+  include: LogAttribute[] 
+  logOnly: LogAttribute[]
 }
-interface BelongsToManyType {
-	model: ModelNames;
-	firstForeignKey?: string;
-	secondForeignKey?: string;
-	pivotTable?: string;
-	relationName?: string;
+declare interface BelongsToManyType {
+  model: ModelNames
+  firstForeignKey?: string
+  secondForeignKey?: string
+  pivotTable?: string
+  relationName?: string
 }
-export interface ApiSettings {
-	uri: string;
-	middleware: string[];
-	routes: { [key in ApiRoutes] : Action } | string[];
-	openApi: boolean;
+export declare interface ApiSettings {
+  uri: string
+  middleware: string[]
+  routes:
+    | {
+      [key in ApiRoutes]: Action
+    }
+    | string[]
+  openApi: boolean
 }
-type ApiOptions = DeepPartial<ApiSettings>;
-export interface TimestampOptions {
-	createdAt?: string;
-	updatedAt?: string;
-	deletedAt?: string;
+declare type ApiOptions = DeepPartial<ApiSettings>
+export declare interface TimestampOptions {
+  createdAt?: string 
+  updatedAt?: string
+  deletedAt?: string
 }
-interface ValidatorMessage {
-	[key: string]: string;
+declare interface ValidatorMessage {
+  [key: string]: string
 }
-export interface SoftDeleteOptions {
-	deletedAt?: string;
+export declare interface SoftDeleteOptions {
+  deletedAt?: string 
 }
-interface Base {}
-/**
-* Model.
-*/
-export interface ModelOptions extends Base {
-	/**
-	* The name of the model.
-	*
-	* @default string - The file name of the model.
-	*/
-	name: string;
-	table?: string;
-	primaryKey?: string;
-	autoIncrement?: boolean;
-	dashboard?: { highlight?: boolean | number };
-	traits?: {
-		useUuid?: boolean;
-		useTimestamps?: boolean | TimestampOptions;
-		timestampable?: boolean | TimestampOptions;
-		useSoftDeletes?: boolean | SoftDeleteOptions;
-		softDeletable?: boolean | SoftDeleteOptions;
-		useAuth?: boolean | AuthOptions;
-		authenticatable?: boolean | AuthOptions;
-		useSeeder?: boolean | SeedOptions;
-		seedable?: boolean | SeedOptions;
-		useSearch?: boolean | SearchOptions;
-		searchable?: boolean | SearchOptions;
-		useApi?: ApiOptions | boolean;
-		observe?: string[] | boolean;
-		useActivityLog?: boolean | ActivityLogOption;
-	};
-	attributes?: Attributes;
-	hasOne?: {
-		model: ModelNames;
-		foreignKey?: string;
-		relationName?: string;
-	}[] | string[];
-	hasMany?: {
-		model: ModelNames;
-		foreignKey?: string;
-		relationName?: string;
-	}[] | ModelNames[];
-	belongsTo?: {
-		model: ModelNames;
-		foreignKey?: string;
-		relationName?: string;
-	}[] | ModelNames[];
-	belongsToMany?: BelongsToManyType[] | ModelNames[];
-	hasOneThrough?: {
-		model: ModelNames;
-		through: ModelNames;
-		foreignKey?: string;
-		throughForeignKey?: string;
-		relationName?: string;
-	}[];
-	get?: { [key: string]: (value: any) => any };
-	set?: { [key: string]: (value: any) => any };
+declare interface Base {}
+export declare interface ModelOptions extends Base {
+  name: string 
+  table?: string 
+  primaryKey?: string 
+  autoIncrement?: boolean 
+  dashboard?: {
+    highlight?: boolean | number 
+  }
+
+  traits?: {
+    useUuid?: boolean 
+    useTimestamps?: boolean | TimestampOptions 
+    timestampable?: boolean | TimestampOptions 
+    useSoftDeletes?: boolean | SoftDeleteOptions 
+    softDeletable?: boolean | SoftDeleteOptions 
+
+    useAuth?: boolean | AuthOptions 
+    authenticatable?: boolean | AuthOptions 
+    useSeeder?: boolean | SeedOptions 
+    seedable?: boolean | SeedOptions 
+    useSearch?: boolean | SearchOptions 
+    searchable?: boolean | SearchOptions 
+    useApi?: ApiOptions | boolean
+    observe?: string[] | boolean
+    billable?: boolean
+    useActivityLog?: boolean | ActivityLogOption
+  }
+
+  attributes?: Attributes
+
+  hasOne?:
+    | {
+      model: ModelNames
+      foreignKey?: string
+      relationName?: string
+    }[]
+    | string[]
+  hasMany?:
+    | {
+      model: ModelNames 
+      foreignKey?: string
+      relationName?: string
+    }[]
+    | ModelNames[]
+  belongsTo?:
+    | {
+      model: ModelNames 
+      foreignKey?: string
+      relationName?: string
+    }[]
+    | ModelNames[] 
+  belongsToMany?: BelongsToManyType[] | ModelNames[]
+  hasOneThrough?: {
+    model: ModelNames
+    through: ModelNames
+    foreignKey?: string
+    throughForeignKey?: string
+    relationName?: string
+  }[]
+
+  scopes?: {
+    [key: string]: (value: any) => any
+  }
+
+  get?: {
+    [key: string]: (value: any) => any
+  }
+
+  set?: {
+    [key: string]: (value: any) => any
+  }
 }
-export interface Attribute {
-	default?: string | number | boolean | Date;
-	unique?: boolean;
-	order?: number;
-	required?: boolean;
-	hidden?: boolean;
-	fillable?: boolean;
-	factory?: () => any;
-	validation?: {
-		rule: VineType;
-		message: ValidatorMessage;
-	};
+export declare interface Attribute {
+  default?: string | number | boolean | Date
+  unique?: boolean
+  order?: number
+  required?: boolean
+  hidden?: boolean
+  fillable?: boolean
+  factory?: () => any
+  validation?: {
+    rule: VineType
+    message: ValidatorMessage
+  }
 }
-export interface Attributes {
-	[key: string]: Attribute;
+export declare interface Attributes {
+  [key: string]: Attribute
 }
-export interface RelationConfig {
-	relationship: string;
-	model: string;
-	table: string;
-	relationModel?: string;
-	relationTable?: string;
-	foreignKey: string;
-	relationName?: string;
-	throughModel?: string;
-	throughForeignKey?: string;
-	pivotTable: string;
-}
-export {};
+export declare interface RelationConfig {
+  relationship: string
+  model: string
+  table: string
+  relationModel?: string
+  relationTable?: string
+  foreignKey: string
+  modelKey: string
+  relationName?: string
+  throughModel?: string
+  throughForeignKey?: string
+  pivotTable: string
+}

package/dist/notifications.d.ts

@@ -1,106 +1,151 @@
-export interface NotificationOptions {
-	default: "email" | "sms" | "chat" | string;
-	email: {
-		default: "emailjs" | "mailgun" | "mailjet" | "mandrill" | "netcore" | "nodemailer" | "postmark" | "sendgrid" | "ses" | string;
-		from: {
-			name: string;
-			address: 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;
-		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;
-		drivers: {
-			slack?: {
-				appId: string;
-				clientId: string;
-				secret: string;
-			};
-			msTeams?: {
-				appId: string;
-				clientId: string;
-				secret: string;
-			};
-		};
-	};
+export declare interface NotificationOptions {
+  default: 'email' | 'sms' | 'chat' | string
+
+  email: {
+    default:
+      | 'emailjs'
+      | 'mailgun'
+      | 'mailjet'
+      | 'mandrill'
+      | 'netcore'
+      | 'nodemailer'
+      | 'postmark'
+      | 'sendgrid'
+      | 'ses'
+      | string
+
+    from: {
+      name: string
+      address: 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
+
+    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
+
+    drivers: {
+      slack?: {
+        appId: string
+        clientId: string
+        secret: string
+      }
+
+      msTeams?: {
+        appId: string
+        clientId: string
+        secret: string
+      }
+
+    }
+  }
 }
-export type NotificationConfig = Partial<NotificationOptions>;
+export declare type NotificationConfig = Partial<NotificationOptions>

package/dist/pages.d.ts

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