@stacksjs/types 0.42.1 → 0.43.0

package/dist/app.d.ts

@@ -1,5 +1,5 @@
 /**
- * ### Application Options
+ * **Application Options**
  *
  * This configuration defines all of your application options. Because Stacks is full-typed,
  * you may hover any of the options below and the definitions will be provided. In case
@@ -7,7 +7,7 @@
  */
 export interface AppOptions {
     /**
-     * ### Application Name
+     * **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
@@ -17,7 +17,7 @@ export interface AppOptions {
      */
     name: string;
     /**
-     * ### Application Environment
+     * **Application Environment**
      *
      * This value determines the "environment" your application is currently
      * running in. This may determine how you prefer to configure various
@@ -27,7 +27,7 @@ export interface AppOptions {
      */
     env?: 'local' | 'development' | 'production';
     /**
-     * ### Application URL
+     * **Application URL**
      *
      * This URL is used by the console to properly generate URLs when using
      * the Artisan command line tool. You should set this to the root of
@@ -39,7 +39,7 @@ export interface AppOptions {
      */
     url?: string;
     /**
-     * ### Application Debug Mode
+     * **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
@@ -49,7 +49,7 @@ export interface AppOptions {
      */
     debug: boolean;
     /**
-     * ### Application Port
+     * **Application Port**
      *
      * This port is used when Stacks creates a server you. You should set
      * a port that's not already in use by your machine. Stacks defaults
@@ -59,7 +59,7 @@ export interface AppOptions {
      */
     port: number;
     /**
-     * ### Encryption Key
+     * **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
@@ -67,7 +67,7 @@ export interface AppOptions {
      */
     key?: string;
     /**
-     * ### Application Timezone
+     * **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
@@ -77,7 +77,7 @@ export interface AppOptions {
      */
     timezone?: string;
     /**
-     * ### Application Locale Configuration
+     * **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
@@ -89,7 +89,7 @@ export interface AppOptions {
      */
     locale?: string;
     /**
-     * ### Application Fallback Locale
+     * **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
@@ -99,7 +99,7 @@ export interface AppOptions {
      */
     fallbackLocale: 'en';
     /**
-     * ### Integrated Development Environment
+     * **Integrated Development Environment**
      *
      * Currently, only VS Code is fully supported. While you may use Stacks with
      * any editor, some of its tooling is VS Code specific. Hence, for the
@@ -109,7 +109,7 @@ export interface AppOptions {
      */
     editor: string;
     /**
-     * ### Cipher
+     * **Cipher**
      *
      * Description WIP.
      *

package/dist/cli.d.ts

@@ -24,7 +24,7 @@ type SpinnerOptions = Ora;
  */
 export interface CliOptions {
     /**
-     * ### CLI Debug Level
+     * **CLI Debug Level**
      *
      * When your application is in debug mode, a different level of information,
      * like stack traces, will be shown on every error that occurs within the
@@ -34,7 +34,7 @@ export interface CliOptions {
      */
     debug?: boolean;
     /**
-     * ### Current Work Directory
+     * **Current Work Directory**
      *
      * Based on the `cwd` value, that's where the command...
      *
@@ -42,7 +42,7 @@ export interface CliOptions {
      */
     cwd?: string;
     /**
-     * ### Loading Animation
+     * **Loading Animation**
      *
      * Should the command show a loading animation?
      * Please note, when debug mode is enabled,
@@ -133,7 +133,7 @@ export declare const enum NpmScript {
     BuildFunctions = "build:functions",
     BuildDocs = "build:docs",
     BuildStacks = "build:stacks",
-    Clean = "clean",
+    Clean = "rimraf ./pnpm-lock.yaml ./node_modules/ ./.stacks/**/node_modules",
     Dev = "dev",
     DevComponents = "dev:components",
     DevDocs = "dev:docs",
@@ -142,16 +142,17 @@ export declare const enum NpmScript {
     DevFunctions = "dev:functions",
     Fresh = "fresh",
     Update = "update",
-    UpdateDependencies = "update:dependencies",
+    UpdateDependencies = "pnpm update",
     UpdateFramework = "update:framework",
     UpdatePackageManager = "update:package-manager",
-    UpdateNode = "update:node",
-    Lint = "lint",
+    UpdateNode = "pnpm env use",
+    Lint = "eslint .",
     LintFix = "lint:fix",
     MakeStack = "make:stack",
-    Test = "test",
-    TestTypes = "test:types",
-    TestCoverage = "test:coverage",
+    Test = "vitest --config .stacks/vitest.config.ts",
+    TestUi = "vitest --config .stacks/vitest.config.ts --ui",
+    TestCoverage = "vitest --config .stacks/vitest.config.ts --coverage",
+    TestTypes = "vue-tsc --noEmit",
     Generate = "generate",
     GenerateTypes = "generate:types",
     GenerateEntries = "generate:entries",

package/dist/cli.mjs

@@ -5,7 +5,7 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["BuildFunctions"] = "build:functions";
   NpmScript2["BuildDocs"] = "build:docs";
   NpmScript2["BuildStacks"] = "build:stacks";
-  NpmScript2["Clean"] = "clean";
+  NpmScript2["Clean"] = "rimraf ./pnpm-lock.yaml ./node_modules/ ./.stacks/**/node_modules";
   NpmScript2["Dev"] = "dev";
   NpmScript2["DevComponents"] = "dev:components";
   NpmScript2["DevDocs"] = "dev:docs";
@@ -14,16 +14,17 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["DevFunctions"] = "dev:functions";
   NpmScript2["Fresh"] = "fresh";
   NpmScript2["Update"] = "update";
-  NpmScript2["UpdateDependencies"] = "update:dependencies";
+  NpmScript2["UpdateDependencies"] = "pnpm update";
   NpmScript2["UpdateFramework"] = "update:framework";
   NpmScript2["UpdatePackageManager"] = "update:package-manager";
-  NpmScript2["UpdateNode"] = "update:node";
-  NpmScript2["Lint"] = "lint";
+  NpmScript2["UpdateNode"] = "pnpm env use";
+  NpmScript2["Lint"] = "eslint .";
   NpmScript2["LintFix"] = "lint:fix";
   NpmScript2["MakeStack"] = "make:stack";
-  NpmScript2["Test"] = "test";
-  NpmScript2["TestTypes"] = "test:types";
-  NpmScript2["TestCoverage"] = "test:coverage";
+  NpmScript2["Test"] = "vitest --config .stacks/vitest.config.ts";
+  NpmScript2["TestUi"] = "vitest --config .stacks/vitest.config.ts --ui";
+  NpmScript2["TestCoverage"] = "vitest --config .stacks/vitest.config.ts --coverage";
+  NpmScript2["TestTypes"] = "vue-tsc --noEmit";
   NpmScript2["Generate"] = "generate";
   NpmScript2["GenerateTypes"] = "generate:types";
   NpmScript2["GenerateEntries"] = "generate:entries";

package/dist/components.d.ts

@@ -1,7 +1,7 @@
 import type { Options } from 'unplugin-vue-components';
 export interface TagOption {
     /**
-     * ### Tag Name
+     * **Tag Name**
      *
      * This is the name of the component to be included in your library build.
      * When defining a tag, ensure that the name corresponds to a file within
@@ -24,7 +24,7 @@ export interface TagOption {
      */
     name: string | string[];
     /**
-     * ### Tag Description
+     * **Tag Description**
      *
      * This is the description of your component. This value is
      * used when to provide additional information to IDEs.
@@ -37,7 +37,7 @@ export interface TagOption {
      */
     description?: string;
     /**
-     * ### Tag Attributes
+     * **Tag Attributes**
      *
      * These are your component's attributes. While it's an optional field, you should aim
      * to define all of your component attributes here, to provide as much context

package/dist/debug.d.ts

@@ -0,0 +1,6 @@
+export interface DebugOptions {
+    driver: string;
+    enabled: boolean;
+    host: string;
+    port: number;
+}

package/dist/deploy.d.ts

@@ -1,6 +1,6 @@
 export interface DeployOptions {
     /**
-     * ### Deployment Host
+     * **Deployment Host**
      *
      * The host to deploy to.
      *

package/dist/git.d.ts

@@ -1,5 +1,5 @@
 /**
- * ### Git Options
+ * **Git Options**
  *
  * This configuration defines all of your git options. Because Stacks is full-typed, you may
  * hover any of the options below and the definitions will be provided. In case you
@@ -7,7 +7,7 @@
  */
 export interface GitOptions {
     /**
-     * ### Git Hooks
+     * **Git Hooks**
      *
      * The git hooks to use.
      *
@@ -23,7 +23,7 @@ export interface GitOptions {
      */
     hooks: GitHooks;
     /**
-     * ### Git Commit Scopes
+     * **Git Commit Scopes**
      *
      * The git commit scopes to use.
      *
@@ -39,7 +39,7 @@ export interface GitOptions {
      */
     scopes: string[];
     /**
-     * ### Git Commit Types
+     * **Git Commit Types**
      *
      * The git commit types to use.
      *
@@ -61,7 +61,7 @@ export interface GitOptions {
         emoji: string;
     }[];
     /**
-     * ### Messages—Options
+     * **Messages—Options**
      *
      * The git messages/prompts to use.
      *

package/dist/hashing.d.ts

@@ -13,7 +13,7 @@
  */
 export interface HashingOptions {
     /**
-     * ### Hashing Driver
+     * **Hashing Driver**
      *
      * This option controls the default hash driver that will be used to hash
      * passwords for your application. By default, the bcrypt algorithm is
@@ -23,7 +23,7 @@ export interface HashingOptions {
      */
     driver: 'argon' | 'bcrypt';
     /**
-     * ### Bcrypt Option
+     * **Bcrypt Option**
      *
      * Here you may specify the configuration options that should be used when
      * passwords are hashed using the Bcrypt algorithm. This will allow you
@@ -33,7 +33,7 @@ export interface HashingOptions {
      */
     bcrypt?: BcryptOptions;
     /**
-     * ### Argon Options
+     * **Argon Options**
      *
      * Here you may specify the configuration options that should be used when
      * passwords are hashed using the Argon algorithm. These will allow you
@@ -44,7 +44,7 @@ export interface HashingOptions {
     argon?: ArgonOptions;
 }
 /**
- * ### Bcrypt Options
+ * **Bcrypt Options**
  *
  * Here you may specify the configuration options that should be used when
  * passwords are hashed using the Bcrypt algorithm. This will allow you
@@ -62,7 +62,7 @@ export interface BcryptOptions {
     rounds?: number;
 }
 /**
- * ### Argon Options
+ * **Argon Options**
  *
  * Here you may specify the configuration options that should be used when
  * passwords are hashed using the Argon algorithm. These will allow you
@@ -72,7 +72,7 @@ export interface BcryptOptions {
  */
 export interface ArgonOptions {
     /**
-     * ### Argon Memory
+     * **Argon Memory**
      *
      * Amount of memory (in kibibytes) to use.
      *
@@ -81,7 +81,7 @@ export interface ArgonOptions {
      */
     memory?: number;
     /**
-     * ### Argon Parallelism
+     * **Argon Parallelism**
      *
      * Degree of parallelism (i.e. number of threads).
      *
@@ -90,7 +90,7 @@ export interface ArgonOptions {
      */
     threads?: number;
     /**
-     * ### Argon time
+     * **Argon time**
      *
      * Execution time.
      *

package/dist/i18n.d.ts

@@ -9,7 +9,7 @@ interface VitePluginVueI18nOptions {
     useVueI18nImportName?: boolean;
 }
 /**
- * ### Internationalization Options
+ * **Internationalization Options**
  *
  * The i18n option.
  *

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from './components';
 export * from './cli';
 export * from './database';
 export * from './deploy';
+export * from './debug';
 export * from './docs';
 export * from './errors';
 export * from './exit-code';
@@ -17,6 +18,7 @@ export * from './layout';
 export * from './library';
 export * from './manifest';
 export * from './markdown';
+export * from './notifications';
 export * from './pages';
 export * from './promise';
 export * from './pwa';

package/dist/index.mjs

@@ -5,6 +5,7 @@ export * from "./components.mjs";
 export * from "./cli.mjs";
 export * from "./database.mjs";
 export * from "./deploy.mjs";
+export * from "./debug.mjs";
 export * from "./docs.mjs";
 export * from "./errors.mjs";
 export * from "./exit-code.mjs";
@@ -17,6 +18,7 @@ export * from "./layout.mjs";
 export * from "./library.mjs";
 export * from "./manifest.mjs";
 export * from "./markdown.mjs";
+export * from "./notifications.mjs";
 export * from "./pages.mjs";
 export * from "./promise.mjs";
 export * from "./pwa.mjs";

package/dist/inspect.d.ts

@@ -1,6 +1,6 @@
 import type { Options } from 'vite-plugin-inspect';
 /**
- * ### Inspect Options
+ * **Inspect Options**
  *
  * The inspect options.
  *

package/dist/layout.d.ts

@@ -1,6 +1,6 @@
 import type { UserOptions } from 'vite-plugin-vue-layouts';
 /**
- * ### Layout Options
+ * **Layout Options**
  *
  * The layout options.
  */

package/dist/library.d.ts

@@ -1,6 +1,6 @@
 import type { TagsOptions } from '.';
 /**
- * ### Library Options
+ * **Library Options**
  *
  * This configuration defines all of your library options. Because Stacks is full-typed, you
  * may hover any of the options below and the definitions will be provided. In case you

package/dist/markdown.d.ts

@@ -158,7 +158,7 @@ export interface MarkdownEnv extends MarkdownItEnv {
     id: string;
 }
 /**
- * ### Markdown Options
+ * **Markdown Options**
  *
  * The Markdown options.
  *

package/dist/notifications.d.ts

@@ -0,0 +1,5 @@
+import type { IChatOptions, IEmailOptions, ISendMessageSuccessResponse, ISmsOptions } from '@novu/stateless';
+export type EmailOptions = IEmailOptions;
+export type SendMessageSuccessResponse = ISendMessageSuccessResponse;
+export type ChatOptions = IChatOptions;
+export type SmsOptions = ISmsOptions;

package/dist/pages.d.ts

@@ -1,6 +1,6 @@
 import type { UserOptions } from 'vite-plugin-pages';
 /**
- * ### Pages Options
+ * **Pages Options**
  *
  * The pages options.
  */

package/dist/pwa.d.ts

@@ -1,6 +1,6 @@
 import type { Options } from 'vite-plugin-pwa';
 /**
- * ### PWA Options
+ * **PWA Options**
  *
  * The PWA options.
  */

package/dist/search-engine.d.ts

@@ -1,9 +1,19 @@
 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 { MaybePromise } from '.';
-export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, Record, RecordOptions, Records, RecordsResults, SearchEngineSettings, SearchParams, SearchResponse };
+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
+     * **Search Engine Driver**
      *
      * The search engine to utilize.
      *
@@ -11,8 +21,15 @@ export interface SearchEngineOptions {
      * @see https://stacksjs.dev/docs/search-engine
      */
     driver: 'meilisearch' | 'algolia';
+    meilisearch?: {
+        host: string;
+        apiKey: string;
+    };
+}
+export interface MeiliSearchOptions {
+    apiKey: string;
+    host: string;
 }
-type Search = any;
 export interface SearchEngineDriver {
     client: MeiliSearch;
     createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>;
@@ -32,28 +49,29 @@ export interface SearchEngineDriver {
     deleteAllRecords?: (indexName: string) => MaybePromise<EnqueuedTask>;
     batchDeleteRecords?: (recordIds: string[] | number[], indexName: string) => MaybePromise<EnqueuedTask>;
     search?: (query: string, indexName: string, options: SearchParams) => MaybePromise<Search>;
-    calculatePagination: any;
-    currentPage: any;
-    filterName: any;
-    filters: any;
-    goToNextPage: any;
-    goToPage: any;
-    goToPrevPage: any;
-    hits: any;
-    index: any;
-    lastPageNumber: any;
-    perPage: any;
-    query: any;
-    results: any;
-    searchFilters: any;
-    searchParams: any;
-    setTotalHits: any;
-    sort: any;
-    sorts: any;
-    totalPages: any;
+    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;
 }
+export type SearchEngineDriverFactory<T> = (opts?: T) => SearchEngineDriver;
 /**
- * the TableStore interface is primarily used to unify the persisting of data to localStorage
+ * This interface is used to unify the persisting of data to localStorage
  */
 export interface SearchEngineStorage {
     /**
@@ -82,3 +100,4 @@ export interface SearchEngineStorage {
      */
     currentPage: number;
 }
+export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, Record, RecordOptions, Records, RecordsResults, SearchEngineSettings, SearchParams, SearchResponse };

package/dist/ui.d.ts

@@ -9,7 +9,7 @@ export interface WebFontMeta {
     provider?: WebFontsProviders;
 }
 /**
- * ### UI Engine Options
+ * **UI Engine Options**
  *
  * This type defines all of your UI Engine options. Because Stacks is full-typed, you may
  * hover any of the options below and the definitions will be provided. In case you
@@ -17,7 +17,7 @@ export interface WebFontMeta {
  */
 export interface UiOptions {
     /**
-     * ### Shortcuts
+     * **Shortcuts**
      *
      * Shortcuts provide you with the ability to combine
      * utility names for reusability purposes.
@@ -32,7 +32,7 @@ export interface UiOptions {
      */
     shortcuts: Shortcuts;
     /**
-     * ### Safelist
+     * **Safelist**
      *
      * Use the `safelist` option to ensure the generation of
      * those utility classes. This is useful when certain
@@ -49,7 +49,7 @@ export interface UiOptions {
      */
     safelist: string;
     /**
-     * ### Trigger String
+     * **Trigger String**
      *
      * The "trigger string" defines the class name markup
      * you want to add into your components.
@@ -63,7 +63,7 @@ export interface UiOptions {
      */
     trigger?: string;
     /**
-     * ### Class Prefix
+     * **Class Prefix**
      *
      * The prefix for the compiled class name. When transforming
      * all utility classes into a single class, this prefix
@@ -78,7 +78,7 @@ export interface UiOptions {
      */
     classPrefix?: string;
     /**
-     * ### Hash Function
+     * **Hash Function**
      *
      * The hash function used to generate the class name.
      *
@@ -96,7 +96,7 @@ export interface UiOptions {
      */
     hashFn?: (str: string) => string;
     /**
-     * ### CSS Resets—Preset
+     * **CSS Resets—Preset**
      *
      * Define a standard of reset CSS stylesheets. By default, the Tailwind
      * reset styles are utilized. You may set this value to `null`
@@ -111,7 +111,7 @@ export interface UiOptions {
      */
     reset?: ResetPreset;
     /**
-     * ### Fonts
+     * **Fonts**
      *
      * Define the local fonts you want to use. By default, Stacks provides
      * support for several local font providers. You may set this value
@@ -125,7 +125,7 @@ export interface UiOptions {
      */
     fonts?: Record<string, WebFontMeta | string | (WebFontMeta | string)[]>;
     /**
-     * ### Web Fonts
+     * **Web Fonts**
      *
      * Define the web fonts you want to use. By default, Stacks provides
      * support for several web font providers. You may set this value
@@ -139,7 +139,7 @@ export interface UiOptions {
      */
     webFonts?: Record<string, WebFontMeta | string | (WebFontMeta | string)[]>;
     /**
-     * ### Icon Sets
+     * **Icon Sets**
      *
      * This value defines the icon sets you want to use. When using icons, they
      * are displayed utilizing a technique called "icons in pure css."
@@ -160,7 +160,7 @@ export interface UiOptions {
 }
 export type Shortcuts = UserShortcuts;
 /**
- * ### Style Reset — Preset
+ * **Style Reset — Preset**
  *
  * This value sets the "reset preset." A preset defines certain
  * CSS defaults to be applied.

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.42.1",
-  "packageManager": "pnpm@7.17.0",
+  "version": "0.43.0",
+  "packageManager": "pnpm@7.17.1",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -34,7 +34,7 @@
   ],
   "engines": {
     "node": ">=v18.12.1",
-    "pnpm": ">=7.17.0"
+    "pnpm": ">=7.17.1"
   },
   "devDependencies": {
     "@mdit-vue/plugin-component": "^0.11.1",
@@ -47,7 +47,7 @@
     "@types/fs-extra": "^9.0.13",
     "@types/markdown-it-link-attributes": "^3.0.1",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^18.11.9",
+    "@types/node": "^18.11.10",
     "@types/nprogress": "^0.2.0",
     "@types/pluralize": "^0.0.29",
     "@types/prompts": "^2.4.1",
@@ -55,7 +55,7 @@
     "markdown-it": "^13.0.1",
     "mkdist": "^1.0.0",
     "typescript": "^4.9.3",
-    "unplugin-auto-import": "^0.11.5",
+    "unplugin-auto-import": "^0.12.0",
     "unplugin-vue-components": "^0.22.11",
     "vite-plugin-inspect": "^0.7.9",
     "vite-plugin-vue-layouts": "^0.7.0",