stacks 0.40.0 → 0.44.9

package/core/types/src/search-engine.ts

@@ -0,0 +1,118 @@
+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 '.'
+
+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 'meilisearch'
+   * @see https://stacksjs.dev/docs/search-engine
+   */
+  driver: 'meilisearch' | 'algolia'
+
+  meilisearch?: {
+    host: string
+    apiKey: string
+  }
+}
+
+export interface MeiliSearchOptions {
+  apiKey: string
+  host: string
+}
+
+export interface SearchEngineDriver {
+  client: MeiliSearch
+
+  // Indexes
+  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[]>> // alternatives plural spelling
+
+  // Records (MeiliSearch uses the term "documents")
+  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
+  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 // SearchResponse
+  searchFilters: SearchFilters
+  searchParams: SearchParams
+  setTotalHits: number
+  sort: Sort
+  sorts: Sorts
+  totalPages: number
+}
+
+export type SearchEngineDriverFactory<T> = (opts?: T) => SearchEngineDriver
+
+/**
+ * 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 type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, Record, RecordOptions, Records, RecordsResults, SearchEngineSettings, SearchParams, SearchResponse }

package/core/types/src/ssg.ts

@@ -0,0 +1,3 @@
+import { type ViteSSGContext } from '@stacksjs/types'
+
+export type UserModule = (ctx: ViteSSGContext) => void

package/core/types/src/ui.ts

@@ -0,0 +1,184 @@
+import type { UserShortcuts } from 'unocss'
+
+export type Font = 'inter' | 'mona' | 'hubot'
+export type Icon = 'heroicon-outline' | 'heroicon-solid'
+export type WebFontsProviders = 'google' | 'bunny' | 'fontshare' | 'none'
+
+export interface WebFontMeta {
+  name: string
+  weights?: (string | number)[]
+  italic?: boolean
+  provider?: WebFontsProviders
+}
+
+/**
+ * **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
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export interface UiOptions {
+  /**
+   * **Shortcuts**
+   *
+   * Shortcuts provide you with the ability to combine
+   * utility names for reusability purposes.
+   *
+   * @example
+   * ```
+   * shortcuts: {
+   *   'btn': 'px-4 py-2 rounded text-white bg-blue-500',
+   *   'btn-lg': 'btn px-6 py-3',
+   * }
+   * ```
+   */
+  shortcuts: Shortcuts
+
+  /**
+   * **Safelist**
+   *
+   * Use the `safelist` option to ensure the generation of
+   * those utility classes. This is useful when certain
+   * class names don’t exist in your content files.
+   *
+   * @example
+   * ```ts
+   * safelist: [
+   *   'btn',
+   *   'btn-lg',
+   *   'btn-blue',
+   *   'btn-blue-500',
+   * ]
+   */
+  safelist: string
+
+  /**
+   * **Trigger String**
+   *
+   * The "trigger string" defines the class name markup
+   * you want to add into your components.
+   *
+   * @default ':stx:'
+   *
+   * @example
+   * ```ts
+   * trigger: ':stx:'
+   * ```
+   */
+  trigger?: string
+
+  /**
+   * **Class Prefix**
+   *
+   * The prefix for the compiled class name. When transforming
+   * all utility classes into a single class, this prefix
+   * will be added to the generated CSS class name.
+   *
+   * @default 'stx-'
+   *
+   * @example
+   * ```ts
+   * prefix: 'stx-'
+   * ```
+   */
+  classPrefix?: string
+
+  /**
+   * **Hash Function**
+   *
+   * The hash function used to generate the class name.
+   *
+   * @example
+   * ```ts
+   * hash: (str: string) => {
+   *   return str
+   *     .split('')
+   *     .reduce((a, b) => {
+   *       a = ((a << 5) - a) + b.charCodeAt(0)
+   *       return a & a
+   *     }, 0)
+   *     .toString(36)
+   * }
+   */
+  hashFn?: (str: string) => string
+
+  /**
+   * **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`
+   * if you prefer not applying any default stylesheets.
+   *
+   * @url https://www.npmjs.com/package/@unocss/reset
+   * @todo preset needs to be added via a Vite plugin on development & build
+   * @example
+   * ```ts
+   * reset: 'tailwind'
+   * ```
+   */
+  reset?: ResetPreset
+
+  /**
+   * **Fonts**
+   *
+   * Define the local fonts you want to use. By default, Stacks provides
+   * support for several local font providers. You may set this value
+   * to `null` if you prefer not utilize any local fonts.
+   *
+   * @see https://stacks.ow3.org/fonts
+   * @example
+   * ```ts
+   * fonts: 'mona-lisa'
+   * ```
+   */
+  fonts?: Record<string, WebFontMeta | string | (WebFontMeta | string)[]>
+
+  /**
+   * **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
+   * to `null` if you prefer not utilize any web fonts.
+   *
+   * @see https://stacks.ow3.org/fonts
+   * @example
+   * ```ts
+   * webFonts: 'inter'
+   * ```
+   */
+  webFonts?: Record<string, WebFontMeta | string | (WebFontMeta | string)[]>
+
+  /**
+   * **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."
+   * Learn more here https://antfu.me/posts/icons-in-pure-css.
+   *
+   * @see https://stacks.ow3.org/config/icons — list of available icon sets
+   * @todo implement this into Vite build flow
+   * @example
+   * ```ts
+   * icons: ['heroicons']
+   * ```
+   * @example
+   * ```html
+   * <i class="i-heroicons-outline-book-open w-8 h-8 text-gray-500" aria-hidden="true" />
+   * ```
+   */
+  icons: Icon | Icon[]
+  // icons: Record<string, () => Promise<any>>
+}
+
+export type Shortcuts = UserShortcuts
+
+/**
+ * **Style Reset — Preset**
+ *
+ * This value sets the "reset preset." A preset defines certain
+ * CSS defaults to be applied.
+ *
+ * @default "tailwind"
+ */
+export type ResetPreset = 'tailwind' | 'normalize' | 'sanitize' | 'eric-meyer' | 'antfu' | null

package/core/types/src/utils.ts

@@ -0,0 +1,38 @@
+/**
+ * Null or whatever.
+ */
+export type Nullable<T> = T | null | undefined
+
+/**
+ * Array, or not yet
+ */
+export type Arrayable<T> = T | Array<T>
+
+/**
+ * Constructor.
+ */
+export type Constructor<T = void> = new (...args: any[]) => T
+
+/**
+ * Defines an intersection type of all union items.
+ *
+ * @param U Union of any types that will be intersected.
+ * @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 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
+    ? DeepMerge<F[K], S[K]>
+    : K extends keyof S
+      ? S[K]
+      : K extends keyof F
+        ? F[K]
+        : never;
+}>

package/core/ui/README.md

@@ -0,0 +1,66 @@
+# Stacks UI
+
+This package contains the Stacks UI engine.
+
+## ☘️ Features
+
+- 🍀 **Vue-powered** _extendable & native access to the ecosystem_
+- 🎨 **Style with ease** _via an atomic CSS engine, powered by UnoCSS_
+- 🍍 **Simple data storage** _accessed via an intuitive API_
+- Written in modern ESM/TypeScript
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/ui
+```
+
+Now, you can use it in your project:
+
+```js
+import ui from '@stacksjs/ui'
+
+// wip
+```
+
+To view the full documentation, please visit [https://stacksjs.dev/ui](https://stacksjs.dev/ui).
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Stacks Discord Server](https://discord.ow3.org)
+
+## 🙏🏼 Credits
+
+Many thanks to the following core technologies & people who have contributed to this package:
+
+- [Vue](https://vuejs.org)
+- [UnoCSS](https://github.com/unocss/unocss)
+- [Pinia](https://pinia.vuejs.org)
+- [Chris Breuer](https://github.com/chrisbbreuer)
+- [All Contributors](../../contributors)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/core/ui/node_modules/.bin/mkdist

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/mkdist@1.0.0_typescript@4.9.4/node_modules/mkdist/dist/cli.cjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/mkdist@1.0.0_typescript@4.9.4/node_modules/mkdist/dist/cli.cjs" "$@"
+fi

package/core/ui/node_modules/.bin/tsc

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsc" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsc" "$@"
+fi

package/core/ui/node_modules/.bin/tsserver

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsserver" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsserver" "$@"
+fi

package/core/ui/node_modules/.bin/vue-tsc

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/vue-tsc@1.0.13_typescript@4.9.4/node_modules/vue-tsc/bin/vue-tsc.js" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/vue-tsc@1.0.13_typescript@4.9.4/node_modules/vue-tsc/bin/vue-tsc.js" "$@"
+fi

package/core/ui/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@stacksjs/ui",
+  "type": "module",
+  "version": "0.44.9",
+  "packageManager": "pnpm@7.18.2",
+  "description": "The Stacks atomic UI engine, powered by UnoCSS.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/ui#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/ui"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "css",
+    "atomic",
+    "ui",
+    "engine",
+    "styles",
+    "stacks",
+    "unocss"
+  ],
+  "sideEffects": false,
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.18.2"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "prepublishOnly": "pnpm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@iconify-json/heroicons-outline": "^1.1.5",
+    "@iconify-json/heroicons-solid": "^1.1.6",
+    "@julr/unocss-preset-forms": "^0.0.2",
+    "@stacksjs/build": "workspace:*",
+    "@stacksjs/config": "workspace:*",
+    "@unocss/transformer-compile-class": "^0.47.6",
+    "pinia": "^2.0.28",
+    "unocss": "^0.47.6",
+    "vue": "^3.2.45",
+    "vue-tsc": "^1.0.13"
+  },
+  "devDependencies": {
+    "@stacksjs/testing": "workspace:*",
+    "mkdist": "^1.0.0",
+    "typescript": "^4.9.4"
+  }
+}

package/core/ui/src/index.ts

@@ -0,0 +1,17 @@
+import * as CssEngine from 'unocss'
+import { presetForms } from '@julr/unocss-preset-forms'
+import transformerCompileClass from '@unocss/transformer-compile-class'
+import { ui as options } from '@stacksjs/config'
+import * as UiEngine from 'vue'
+import * as Store from 'pinia'
+import config from './unocss'
+
+export default {
+  UiEngine,
+  CssEngine,
+  Store,
+  presetForms,
+  transformerCompileClass,
+  config,
+  options,
+}

package/core/ui/src/unocss.ts

@@ -0,0 +1,45 @@
+import type { UserConfig } from 'unocss'
+import { defineConfig, presetIcons, presetTypography, presetWebFonts, presetWind, transformerDirectives, transformerVariantGroup } from 'unocss'
+import { presetForms } from '@julr/unocss-preset-forms'
+import transformerCompileClass from '@unocss/transformer-compile-class'
+import { ui } from '@stacksjs/config'
+
+const config: UserConfig = defineConfig({
+  shortcuts: ui.shortcuts,
+
+  presets: [
+    presetWind(), // allows for Tailwind utility classes
+    presetForms(), // allows for form Tailwind's form styling
+    presetTypography(),
+    presetIcons({
+      prefix: 'i-',
+      warn: true,
+      collections: ui.icons,
+      extraProperties: {
+        'display': 'inline-block',
+        'vertical-align': 'middle',
+      },
+    }),
+    presetWebFonts({
+      provider: 'bunny', // privacy-friendly Google Web Fonts proxy
+      fonts: {
+        // these will extend the default theme
+        sans: 'Inter',
+        mono: 'Inter',
+      },
+    }),
+  ],
+
+  transformers: [
+    transformerCompileClass({
+      classPrefix: ui.classPrefix,
+      trigger: ui.trigger,
+    }),
+    transformerDirectives(),
+    transformerVariantGroup(),
+  ],
+
+  safelist: ui.safelist.split(' '),
+})
+
+export default config

package/core/ui/tests/example.test.ts

@@ -0,0 +1,7 @@
+import { assert, describe, test } from 'vitest'
+
+describe('example test', () => {
+  test('assert', () => {
+    assert.equal(1, 1)
+  })
+})

package/core/utils/node_modules/.bin/esno

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/esno@0.16.3/node_modules/esno/esno.js" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/esno@0.16.3/node_modules/esno/esno.js" "$@"
+fi

package/core/utils/node_modules/.bin/mkdist

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/mkdist@1.0.0_typescript@4.9.4/node_modules/mkdist/dist/cli.cjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/mkdist@1.0.0_typescript@4.9.4/node_modules/mkdist/dist/cli.cjs" "$@"
+fi

package/core/utils/node_modules/.bin/rimraf

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/rimraf@3.0.2/node_modules/rimraf/bin.js" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/rimraf@3.0.2/node_modules/rimraf/bin.js" "$@"
+fi