@stacksjs/types 0.64.6 → 0.65.0

package/dist/model.d.ts

@@ -0,0 +1,144 @@
+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;
+}
+export interface ModelElement {
+	field: string;
+	default: string | number | boolean | Date | undefined | null;
+	unique: boolean;
+	fieldArray: FieldArrayElement | null;
+}
+export 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>;
+export interface SeedOptions {
+	count: number;
+}
+type LogAttribute = string;
+interface ActivityLogOption {
+	exclude: LogAttribute[];
+	include: LogAttribute[];
+	logOnly: LogAttribute[];
+}
+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;
+}
+type ApiOptions = DeepPartial<ApiSettings>;
+export interface TimestampOptions {
+	createdAt?: string;
+	updatedAt?: string;
+	deletedAt?: string;
+}
+interface ValidatorMessage {
+	[key: string]: string;
+}
+export 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 };
+}
+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 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 {};

package/dist/notifications.d.ts

@@ -0,0 +1,106 @@
+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 type NotificationConfig = Partial<NotificationOptions>;

package/dist/pages.d.ts

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

package/dist/payments.d.ts

@@ -0,0 +1,60 @@
+export interface PaymentOptions {
+	driver: "stripe";
+}
+export type PaymentConfig = Partial<PaymentOptions>;
+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/ports.d.ts

@@ -0,0 +1,20 @@
+/**
+* **Stacks Ports**
+*
+* This port is used by the Stacks servers when running your application, library, email services,
+* and other services. You may change this port to any other port that is free
+* on your machine, as long as the following 6 ports are also available.
+*/
+export interface Ports {
+	frontend: number;
+	backend: number;
+	admin: number;
+	library: number;
+	desktop: number;
+	email: number;
+	docs: number;
+	inspect: number;
+	api: number;
+	systemTray: number;
+	database: number;
+}

package/dist/promise.d.ts

@@ -0,0 +1 @@
+export type MaybePromise<T> = T | Promise<T>;

package/dist/push.d.ts

@@ -0,0 +1,31 @@
+export interface FCMPushNotificationOptions {
+	eventName: string;
+	to: { subscriberId: string };
+	payload: {
+		deviceTokens: Array<string>;
+		badge: boolean;
+		clickAction: string;
+		color: string;
+		icon: string;
+		sound: string;
+	};
+}
+export interface ExpoPushNotificationOptions {
+	eventName: string;
+	to: { subscriberId: string };
+	payload: {
+		to: string[];
+		data: object;
+		title: string;
+		body: string;
+		ttl: number;
+		expiration: number;
+		priority: "default" | "normal" | "high";
+		subtitle: string;
+		sound: "default" | null;
+		badge: number;
+		channelId: string;
+		categoryId: string;
+		mutableContent: boolean;
+	};
+}

package/dist/pwa.d.ts

@@ -0,0 +1,7 @@
+import type { Options } from "vite-plugin-pwa";
+/**
+* **PWA Options**
+*
+* The PWA options.
+*/
+export type PwaOptions = Options;

package/dist/queue.d.ts

@@ -0,0 +1,34 @@
+import type { DeepPartial } from "./utils";
+export interface QueueOptions {
+	default: "sync" | "database" | "redis" | "sqs";
+	connections: {
+		sync: { driver: "sync" };
+		database: {
+			driver: "database";
+			table: "jobs";
+			queue: "default";
+			retry_after: 90;
+		};
+		redis: {
+			driver: "redis";
+			connection: "default";
+			queue: "default";
+			retry_after: 90;
+		};
+		sqs: {
+			driver: "sqs";
+			key: "";
+			secret: "";
+			prefix: "";
+			suffix: "";
+			queue: "default";
+			region: "us-east-1";
+		};
+	};
+	failed: {
+		driver: "database";
+		database: "mysql";
+		table: "failed_jobs";
+	};
+}
+export type QueueConfig = DeepPartial<QueueOptions>;

package/dist/reactivity.d.ts

@@ -0,0 +1 @@
+export type { Ref } from "vue";

package/dist/request.d.ts

@@ -0,0 +1,30 @@
+import type { VineType } from "@stacksjs/types";
+export type * from "../../../types/requests";
+interface RequestData {
+	[key: string]: any;
+}
+type RouteParams = { [key: string]: string | number } | null;
+interface ValidationField {
+	rule: VineType;
+	message: Record<string, string>;
+}
+interface CustomAttributes {
+	[key: string]: ValidationField;
+}
+export interface RequestInstance {
+	addQuery: (url: URL) => void;
+	addBodies: (params: any) => void;
+	addParam: (param: RouteParams) => void;
+	get: <T>(element: T) => string | undefined;
+	header: (element: string) => string | number | boolean | null;
+	Header: (element: string) => string | number | boolean | null;
+	all: () => RequestData;
+	validate: (attributes: CustomAttributes) => void;
+	has: (element: string) => boolean;
+	isEmpty: () => boolean;
+	extractParamsFromRoute: (routePattern: string, pathname: string) => void;
+	getParam: (key: string) => number | string | null;
+	getParams: () => RouteParams;
+	getParamAsInt: (key: string) => number | null;
+}
+export {};

package/dist/router.d.ts

@@ -0,0 +1,55 @@
+import type { Action } from "@stacksjs/actions";
+type ActionPath = string;
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "before" | "after" | "view";
+export type RouteCallback = (params?: Record<string, any>) => any | string | object;
+export interface Route {
+	name: string;
+	uri: string;
+	url: string;
+	path?: string;
+	prefix?: string;
+	method: HttpMethod;
+	pattern: RegExp;
+	callback: RouteCallback | ActionPath | Action | Promise<any>;
+	paramNames: string[];
+	middleware?: string | string[];
+	statusCode?: StatusCode;
+}
+export interface MiddlewareOptions {
+	name: string;
+	description?: string;
+	priority: number;
+	handle: Function;
+}
+export type StatusCode = 200 | 201 | 202 | 204 | 301 | 302 | 304 | 400 | 401 | 403 | 404 | 500;
+export type RedirectCode = Extract<StatusCode, 301 | 302>;
+export type RouteParam = { [key: string]: string | number } | null;
+export type MiddlewareFn = () => void;
+export interface Middlewares {
+	logger: MiddlewareFn;
+	auth: MiddlewareFn;
+	[key: string]: MiddlewareFn;
+}
+export interface RouteGroupOptions {
+	prefix?: string;
+	middleware?: Route["middleware"];
+}
+type Prefix = string;
+export interface RouterInterface {
+	get: (url: Route["url"], callback: Route["callback"]) => this;
+	post: (url: Route["url"], callback: Route["callback"]) => this;
+	view: (url: Route["url"], callback: Route["callback"]) => this;
+	redirect: (url: Route["url"], callback: Route["callback"], status?: RedirectCode) => this;
+	delete: (url: Route["url"], callback: Route["callback"]) => this;
+	patch: (url: Route["url"], callback: Route["callback"]) => this;
+	put: (url: Route["url"], callback: Route["callback"]) => this;
+	email: (url: Route["url"]) => Promise<this>;
+	health: () => Promise<this>;
+	job: (url: Route["url"]) => Promise<this>;
+	action: (url: Route["url"]) => Promise<this>;
+	group: (options: Prefix | RouteGroupOptions, callback: () => void) => this;
+	name: (name: string) => this;
+	middleware: (middleware: Route["middleware"]) => this;
+	getRoutes: () => Promise<Route[]>;
+}
+export {};

package/dist/scheduler.d.ts

@@ -0,0 +1 @@
+export type { Schedule } from "@stacksjs/scheduler";

package/dist/search-engine.d.ts

@@ -0,0 +1,114 @@
+import type { EnqueuedTask, Hits, Index, IndexesResults, IndexOptions, MeiliSearch, Settings as MeilisearchOptions, DocumentOptions as RecordOptions, SearchParams, SearchResponse } from "meilisearch";
+import type { MaybePromise } from ".";
+type Search = any;
+type Page = any;
+type Pages = Page[];
+type Filter = any;
+type Filters = Filter[];
+type Result = any;
+type Results = Result[];
+type SearchFilter = any;
+type SearchFilters = SearchFilter[];
+type Sorts = any;
+type Sort = any;
+export interface SearchEngineOptions {
+	/**
+	* **Search Engine Driver**
+	*
+	* The search engine to utilize.
+	*
+	* @default string 'opensearch'
+	* @see https://stacksjs.org/docs/search-engine
+	*/
+	driver: "opensearch";
+	opensearch?: {
+		host: string;
+		protocol: number;
+		port: number;
+		auth: string;
+	};
+	filters?: { [key: string]: string };
+	/**
+	* The number of hits to be returned per page.
+	*
+	* @default number 20
+	*/
+	perPage?: number;
+}
+export type SearchEngineConfig = Partial<SearchEngineOptions>;
+export interface SearchEngineDriver {
+	client: MeiliSearch;
+	createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>;
+	getIndex: (name: string) => MaybePromise<Index>;
+	updateIndex: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>;
+	deleteIndex: (name: string) => MaybePromise<EnqueuedTask>;
+	updateIndexSettings: (name: string, settings: SearchEngineOptions) => MaybePromise<EnqueuedTask>;
+	listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>;
+	listAllIndices: () => MaybePromise<IndexesResults<Index[]>>;
+	getRecord: (key: string) => MaybePromise<any>;
+	getRecords: (key: string) => MaybePromise<RecordOptions>;
+	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>;
+	search: (query: string, indexName: string, options: SearchParams) => MaybePromise<Search>;
+	calculatePagination: Pages;
+	currentPage: Page;
+	filterName: string;
+	filters: Filters;
+	goToNextPage: () => Page;
+	goToPage: (pageNumber: number) => Page;
+	goToPrevPage: () => Page;
+	hits: Hits;
+	index: Index;
+	lastPage: Page;
+	perPage: number;
+	query: string;
+	results: Results;
+	searchFilters: SearchFilters;
+	searchParams: SearchParams;
+	setTotalHits: number;
+	sort: Sort;
+	sorts: Sorts;
+	totalPages: number;
+}
+/**
+* This interface is used to unify the persisting of data to localStorage
+*/
+export interface SearchEngineStorage {
+	/**
+	* The search engine index name.
+	* i.e. the type of table, like `users`, `posts`, `products`, etc.
+	*/
+	index?: string;
+	/**
+	* The search engine results object.
+	*/
+	results?: SearchResponse;
+	/**
+	* The search engine hits object.
+	*/
+	hits?: Hits;
+	/**
+	* The number of hits to be returned per page.
+	*
+	* @default number 20
+	*/
+	perPage: number;
+	/**
+	* The current page number.
+	*
+	* @default number 1
+	*/
+	currentPage: number;
+}
+export interface SearchOptions {
+	searchable: string[];
+	sortable: string[];
+	filterable: string[];
+	options?: SearchEngineOptions;
+}
+export type { EnqueuedTask, Hits, Index, IndexesResults, IndexOptions, MeiliSearch, MeilisearchOptions, RecordOptions, SearchParams, SearchResponse };

package/dist/security.d.ts

@@ -0,0 +1,18 @@
+import type { CountryCode } from "./cloud";
+import type { DeepPartial } from "./utils";
+export interface FirewallOptions {
+	enabled: boolean;
+	countryCodes: CountryCode[];
+	ipAddresses: string[];
+	queryString: string[];
+	httpHeaders: string[];
+	rateLimitPerMinute: number;
+	useIpReputationLists: boolean;
+	useKnownBadInputsRuleSet: boolean;
+}
+export type FirewallConfig = Partial<FirewallOptions>;
+export interface SecurityOptions {
+	driver: "aws";
+	firewall: FirewallOptions;
+}
+export type SecurityConfig = DeepPartial<SecurityOptions>;

package/dist/server.d.ts

@@ -0,0 +1,6 @@
+export interface ServerOptions {
+	type?: "frontend" | "backend" | "api" | "library" | "desktop" | "docs" | "email" | "admin" | "system-tray" | "database";
+	host?: string;
+	port?: number;
+	open?: boolean;
+}

package/dist/services.d.ts

@@ -0,0 +1,29 @@
+export interface ServicesOptions {
+	algolia?: {
+		appId: string;
+		apiKey: string;
+	};
+	godaddy?: {
+		apiKey: string;
+		apiSecret: string;
+	};
+	meilisearch?: {
+		appId: string;
+		apiKey: string;
+	};
+	lemonSqueezy?: {
+		appId: string;
+		apiKey: string;
+	};
+	stripe?: {
+		appId: string;
+		apiKey: string;
+	};
+	aws?: {
+		accountId: string;
+		appId: string;
+		apiKey: string;
+		region: string;
+	};
+}
+export type ServicesConfig = Partial<ServicesOptions>;

package/dist/settings-config.d.ts

@@ -0,0 +1,9 @@
+export interface SettingsMenuOption {
+	label: string;
+	path: string;
+	icon?: MenuIcon;
+}
+export interface MenuIcon {
+	name?: string;
+	source?: string;
+}