@stacksjs/types 0.53.1 → 0.56.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.mjs +5 -3
- package/dist/cron-jobs.mjs +12 -0
- package/dist/errors.mjs +7 -1
- package/dist/index.mjs +2 -1
- package/dist/queue.mjs +0 -0
- package/package.json +25 -18
- package/dist/app.d.ts +0 -108
- package/dist/auto-imports.d.ts +0 -1
- package/dist/build.d.ts +0 -2
- package/dist/cache.d.ts +0 -69
- package/dist/cdn.d.ts +0 -15
- package/dist/cli.d.ts +0 -278
- package/dist/components.d.ts +0 -60
- package/dist/cron-jobs.d.ts +0 -16
- package/dist/database.d.ts +0 -32
- package/dist/debug.d.ts +0 -6
- package/dist/deploy.d.ts +0 -9
- package/dist/dns.d.ts +0 -43
- package/dist/docs.d.ts +0 -3
- package/dist/errors.d.ts +0 -1
- package/dist/events.d.ts +0 -22
- package/dist/exit-code.d.ts +0 -10
- package/dist/fs.d.ts +0 -27
- package/dist/git.d.ts +0 -128
- package/dist/hashing.d.ts +0 -102
- package/dist/i18n.d.ts +0 -19
- package/dist/index.d.ts +0 -39
- package/dist/inspect.d.ts +0 -9
- package/dist/layout.d.ts +0 -7
- package/dist/library.d.ts +0 -132
- package/dist/manifest.d.ts +0 -9
- package/dist/markdown.d.ts +0 -167
- package/dist/model.d.ts +0 -40
- package/dist/notifications.d.ts +0 -164
- package/dist/pages.d.ts +0 -10
- package/dist/payments.d.ts +0 -59
- package/dist/promise.d.ts +0 -1
- package/dist/pwa.d.ts +0 -7
- package/dist/reactivity.d.ts +0 -1
- package/dist/router.d.ts +0 -42
- package/dist/search-engine.d.ts +0 -143
- package/dist/ssg.d.ts +0 -2
- package/dist/stacks.d.ts +0 -163
- package/dist/tables.d.ts +0 -52
- package/dist/ui.d.ts +0 -180
- package/dist/utils.d.ts +0 -30
- /package/dist/{markdown.mjs → money.mjs} +0 -0
package/dist/cli.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
|
|
2
2
|
NpmScript2["Build"] = "build";
|
|
3
|
-
NpmScript2["BuildComponents"] = "build
|
|
3
|
+
NpmScript2["BuildComponents"] = "vite build --config ./core/build/src/vue-components.ts";
|
|
4
4
|
NpmScript2["BuildWebComponents"] = "build:web-components";
|
|
5
5
|
NpmScript2["BuildFunctions"] = "build:functions";
|
|
6
6
|
NpmScript2["BuildDocs"] = "build:docs";
|
|
@@ -13,8 +13,9 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
|
|
|
13
13
|
NpmScript2["DevPages"] = "dev:pages";
|
|
14
14
|
NpmScript2["DevFunctions"] = "dev:functions";
|
|
15
15
|
NpmScript2["Fresh"] = "fresh";
|
|
16
|
-
NpmScript2["Lint"] = "eslint .
|
|
16
|
+
NpmScript2["Lint"] = "eslint .";
|
|
17
17
|
NpmScript2["LintFix"] = "eslint . --fix";
|
|
18
|
+
NpmScript2["LintPackageJson"] = "npx publint";
|
|
18
19
|
NpmScript2["MakeStack"] = "make:stack";
|
|
19
20
|
NpmScript2["Test"] = "vitest --config vitest.config.ts";
|
|
20
21
|
NpmScript2["TestUnit"] = "vitest --config vitest.config.ts";
|
|
@@ -48,7 +49,7 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
|
|
|
48
49
|
export var Action = /* @__PURE__ */ ((Action2) => {
|
|
49
50
|
Action2["Bump"] = "bump";
|
|
50
51
|
Action2["BuildStacks"] = "build/stacks";
|
|
51
|
-
Action2["BuildComponentLibs"] = "build
|
|
52
|
+
Action2["BuildComponentLibs"] = "build/component-libs";
|
|
52
53
|
Action2["BuildVueComponentLib"] = "build-vue-component-lib";
|
|
53
54
|
Action2["BuildWebComponentLib"] = "build-web-component-lib";
|
|
54
55
|
Action2["BuildCli"] = "build-cli";
|
|
@@ -58,6 +59,7 @@ export var Action = /* @__PURE__ */ ((Action2) => {
|
|
|
58
59
|
Action2["Changelog"] = "changelog";
|
|
59
60
|
Action2["Clean"] = "clean";
|
|
60
61
|
Action2["DevComponents"] = "dev/components";
|
|
62
|
+
Action2["Dev"] = "dev/index";
|
|
61
63
|
Action2["DevDocs"] = "dev/docs";
|
|
62
64
|
Action2["Deploy"] = "deploy";
|
|
63
65
|
Action2["Fresh"] = "fresh";
|
package/dist/cron-jobs.mjs
CHANGED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export var Every = /* @__PURE__ */ ((Every2) => {
|
|
2
|
+
Every2["Minute"] = "* * * * *";
|
|
3
|
+
Every2["Hour"] = "0 * * * *";
|
|
4
|
+
Every2["HalfHour"] = "0,30 * * * *";
|
|
5
|
+
Every2["Day"] = "0 0 * * *";
|
|
6
|
+
Every2["Month"] = "0 0 1 * *";
|
|
7
|
+
Every2["Week"] = "0 0 * * 0";
|
|
8
|
+
Every2["Year"] = "0 0 1 1 *";
|
|
9
|
+
Every2["FifthMinute"] = "*/5 * * * *";
|
|
10
|
+
Every2["TenthMinute"] = "*/10 * * * *";
|
|
11
|
+
return Every2;
|
|
12
|
+
})(Every || {});
|
package/dist/errors.mjs
CHANGED
package/dist/index.mjs
CHANGED
|
@@ -22,13 +22,14 @@ export * from "./inspect.mjs";
|
|
|
22
22
|
export * from "./layout.mjs";
|
|
23
23
|
export * from "./library.mjs";
|
|
24
24
|
export * from "./manifest.mjs";
|
|
25
|
-
export * from "./markdown.mjs";
|
|
26
25
|
export * from "./model.mjs";
|
|
26
|
+
export * from "./money.mjs";
|
|
27
27
|
export * from "./notifications.mjs";
|
|
28
28
|
export * from "./pages.mjs";
|
|
29
29
|
export * from "./payments.mjs";
|
|
30
30
|
export * from "./promise.mjs";
|
|
31
31
|
export * from "./pwa.mjs";
|
|
32
|
+
export * from "./queue.mjs";
|
|
32
33
|
export * from "./reactivity.mjs";
|
|
33
34
|
export * from "./router.mjs";
|
|
34
35
|
export * from "./search-engine.mjs";
|
package/dist/queue.mjs
ADDED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacksjs/types",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
5
|
-
"packageManager": "pnpm@8.5
|
|
4
|
+
"version": "0.56.21",
|
|
5
|
+
"packageManager": "pnpm@8.6.5",
|
|
6
6
|
"description": "The Stacks framework types.",
|
|
7
7
|
"author": "Chris Breuer",
|
|
8
8
|
"license": "MIT",
|
|
@@ -26,7 +26,8 @@
|
|
|
26
26
|
".": {
|
|
27
27
|
"types": "./dist/index.d.ts",
|
|
28
28
|
"import": "./dist/index.mjs"
|
|
29
|
-
}
|
|
29
|
+
},
|
|
30
|
+
"./*": "./*"
|
|
30
31
|
},
|
|
31
32
|
"main": "dist/index.mjs",
|
|
32
33
|
"module": "dist/index.mjs",
|
|
@@ -38,42 +39,48 @@
|
|
|
38
39
|
"dist",
|
|
39
40
|
"README.md"
|
|
40
41
|
],
|
|
42
|
+
"peerDependencies": {
|
|
43
|
+
"neverthrow": "^6.0.0"
|
|
44
|
+
},
|
|
41
45
|
"dependencies": {
|
|
42
46
|
"@mdit-vue/plugin-component": "^0.12.0",
|
|
43
47
|
"@mdit-vue/plugin-frontmatter": "^0.12.0",
|
|
44
48
|
"@mdit-vue/types": "^0.12.0",
|
|
45
|
-
"@novu/stateless": "^0.
|
|
49
|
+
"@novu/stateless": "^0.16.2",
|
|
46
50
|
"@rollup/pluginutils": "^5.0.2",
|
|
47
51
|
"@types/bcryptjs": "^2.4.2",
|
|
48
52
|
"@types/crypto-js": "^4.1.1",
|
|
49
|
-
"@types/eslint": "^8.40.
|
|
53
|
+
"@types/eslint": "^8.40.2",
|
|
50
54
|
"@types/fs-extra": "^11.0.1",
|
|
51
55
|
"@types/markdown-it-link-attributes": "^3.0.1",
|
|
52
56
|
"@types/minimatch": "^5.1.2",
|
|
53
|
-
"@types/node": "^18.16.
|
|
57
|
+
"@types/node": "^18.16.18",
|
|
54
58
|
"@types/nprogress": "^0.2.0",
|
|
55
59
|
"@types/pluralize": "^0.0.29",
|
|
60
|
+
"@vinejs/vine": "^1.4.1",
|
|
56
61
|
"cac": "^6.7.14",
|
|
57
62
|
"execa": "^7.1.1",
|
|
58
63
|
"markdown-it": "^13.0.1",
|
|
59
|
-
"meilisearch": "^0.
|
|
64
|
+
"meilisearch": "^0.33.0",
|
|
60
65
|
"neverthrow": "^6.0.0",
|
|
61
66
|
"ora": "^6.3.1",
|
|
62
|
-
"unocss": "^0.
|
|
63
|
-
"unplugin-auto-import": "^0.16.
|
|
64
|
-
"unplugin-vue-components": "^0.
|
|
65
|
-
"vite": "^4.3.
|
|
66
|
-
"vite-plugin-inspect": "^0.7.
|
|
67
|
-
"vite-plugin-pwa": "^0.
|
|
67
|
+
"unocss": "^0.53.4",
|
|
68
|
+
"unplugin-auto-import": "^0.16.4",
|
|
69
|
+
"unplugin-vue-components": "^0.25.1",
|
|
70
|
+
"vite": "^4.3.9",
|
|
71
|
+
"vite-plugin-inspect": "^0.7.30",
|
|
72
|
+
"vite-plugin-pwa": "^0.16.4",
|
|
68
73
|
"vite-plugin-vue-layouts": "^0.8.0",
|
|
69
74
|
"vite-ssg": "^0.22.2",
|
|
70
|
-
"vitepress": "1.0.0-beta.
|
|
71
|
-
"vue": "^3.3.4"
|
|
72
|
-
|
|
73
|
-
|
|
75
|
+
"vitepress": "1.0.0-beta.3",
|
|
76
|
+
"vue": "^3.3.4"
|
|
77
|
+
},
|
|
78
|
+
"devDependencies": {
|
|
79
|
+
"typescript": "^5.1.5",
|
|
80
|
+
"unbuild": "^1.2.1"
|
|
74
81
|
},
|
|
75
82
|
"scripts": {
|
|
76
|
-
"build": "
|
|
83
|
+
"build": "mkdist",
|
|
77
84
|
"dev": "unbuild --stub",
|
|
78
85
|
"typecheck": "tsc --noEmit"
|
|
79
86
|
}
|
package/dist/app.d.ts
DELETED
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* **Application Options**
|
|
3
|
-
*
|
|
4
|
-
* This configuration defines all of your application options. Because Stacks is fully-typed,
|
|
5
|
-
* you may hover any of the options below and the definitions will be provided. In case
|
|
6
|
-
* you have any questions, feel free to reach out via Discord or GitHub Discussions.
|
|
7
|
-
*/
|
|
8
|
-
export interface AppOptions {
|
|
9
|
-
/**
|
|
10
|
-
* **Application Name**
|
|
11
|
-
*
|
|
12
|
-
* This value is the name of your application. This value is used when the
|
|
13
|
-
* framework needs to place the application's name in a log or any
|
|
14
|
-
* other location as required by the application or its packages.
|
|
15
|
-
*
|
|
16
|
-
* @default string "Stacks"
|
|
17
|
-
*/
|
|
18
|
-
name: string;
|
|
19
|
-
/**
|
|
20
|
-
* **Application Environment**
|
|
21
|
-
*
|
|
22
|
-
* This value determines the "environment" your application is currently
|
|
23
|
-
* running in. This may determine how you prefer to configure various
|
|
24
|
-
* services the application utilizes. Set this in your ".env" file
|
|
25
|
-
*
|
|
26
|
-
* @default "local"
|
|
27
|
-
*/
|
|
28
|
-
env?: 'local' | 'development' | 'production';
|
|
29
|
-
/**
|
|
30
|
-
* **Application URL**
|
|
31
|
-
*
|
|
32
|
-
* This URL is used by the console to properly generate URLs when using
|
|
33
|
-
* the Buddy command line tool. You should set this to the root of
|
|
34
|
-
* your application so that it is used when running Buddy tasks.
|
|
35
|
-
*
|
|
36
|
-
* @default string "https://localhost"
|
|
37
|
-
* @example "https://hello-world.test"
|
|
38
|
-
*/
|
|
39
|
-
url?: string;
|
|
40
|
-
/**
|
|
41
|
-
* **Application Debug Mode**
|
|
42
|
-
*
|
|
43
|
-
* When your application is in debug mode, detailed error messages with
|
|
44
|
-
* stack traces will be shown on every error that occurs within your
|
|
45
|
-
* application. If disabled, a simple generic error page is shown.
|
|
46
|
-
*
|
|
47
|
-
* @default true
|
|
48
|
-
*/
|
|
49
|
-
debug: boolean;
|
|
50
|
-
/**
|
|
51
|
-
* **Application Port**
|
|
52
|
-
*
|
|
53
|
-
* This port is used when Stacks creates a server you. You should set
|
|
54
|
-
* a port that's not already in use by your machine. Stacks defaults
|
|
55
|
-
* to a memorable port that likely is free on your end: 3333.
|
|
56
|
-
*
|
|
57
|
-
* @default number 3333
|
|
58
|
-
*/
|
|
59
|
-
port: number;
|
|
60
|
-
/**
|
|
61
|
-
* **Encryption Key**
|
|
62
|
-
*
|
|
63
|
-
* This key is used by the Stacks encrypter service and should be set to
|
|
64
|
-
* a random, 32 character string, otherwise these encrypted strings will
|
|
65
|
-
* not be safe. Please do this before deploying an application!
|
|
66
|
-
*/
|
|
67
|
-
key?: string;
|
|
68
|
-
/**
|
|
69
|
-
* **Application Timezone**
|
|
70
|
-
*
|
|
71
|
-
* Here you may specify the default timezone for your application, which
|
|
72
|
-
* will be used by Stacks and date-time functions. We have gone ahead
|
|
73
|
-
* and set this to a sensible default for you out of the box.
|
|
74
|
-
*
|
|
75
|
-
* @default string "UTC"
|
|
76
|
-
*/
|
|
77
|
-
timezone?: string;
|
|
78
|
-
/**
|
|
79
|
-
* **Application Locale Configuration**
|
|
80
|
-
*
|
|
81
|
-
* The application locale determines the default locale that will be used
|
|
82
|
-
* by the translation service provider. You are free to set this value
|
|
83
|
-
* to any of the locales which will be supported by the application.
|
|
84
|
-
*
|
|
85
|
-
* @default string "en"
|
|
86
|
-
* @example
|
|
87
|
-
* de // ./lang/de.yml needs to be present for this
|
|
88
|
-
*/
|
|
89
|
-
locale?: string;
|
|
90
|
-
/**
|
|
91
|
-
* **Application Fallback Locale**
|
|
92
|
-
*
|
|
93
|
-
* The fallback locale determines the locale to use when the current one
|
|
94
|
-
* is not available. You may change the value to correspond to any of
|
|
95
|
-
* the language folders that are provided through your application.
|
|
96
|
-
*
|
|
97
|
-
* @default string "en"
|
|
98
|
-
*/
|
|
99
|
-
fallbackLocale: 'en';
|
|
100
|
-
/**
|
|
101
|
-
* **Cipher**
|
|
102
|
-
*
|
|
103
|
-
* Description WIP.
|
|
104
|
-
*
|
|
105
|
-
* @default string "aes-256-cbc"
|
|
106
|
-
*/
|
|
107
|
-
cipher: string;
|
|
108
|
-
}
|
package/dist/auto-imports.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export type { Options as AutoImportsOptions } from 'unplugin-auto-import/types';
|
package/dist/build.d.ts
DELETED
package/dist/cache.d.ts
DELETED
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
export interface CacheOptions {
|
|
2
|
-
/**
|
|
3
|
-
* **Cache Driver**
|
|
4
|
-
*
|
|
5
|
-
* This value determines the cache driver that will be used by your application to store
|
|
6
|
-
* cached data. By default, Stacks uses the "redis" driver, which stores cached data in
|
|
7
|
-
* in a self-configufed Redis instance. You may use any of the other drivers provided
|
|
8
|
-
* by Stacks or write your own custom driver.
|
|
9
|
-
*
|
|
10
|
-
* @default "redis"
|
|
11
|
-
* @example "redis"
|
|
12
|
-
* @example "memcached"
|
|
13
|
-
* @example "dynamodb"
|
|
14
|
-
*
|
|
15
|
-
* @see https://stacks.js.org/docs/cache
|
|
16
|
-
*/
|
|
17
|
-
driver: string;
|
|
18
|
-
/**
|
|
19
|
-
* **Cache Prefix**
|
|
20
|
-
*
|
|
21
|
-
* This value determines the prefix that will be used when storing items in the cache. This
|
|
22
|
-
* prefix may be useful when multiple applications are sharing the same cache driver so that
|
|
23
|
-
* they may avoid collisions when attempting to retrieve items from the cache.
|
|
24
|
-
*
|
|
25
|
-
* @default string "stacks"
|
|
26
|
-
* @example "stacks"
|
|
27
|
-
*
|
|
28
|
-
* @see https://stacks.js.org/docs/cache
|
|
29
|
-
*/
|
|
30
|
-
prefix: string;
|
|
31
|
-
/**
|
|
32
|
-
* **Cache TTL**
|
|
33
|
-
*
|
|
34
|
-
* This value determines the default time to live for items stored in the cache. This value
|
|
35
|
-
* may be overridden when storing items in the cache. If no value is specified, the cache
|
|
36
|
-
* driver will default to a reasonable time to live for the given item.
|
|
37
|
-
*
|
|
38
|
-
* @default number 3600
|
|
39
|
-
* @example 3600
|
|
40
|
-
* @example 3600 * 24
|
|
41
|
-
* @example -1 (never expires)
|
|
42
|
-
*/
|
|
43
|
-
ttl: number;
|
|
44
|
-
drivers: {
|
|
45
|
-
redis?: {
|
|
46
|
-
connection: string;
|
|
47
|
-
/**
|
|
48
|
-
* **Redis Host**
|
|
49
|
-
*
|
|
50
|
-
* This value determines the host that will be used to connect to the Redis server.
|
|
51
|
-
*
|
|
52
|
-
* @default string "localhost"
|
|
53
|
-
* @example "localhost"
|
|
54
|
-
*/
|
|
55
|
-
host: string;
|
|
56
|
-
/**
|
|
57
|
-
* **Redis Port**
|
|
58
|
-
*
|
|
59
|
-
* This value determines the port that will be used to connect to the Redis server.
|
|
60
|
-
*
|
|
61
|
-
* @default number 6379
|
|
62
|
-
* @example 6379
|
|
63
|
-
*/
|
|
64
|
-
port: number;
|
|
65
|
-
};
|
|
66
|
-
memcached?: {};
|
|
67
|
-
dynamodb?: {};
|
|
68
|
-
};
|
|
69
|
-
}
|
package/dist/cdn.d.ts
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
export interface CdnOptions {
|
|
2
|
-
/**
|
|
3
|
-
* **CDN Driver**
|
|
4
|
-
*
|
|
5
|
-
* This value determines the default CDN driver that will be used when interacting with the
|
|
6
|
-
* CDN service. This value may be overridden when interacting with the CDN service.
|
|
7
|
-
*
|
|
8
|
-
* @default "cloudfront"
|
|
9
|
-
* @example "cloudfront"
|
|
10
|
-
* @example "fastly" wip
|
|
11
|
-
*
|
|
12
|
-
* @see https://stacks.js.org/docs/cdn
|
|
13
|
-
*/
|
|
14
|
-
driver: string;
|
|
15
|
-
}
|
package/dist/cli.d.ts
DELETED
|
@@ -1,278 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The parsed command-line arguments
|
|
3
|
-
*/
|
|
4
|
-
import type { Ora } from 'ora';
|
|
5
|
-
import type { ExecaReturnValue } from 'execa';
|
|
6
|
-
import type { Err, Ok } from './errors';
|
|
7
|
-
export type CommandReturnValue = ExecaReturnValue<string>;
|
|
8
|
-
export type CommandResult = Ok<ExecaReturnValue<string>, Error | void> | Err<ExecaReturnValue<string>, Error | string | void>;
|
|
9
|
-
export interface OutroOptions extends CliOptions {
|
|
10
|
-
type?: 'success' | 'error' | 'warning' | 'info';
|
|
11
|
-
startTime?: number;
|
|
12
|
-
useSeconds?: boolean;
|
|
13
|
-
isError?: boolean;
|
|
14
|
-
quiet?: boolean;
|
|
15
|
-
}
|
|
16
|
-
export interface IntroOptions {
|
|
17
|
-
/**
|
|
18
|
-
* @default true
|
|
19
|
-
*/
|
|
20
|
-
showPerformance?: boolean;
|
|
21
|
-
/**
|
|
22
|
-
* @default false
|
|
23
|
-
*/
|
|
24
|
-
quiet: boolean;
|
|
25
|
-
}
|
|
26
|
-
type SpinnerOptions = Ora;
|
|
27
|
-
export type CliOptionsKeys = keyof CliOptions;
|
|
28
|
-
/**
|
|
29
|
-
* The CLI Options used in `./config/cli.ts`.
|
|
30
|
-
*/
|
|
31
|
-
export interface UserCliOptions {
|
|
32
|
-
name?: string;
|
|
33
|
-
command?: string;
|
|
34
|
-
description?: string;
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* The options to pass to the CLI.
|
|
38
|
-
*/
|
|
39
|
-
export interface CliOptions {
|
|
40
|
-
/**
|
|
41
|
-
* **Quiet Output**
|
|
42
|
-
*
|
|
43
|
-
* When your application is in "quiet"-mode, a different level of information
|
|
44
|
-
* like useful outputs for debugging reasons, will be shown.
|
|
45
|
-
* When disabled, it defaults to the "normal experience."
|
|
46
|
-
*
|
|
47
|
-
* @default false
|
|
48
|
-
*/
|
|
49
|
-
quiet?: boolean;
|
|
50
|
-
/**
|
|
51
|
-
* **Verbose Output**
|
|
52
|
-
*
|
|
53
|
-
* When your application is in "verbose"-mode, a different level of,
|
|
54
|
-
* information like useful outputs for debugging reasons, will be
|
|
55
|
-
* shown. When disabled, it defaults to the "normal experience."
|
|
56
|
-
*
|
|
57
|
-
* @default false
|
|
58
|
-
*/
|
|
59
|
-
verbose?: boolean;
|
|
60
|
-
/**
|
|
61
|
-
* **Current Work Directory**
|
|
62
|
-
*
|
|
63
|
-
* Based on the `cwd` value, that's where the command...
|
|
64
|
-
*
|
|
65
|
-
* @default projectPath()
|
|
66
|
-
*/
|
|
67
|
-
cwd?: string;
|
|
68
|
-
/**
|
|
69
|
-
* **Should show loading animation spinner?**
|
|
70
|
-
*
|
|
71
|
-
* Should the command show a loading animation?
|
|
72
|
-
* Please note, when debug mode is enabled,
|
|
73
|
-
* the animation will not show.
|
|
74
|
-
*
|
|
75
|
-
* @default true
|
|
76
|
-
*/
|
|
77
|
-
showSpinner?: boolean | SpinnerOptions;
|
|
78
|
-
/**
|
|
79
|
-
* **Spinner Text**
|
|
80
|
-
*
|
|
81
|
-
* The text to show when the spinner is shown.
|
|
82
|
-
*
|
|
83
|
-
* @default 'Executing...'
|
|
84
|
-
*/
|
|
85
|
-
spinnerText?: string;
|
|
86
|
-
/**
|
|
87
|
-
* **Should the command be run inside a shell?**
|
|
88
|
-
*
|
|
89
|
-
* If `true`, runs `command` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe`
|
|
90
|
-
* on Windows. A different shell can be specified as a string. The shell should
|
|
91
|
-
* understand the `-c` switch on UNIX or `/d /s /c` on Windows.
|
|
92
|
-
*
|
|
93
|
-
* We recommend against using this option since it is:
|
|
94
|
-
* - not cross-platform, encouraging shell-specific syntax.
|
|
95
|
-
* - slower, because of the additional shell interpretation.
|
|
96
|
-
* - unsafe, potentially allowing command injection.
|
|
97
|
-
*
|
|
98
|
-
* @default false
|
|
99
|
-
*/
|
|
100
|
-
shell?: boolean;
|
|
101
|
-
/**
|
|
102
|
-
* **Encoding**
|
|
103
|
-
*
|
|
104
|
-
* Encoding type
|
|
105
|
-
*
|
|
106
|
-
* @default 'utf-8'
|
|
107
|
-
*/
|
|
108
|
-
encoding?: string;
|
|
109
|
-
}
|
|
110
|
-
export type { Ora as SpinnerOptions } from 'ora';
|
|
111
|
-
export type ActionOption = 'types';
|
|
112
|
-
/**
|
|
113
|
-
* The options to pass to the Action.
|
|
114
|
-
*/
|
|
115
|
-
export type ActionOptions = {
|
|
116
|
-
[key in ActionOption]?: boolean;
|
|
117
|
-
} & CliOptions;
|
|
118
|
-
export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'pages' | 'stacks' | 'all';
|
|
119
|
-
export type BuildOptions = {
|
|
120
|
-
[key in BuildOption]: boolean;
|
|
121
|
-
} & CliOptions;
|
|
122
|
-
export type AddOption = 'table' | 'calendar' | 'all';
|
|
123
|
-
export type AddOptions = {
|
|
124
|
-
[key in AddOption]?: boolean;
|
|
125
|
-
} & CliOptions;
|
|
126
|
-
export type CreateStringOption = 'name';
|
|
127
|
-
export type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'pages' | 'functions' | 'api' | 'database';
|
|
128
|
-
export type CreateOptions = {
|
|
129
|
-
[key in CreateBooleanOption]: boolean;
|
|
130
|
-
} & {
|
|
131
|
-
[key in CreateStringOption]: string;
|
|
132
|
-
} & CliOptions;
|
|
133
|
-
export type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'desktop' | 'all';
|
|
134
|
-
export type DevOptions = {
|
|
135
|
-
[key in DevOption]: boolean;
|
|
136
|
-
} & CliOptions;
|
|
137
|
-
export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'vueCompatibility' | 'componentMeta';
|
|
138
|
-
export type GeneratorOptions = {
|
|
139
|
-
[key in GeneratorOption]?: boolean;
|
|
140
|
-
} & CliOptions;
|
|
141
|
-
export type LintOption = 'fix';
|
|
142
|
-
export type LintOptions = {
|
|
143
|
-
[key in LintOption]: boolean;
|
|
144
|
-
} & CliOptions;
|
|
145
|
-
export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
|
|
146
|
-
export type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'factory' | 'notification' | 'stack';
|
|
147
|
-
export type MakeOptions = {
|
|
148
|
-
[key in MakeBooleanOption]: boolean;
|
|
149
|
-
} & {
|
|
150
|
-
[key in MakeStringOption]: string;
|
|
151
|
-
} & CliOptions;
|
|
152
|
-
export type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force';
|
|
153
|
-
export type UpgradeString = 'version';
|
|
154
|
-
export type UpgradeOptions = {
|
|
155
|
-
[key in UpgradeBoolean]: boolean;
|
|
156
|
-
} & {
|
|
157
|
-
[key in UpgradeString]: string;
|
|
158
|
-
} & CliOptions;
|
|
159
|
-
export type ExamplesString = 'version';
|
|
160
|
-
export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
|
|
161
|
-
export type ExamplesOption = ExamplesString & ExamplesBoolean | void;
|
|
162
|
-
export type ExamplesOptions = {
|
|
163
|
-
[key in ExamplesString]: string;
|
|
164
|
-
} & {
|
|
165
|
-
[key in ExamplesBoolean]: boolean;
|
|
166
|
-
} & CliOptions;
|
|
167
|
-
export type TestOptions = CliOptions & {
|
|
168
|
-
showReport?: boolean;
|
|
169
|
-
};
|
|
170
|
-
export interface CleanOptions extends CliOptions {
|
|
171
|
-
}
|
|
172
|
-
export interface CommitOptions extends CliOptions {
|
|
173
|
-
}
|
|
174
|
-
export interface KeyOptions extends CliOptions {
|
|
175
|
-
}
|
|
176
|
-
export interface FreshOptions extends CliOptions {
|
|
177
|
-
}
|
|
178
|
-
export interface InspireOptions extends CliOptions {
|
|
179
|
-
}
|
|
180
|
-
export interface ReleaseOptions extends CliOptions {
|
|
181
|
-
}
|
|
182
|
-
export interface PreinstallOptions extends CliOptions {
|
|
183
|
-
}
|
|
184
|
-
export interface PrepublishOptions extends CliOptions {
|
|
185
|
-
}
|
|
186
|
-
export interface TinkerOptions extends CliOptions {
|
|
187
|
-
}
|
|
188
|
-
export interface TypesOptions extends CliOptions {
|
|
189
|
-
}
|
|
190
|
-
export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all';
|
|
191
|
-
/**
|
|
192
|
-
* The available npm scripts within the Stacks toolkit.
|
|
193
|
-
*/
|
|
194
|
-
export declare const enum NpmScript {
|
|
195
|
-
Build = "build",
|
|
196
|
-
BuildComponents = "build:components",
|
|
197
|
-
BuildWebComponents = "build:web-components",
|
|
198
|
-
BuildFunctions = "build:functions",
|
|
199
|
-
BuildDocs = "build:docs",
|
|
200
|
-
BuildStacks = "build:stacks",
|
|
201
|
-
Clean = "rimraf pnpm-lock.yaml node_modules/ .stacks/**/node_modules .stacks/**/dist",
|
|
202
|
-
Dev = "dev",
|
|
203
|
-
DevComponents = "vite --config ./core/build/src/vue-components.ts",
|
|
204
|
-
DevDocs = "npx vitepress dev ./docs/src",
|
|
205
|
-
DevDesktop = "dev:desktop",
|
|
206
|
-
DevPages = "dev:pages",
|
|
207
|
-
DevFunctions = "dev:functions",
|
|
208
|
-
Fresh = "fresh",
|
|
209
|
-
Lint = "eslint . ; npx publint",
|
|
210
|
-
LintFix = "eslint . --fix",
|
|
211
|
-
MakeStack = "make:stack",
|
|
212
|
-
Test = "vitest --config vitest.config.ts",
|
|
213
|
-
TestUnit = "vitest --config vitest.config.ts",
|
|
214
|
-
TestFeature = "playwright test --config playwright.config.ts",
|
|
215
|
-
TestUi = "vitest --config vitest.config.ts --ui",
|
|
216
|
-
TestCoverage = "vitest --config vitest.config.ts --coverage",
|
|
217
|
-
TestTypes = "vue-npx tsc --noEmit",
|
|
218
|
-
Generate = "generate",
|
|
219
|
-
GenerateTypes = "generate:types",
|
|
220
|
-
GenerateEntries = "generate:entries",
|
|
221
|
-
GenerateVueCompat = "generate:vue-compatibility",
|
|
222
|
-
GenerateWebTypes = "generate:web-types",
|
|
223
|
-
GenerateVsCodeCustomData = "generate:vscode-custom-data",
|
|
224
|
-
GenerateIdeHelpers = "generate:ide-helpers",
|
|
225
|
-
GenerateComponentMeta = "generate:component-meta",
|
|
226
|
-
Release = "release",
|
|
227
|
-
Commit = "commit",
|
|
228
|
-
Example = "example",
|
|
229
|
-
ExampleVue = "example:vue",
|
|
230
|
-
ExampleWebComponents = "example:web-components",
|
|
231
|
-
KeyGenerate = "key:generate",
|
|
232
|
-
TypesFix = "types:fix",
|
|
233
|
-
TypesGenerate = "types:generate",
|
|
234
|
-
Preinstall = "preinstall",
|
|
235
|
-
Prepublish = "prepublish",
|
|
236
|
-
Wip = "wip",
|
|
237
|
-
UpgradeNode = "./.stacks/scripts/setup.sh +nodejs.org",
|
|
238
|
-
UpgradeDependencies = "pnpm up"
|
|
239
|
-
}
|
|
240
|
-
export declare const enum Action {
|
|
241
|
-
Bump = "bump",
|
|
242
|
-
BuildStacks = "build/stacks",
|
|
243
|
-
BuildComponentLibs = "build-component-libs",
|
|
244
|
-
BuildVueComponentLib = "build-vue-component-lib",
|
|
245
|
-
BuildWebComponentLib = "build-web-component-lib",
|
|
246
|
-
BuildCli = "build-cli",
|
|
247
|
-
BuildCore = "build/core",
|
|
248
|
-
BuildDocs = "build-docs",
|
|
249
|
-
BuildFunctionLib = "build-function-lib",
|
|
250
|
-
Changelog = "changelog",
|
|
251
|
-
Clean = "clean",
|
|
252
|
-
DevComponents = "dev/components",
|
|
253
|
-
DevDocs = "dev/docs",
|
|
254
|
-
Deploy = "deploy",
|
|
255
|
-
Fresh = "fresh",
|
|
256
|
-
GenerateLibraryEntries = "generate/lib-entries",
|
|
257
|
-
Inspire = "inspire",
|
|
258
|
-
KeyGenerate = "key-generate",
|
|
259
|
-
MakeNotification = "make-notification",
|
|
260
|
-
Migrate = "migrate",
|
|
261
|
-
Seed = "seed",
|
|
262
|
-
Lint = "lint/index",
|
|
263
|
-
LintFix = "lint/fix",
|
|
264
|
-
Prepublish = "prepublish",
|
|
265
|
-
Release = "release",
|
|
266
|
-
ShowFeatureTestReport = "show-feature-test-report",
|
|
267
|
-
Test = "test",
|
|
268
|
-
TestUi = "test-ui",
|
|
269
|
-
TestUnit = "test-unit",
|
|
270
|
-
TestFeature = "test-feature",
|
|
271
|
-
TestCoverage = "test-coverage",
|
|
272
|
-
Tinker = "tinker",
|
|
273
|
-
Typecheck = "typecheck",
|
|
274
|
-
Upgrade = "upgrade/index",
|
|
275
|
-
UpgradeNode = "upgrade/node",
|
|
276
|
-
UpgradePackageManager = "upgrade/package-manager"
|
|
277
|
-
}
|
|
278
|
-
export type { CAC as CLI } from 'cac';
|