stacks 0.56.23 → 0.58.15

package/core/src/types/src/stacks.ts

@@ -0,0 +1,236 @@
+import type {
+  AiConfig,
+  AnalyticsConfig,
+  ApiConfig,
+  AppConfig,
+  BinaryConfig,
+  CacheConfig,
+  CloudConfig,
+  DatabaseConfig,
+  DnsConfig,
+  DocsConfig,
+  EmailConfig,
+  GitConfig,
+  HashingConfig,
+  LibraryConfig,
+  NotificationConfig,
+  PaymentConfig,
+  QueueConfig,
+  SearchEngineConfig,
+  SecurityConfig,
+  ServicesConfig,
+  StorageConfig,
+  Team,
+  UiConfig,
+} from '.'
+
+/**
+ * **Stacks Options**
+ *
+ * This configuration defines all of your Stacks 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 StacksOptions {
+  ai: AiConfig
+
+  /**
+   * **Analytics Options**
+   *
+   * This configuration defines all of your Analytics 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.
+   */
+  analytics: AnalyticsConfig
+
+  /**
+   * **API Options**
+   *
+   * This configuration defines all of your API 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.
+   */
+  api: ApiConfig
+
+  /**
+   * **Application Options**
+   *
+   * This configuration defines all of your Application 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.
+   */
+  app: AppConfig
+
+  /**
+   * **Binary Options**
+   *
+   * This configuration defines all of your Binary 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.
+   */
+  binary: BinaryConfig
+
+  /**
+   * **Cache Options**
+   *
+   * This configuration defines all of your Cache 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.
+   */
+  cache: CacheConfig
+
+  /**
+   * **Cloud Options**
+   *
+   * This configuration defines all of your Cloud 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.
+   */
+  cloud: CloudConfig
+
+  /**
+   * **Database Options**
+   *
+   * This configuration defines all of your Database 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.
+   */
+  database: DatabaseConfig
+
+  /**
+   * **DNS Options**
+   *
+   * This configuration defines all of your DNS 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.
+   */
+  dns: DnsConfig
+
+  /**
+   * **Docs Options**
+   *
+   * This configuration defines all of your Docs 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.
+   */
+  docs: DocsConfig
+
+  /**
+   * **Email Options**
+   *
+   * This configuration defines all of your Email 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.
+   */
+  email: EmailConfig
+
+  /**
+   * **Git Options**
+   *
+   * This configuration defines all of your Git 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.
+   */
+  git: GitConfig
+
+  /**
+   * **Hashing Options**
+   *
+   * This configuration defines all of your Hashing 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.
+   */
+  hashing: HashingConfig
+
+  /**
+   * **Library Options**
+   *
+   * This configuration defines all of your Library 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.
+   */
+  library: LibraryConfig
+
+  /**
+   * **Notification Options**
+   *
+   * This configuration defines all of your Notification 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.
+   */
+  notification: NotificationConfig
+
+  /**
+   * **Payment Options**
+   *
+   * This configuration defines all of your Payment 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.
+   */
+  payment: PaymentConfig
+
+  /**
+   * **Queue Options**
+   *
+   * This configuration defines all of your Queue 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.
+   */
+  queue: QueueConfig
+
+  /**
+   * **Search Engine Options**
+   *
+   * This configuration defines all of your Search Engine 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.
+   */
+  security: SecurityConfig
+
+  /**
+   * **Search Engine Options**
+   *
+   * This configuration defines all of your Search Engine 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.
+   */
+  searchEngine: SearchEngineConfig
+
+  /**
+   * **Services Options**
+   *
+   * This configuration defines all of your Services 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.
+   */
+  services: ServicesConfig
+
+  /**
+   * **Storage Options**
+   *
+   * This configuration defines all of your Storage 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.
+   */
+  storage: StorageConfig
+
+  /**
+   * **Team Members**
+   *
+   * This configuration defines all of your Team members. 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.
+   */
+  team: Team
+
+  /**
+   * **UI Options**
+   *
+   * This configuration defines all of your UI 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.
+   */
+  ui: UiConfig
+}
+
+export type StacksConfig = Partial<StacksOptions>

package/core/src/types/src/storage.ts

@@ -0,0 +1,13 @@
+export interface StorageOptions {
+  /**
+   * **Storage Driver**
+   *
+   * The storage driver to utilize.
+   *
+   * @default string 's3'
+   * @see https://stacksjs.org/docs/storage
+   */
+  driver: 's3' | 'efs' | 'local'
+}
+
+export type StorageConfig = Partial<StorageOptions>

package/core/src/types/src/team.ts

@@ -0,0 +1,8 @@
+type TeamMemberName = string
+type Email = string
+type TeamMembers = Record<TeamMemberName, Email>
+
+export interface Team {
+  name: string
+  members?: TeamMembers
+}

package/core/src/types/src/ui.ts

@@ -0,0 +1,197 @@
+import type { UserShortcuts } from 'unocss'
+
+export type Font = 'inter' | 'mona' | 'hubot'
+export type Icon = 'heroicons'
+export type WebFontsProviders = 'google' | 'bunny' | 'fontshare'
+
+export interface FontInfo {
+  title: string
+  text: string
+}
+export type FontFor = 'email' | 'desktop' | 'mobile' | 'web'
+
+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 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 UiOptions {
+  /**
+   * **Shortcuts**
+   *
+   * Shortcuts provide you with the ability to combine
+   * utility names for reusability purposes.
+   *
+   * @example
+   * ```
+   * config: {
+   *   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 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 applies the same font for all platforms _(web, email, desktop, and mobile)_
+   * ```ts
+   * fonts: {
+   *   title: 'Mona',
+   *   text: 'Hubot'
+   * }
+   * ```
+   * @example
+   * ```ts
+   * fonts: {
+   *   web: {
+   *     title: 'Inter',
+   *     text: 'Mona'
+   *   },
+   *   desktop: {
+   *     title: 'Mona',
+   *     text: 'Inter'
+   *   },
+   * }
+   * ```
+   */
+  fonts?: Record<FontFor, FontInfo> | { [key in FontFor]: FontInfo }
+
+  useWebFonts?: boolean | WebFontsProviders
+
+  /**
+   * **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 UiConfig = Partial<UiOptions>
+
+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/src/types/src/utils.ts

@@ -0,0 +1,47 @@
+/**
+ * Null or whatever.
+ */
+export type Nullable<T> = T | null | undefined
+
+/**
+ * Function
+ */
+export type Fn<T = void> = () => T
+
+/**
+ * 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;
+}>
+
+export type DeepPartial<T> = {
+  [P in keyof T]?: DeepPartial<T[P]>;
+}

package/core/src/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
+bun install -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.org/ui](https://stacksjs.org/ui).
+
+## 🧪 Testing
+
+```bash
+bun 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.gg/stacksjs)
+
+## 🙏🏼 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/src/ui/build.ts

@@ -0,0 +1,8 @@
+import { log, runCommand } from '@stacksjs/cli'
+
+const result = await runCommand('bun build ./src/index.ts ./src/components.ts --outdir dist --format esm --external @stacksjs/config --external unocss --external @headlessui/vue --external @julr/unocss-preset-forms --external vue --external pinia --target bun', {
+  cwd: import.meta.dir,
+})
+
+if (result.isErr())
+  log.error(result.error)

package/core/src/ui/dist/components.js

@@ -0,0 +1,68 @@
+// @bun
+// src/components/disclosure.ts
+import {
+Disclosure,
+DisclosureButton,
+DisclosurePanel
+} from "@headlessui/vue";
+// src/components/menu.ts
+import {Menu, MenuButton, MenuItems, MenuItem} from "@headlessui/vue";
+// src/components/modal.ts
+import {
+Dialog,
+DialogPanel,
+DialogTitle,
+DialogDescription
+} from "@headlessui/vue";
+// src/components/popover.ts
+import {Popover, PopoverButton, PopoverPanel} from "@headlessui/vue";
+// src/components/radio-group.ts
+import {
+RadioGroup,
+RadioGroupLabel,
+RadioGroupOption
+} from "@headlessui/vue";
+// src/components/select.ts
+import {
+Combobox,
+ComboboxInput,
+ComboboxOptions,
+ComboboxOption
+} from "@headlessui/vue";
+// src/components/tabs.ts
+import {TabGroup, TabList, Tab, TabPanels, TabPanel} from "@headlessui/vue";
+// src/components/toggle.ts
+import {Switch} from "@headlessui/vue";
+// src/components/transition.ts
+import {TransitionRoot, TransitionChild} from "@headlessui/vue";
+export {
+  TransitionRoot,
+  TransitionChild,
+  TabPanels,
+  TabPanel,
+  TabList,
+  TabGroup,
+  Tab,
+  Switch,
+  RadioGroupOption,
+  RadioGroupLabel,
+  RadioGroup,
+  PopoverPanel,
+  PopoverButton,
+  Popover,
+  MenuItems,
+  MenuItem,
+  MenuButton,
+  Menu,
+  DisclosurePanel,
+  DisclosureButton,
+  Disclosure,
+  DialogTitle,
+  DialogPanel,
+  DialogDescription,
+  Dialog,
+  ComboboxOptions,
+  ComboboxOption,
+  ComboboxInput,
+  Combobox
+};