@stacksjs/types 0.37.9 → 0.38.3

package/README.md

@@ -36,7 +36,7 @@ pnpm test
 
 ## 📈 Changelog
 
-Please see our [releases](https://github.com/stacksjs/stacksjs/releases) page for more information on what has changed recently.
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
 ## 💪🏼 Contributing
 

package/dist/app.d.ts

@@ -25,7 +25,7 @@ export interface AppOptions {
      *
      * @default "local"
      */
-    env?: 'development' | 'production' | 'local';
+    env?: 'local' | 'development' | 'production';
     /**
      * ### Application URL
      *
@@ -45,7 +45,7 @@ export interface AppOptions {
      * stack traces will be shown on every error that occurs within your
      * application. If disabled, a simple generic error page is shown.
      *
-     * @default false
+     * @default true
      */
     debug: boolean;
     /**

package/dist/build.d.ts

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

package/dist/build.mjs

@@ -0,0 +1 @@
+export {} from "vite-ssg";

package/dist/cli.d.ts

@@ -1,11 +1,128 @@
 /**
  * The parsed command-line arguments
  */
+import type { Ora } from 'ora';
 export interface StacksOptions {
     componentsSrcPath?: string;
     dtsPath?: string;
     extensions?: string[];
 }
+export interface OutroOptions {
+    startTime?: number;
+    useSeconds?: boolean;
+    isError?: boolean;
+}
+export interface IntroOptions {
+    /**
+     * @default true
+     */
+    showPerformance?: boolean;
+}
+declare type SpinnerOptions = Ora;
+/**
+ * The options to pass to the CLI.
+ */
+export interface CliOptions {
+    /**
+     * ### CLI Debug Level
+     *
+     * When your application is in debug mode, a different level of information,
+     * like stack traces, will be shown on every error that occurs within the
+     * application. When disabled, it defaults to the "normal experience."
+     *
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * ### Current Work Directory
+     *
+     * Based on the `cwd` value, that's where the command...
+     *
+     * @default projectPath()
+     */
+    cwd?: string;
+    /**
+     * ### Loading Animation
+     *
+     * Should the command show a loading animation?
+     * Please note, when debug mode is enabled,
+     * the animation will not show.
+     *
+     * @default true
+     */
+    shouldBeAnimated?: boolean | SpinnerOptions;
+}
+export type { Ora as SpinnerOptions } from 'ora';
+export declare type ActionsOption = 'types';
+export declare type ActionsOptions = {
+    [key in ActionsOption]?: boolean;
+} & CliOptions;
+export declare type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'pages' | 'stacks' | 'all';
+export declare type BuildOptions = {
+    [key in BuildOption]: boolean;
+} & CliOptions;
+export declare type AddOption = 'table' | 'calendar' | 'all';
+export declare type AddOptions = {
+    [key in AddOption]?: boolean;
+} & CliOptions;
+export declare type CreateStringOption = 'name';
+export declare type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'pages' | 'functions' | 'api' | 'database';
+export declare type CreateOptions = {
+    [key in CreateBooleanOption]: boolean;
+} & {
+    [key in CreateStringOption]: string;
+} & CliOptions;
+export declare type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'all';
+export declare type DevOptions = {
+    [key in DevOption]: boolean;
+} & CliOptions;
+export declare type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'vueCompatibility' | 'componentMeta';
+export declare type GeneratorOptions = {
+    [key in GeneratorOption]?: boolean;
+} & CliOptions;
+export declare type LintOption = 'fix';
+export declare type LintOptions = {
+    [key in LintOption]: boolean;
+} & CliOptions;
+export declare type MakeStringOption = 'name';
+export declare type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'factory' | 'notification' | 'stack';
+export declare type MakeOptions = {
+    [key in MakeBooleanOption]: boolean;
+} & {
+    [key in MakeStringOption]: string;
+} & CliOptions;
+export declare type UpdateString = 'version';
+export declare type UpdateBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force';
+export declare type UpdateOptions = {
+    [key in UpdateString]: string;
+} & {
+    [key in UpdateBoolean]: boolean;
+} & CliOptions;
+export declare type ExamplesString = 'version';
+export declare type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
+export declare type ExamplesOption = ExamplesString & ExamplesBoolean | void;
+export declare type ExamplesOptions = {
+    [key in ExamplesString]: string;
+} & {
+    [key in ExamplesBoolean]: boolean;
+} & CliOptions;
+export interface TestOptions extends CliOptions {
+}
+export interface CleanOptions extends CliOptions {
+}
+export interface CommitOptions extends CliOptions {
+}
+export interface KeyOptions extends CliOptions {
+}
+export interface FreshOptions extends CliOptions {
+}
+export interface ReleaseOptions extends CliOptions {
+}
+export interface PreinstallOptions extends CliOptions {
+}
+export interface PrepublishOptions extends CliOptions {
+}
+export declare type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all';
 /**
  * The available npm scripts within the Stacks toolkit.
  */
@@ -16,14 +133,18 @@ export declare const enum NpmScript {
     BuildFunctions = "build:functions",
     BuildDocs = "build:docs",
     BuildStacks = "build:stacks",
+    Clean = "clean",
     Dev = "dev",
     DevComponents = "dev:components",
     DevDocs = "dev:docs",
+    DevPages = "dev:pages",
+    DevFunctions = "dev:functions",
     Fresh = "fresh",
     Update = "update",
     UpdateDependencies = "update:dependencies",
     UpdateFramework = "update:framework",
     UpdatePackageManager = "update:package-manager",
+    UpdateNode = "update:node",
     Lint = "lint",
     LintFix = "lint:fix",
     MakeStack = "make:stack",
@@ -31,6 +152,7 @@ export declare const enum NpmScript {
     TestTypes = "test:types",
     TestCoverage = "test:coverage",
     Generate = "generate",
+    GenerateTypes = "generate:types",
     GenerateEntries = "generate:entries",
     GenerateVueCompat = "generate:vue-compatibility",
     GenerateWebTypes = "generate:web-types",
@@ -44,5 +166,10 @@ export declare const enum NpmScript {
     ExampleWebComponents = "example:web-components",
     KeyGenerate = "key:generate",
     TypesFix = "types:fix",
-    TypesGenerate = "types:generate"
+    TypesGenerate = "types:generate",
+    Preinstall = "preinstall",
+    Prepublish = "prepublish",
+    Wip = "wip"
 }
+export type { CAC as CLI } from 'cac';
+export type { ExecaReturnValue as CommandResult } from 'execa';

package/dist/cli.mjs

@@ -5,14 +5,18 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["BuildFunctions"] = "build:functions";
   NpmScript2["BuildDocs"] = "build:docs";
   NpmScript2["BuildStacks"] = "build:stacks";
+  NpmScript2["Clean"] = "clean";
   NpmScript2["Dev"] = "dev";
   NpmScript2["DevComponents"] = "dev:components";
   NpmScript2["DevDocs"] = "dev:docs";
+  NpmScript2["DevPages"] = "dev:pages";
+  NpmScript2["DevFunctions"] = "dev:functions";
   NpmScript2["Fresh"] = "fresh";
   NpmScript2["Update"] = "update";
   NpmScript2["UpdateDependencies"] = "update:dependencies";
   NpmScript2["UpdateFramework"] = "update:framework";
   NpmScript2["UpdatePackageManager"] = "update:package-manager";
+  NpmScript2["UpdateNode"] = "update:node";
   NpmScript2["Lint"] = "lint";
   NpmScript2["LintFix"] = "lint:fix";
   NpmScript2["MakeStack"] = "make:stack";
@@ -20,6 +24,7 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["TestTypes"] = "test:types";
   NpmScript2["TestCoverage"] = "test:coverage";
   NpmScript2["Generate"] = "generate";
+  NpmScript2["GenerateTypes"] = "generate:types";
   NpmScript2["GenerateEntries"] = "generate:entries";
   NpmScript2["GenerateVueCompat"] = "generate:vue-compatibility";
   NpmScript2["GenerateWebTypes"] = "generate:web-types";
@@ -34,5 +39,8 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["KeyGenerate"] = "key:generate";
   NpmScript2["TypesFix"] = "types:fix";
   NpmScript2["TypesGenerate"] = "types:generate";
+  NpmScript2["Preinstall"] = "preinstall";
+  NpmScript2["Prepublish"] = "prepublish";
+  NpmScript2["Wip"] = "wip";
   return NpmScript2;
 })(NpmScript || {});

package/dist/errors.d.ts

@@ -0,0 +1 @@
+export { Err, Ok, Result, ResultAsync, } from 'neverthrow';

package/dist/errors.mjs

@@ -0,0 +1,6 @@
+export {
+  Err,
+  Ok,
+  Result,
+  ResultAsync
+} from "neverthrow";

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from './components';
 export * from './cli';
 export * from './deploy';
 export * from './docs';
+export * from './errors';
 export * from './exit-code';
 export * from './fs';
 export * from './git';

package/dist/index.mjs

@@ -5,6 +5,7 @@ export * from "./components.mjs";
 export * from "./cli.mjs";
 export * from "./deploy.mjs";
 export * from "./docs.mjs";
+export * from "./errors.mjs";
 export * from "./exit-code.mjs";
 export * from "./fs.mjs";
 export * from "./git.mjs";

package/dist/ssg.d.ts

@@ -1,2 +1,2 @@
-import { type ViteSSGContext } from 'vite-ssg';
+import { type ViteSSGContext } from '@stacksjs/types';
 export declare type UserModule = (ctx: ViteSSGContext) => void;

package/dist/ui.d.ts

@@ -14,11 +14,12 @@ export interface UiOptions {
      * utility names for reusability purposes.
      *
      * @example
-     * ```ts
+     * ```
      * shortcuts: {
      *   'btn': 'px-4 py-2 rounded text-white bg-blue-500',
      *   'btn-lg': 'btn px-6 py-3',
      * }
+     * ```
      */
     shortcuts: Shortcuts;
     /**

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.37.9",
-  "packageManager": "pnpm@7.14.0",
+  "version": "0.38.3",
+  "packageManager": "pnpm@7.15.0",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -29,27 +29,38 @@
     "Chris Breuer <chris@ow3.org>"
   ],
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "engines": {
-    "node": ">=v18.10.0",
-    "pnpm": ">=7.14.0"
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.15.0"
   },
-  "dependencies": {
+  "devDependencies": {
     "@mdit-vue/plugin-component": "^0.11.1",
     "@mdit-vue/plugin-frontmatter": "^0.11.1",
     "@mdit-vue/types": "^0.11.0",
     "@rollup/pluginutils": "^5.0.2",
+    "@types/bcryptjs": "^2.4.2",
+    "@types/crypto-js": "^4.1.1",
+    "@types/eslint": "^8.4.10",
+    "@types/fs-extra": "^9.0.13",
+    "@types/markdown-it-link-attributes": "^3.0.1",
+    "@types/minimatch": "^5.1.2",
+    "@types/node": "^18.11.9",
+    "@types/nprogress": "^0.2.0",
+    "@types/pluralize": "^0.0.29",
+    "@types/prompts": "^2.4.1",
+    "cac": "^6.7.14",
     "markdown-it": "^13.0.1",
-    "unplugin-auto-import": "^0.11.2",
-    "unplugin-vue-components": "^0.22.8",
-    "vite": "^3.1.8",
-    "vite-plugin-inspect": "^0.7.5",
+    "mkdist": "^0.4.0",
+    "typescript": "^4.8.4",
+    "unplugin-auto-import": "^0.11.4",
+    "unplugin-vue-components": "^0.22.9",
+    "vite-plugin-inspect": "^0.7.7",
     "vite-plugin-vue-layouts": "^0.7.0",
-    "vitepress": "1.0.0-alpha.22"
-  },
-  "devDependencies": {
-    "mkdist": "^0.3.13"
+    "vite-ssg": "^0.21.2",
+    "vitepress": "1.0.0-alpha.28"
   },
   "scripts": {
     "build": "mkdist -d",