stacks 0.41.1 → 0.44.9

package/core/search-engine/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/search-engine/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@stacksjs/search-engine",
+  "type": "module",
+  "version": "0.44.9",
+  "packageManager": "pnpm@7.18.2",
+  "description": "The Stacks search engine integrations.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/search-engine#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/search-engine"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "search-engine",
+    "meilisearch",
+    "algolia",
+    "typesense",
+    "pagination",
+    "sorting",
+    "filtering",
+    "searching",
+    "api",
+    "headless",
+    "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"
+  },
+  "peerDependencies": {
+    "@stacksjs/cli": "workspace:*",
+    "@stacksjs/config": "workspace:*",
+    "@vueuse/core": "^9.6.0",
+    "meilisearch": "^0.30.0",
+    "vue": "^3.2.45"
+  },
+  "devDependencies": {
+    "@stacksjs/testing": "workspace:*",
+    "mkdist": "^1.0.0",
+    "typescript": "^4.9.4"
+  }
+}

package/core/search-engine/src/drivers/meilisearch.ts

@@ -0,0 +1,37 @@
+import { log } from '@stacksjs/cli'
+import { searchEngine } from '@stacksjs/config'
+import { MeiliSearch } from 'meilisearch'
+
+interface SearchEngineOptions {
+  host: string
+  apiKey: string
+}
+
+function client(options?: SearchEngineOptions) {
+  let host = searchEngine.meilisearch?.host
+  let apiKey = searchEngine.meilisearch?.apiKey
+
+  if (options?.host)
+    host = options.host
+
+  if (options?.apiKey)
+    apiKey = options.apiKey
+
+  if (!host) {
+    log.error('Please specify a search engine host.')
+    process.exit()
+  }
+
+  return new MeiliSearch({ host, apiKey })
+}
+
+async function search(index: string, params: any) {
+  return await client()
+    .index(index)
+    .search(params.query, { limit: params.perPage, offset: params.page * params.perPage })
+}
+
+export {
+  client,
+  search,
+}

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

@@ -0,0 +1,74 @@
+/**
+ * This file is used to define the types/interfaces used in the project.
+ */
+
+import type { Hits, SearchResponse } from 'meilisearch'
+
+// this interface is primarily used to persist data to localStorage, in a unified way
+export interface SearchEngineStore {
+  /**
+   * The search engine index.
+   */
+  index: string
+  /**
+   * The search engine host.
+   * @default 'http://127.0.0.1:7700'
+   */
+  source?: string
+  /**
+   * The search engine password/API key.
+   */
+  password?: string
+  /**
+   * The search query.
+   * @default 20
+   * @type {string}
+   * @default: ''
+   */
+  query?: string
+  /**
+   * The number of results to return.
+   * @default 20
+   * @type {number}
+   */
+  perPage?: number
+  /**
+   * The current page number
+   * @default 1
+   * @type {number}
+   */
+  currentPage?: number
+  /**
+   * The results object returned from the search engine.
+   */
+  results?: SearchResponse<Record<string, any>> // optional: the Meilisearch search response (defaults: {})
+  /**
+   * The hits object returned from the search engine.
+   */
+  hits?: Hits<Record<string, any>>
+
+  // table related config
+  // actionable?: string | boolean // optional: determines whether the table displays any "action items" (defaults: true)
+  // actions?: string | string[] // optional: the specific type of actions to be displayed/utilized in the table (defaults: 'Edit, Delete')
+  // columns: string[] // used as table heads/column titles
+  // selectable?: string | boolean // optional: determines whether the table displays the checkboxes (defaults: true)
+  // selectedRows?: number[] | string[] // optional: holds the selected rows (defaults: [])
+  // selectedAll?: boolean // optional: determines whether all the rows are selected (defaults: false)
+  // stickyHeader?: string | boolean // optional: determines whether the table displays the sticky header (defaults: false)
+  // stickyFooter?: string | boolean // optional: determines whether the table displays the sticky footer (defaults: false)
+}
+
+export function determineState(): SearchEngineStore {
+  const ls = localStorage.getItem('search-engine')
+
+  if (isString(ls))
+    return JSON.parse(ls)
+
+  return { // default state
+    source: 'http://127.0.0.1:7700',
+    index: '',
+    perPage: 20,
+    currentPage: 1,
+    query: '',
+  }
+}

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

@@ -0,0 +1,56 @@
+import { searchEngine } from '@stacksjs/config'
+import type { Ref } from 'vue'
+import { client as meilisearch, search } from './drivers/meilisearch'
+import { determineState } from './helpers'
+
+const table = (useStorage('table', determineState()).value)
+const totalHits = table.results?.estimatedTotalHits ?? 1
+
+// state
+const pages: Ref<number[]> = ref([])
+const totalPages = ref(0)
+const currentPage = computed(() => table.currentPage)
+
+export function client() {
+  if (searchEngine.driver === 'meilisearch')
+    return meilisearch
+}
+
+export function useSearchEngine() {
+  return client()
+}
+
+export function calculatePagination() {
+  if (table.perPage)
+    totalPages.value = Math.ceil(totalHits / table.perPage)
+
+  const hitPages = [...Array(totalPages.value).keys()].map(i => i + 1)
+  const offset = 2
+  const currentPage = table.currentPage ?? 1
+  const lastPage = hitPages[hitPages.length - 1]
+
+  let from = currentPage - offset
+  if (from < 1)
+    from = 1
+
+  let to = from + offset * 2
+  if (to >= lastPage)
+    to = lastPage
+
+  const allPages = []
+  for (let page = from; page <= to; page++)
+    allPages.push(page)
+
+  pages.value = allPages
+}
+
+// it needs these exports
+// currentPage, filterName, filters, goToNextPage, goToPage, goToPrevPage, hits, index, lastPageNumber, perPage, query, results, search, searchFilters, searchParams, setTotalHits, sort, sorts, totalPages
+
+export default {
+  useSearchEngine,
+  client,
+  search,
+  calculatePagination,
+  currentPage,
+}

package/core/search-engine/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/security/README.md

@@ -0,0 +1,66 @@
+# Stacks Path
+
+Easily work with encryptions, decryptions, and hashing.
+
+## ☘️ Features
+
+- Base64 support
+- Bcrypt support
+- Argon support
+- Implements the Advanced Encryption Standard (AES)
+- Written in modern ESM/TypeScript
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/security
+```
+
+Now, you can easily access it in your project:
+
+```js
+import { base64Encode, base64Verify, bcryptEncode, bcryptVerify, decrypt, encrypt, makeHash, md5Encode, verifyHash } from '@stacksjs/security'
+
+// and more...
+```
+
+To view the full documentation, please visit [https://stacksjs.dev/security](https://stacksjs.dev/security).
+
+## 🧪 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:
+
+- [crypto-js](https://github.com/brix/crypto-js)
+- [js-base64](https://www.npmjs.com/package/js-base64)
+- [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/security/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/security/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/security/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/security/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@stacksjs/security",
+  "type": "module",
+  "version": "0.44.9",
+  "packageManager": "pnpm@7.18.2",
+  "description": "The Stacks framework security.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/security#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/security"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "security",
+    "framework",
+    "typescript",
+    "javascript"
+  ],
+  "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": {
+    "@stacksjs/config": "workspace:*",
+    "@stacksjs/types": "workspace:*",
+    "bcryptjs": "^2.4.3",
+    "crypto-js": "^4.1.1",
+    "js-base64": "^3.7.3"
+  },
+  "devDependencies": {
+    "@stacksjs/testing": "workspace:*",
+    "mkdist": "^1.0.0",
+    "typescript": "^4.9.4"
+  }
+}

package/core/security/src/crypt.ts

@@ -0,0 +1,14 @@
+import aes from 'crypto-js/aes'
+import utf8 from 'crypto-js/enc-utf8'
+
+const passphrase = import.meta.env.APP_KEY as string
+
+function encrypt(message: string): string {
+  return aes.encrypt(message, passphrase).toString()
+}
+
+function decrypt(encrypted: string): string {
+  return aes.decrypt(encrypted, passphrase).toString(utf8)
+}
+
+export { encrypt, decrypt }

package/core/security/src/hash.ts

@@ -0,0 +1,52 @@
+import bcryptjs from 'bcryptjs'
+import { Base64 } from 'js-base64'
+import md5 from 'crypto-js/md5'
+import { hashing } from '@stacksjs/config'
+
+async function make(password: string, algorithm = 'bcrypt') {
+  if (algorithm === 'bcrypt')
+    return bcryptEncode(password)
+
+  if (algorithm === 'base64')
+    return base64Encode(password)
+
+  throw new Error('Unsupported algorithm')
+}
+
+async function verify(password: string, hash: string, algorithm = 'bcrypt') {
+  if (algorithm === 'bcrypt')
+    return bcryptVerify(password, hash)
+
+  if (algorithm === 'base64')
+    return base64Verify(password, hash)
+
+  throw new Error('Unsupported algorithm')
+}
+
+async function bcryptEncode(password: string) {
+  if (!hashing.bcrypt)
+    throw new Error('Bcrypt hashing is not configured')
+
+  const salt = await bcryptjs.genSaltSync(hashing.bcrypt.rounds)
+  const hash = await bcryptjs.hash(password, salt)
+
+  return hash
+}
+
+async function bcryptVerify(password: string, hash: string) {
+  return await bcryptjs.compare(password, hash)
+}
+
+async function base64Encode(password: string) {
+  return await Base64.encode(password)
+}
+
+async function base64Verify(password: string, hash: string) {
+  return Base64.decode(hash) === password
+}
+
+async function md5Encode(password: string) {
+  return md5(password)
+}
+
+export { make as makeHash, verify as verifyHash, base64Encode, base64Verify, bcryptEncode, bcryptVerify, md5Encode }

package/core/security/src/index.ts

@@ -0,0 +1,3 @@
+export * from './key'
+export * from './crypt'
+export * from './hash'

package/core/security/src/key.ts

@@ -0,0 +1,11 @@
+import { getRandomValues } from 'node:crypto'
+import utf8 from 'crypto-js/enc-utf8'
+import base64 from 'crypto-js/enc-base64'
+
+export async function generateAppKey() {
+  const random = getRandomValues(new Uint8Array(32))
+  const encodedWord = utf8.parse(random.toString())
+  const key = base64.stringify(encodedWord)
+
+  return `base64:${key}`
+}

package/core/security/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/server/README.md

@@ -0,0 +1,51 @@
+# Stacks Server
+
+## ☘️ Features
+
+- easily access the server's configuration
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/server
+```
+
+Now, you can use it in your project:
+
+```js
+import { server } from '@stacksjs/server'
+
+console.log('server config is', server)
+```
+
+Learn more in the docs.
+
+## 🧪 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)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/core/server/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/server/node_modules/.bin/nitro

@@ -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/nitropack@1.0.0/node_modules/nitropack/dist/cli.mjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/nitropack@1.0.0/node_modules/nitropack/dist/cli.mjs" "$@"
+fi

package/core/server/node_modules/.bin/nitropack

@@ -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/nitropack@1.0.0/node_modules/nitropack/dist/cli.mjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/nitropack@1.0.0/node_modules/nitropack/dist/cli.mjs" "$@"
+fi

package/core/server/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