stacks 0.40.0 → 0.44.9

package/core/objects/src/index.ts

@@ -0,0 +1,130 @@
+import { isObject, notNullish } from '@stacksjs/utils'
+import type { DeepMerge } from '@stacksjs/types'
+
+export { Collection, collect } from '@stacksjs/collections'
+
+/**
+ * Map key/value pairs for an object, and construct a new one
+ *
+ *
+ * @category Object
+ *
+ * Transform:
+ * @example
+ * ```
+ * objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])
+ * // { A: '1', B: '2' }
+ * ```
+ *
+ * Swap key/value:
+ * @example
+ * ```
+ * objectMap({ a: 1, b: 2 }, (k, v) => [v, k])
+ * // { 1: 'a', 2: 'b' }
+ * ```
+ *
+ * Filter keys:
+ * @example
+ * ```
+ * objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])
+ * // { b: 2 }
+ * ```
+ */
+export function objectMap<K extends string, V, NK = K, NV = V>(obj: Record<K, V>, fn: (key: K, value: V) => [NK, NV] | undefined): Record<K, V> {
+  return Object.fromEntries(
+    Object.entries(obj)
+      .map(([k, v]) => fn(k as K, v as V))
+      .filter(notNullish),
+  )
+}
+
+/**
+ * Type guard for any key, `k`.
+ * Marks `k` as a key of `T` if `k` is in `obj`.
+ *
+ * @category Object
+ * @param obj object to query for key `k`
+ * @param k key to check existence in `obj`
+ */
+export function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T {
+  return k in obj
+}
+
+/**
+ * Strict typed `Object.keys`
+ *
+ * @category Object
+ */
+export function objectKeys<T extends object>(obj: T) {
+  return Object.keys(obj) as Array<`${keyof T & (string | number | boolean | null | undefined)}`>
+}
+
+/**
+ * Strict typed `Object.entries`
+ *
+ * @category Object
+ */
+export function objectEntries<T extends object>(obj: T) {
+  return Object.entries(obj) as Array<[keyof T, T[keyof T]]>
+}
+
+/**
+ * Deep merge :P
+ *
+ * @category Object
+ */
+export function deepMerge<T extends object = object, S extends object = T>(target: T, ...sources: S[]): DeepMerge<T, S> {
+  if (!sources.length)
+    return target as any
+
+  const source = sources.shift()
+  if (source === undefined)
+    return target as any
+
+  if (isMergeableObject(target) && isMergeableObject(source)) {
+    objectKeys(source).forEach((key) => {
+      // @ts-expect-error some description
+      if (isMergeableObject(source[key])) {
+        // @ts-expect-error some description
+        if (!target[key])
+          // @ts-expect-error some description
+          target[key] = {}
+
+        // @ts-expect-error some description
+        deepMerge(target[key], source[key])
+      }
+      else {
+        // @ts-expect-error some description
+        target[key] = source[key]
+      }
+    })
+  }
+
+  return deepMerge(target, ...sources)
+}
+
+function isMergeableObject(item: any): item is Object {
+  return isObject(item) && !Array.isArray(item)
+}
+
+/**
+ * Clear undefined fields from an object. It mutates the object
+ *
+ * @category Object
+ */
+export function clearUndefined<T extends object>(obj: T): T {
+  Object.keys(obj).forEach((key: string) => (obj[key] === undefined ? delete obj[key] : {}))
+  return obj
+}
+
+/**
+ * Determines whether an object has a property with the specified name
+ *
+ * @see https://eslint.org/docs/rules/no-prototype-builtins
+ * @category Object
+ */
+export function hasOwnProperty<T>(obj: T, v: PropertyKey) {
+  if (obj == null)
+    return false
+  return Object.prototype.hasOwnProperty.call(obj, v)
+}

package/core/objects/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/path/README.md

@@ -0,0 +1,64 @@
+# Stacks Path
+
+Easily work with file paths.
+
+## ☘️ Features
+
+- Ensures paths are normalized across all Operating Systems
+- Easily access the path's basename, dirname, extension, filename, and more
+- Drop-in Node.js module replacement
+- Written in modern ESM/TypeScript
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/path
+```
+
+Now, you can easily access it in your project:
+
+```js
+import { filename, normalizeAliases, resolve, resolveAlias } from '@stacksjs/path'
+
+// and more...
+```
+
+To view the full documentation, please visit [https://stacksjs.dev/path](https://stacksjs.dev/path).
+
+## 🧪 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:
+
+- [pathe](https://github.com/unjs/pathe)
+- [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/path/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/path/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/path/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/path/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@stacksjs/path",
+  "type": "module",
+  "version": "0.44.9",
+  "packageManager": "pnpm@7.18.2",
+  "description": "The Stacks path.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/path#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/path"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "path",
+    "pathe",
+    "paths",
+    "utilities",
+    "functions",
+    "stacks"
+  ],
+  "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"
+  },
+  "dependencies": {
+    "pathe": "^1.0.0"
+  },
+  "devDependencies": {
+    "@stacksjs/testing": "workspace:*",
+    "mkdist": "^1.0.0",
+    "typescript": "^4.9.4"
+  }
+}

package/core/path/src/index.ts

@@ -0,0 +1,353 @@
+import { basename, delimiter, dirname, extname, format, isAbsolute, join, normalize, normalizeString, parse, relative, resolve, sep, toNamespacedPath } from 'pathe'
+
+/**
+ * Returns the path to the `ai` directory. The AI directory
+ * contains the core Stacks' AI logic which currently
+ * is a wrapper of the OpenAI API.
+ *
+ * @param path - relative path to the file or directory
+ * @returns string - absolute path to the file or directory
+ * @example
+ * ```ts
+ * import { aiPath } from '@stacks/paths'
+ *
+ * console.log('path is', aiPath())
+ * // path is /Users/chrisbreuer/Code/stacks/.stacks/core/ai
+ * ```
+ */
+export function aiPath(path?: string) {
+  return corePath(`ai/${path || ''}`)
+}
+
+/**
+ * Returns the path to the `actions` directory. The actions directory
+ * contains the core Stacks' actions. An action
+ *
+ * @param path - relative path to the file or directory
+ * @returns string - absolute path to the file or directory
+ * @example
+ * ```ts
+ * import { buildPath } from '@stacks/paths'
+ *
+ * buildPath('functions.vue')
+ * buildPath('any-path.ts')
+ * ```
+ */
+export function actionsPath(path?: string) {
+  return corePath(`actions/src/${path || ''}`)
+}
+
+export function aliasPath() {
+  return corePath('alias/src/index.ts')
+}
+
+export function runtimePath(path?: string) {
+  return frameworkPath(`buddy/${path || ''}`)
+}
+
+export function arraysPath(path?: string) {
+  return corePath(`arrays/${path || ''}`)
+}
+
+export function authPath(path?: string) {
+  return corePath(`auth/${path || ''}`)
+}
+
+/**
+ * Returns the path to the build directory. The build directory
+ * contains Stacks' build engine & its tooling integrations.
+ *
+ * @param path string - relative path to the file or directory
+ * @returns string - absolute path to the file or directory
+ * @example
+ * ```ts
+ * buildPath('functions.vue')
+ * buildPath('vue-components.ts')
+ * ```
+ */
+export function buildPath(path?: string) {
+  return corePath(`build/${path || ''}`)
+}
+
+export function buildEnginePath(path?: string) {
+  return buildPath(`${path || ''}`)
+}
+
+export function buildEntriesPath(path?: string) {
+  return buildPath(`entries/${path || ''}`)
+}
+
+export function cachePath(path?: string) {
+  return corePath(`cache/${path || ''}`)
+}
+
+export function cliPath(path?: string) {
+  return corePath(`cli/${path || ''}`)
+}
+
+export function collectionsPath(path?: string) {
+  return corePath(`collections/${path || ''}`)
+}
+
+export function componentsPath(path?: string) {
+  return projectPath(`components/${path || ''}`)
+}
+
+export function configPath(path?: string) {
+  return corePath(`config/${path || ''}`)
+}
+
+export function corePath(path?: string) {
+  return frameworkPath(`core/${path || ''}`)
+}
+
+export function dashboardPath(path?: string) {
+  return corePath(`dashboard/${path || ''}`)
+}
+
+export function desktopPath(path?: string) {
+  return corePath(`desktop/${path || ''}`)
+}
+
+export function docsPath(path?: string) {
+  return corePath(`docs/${path || ''}`)
+}
+
+export function domainsPath(path?: string) {
+  return corePath(`domains/${path || ''}`)
+}
+
+export function driversPath(path?: string) {
+  return corePath(`drivers/${path || ''}`)
+}
+
+export function customElementsDataPath() {
+  return frameworkPath('custom-elements.json')
+}
+
+export function errorHandlingPath(path?: string) {
+  return corePath(`error-handling/${path || ''}`)
+}
+
+export function examplesPath(type: 'vue-components' | 'web-components') {
+  return frameworkPath(`examples/${type || ''}`)
+}
+
+export function frameworkPath(path?: string) {
+  return projectPath(`.stacks/${path || ''}`)
+}
+
+export function fsPath(path?: string) {
+  return corePath(`storage/${path || ''}`)
+}
+
+export function functionsPath(path?: string) {
+  return projectPath(`functions/${path || ''}`)
+}
+
+export function gitPath(path?: string) {
+  return corePath(`git/${path || ''}`)
+}
+
+export function langPath(path?: string) {
+  return projectPath(`lang/${path || ''}`)
+}
+
+export function libraryEntryPath(type: 'vue-components' | 'web-components' | 'functions') {
+  return buildEntriesPath(`${type}.ts`)
+}
+
+export function lintPath(path?: string) {
+  return corePath(`lint/${path || ''}`)
+}
+
+export function loggingPath(path?: string) {
+  return corePath(`logging/${path || ''}`)
+}
+
+export function xRayPath(path?: string) {
+  return corePath(`x-ray/${path || ''}`)
+}
+
+export function modulesPath(path?: string) {
+  return corePath(`modules/${path || ''}`)
+}
+
+export function notificationsPath(path?: string) {
+  return corePath(`notifications/${path || ''}`)
+}
+
+export function objectsPath(path?: string) {
+  return corePath(`objects/${path || ''}`)
+}
+
+export function packageJsonPath(type: 'vue-components' | 'web-components' | 'functions') {
+  if (type === 'vue-components')
+    return frameworkPath('components/vue/package.json')
+
+  if (type === 'web-components')
+    return frameworkPath('components/web/package.json')
+
+  if (type === 'functions')
+    return frameworkPath('functions/package.json')
+
+  return frameworkPath(`${type}/package.json`)
+}
+
+export function pagesPath(path?: string) {
+  return projectPath(`pages/${path || ''}`)
+}
+
+export function pathPath(path?: string) {
+  return corePath(`path/${path || ''}`)
+}
+
+export function projectPath(filePath = '') {
+  let path = process.cwd()
+
+  // workaround: simple way to determine the project path
+  if (path.includes('.stacks'))
+    path = resolve(path, '..')
+
+  if (path.includes('.stacks'))
+    path = resolve(path, '..')
+
+  if (path.includes('.stacks'))
+    path = resolve(path, '..')
+
+  if (!path.includes('.stacks'))
+    path = resolve(path, '.')
+
+  return resolve(path, filePath)
+}
+
+export function routerPath(path?: string) {
+  return corePath(`router/${path || ''}`)
+}
+
+export function searchEnginePath(path?: string) {
+  return corePath(`search-engine/${path || ''}`)
+}
+
+export function routesPath(path?: string) {
+  return projectPath(`routes/${path || ''}`)
+}
+
+export function securityPath(path?: string) {
+  return corePath(`security/${path || ''}`)
+}
+
+export function serverPath(path?: string) {
+  return corePath(`server/${path || ''}`)
+}
+
+export function serverlessPath(path?: string) {
+  return corePath(`serverless/${path || ''}`)
+}
+
+export function stacksPath(path?: string) {
+  return frameworkPath(`src/${path || ''}`)
+}
+
+export function tablesPath(path?: string) {
+  return corePath(`tables/${path || ''}`)
+}
+
+export function testingPath(path?: string) {
+  return corePath(`testing/${path || ''}`)
+}
+
+export function typesPath(path?: string) {
+  return corePath(`types/${path || ''}`)
+}
+
+export function stringsPath(path?: string) {
+  return corePath(`strings/${path || ''}`)
+}
+
+export function scriptsPath(path?: string) {
+  return frameworkPath(`scripts/${path || ''}`)
+}
+
+export function uiPath(path?: string) {
+  return corePath(`ui/${path || ''}`)
+}
+
+export function utilsPath(path?: string) {
+  return corePath(`utils/${path || ''}`)
+}
+
+export const path = {
+  aiPath,
+  actionsPath,
+  aliasPath,
+  arraysPath,
+  authPath,
+  buildEnginePath,
+  buildEntriesPath,
+  buildPath,
+  cachePath,
+  cliPath,
+  collectionsPath,
+  componentsPath,
+  configPath,
+  corePath,
+  customElementsDataPath,
+  dashboardPath,
+  desktopPath,
+  docsPath,
+  domainsPath,
+  driversPath,
+  errorHandlingPath,
+  examplesPath,
+  frameworkPath,
+  fsPath,
+  functionsPath,
+  gitPath,
+  langPath,
+  libraryEntryPath,
+  lintPath,
+  loggingPath,
+  xRayPath,
+  modulesPath,
+  objectsPath,
+  notificationsPath,
+  packageJsonPath,
+  pagesPath,
+  pathPath,
+  projectPath,
+  routerPath,
+  searchEnginePath,
+  routesPath,
+  scriptsPath,
+  securityPath,
+  serverPath,
+  serverlessPath,
+  stacksPath,
+  stringsPath,
+  tablesPath,
+  testingPath,
+  typesPath,
+  uiPath,
+  utilsPath,
+
+  // path utils
+  basename,
+  delimiter,
+  dirname,
+  extname,
+  format,
+  isAbsolute,
+  join,
+  normalize,
+  normalizeString,
+  parse,
+  relative,
+  resolve,
+  sep,
+  toNamespacedPath,
+}
+
+export { basename, delimiter, dirname, extname, format, isAbsolute, join, normalize, normalizeString, parse, relative, resolve, sep, toNamespacedPath }
+
+export default path

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

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