@stacksjs/types 0.53.1 → 0.56.3

package/dist/index.mjs

@@ -1,39 +1,112 @@
-export * from "./app.mjs";
-export * from "./auto-imports.mjs";
-export * from "./build.mjs";
-export * from "./cache.mjs";
-export * from "./cdn.mjs";
-export * from "./cli.mjs";
-export * from "./components.mjs";
-export * from "./cron-jobs.mjs";
-export * from "./database.mjs";
-export * from "./debug.mjs";
-export * from "./deploy.mjs";
-export * from "./dns.mjs";
-export * from "./docs.mjs";
-export * from "./errors.mjs";
-export * from "./events.mjs";
-export * from "./exit-code.mjs";
-export * from "./fs.mjs";
-export * from "./git.mjs";
-export * from "./hashing.mjs";
-export * from "./i18n.mjs";
-export * from "./inspect.mjs";
-export * from "./layout.mjs";
-export * from "./library.mjs";
-export * from "./manifest.mjs";
-export * from "./markdown.mjs";
-export * from "./model.mjs";
-export * from "./notifications.mjs";
-export * from "./pages.mjs";
-export * from "./payments.mjs";
-export * from "./promise.mjs";
-export * from "./pwa.mjs";
-export * from "./reactivity.mjs";
-export * from "./router.mjs";
-export * from "./search-engine.mjs";
-export * from "./ssg.mjs";
-export * from "./stacks.mjs";
-export * from "./tables.mjs";
-export * from "./ui.mjs";
-export * from "./utils.mjs";
+export { Err, Ok, Result, ResultAsync } from 'neverthrow';
+
+var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
+  NpmScript2["Build"] = "build";
+  NpmScript2["BuildComponents"] = "vite build --config ./core/build/src/vue-components.ts";
+  NpmScript2["BuildWebComponents"] = "build:web-components";
+  NpmScript2["BuildFunctions"] = "build:functions";
+  NpmScript2["BuildDocs"] = "build:docs";
+  NpmScript2["BuildStacks"] = "build:stacks";
+  NpmScript2["Clean"] = "rimraf pnpm-lock.yaml node_modules/ .stacks/**/node_modules .stacks/**/dist";
+  NpmScript2["Dev"] = "dev";
+  NpmScript2["DevComponents"] = "vite --config ./core/build/src/vue-components.ts";
+  NpmScript2["DevDocs"] = "npx vitepress dev ./docs/src";
+  NpmScript2["DevDesktop"] = "dev:desktop";
+  NpmScript2["DevPages"] = "dev:pages";
+  NpmScript2["DevFunctions"] = "dev:functions";
+  NpmScript2["Fresh"] = "fresh";
+  NpmScript2["Lint"] = "eslint .";
+  NpmScript2["LintFix"] = "eslint . --fix";
+  NpmScript2["LintPackageJson"] = "npx publint";
+  NpmScript2["MakeStack"] = "make:stack";
+  NpmScript2["Test"] = "vitest --config vitest.config.ts";
+  NpmScript2["TestUnit"] = "vitest --config vitest.config.ts";
+  NpmScript2["TestFeature"] = "playwright test --config playwright.config.ts";
+  NpmScript2["TestUi"] = "vitest --config vitest.config.ts --ui";
+  NpmScript2["TestCoverage"] = "vitest --config vitest.config.ts --coverage";
+  NpmScript2["TestTypes"] = "vue-npx tsc --noEmit";
+  NpmScript2["Generate"] = "generate";
+  NpmScript2["GenerateTypes"] = "generate:types";
+  NpmScript2["GenerateEntries"] = "generate:entries";
+  NpmScript2["GenerateVueCompat"] = "generate:vue-compatibility";
+  NpmScript2["GenerateWebTypes"] = "generate:web-types";
+  NpmScript2["GenerateVsCodeCustomData"] = "generate:vscode-custom-data";
+  NpmScript2["GenerateIdeHelpers"] = "generate:ide-helpers";
+  NpmScript2["GenerateComponentMeta"] = "generate:component-meta";
+  NpmScript2["Release"] = "release";
+  NpmScript2["Commit"] = "commit";
+  NpmScript2["Example"] = "example";
+  NpmScript2["ExampleVue"] = "example:vue";
+  NpmScript2["ExampleWebComponents"] = "example:web-components";
+  NpmScript2["KeyGenerate"] = "key:generate";
+  NpmScript2["TypesFix"] = "types:fix";
+  NpmScript2["TypesGenerate"] = "types:generate";
+  NpmScript2["Preinstall"] = "preinstall";
+  NpmScript2["Prepublish"] = "prepublish";
+  NpmScript2["Wip"] = "wip";
+  NpmScript2["UpgradeNode"] = "./.stacks/scripts/setup.sh +nodejs.org";
+  NpmScript2["UpgradeDependencies"] = "pnpm up";
+  return NpmScript2;
+})(NpmScript || {});
+var Action = /* @__PURE__ */ ((Action2) => {
+  Action2["Bump"] = "bump";
+  Action2["BuildStacks"] = "build/stacks";
+  Action2["BuildComponentLibs"] = "build/component-libs";
+  Action2["BuildVueComponentLib"] = "build-vue-component-lib";
+  Action2["BuildWebComponentLib"] = "build-web-component-lib";
+  Action2["BuildCli"] = "build-cli";
+  Action2["BuildCore"] = "build/core";
+  Action2["BuildDocs"] = "build-docs";
+  Action2["BuildFunctionLib"] = "build-function-lib";
+  Action2["Changelog"] = "changelog";
+  Action2["Clean"] = "clean";
+  Action2["DevComponents"] = "dev/components";
+  Action2["Dev"] = "dev/index";
+  Action2["DevDocs"] = "dev/docs";
+  Action2["Deploy"] = "deploy";
+  Action2["Fresh"] = "fresh";
+  Action2["GenerateLibraryEntries"] = "generate/lib-entries";
+  Action2["Inspire"] = "inspire";
+  Action2["KeyGenerate"] = "key-generate";
+  Action2["MakeNotification"] = "make-notification";
+  Action2["Migrate"] = "migrate";
+  Action2["Seed"] = "seed";
+  Action2["Lint"] = "lint/index";
+  Action2["LintFix"] = "lint/fix";
+  Action2["Prepublish"] = "prepublish";
+  Action2["Release"] = "release";
+  Action2["ShowFeatureTestReport"] = "show-feature-test-report";
+  Action2["Test"] = "test";
+  Action2["TestUi"] = "test-ui";
+  Action2["TestUnit"] = "test-unit";
+  Action2["TestFeature"] = "test-feature";
+  Action2["TestCoverage"] = "test-coverage";
+  Action2["Tinker"] = "tinker";
+  Action2["Typecheck"] = "typecheck";
+  Action2["Upgrade"] = "upgrade/index";
+  Action2["UpgradeNode"] = "upgrade/node";
+  Action2["UpgradePackageManager"] = "upgrade/package-manager";
+  return Action2;
+})(Action || {});
+
+var Every = /* @__PURE__ */ ((Every2) => {
+  Every2["Minute"] = "* * * * *";
+  Every2["Hour"] = "0 * * * *";
+  Every2["HalfHour"] = "0,30 * * * *";
+  Every2["Day"] = "0 0 * * *";
+  Every2["Month"] = "0 0 1 * *";
+  Every2["Week"] = "0 0 * * 0";
+  Every2["Year"] = "0 0 1 1 *";
+  Every2["FifthMinute"] = "*/5 * * * *";
+  Every2["TenthMinute"] = "*/10 * * * *";
+  return Every2;
+})(Every || {});
+
+var ExitCode = /* @__PURE__ */ ((ExitCode2) => {
+  ExitCode2[ExitCode2["Success"] = 0] = "Success";
+  ExitCode2[ExitCode2["FatalError"] = 1] = "FatalError";
+  ExitCode2[ExitCode2["InvalidArgument"] = 9] = "InvalidArgument";
+  return ExitCode2;
+})(ExitCode || {});
+
+export { Action, Every, ExitCode, NpmScript };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.53.1",
-  "packageManager": "pnpm@8.5.1",
+  "version": "0.56.3",
+  "packageManager": "pnpm@8.6.5",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -26,9 +26,9 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs"
-    }
+    },
+    "./*": "./*"
   },
-  "main": "dist/index.mjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "contributors": [
@@ -38,39 +38,45 @@
     "dist",
     "README.md"
   ],
+  "peerDependencies": {
+    "neverthrow": "^6.0.0"
+  },
   "dependencies": {
     "@mdit-vue/plugin-component": "^0.12.0",
     "@mdit-vue/plugin-frontmatter": "^0.12.0",
     "@mdit-vue/types": "^0.12.0",
-    "@novu/stateless": "^0.15.0",
+    "@novu/stateless": "^0.16.1",
     "@rollup/pluginutils": "^5.0.2",
     "@types/bcryptjs": "^2.4.2",
     "@types/crypto-js": "^4.1.1",
-    "@types/eslint": "^8.40.0",
+    "@types/eslint": "^8.40.2",
     "@types/fs-extra": "^11.0.1",
     "@types/markdown-it-link-attributes": "^3.0.1",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^18.16.14",
+    "@types/node": "^18.16.18",
     "@types/nprogress": "^0.2.0",
     "@types/pluralize": "^0.0.29",
+    "@vinejs/vine": "^1.4.1",
     "cac": "^6.7.14",
     "execa": "^7.1.1",
     "markdown-it": "^13.0.1",
-    "meilisearch": "^0.32.4",
+    "meilisearch": "^0.33.0",
     "neverthrow": "^6.0.0",
     "ora": "^6.3.1",
-    "unocss": "^0.52.3",
-    "unplugin-auto-import": "^0.16.2",
-    "unplugin-vue-components": "^0.24.1",
-    "vite": "^4.3.8",
-    "vite-plugin-inspect": "^0.7.28",
-    "vite-plugin-pwa": "^0.15.0",
+    "unocss": "^0.53.4",
+    "unplugin-auto-import": "^0.16.4",
+    "unplugin-vue-components": "^0.25.1",
+    "vite": "^4.3.9",
+    "vite-plugin-inspect": "^0.7.29",
+    "vite-plugin-pwa": "^0.16.4",
     "vite-plugin-vue-layouts": "^0.8.0",
     "vite-ssg": "^0.22.2",
-    "vitepress": "1.0.0-beta.1",
-    "vue": "^3.3.4",
-    "zod": "^3.21.4",
-    "@stacksjs/development": "0.53.1"
+    "vitepress": "1.0.0-beta.3",
+    "vue": "^3.3.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.1.3",
+    "unbuild": "^1.2.1"
   },
   "scripts": {
     "build": "unbuild",

package/dist/app.d.ts

@@ -1,108 +0,0 @@
-/**
- * **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.
- */
-export interface AppOptions {
-    /**
-     * **Application Name**
-     *
-     * This value is the name of your application. This value is used when the
-     * framework needs to place the application's name in a log or any
-     * other location as required by the application or its packages.
-     *
-     * @default string "Stacks"
-     */
-    name: string;
-    /**
-     * **Application Environment**
-     *
-     * This value determines the "environment" your application is currently
-     * running in. This may determine how you prefer to configure various
-     * services the application utilizes. Set this in your ".env" file
-     *
-     * @default "local"
-     */
-    env?: 'local' | 'development' | 'production';
-    /**
-     * **Application URL**
-     *
-     * This URL is used by the console to properly generate URLs when using
-     * the Buddy command line tool. You should set this to the root of
-     * your application so that it is used when running Buddy tasks.
-     *
-     * @default string "https://localhost"
-     * @example "https://hello-world.test"
-     */
-    url?: string;
-    /**
-     * **Application Debug Mode**
-     *
-     * When your application is in debug mode, detailed error messages with
-     * stack traces will be shown on every error that occurs within your
-     * application. If disabled, a simple generic error page is shown.
-     *
-     * @default true
-     */
-    debug: boolean;
-    /**
-     * **Application Port**
-     *
-     * This port is used when Stacks creates a server you. You should set
-     * a port that's not already in use by your machine. Stacks defaults
-     * to a memorable port that likely is free on your end: 3333.
-     *
-     * @default number 3333
-     */
-    port: number;
-    /**
-     * **Encryption Key**
-     *
-     * This key is used by the Stacks encrypter service and should be set to
-     * a random, 32 character string, otherwise these encrypted strings will
-     * not be safe. Please do this before deploying an application!
-     */
-    key?: string;
-    /**
-     * **Application Timezone**
-     *
-     * Here you may specify the default timezone for your application, which
-     * will be used by Stacks and date-time functions. We have gone ahead
-     * and set this to a sensible default for you out of the box.
-     *
-     * @default string "UTC"
-     */
-    timezone?: string;
-    /**
-     * **Application Locale Configuration**
-     *
-     * The application locale determines the default locale that will be used
-     * by the translation service provider. You are free to set this value
-     * to any of the locales which will be supported by the application.
-     *
-     * @default string "en"
-     * @example
-     * de // ./lang/de.yml needs to be present for this
-     */
-    locale?: string;
-    /**
-     * **Application Fallback Locale**
-     *
-     * The fallback locale determines the locale to use when the current one
-     * is not available. You may change the value to correspond to any of
-     * the language folders that are provided through your application.
-     *
-     * @default string "en"
-     */
-    fallbackLocale: 'en';
-    /**
-     * **Cipher**
-     *
-     * Description WIP.
-     *
-     * @default string "aes-256-cbc"
-     */
-    cipher: string;
-}

package/dist/auto-imports.d.ts

@@ -1 +0,0 @@
-export type { Options as AutoImportsOptions } from 'unplugin-auto-import/types';

package/dist/build.d.ts

@@ -1,2 +0,0 @@
-export type { UserConfig as ViteConfig } from 'vite';
-export type { ViteSSGContext } from 'vite-ssg';

package/dist/cache.d.ts

@@ -1,69 +0,0 @@
-export interface CacheOptions {
-    /**
-     * **Cache Driver**
-     *
-     * This value determines the cache driver that will be used by your application to store
-     * cached data. By default, Stacks uses the "redis" driver, which stores cached data in
-     * in a self-configufed Redis instance. You may use any of the other drivers provided
-     * by Stacks or write your own custom driver.
-     *
-     * @default "redis"
-     * @example "redis"
-     * @example "memcached"
-     * @example "dynamodb"
-     *
-     * @see https://stacks.js.org/docs/cache
-     */
-    driver: string;
-    /**
-     * **Cache Prefix**
-     *
-     * This value determines the prefix that will be used when storing items in the cache. This
-     * prefix may be useful when multiple applications are sharing the same cache driver so that
-     * they may avoid collisions when attempting to retrieve items from the cache.
-     *
-     * @default string "stacks"
-     * @example "stacks"
-     *
-     * @see https://stacks.js.org/docs/cache
-     */
-    prefix: string;
-    /**
-     * **Cache TTL**
-     *
-     * This value determines the default time to live for items stored in the cache. This value
-     * may be overridden when storing items in the cache. If no value is specified, the cache
-     * driver will default to a reasonable time to live for the given item.
-     *
-     * @default number 3600
-     * @example 3600
-     * @example 3600 * 24
-     * @example -1 (never expires)
-     */
-    ttl: number;
-    drivers: {
-        redis?: {
-            connection: string;
-            /**
-             * **Redis Host**
-             *
-             * This value determines the host that will be used to connect to the Redis server.
-             *
-             * @default string "localhost"
-             * @example "localhost"
-             */
-            host: string;
-            /**
-             * **Redis Port**
-             *
-             * This value determines the port that will be used to connect to the Redis server.
-             *
-             * @default number 6379
-             * @example 6379
-             */
-            port: number;
-        };
-        memcached?: {};
-        dynamodb?: {};
-    };
-}

package/dist/cdn.d.ts

@@ -1,15 +0,0 @@
-export interface CdnOptions {
-    /**
-     * **CDN Driver**
-     *
-     * This value determines the default CDN driver that will be used when interacting with the
-     * CDN service. This value may be overridden when interacting with the CDN service.
-     *
-     * @default "cloudfront"
-     * @example "cloudfront"
-     * @example "fastly" wip
-     *
-     * @see https://stacks.js.org/docs/cdn
-     */
-    driver: string;
-}