@stacksjs/types 0.41.1 → 0.42.1

package/README.md

@@ -40,7 +40,7 @@ Please see our [releases](https://github.com/stacksjs/stacks/releases) page for
 
 ## 💪🏼 Contributing
 
-Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 
 ## 🏝 Community
 
@@ -50,7 +50,7 @@ For help, discussion about best practices, or any other conversation that would
 
 For casual chit-chat with others using this package:
 
-[Join the Open Web Discord Server](https://discord.ow3.org)
+[Join the Stacks Discord Server](https://discord.ow3.org)
 
 ## 📄 License
 

package/dist/cli.d.ts

@@ -72,7 +72,7 @@ export type CreateOptions = {
 } & {
     [key in CreateStringOption]: string;
 } & CliOptions;
-export type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'all';
+export type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'desktop' | 'all';
 export type DevOptions = {
     [key in DevOption]: boolean;
 } & CliOptions;
@@ -137,6 +137,7 @@ export declare const enum NpmScript {
     Dev = "dev",
     DevComponents = "dev:components",
     DevDocs = "dev:docs",
+    DevDesktop = "dev:desktop",
     DevPages = "dev:pages",
     DevFunctions = "dev:functions",
     Fresh = "fresh",

package/dist/cli.mjs

@@ -9,6 +9,7 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["Dev"] = "dev";
   NpmScript2["DevComponents"] = "dev:components";
   NpmScript2["DevDocs"] = "dev:docs";
+  NpmScript2["DevDesktop"] = "dev:desktop";
   NpmScript2["DevPages"] = "dev:pages";
   NpmScript2["DevFunctions"] = "dev:functions";
   NpmScript2["Fresh"] = "fresh";

package/dist/index.d.ts

@@ -18,6 +18,7 @@ export * from './library';
 export * from './manifest';
 export * from './markdown';
 export * from './pages';
+export * from './promise';
 export * from './pwa';
 export * from './search-engine';
 export * from './ssg';

package/dist/index.mjs

@@ -18,6 +18,7 @@ export * from "./library.mjs";
 export * from "./manifest.mjs";
 export * from "./markdown.mjs";
 export * from "./pages.mjs";
+export * from "./promise.mjs";
 export * from "./pwa.mjs";
 export * from "./search-engine.mjs";
 export * from "./ssg.mjs";

package/dist/promise.d.ts

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

package/dist/search-engine.d.ts

@@ -1,3 +1,6 @@
+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 };
 export interface SearchEngineOptions {
     /**
      * ### Search Engine Driver
@@ -9,3 +12,73 @@ export interface SearchEngineOptions {
      */
     driver: 'meilisearch' | 'algolia';
 }
+type Search = any;
+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: SearchEngineSettings) => MaybePromise<EnqueuedTask>;
+    listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>;
+    listAllIndices: () => MaybePromise<IndexesResults<Index[]>>;
+    getRecord?: (key: string) => MaybePromise<Record>;
+    getRecords?: (key: string) => MaybePromise<RecordOptions>;
+    createRecord?: (record: Record, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
+    createRecords?: (records: Records, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
+    createOrReplaceRecord?: (record: Record, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>;
+    createOrUpdateRecord?: (record: Record, 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: 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;
+}
+/**
+ * the TableStore interface is primarily 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;
+}

package/dist/utils.d.ts

@@ -1,27 +1,11 @@
 /**
- * Promise, or maybe not
- */
-export type Awaitable<T> = T | PromiseLike<T>;
-/**
- * Null or whatever
+ * Null or whatever.
  */
 export type Nullable<T> = T | null | undefined;
 /**
- * Array, or not yet
- */
-export type Arrayable<T> = T | Array<T>;
-/**
- * Function
- */
-export type Fn<T = void> = () => T;
-/**
- * Constructor
+ * Constructor.
  */
 export type Constructor<T = void> = new (...args: any[]) => T;
-/**
- * Infers the element type of an array
- */
-export type ElementOf<T> = T extends (infer E)[] ? E : never;
 /**
  * Defines an intersection type of all union items.
  *
@@ -30,10 +14,6 @@ export type ElementOf<T> = T extends (infer E)[] ? E : never;
  * @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;
-/**
- * Infers the arguments type of a function
- */
-export type ArgumentsType<T> = T extends ((...args: infer A) => any) ? A : never;
 export type MergeInsertions<T> = T extends object ? {
     [K in keyof T]: MergeInsertions<T[K]>;
 } : T;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.41.1",
-  "packageManager": "pnpm@7.16.0",
+  "version": "0.42.1",
+  "packageManager": "pnpm@7.17.0",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -34,7 +34,7 @@
   ],
   "engines": {
     "node": ">=v18.12.1",
-    "pnpm": ">=7.16.0"
+    "pnpm": ">=7.17.0"
   },
   "devDependencies": {
     "@mdit-vue/plugin-component": "^0.11.1",
@@ -55,11 +55,11 @@
     "markdown-it": "^13.0.1",
     "mkdist": "^1.0.0",
     "typescript": "^4.9.3",
-    "unplugin-auto-import": "^0.11.4",
-    "unplugin-vue-components": "^0.22.9",
-    "vite-plugin-inspect": "^0.7.8",
+    "unplugin-auto-import": "^0.11.5",
+    "unplugin-vue-components": "^0.22.11",
+    "vite-plugin-inspect": "^0.7.9",
     "vite-plugin-vue-layouts": "^0.7.0",
-    "vite-ssg": "^0.21.2",
+    "vite-ssg": "^0.22.0",
     "vitepress": "1.0.0-alpha.29"
   },
   "scripts": {