@powerlines/engine 0.47.3 → 0.49.1
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/api/build.cjs +66 -0
- package/dist/api/build.d.cts +14 -0
- package/dist/api/build.d.cts.map +1 -0
- package/dist/api/build.d.mts +14 -0
- package/dist/api/build.d.mts.map +1 -0
- package/dist/api/build.mjs +64 -0
- package/dist/api/build.mjs.map +1 -0
- package/dist/api/clean.cjs +28 -0
- package/dist/api/clean.d.cts +14 -0
- package/dist/api/clean.d.cts.map +1 -0
- package/dist/api/clean.d.mts +14 -0
- package/dist/api/clean.d.mts.map +1 -0
- package/dist/api/clean.mjs +28 -0
- package/dist/api/clean.mjs.map +1 -0
- package/dist/api/create.cjs +59 -0
- package/dist/api/create.d.cts +14 -0
- package/dist/api/create.d.cts.map +1 -0
- package/dist/api/create.d.mts +14 -0
- package/dist/api/create.d.mts.map +1 -0
- package/dist/api/create.mjs +57 -0
- package/dist/api/create.mjs.map +1 -0
- package/dist/api/deploy.cjs +24 -0
- package/dist/api/deploy.d.cts +17 -0
- package/dist/api/deploy.d.cts.map +1 -0
- package/dist/api/deploy.d.mts +17 -0
- package/dist/api/deploy.d.mts.map +1 -0
- package/dist/api/deploy.mjs +24 -0
- package/dist/api/deploy.mjs.map +1 -0
- package/dist/api/docs.cjs +24 -0
- package/dist/api/docs.d.cts +17 -0
- package/dist/api/docs.d.cts.map +1 -0
- package/dist/api/docs.d.mts +17 -0
- package/dist/api/docs.d.mts.map +1 -0
- package/dist/api/docs.mjs +24 -0
- package/dist/api/docs.mjs.map +1 -0
- package/dist/api/lint.cjs +27 -0
- package/dist/api/lint.d.cts +17 -0
- package/dist/api/lint.d.cts.map +1 -0
- package/dist/api/lint.d.mts +17 -0
- package/dist/api/lint.d.mts.map +1 -0
- package/dist/api/lint.mjs +27 -0
- package/dist/api/lint.mjs.map +1 -0
- package/dist/api/prepare.cjs +68 -0
- package/dist/api/prepare.d.cts +14 -0
- package/dist/api/prepare.d.cts.map +1 -0
- package/dist/api/prepare.d.mts +14 -0
- package/dist/api/prepare.d.mts.map +1 -0
- package/dist/api/prepare.mjs +68 -0
- package/dist/api/prepare.mjs.map +1 -0
- package/dist/api/test.cjs +27 -0
- package/dist/api/test.d.cts +17 -0
- package/dist/api/test.d.cts.map +1 -0
- package/dist/api/test.d.mts +17 -0
- package/dist/api/test.d.mts.map +1 -0
- package/dist/api/test.mjs +27 -0
- package/dist/api/test.mjs.map +1 -0
- package/dist/api/types.cjs +70 -0
- package/dist/api/types.d.cts +17 -0
- package/dist/api/types.d.cts.map +1 -0
- package/dist/api/types.d.mts +17 -0
- package/dist/api/types.d.mts.map +1 -0
- package/dist/api/types.mjs +70 -0
- package/dist/api/types.mjs.map +1 -0
- package/dist/api-BgyEi2hF.d.mts +138 -0
- package/dist/api-BgyEi2hF.d.mts.map +1 -0
- package/dist/api-DcHfCjQK.d.cts +138 -0
- package/dist/api-DcHfCjQK.d.cts.map +1 -0
- package/dist/api.cjs +39 -1268
- package/dist/api.d.cts +11 -300
- package/dist/api.d.cts.map +1 -1
- package/dist/api.d.mts +11 -300
- package/dist/api.d.mts.map +1 -1
- package/dist/api.mjs +31 -1264
- package/dist/api.mjs.map +1 -1
- package/dist/config-ByLyzMI0.d.mts +204 -0
- package/dist/config-ByLyzMI0.d.mts.map +1 -0
- package/dist/config-DKEmqMrh.d.cts +204 -0
- package/dist/config-DKEmqMrh.d.cts.map +1 -0
- package/dist/context/engine-context.cjs +177 -0
- package/dist/context/engine-context.d.cts +2 -0
- package/dist/context/engine-context.d.mts +2 -0
- package/dist/context/engine-context.mjs +175 -0
- package/dist/context/engine-context.mjs.map +1 -0
- package/dist/context/index.cjs +2 -9
- package/dist/context/index.d.cts +2 -150
- package/dist/context/index.d.mts +2 -150
- package/dist/context/index.mjs +2 -4
- package/dist/context-D0_a0kRO.d.cts +149 -0
- package/dist/context-D0_a0kRO.d.cts.map +1 -0
- package/dist/context-DcXV6_GL.d.mts +149 -0
- package/dist/context-DcXV6_GL.d.mts.map +1 -0
- package/dist/engine-Dz6BvkFY.cjs +590 -0
- package/dist/engine-context-B8K6Jtkk.d.cts +53 -0
- package/dist/engine-context-B8K6Jtkk.d.cts.map +1 -0
- package/dist/engine-context-DKlA5Pgu.d.mts +53 -0
- package/dist/engine-context-DKlA5Pgu.d.mts.map +1 -0
- package/dist/engine-q6YKXXcB.mjs +571 -0
- package/dist/engine-q6YKXXcB.mjs.map +1 -0
- package/dist/engine.cjs +6 -0
- package/dist/engine.d.cts +143 -0
- package/dist/engine.d.cts.map +1 -0
- package/dist/engine.d.mts +143 -0
- package/dist/engine.d.mts.map +1 -0
- package/dist/engine.mjs +3 -0
- package/dist/helpers/create-execution-host.cjs +57 -0
- package/dist/helpers/create-execution-host.d.cts +20 -0
- package/dist/helpers/create-execution-host.d.cts.map +1 -0
- package/dist/helpers/create-execution-host.d.mts +20 -0
- package/dist/helpers/create-execution-host.d.mts.map +1 -0
- package/dist/helpers/create-execution-host.mjs +57 -0
- package/dist/helpers/create-execution-host.mjs.map +1 -0
- package/dist/helpers/finalize.cjs +26 -0
- package/dist/helpers/finalize.d.cts +12 -0
- package/dist/helpers/finalize.d.cts.map +1 -0
- package/dist/helpers/finalize.d.mts +12 -0
- package/dist/helpers/finalize.d.mts.map +1 -0
- package/dist/helpers/finalize.mjs +26 -0
- package/dist/helpers/finalize.mjs.map +1 -0
- package/dist/helpers/index.cjs +12 -0
- package/dist/helpers/index.d.cts +5 -0
- package/dist/helpers/index.d.mts +5 -0
- package/dist/helpers/index.mjs +6 -0
- package/dist/helpers/rpc.cjs +139 -0
- package/dist/helpers/rpc.d.cts +7 -0
- package/dist/helpers/rpc.d.cts.map +1 -0
- package/dist/helpers/rpc.d.mts +7 -0
- package/dist/helpers/rpc.d.mts.map +1 -0
- package/dist/helpers/rpc.mjs +139 -0
- package/dist/helpers/rpc.mjs.map +1 -0
- package/dist/helpers/stream.cjs +119 -0
- package/dist/helpers/stream.d.cts +45 -0
- package/dist/helpers/stream.d.cts.map +1 -0
- package/dist/helpers/stream.d.mts +45 -0
- package/dist/helpers/stream.d.mts.map +1 -0
- package/dist/helpers/stream.mjs +117 -0
- package/dist/helpers/stream.mjs.map +1 -0
- package/dist/index-BVVgDSdq.d.cts +1 -0
- package/dist/index-BVVgDSdq.d.mts +1 -0
- package/dist/index.cjs +8 -748
- package/dist/index.d.cts +6 -140
- package/dist/index.d.mts +6 -140
- package/dist/index.mjs +4 -747
- package/package.json +102 -132
- package/dist/_internal/worker.cjs +0 -5192
- package/dist/_internal/worker.d.cts +0 -46
- package/dist/_internal/worker.d.cts.map +0 -1
- package/dist/_internal/worker.d.mts +0 -46
- package/dist/_internal/worker.d.mts.map +0 -1
- package/dist/_internal/worker.mjs +0 -5153
- package/dist/_internal/worker.mjs.map +0 -1
- package/dist/base-context-DLemGRbd.cjs +0 -322
- package/dist/base-context-DUha4Lz-.mjs +0 -315
- package/dist/base-context-DUha4Lz-.mjs.map +0 -1
- package/dist/context/index.d.cts.map +0 -1
- package/dist/context/index.d.mts.map +0 -1
- package/dist/engine-context-BfFiKN53.mjs +0 -86
- package/dist/engine-context-BfFiKN53.mjs.map +0 -1
- package/dist/engine-context-D0y88i_J.cjs +0 -91
- package/dist/execution-context-CE5H90Um.mjs +0 -2845
- package/dist/execution-context-CE5H90Um.mjs.map +0 -1
- package/dist/execution-context-CnyaM3Ul.cjs +0 -2889
- package/dist/execution-context-NyDjVZ6T.d.cts +0 -647
- package/dist/execution-context-NyDjVZ6T.d.cts.map +0 -1
- package/dist/execution-context-YrjFeD9k.d.mts +0 -647
- package/dist/execution-context-YrjFeD9k.d.mts.map +0 -1
- package/dist/fs-CeEdzPKE.cjs +0 -262
- package/dist/fs-Dcle8lUp.mjs +0 -226
- package/dist/fs-Dcle8lUp.mjs.map +0 -1
- package/dist/index.d.cts.map +0 -1
- package/dist/index.d.mts.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/rpc/client.cjs +0 -74
- package/dist/rpc/client.d.cts +0 -31
- package/dist/rpc/client.d.cts.map +0 -1
- package/dist/rpc/client.d.mts +0 -31
- package/dist/rpc/client.d.mts.map +0 -1
- package/dist/rpc/client.mjs +0 -71
- package/dist/rpc/client.mjs.map +0 -1
- package/dist/rpc/serialization.cjs +0 -82
- package/dist/rpc/serialization.d.cts +0 -46
- package/dist/rpc/serialization.d.cts.map +0 -1
- package/dist/rpc/serialization.d.mts +0 -46
- package/dist/rpc/serialization.d.mts.map +0 -1
- package/dist/rpc/serialization.mjs +0 -76
- package/dist/rpc/serialization.mjs.map +0 -1
- package/dist/rpc/server.cjs +0 -69
- package/dist/rpc/server.d.cts +0 -29
- package/dist/rpc/server.d.cts.map +0 -1
- package/dist/rpc/server.d.mts +0 -29
- package/dist/rpc/server.d.mts.map +0 -1
- package/dist/rpc/server.mjs +0 -66
- package/dist/rpc/server.mjs.map +0 -1
- package/dist/rpc/types.cjs +0 -0
- package/dist/rpc/types.d.cts +0 -70
- package/dist/rpc/types.d.cts.map +0 -1
- package/dist/rpc/types.d.mts +0 -70
- package/dist/rpc/types.d.mts.map +0 -1
- package/dist/rpc/types.mjs +0 -1
- package/dist/schemas.cjs +0 -9
- package/dist/schemas.d.cts +0 -127
- package/dist/schemas.d.cts.map +0 -1
- package/dist/schemas.d.mts +0 -127
- package/dist/schemas.d.mts.map +0 -1
- package/dist/schemas.mjs +0 -3
- package/dist/storage/base.cjs +0 -216
- package/dist/storage/base.d.cts +0 -199
- package/dist/storage/base.d.cts.map +0 -1
- package/dist/storage/base.d.mts +0 -199
- package/dist/storage/base.d.mts.map +0 -1
- package/dist/storage/base.mjs +0 -215
- package/dist/storage/base.mjs.map +0 -1
- package/dist/storage/file-system.cjs +0 -180
- package/dist/storage/file-system.d.cts +0 -127
- package/dist/storage/file-system.d.cts.map +0 -1
- package/dist/storage/file-system.d.mts +0 -127
- package/dist/storage/file-system.d.mts.map +0 -1
- package/dist/storage/file-system.mjs +0 -179
- package/dist/storage/file-system.mjs.map +0 -1
- package/dist/storage/helpers.cjs +0 -37
- package/dist/storage/helpers.d.cts +0 -25
- package/dist/storage/helpers.d.cts.map +0 -1
- package/dist/storage/helpers.d.mts +0 -25
- package/dist/storage/helpers.d.mts.map +0 -1
- package/dist/storage/helpers.mjs +0 -34
- package/dist/storage/helpers.mjs.map +0 -1
- package/dist/storage/index.cjs +0 -12
- package/dist/storage/index.d.cts +0 -5
- package/dist/storage/index.d.mts +0 -5
- package/dist/storage/index.mjs +0 -6
- package/dist/storage/virtual.cjs +0 -98
- package/dist/storage/virtual.d.cts +0 -80
- package/dist/storage/virtual.d.cts.map +0 -1
- package/dist/storage/virtual.d.mts +0 -80
- package/dist/storage/virtual.d.mts.map +0 -1
- package/dist/storage/virtual.mjs +0 -97
- package/dist/storage/virtual.mjs.map +0 -1
- package/dist/ts-morph-BbM83PT9.cjs +0 -114
- package/dist/ts-morph-C6YBNc46.mjs +0 -102
- package/dist/ts-morph-C6YBNc46.mjs.map +0 -1
- package/dist/tsconfig-DeKMGasE.cjs +0 -198
- package/dist/tsconfig-HzJsMUrr.mjs +0 -155
- package/dist/tsconfig-HzJsMUrr.mjs.map +0 -1
- package/dist/typescript/index.cjs +0 -13
- package/dist/typescript/index.d.cts +0 -106
- package/dist/typescript/index.d.cts.map +0 -1
- package/dist/typescript/index.d.mts +0 -106
- package/dist/typescript/index.d.mts.map +0 -1
- package/dist/typescript/index.mjs +0 -4
- /package/dist/{chunk-C0xms8kb.cjs → chunk-C_NdSu1c.cjs} +0 -0
package/dist/api.d.cts
CHANGED
|
@@ -1,303 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import * as _$_powerlines_core0 from "@powerlines/core";
|
|
3
|
-
import { API, BuildInlineConfig, CallHookOptions, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, EnvironmentContext, Execution, ExecutionOptions, InferHookParameters, LintInlineConfig, NewInlineConfig, PluginConfig, PluginContext, PrepareInlineConfig, ResolvedConfig, TestInlineConfig, TypesInlineConfig } from "@powerlines/core";
|
|
4
|
-
import { PartialKeys } from "@stryke/types/base";
|
|
5
|
-
|
|
6
|
-
//#region src/_internal/execution.d.ts
|
|
7
|
-
/**
|
|
8
|
-
* The Powerlines Execution API class
|
|
9
|
-
*
|
|
10
|
-
* @remarks
|
|
11
|
-
* This class is responsible for managing the Powerlines project lifecycle, including initialization, building, and finalization.
|
|
12
|
-
*
|
|
13
|
-
* @internal
|
|
14
|
-
*/
|
|
15
|
-
declare class PowerlinesExecution<TResolvedConfig extends ResolvedConfig = ResolvedConfig> implements Execution {
|
|
16
|
-
#private;
|
|
17
|
-
/**
|
|
18
|
-
* Initialize a Powerlines API instance
|
|
19
|
-
*
|
|
20
|
-
* @param options - The options to initialize the API with
|
|
21
|
-
* @returns A new instance of the Powerlines API
|
|
22
|
-
*/
|
|
23
|
-
static from<TResolvedConfig extends ResolvedConfig = ResolvedConfig>(options: ExecutionOptions, initialConfig?: TResolvedConfig["initialConfig"]): Promise<PowerlinesExecution<TResolvedConfig>>;
|
|
24
|
-
/**
|
|
25
|
-
* The Powerlines context
|
|
26
|
-
*/
|
|
27
|
-
get context(): PowerlinesExecutionContext<TResolvedConfig>;
|
|
28
|
-
/**
|
|
29
|
-
* Generate the Powerlines typescript declaration file
|
|
30
|
-
*
|
|
31
|
-
* @remarks
|
|
32
|
-
* This method will only generate the typescript declaration file for the Powerlines project. It is generally recommended to run the full `prepare` command, which will run this method as part of its process.
|
|
33
|
-
*
|
|
34
|
-
* @param inlineConfig - The inline configuration for the types command
|
|
35
|
-
*/
|
|
36
|
-
types(inlineConfig?: PartialKeys<TypesInlineConfig, "command">): Promise<void>;
|
|
37
|
-
/**
|
|
38
|
-
* Prepare the Powerlines API
|
|
39
|
-
*
|
|
40
|
-
* @remarks
|
|
41
|
-
* This method will prepare the Powerlines API for use, initializing any necessary resources.
|
|
42
|
-
*
|
|
43
|
-
* @param inlineConfig - The inline configuration for the prepare command
|
|
44
|
-
*/
|
|
45
|
-
prepare(inlineConfig?: PartialKeys<PrepareInlineConfig, "command"> | PartialKeys<TypesInlineConfig, "command"> | PartialKeys<NewInlineConfig, "command"> | PartialKeys<CleanInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command"> | PartialKeys<LintInlineConfig, "command"> | PartialKeys<TestInlineConfig, "command"> | PartialKeys<DocsInlineConfig, "command"> | PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
46
|
-
/**
|
|
47
|
-
* Create a new Powerlines project
|
|
48
|
-
*
|
|
49
|
-
* @remarks
|
|
50
|
-
* This method will create a new Powerlines project in the current directory.
|
|
51
|
-
*
|
|
52
|
-
* @param inlineConfig - The inline configuration for the new command
|
|
53
|
-
* @returns A promise that resolves when the project has been created
|
|
54
|
-
*/
|
|
55
|
-
new(inlineConfig: PartialKeys<NewInlineConfig, "command">): Promise<void>;
|
|
56
|
-
/**
|
|
57
|
-
* Clean any previously prepared artifacts
|
|
58
|
-
*
|
|
59
|
-
* @remarks
|
|
60
|
-
* This method will remove the previous Powerlines artifacts from the project.
|
|
61
|
-
*
|
|
62
|
-
* @param inlineConfig - The inline configuration for the clean command
|
|
63
|
-
* @returns A promise that resolves when the clean command has completed
|
|
64
|
-
*/
|
|
65
|
-
clean(inlineConfig?: PartialKeys<CleanInlineConfig, "command"> | PartialKeys<PrepareInlineConfig, "command">): Promise<void>;
|
|
66
|
-
/**
|
|
67
|
-
* Lint the project
|
|
68
|
-
*
|
|
69
|
-
* @param inlineConfig - The inline configuration for the lint command
|
|
70
|
-
* @returns A promise that resolves when the lint command has completed
|
|
71
|
-
*/
|
|
72
|
-
lint(inlineConfig?: PartialKeys<LintInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
73
|
-
/**
|
|
74
|
-
* Test the project source code
|
|
75
|
-
*
|
|
76
|
-
* @param inlineConfig - The inline configuration for the test command
|
|
77
|
-
* @returns A promise that resolves when the test command has completed
|
|
78
|
-
*/
|
|
79
|
-
test(inlineConfig?: PartialKeys<TestInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
80
|
-
/**
|
|
81
|
-
* Build the project
|
|
82
|
-
*
|
|
83
|
-
* @remarks
|
|
84
|
-
* This method will build the Powerlines project, generating the necessary artifacts.
|
|
85
|
-
*
|
|
86
|
-
* @param inlineConfig - The inline configuration for the build command
|
|
87
|
-
* @returns A promise that resolves when the build command has completed
|
|
88
|
-
*/
|
|
89
|
-
build(inlineConfig?: PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
90
|
-
/**
|
|
91
|
-
* Prepare the documentation for the project
|
|
92
|
-
*
|
|
93
|
-
* @param inlineConfig - The inline configuration for the docs command
|
|
94
|
-
* @returns A promise that resolves when the documentation generation has completed
|
|
95
|
-
*/
|
|
96
|
-
docs(inlineConfig?: DocsInlineConfig): Promise<void>;
|
|
97
|
-
/**
|
|
98
|
-
* Deploy the project source code
|
|
99
|
-
*
|
|
100
|
-
* @remarks
|
|
101
|
-
* This method will prepare and build the Powerlines project, generating the necessary artifacts for the deployment.
|
|
102
|
-
*
|
|
103
|
-
* @param inlineConfig - The inline configuration for the deploy command
|
|
104
|
-
*/
|
|
105
|
-
deploy(inlineConfig?: PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
106
|
-
/**
|
|
107
|
-
* Finalization/cleanup processing for the Powerlines API
|
|
108
|
-
*
|
|
109
|
-
* @remarks
|
|
110
|
-
* This step includes any final processes or clean up required by Powerlines. It will be run after each Powerlines command.
|
|
111
|
-
*
|
|
112
|
-
* @returns A promise that resolves when the finalization process has completed
|
|
113
|
-
*/
|
|
114
|
-
finalize(): Promise<void>;
|
|
115
|
-
/**
|
|
116
|
-
* Invokes the configured plugin hooks
|
|
117
|
-
*
|
|
118
|
-
* @remarks
|
|
119
|
-
* By default, it will call the `"pre"`, `"normal"`, and `"post"` ordered hooks in sequence
|
|
120
|
-
*
|
|
121
|
-
* @param hook - The hook to call
|
|
122
|
-
* @param options - The options to provide to the hook
|
|
123
|
-
* @param args - The arguments to pass to the hook
|
|
124
|
-
* @returns The result of the hook call
|
|
125
|
-
*/
|
|
126
|
-
callHook<TKey extends string>(hook: TKey, options: CallHookOptions & {
|
|
127
|
-
environment?: string | EnvironmentContext<TResolvedConfig>;
|
|
128
|
-
}, ...args: InferHookParameters<PluginContext<TResolvedConfig>, TKey>): Promise<ReturnType<_$_powerlines_core0.InferHookFunction<PluginContext<TResolvedConfig, _$_powerlines_core0.API<any>>, TKey>> | undefined>;
|
|
129
|
-
/**
|
|
130
|
-
* Create a new Powerlines API instance
|
|
131
|
-
*
|
|
132
|
-
* @param context - The Powerlines context
|
|
133
|
-
*/
|
|
134
|
-
protected constructor(context: PowerlinesExecutionContext<TResolvedConfig>);
|
|
135
|
-
/**
|
|
136
|
-
* Initialize the execution API with the provided configuration options
|
|
137
|
-
*/
|
|
138
|
-
protected init(): Promise<void>;
|
|
139
|
-
/**
|
|
140
|
-
* Add a Powerlines plugin used in the build process
|
|
141
|
-
*
|
|
142
|
-
* @param config - The import path of the plugin to add
|
|
143
|
-
*/
|
|
144
|
-
protected addPlugin(config: PluginConfig<PluginContext<TResolvedConfig>>): Promise<void>;
|
|
145
|
-
/**
|
|
146
|
-
* Get the configured environments
|
|
147
|
-
*
|
|
148
|
-
* @returns The configured environments
|
|
149
|
-
*/
|
|
150
|
-
private getEnvironments;
|
|
151
|
-
/**
|
|
152
|
-
* Execute a handler function for each environment
|
|
153
|
-
*
|
|
154
|
-
* @param handle - The handler function to execute for each environment
|
|
155
|
-
*/
|
|
156
|
-
private executeEnvironments;
|
|
157
|
-
/**
|
|
158
|
-
* Initialize a Powerlines plugin
|
|
159
|
-
*
|
|
160
|
-
* @param config - The configuration for the plugin
|
|
161
|
-
* @returns The initialized plugin instance, or null if the plugin was a duplicate
|
|
162
|
-
* @throws Will throw an error if the plugin cannot be found or is invalid
|
|
163
|
-
*/
|
|
164
|
-
private initPlugin;
|
|
165
|
-
private resolvePlugin;
|
|
166
|
-
private handleBuild;
|
|
167
|
-
/**
|
|
168
|
-
* Generate the Powerlines TypeScript declaration file
|
|
169
|
-
*
|
|
170
|
-
* @remarks
|
|
171
|
-
* This method will generate the TypeScript declaration file for the Powerlines project, including any types provided by plugins.
|
|
172
|
-
*
|
|
173
|
-
* @param context - The environment context to use for generating the TypeScript declaration file
|
|
174
|
-
* @returns A promise that resolves when the TypeScript declaration file has been generated
|
|
175
|
-
*/
|
|
176
|
-
private handleTypes;
|
|
177
|
-
}
|
|
178
|
-
//#endregion
|
|
1
|
+
import { r as ExecutionHostParams } from "./api-DcHfCjQK.cjs";
|
|
179
2
|
//#region src/api.d.ts
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
declare
|
|
189
|
-
/**
|
|
190
|
-
* Initialize a Powerlines API instance
|
|
191
|
-
*
|
|
192
|
-
* @param options - The options to initialize the API with
|
|
193
|
-
* @param initialConfig - The initial configuration for the API, which can be used to provide additional context or override certain configuration values during initialization. This is particularly useful when initializing the API from a CLI command, where the CLI flags can be passed as part of the initial configuration to ensure they are properly merged with the configuration file and made available to plugins during their setup and execution.
|
|
194
|
-
* @returns A new instance of the Powerlines API
|
|
195
|
-
*/
|
|
196
|
-
static from<TResolvedConfig extends ResolvedConfig = ResolvedConfig>(options: PartialKeys<ExecutionOptions, "executionId" | "executionIndex">, initialConfig?: TResolvedConfig["initialConfig"]): Promise<PowerlinesAPI<TResolvedConfig>>;
|
|
197
|
-
/**
|
|
198
|
-
* Generate the Powerlines typescript declaration file
|
|
199
|
-
*
|
|
200
|
-
* @remarks
|
|
201
|
-
* This method will only generate the typescript declaration file for the Powerlines project. It is generally recommended to run the full `prepare` command, which will run this method as part of its process.
|
|
202
|
-
*
|
|
203
|
-
* @param inlineConfig - The inline configuration for the types command
|
|
204
|
-
*/
|
|
205
|
-
types(inlineConfig?: PartialKeys<TypesInlineConfig, "command">): Promise<void>;
|
|
206
|
-
/**
|
|
207
|
-
* Prepare the Powerlines API
|
|
208
|
-
*
|
|
209
|
-
* @remarks
|
|
210
|
-
* This method will prepare the Powerlines API for use, initializing any necessary resources.
|
|
211
|
-
*
|
|
212
|
-
* @param inlineConfig - The inline configuration for the prepare command
|
|
213
|
-
*/
|
|
214
|
-
prepare(inlineConfig?: PartialKeys<PrepareInlineConfig, "command"> | PartialKeys<TypesInlineConfig, "command"> | PartialKeys<NewInlineConfig, "command"> | PartialKeys<CleanInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command"> | PartialKeys<LintInlineConfig, "command"> | PartialKeys<TestInlineConfig, "command"> | PartialKeys<DocsInlineConfig, "command"> | PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
215
|
-
/**
|
|
216
|
-
* Create a new Powerlines project
|
|
217
|
-
*
|
|
218
|
-
* @remarks
|
|
219
|
-
* This method will create a new Powerlines project in the current directory.
|
|
220
|
-
*
|
|
221
|
-
* @param inlineConfig - The inline configuration for the new command
|
|
222
|
-
* @returns A promise that resolves when the project has been created
|
|
223
|
-
*/
|
|
224
|
-
new(inlineConfig: PartialKeys<NewInlineConfig, "command">): Promise<void>;
|
|
225
|
-
/**
|
|
226
|
-
* Clean any previously prepared artifacts
|
|
227
|
-
*
|
|
228
|
-
* @remarks
|
|
229
|
-
* This method will remove the previous Powerlines artifacts from the project.
|
|
230
|
-
*
|
|
231
|
-
* @param inlineConfig - The inline configuration for the clean command
|
|
232
|
-
* @returns A promise that resolves when the clean command has completed
|
|
233
|
-
*/
|
|
234
|
-
clean(inlineConfig?: PartialKeys<CleanInlineConfig, "command"> | PartialKeys<PrepareInlineConfig, "command">): Promise<void>;
|
|
235
|
-
/**
|
|
236
|
-
* Lint the project
|
|
237
|
-
*
|
|
238
|
-
* @param inlineConfig - The inline configuration for the lint command
|
|
239
|
-
* @returns A promise that resolves when the lint command has completed
|
|
240
|
-
*/
|
|
241
|
-
lint(inlineConfig?: PartialKeys<LintInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
242
|
-
/**
|
|
243
|
-
* Test the project
|
|
244
|
-
*
|
|
245
|
-
* @remarks
|
|
246
|
-
* This method will run the tests for the Powerlines project.
|
|
247
|
-
*
|
|
248
|
-
* @param inlineConfig - The inline configuration for the test command
|
|
249
|
-
* @returns A promise that resolves when the test command has completed
|
|
250
|
-
*/
|
|
251
|
-
test(inlineConfig?: PartialKeys<TestInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
252
|
-
/**
|
|
253
|
-
* Build the project
|
|
254
|
-
*
|
|
255
|
-
* @remarks
|
|
256
|
-
* This method will build the Powerlines project, generating the necessary artifacts.
|
|
257
|
-
*
|
|
258
|
-
* @param inlineConfig - The inline configuration for the build command
|
|
259
|
-
* @returns A promise that resolves when the build command has completed
|
|
260
|
-
*/
|
|
261
|
-
build(inlineConfig?: PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
262
|
-
/**
|
|
263
|
-
* Prepare the documentation for the project
|
|
264
|
-
*
|
|
265
|
-
* @param inlineConfig - The inline configuration for the docs command
|
|
266
|
-
* @returns A promise that resolves when the documentation generation has completed
|
|
267
|
-
*/
|
|
268
|
-
docs(inlineConfig?: DocsInlineConfig): Promise<void>;
|
|
269
|
-
/**
|
|
270
|
-
* Deploy the project source code
|
|
271
|
-
*
|
|
272
|
-
* @remarks
|
|
273
|
-
* This method will prepare and build the Powerlines project, generating the necessary artifacts for the deployment.
|
|
274
|
-
*
|
|
275
|
-
* @param inlineConfig - The inline configuration for the deploy command
|
|
276
|
-
*/
|
|
277
|
-
deploy(inlineConfig?: PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
278
|
-
/**
|
|
279
|
-
* Finalization/cleanup processing for the Powerlines API
|
|
280
|
-
*
|
|
281
|
-
* @remarks
|
|
282
|
-
* This step includes any final processes or clean up required by Powerlines. It will be run after each Powerlines command.
|
|
283
|
-
*
|
|
284
|
-
* @returns A promise that resolves when the finalization process has completed
|
|
285
|
-
*/
|
|
286
|
-
finalize(): Promise<void>;
|
|
287
|
-
/**
|
|
288
|
-
* Dispose of the Powerlines API instance
|
|
289
|
-
*
|
|
290
|
-
* @remarks
|
|
291
|
-
* This method will finalize the Powerlines API instance, cleaning up any resources used.
|
|
292
|
-
*/
|
|
293
|
-
[Symbol.asyncDispose](): Promise<void>;
|
|
294
|
-
/**
|
|
295
|
-
* Create a new Powerlines API instance
|
|
296
|
-
*
|
|
297
|
-
* @param context - The Powerlines context
|
|
298
|
-
*/
|
|
299
|
-
protected constructor(context: PowerlinesExecutionContext<TResolvedConfig>);
|
|
300
|
-
}
|
|
3
|
+
declare const types: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
4
|
+
declare const prepare: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
5
|
+
declare const create: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
6
|
+
declare const clean: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
7
|
+
declare const lint: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
8
|
+
declare const test: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
9
|
+
declare const build: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
10
|
+
declare const docs: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
11
|
+
declare const deploy: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
301
12
|
//#endregion
|
|
302
|
-
export {
|
|
13
|
+
export { build, clean, create, deploy, docs, lint, prepare, test, types };
|
|
303
14
|
//# sourceMappingURL=api.d.cts.map
|
package/dist/api.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.cts","names":[],"sources":["../src/
|
|
1
|
+
{"version":3,"file":"api.d.cts","names":[],"sources":["../src/api.ts"],"mappings":";;cAyCa,KAAA,IAAK,MAAA,EAAsB,mBAAA,KAAtB,OAAA;AAAA,cACL,OAAA,IAAO,MAAA,EAAwB,mBAAA,KAAxB,OAAA;AAAA,cACP,MAAA,IAAM,MAAA,EAAuB,mBAAA,KAAvB,OAAA;AAAA,cACN,KAAA,IAAK,MAAA,EAAsB,mBAAA,KAAtB,OAAA;AAAA,cACL,IAAA,IAAI,MAAA,EAAqB,mBAAA,KAArB,OAAA;AAAA,cACJ,IAAA,IAAI,MAAA,EAAqB,mBAAA,KAArB,OAAA;AAAA,cACJ,KAAA,IAAK,MAAA,EAAsB,mBAAA,KAAtB,OAAA;AAAA,cACL,IAAA,IAAI,MAAA,EAAqB,mBAAA,KAArB,OAAA;AAAA,cACJ,MAAA,IAAM,MAAA,EAAuB,mBAAA,KAAvB,OAAA"}
|
package/dist/api.d.mts
CHANGED
|
@@ -1,303 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import * as _$_powerlines_core0 from "@powerlines/core";
|
|
3
|
-
import { API, BuildInlineConfig, CallHookOptions, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, EnvironmentContext, Execution, ExecutionOptions, InferHookParameters, LintInlineConfig, NewInlineConfig, PluginConfig, PluginContext, PrepareInlineConfig, ResolvedConfig, TestInlineConfig, TypesInlineConfig } from "@powerlines/core";
|
|
4
|
-
import { PartialKeys } from "@stryke/types/base";
|
|
5
|
-
|
|
6
|
-
//#region src/_internal/execution.d.ts
|
|
7
|
-
/**
|
|
8
|
-
* The Powerlines Execution API class
|
|
9
|
-
*
|
|
10
|
-
* @remarks
|
|
11
|
-
* This class is responsible for managing the Powerlines project lifecycle, including initialization, building, and finalization.
|
|
12
|
-
*
|
|
13
|
-
* @internal
|
|
14
|
-
*/
|
|
15
|
-
declare class PowerlinesExecution<TResolvedConfig extends ResolvedConfig = ResolvedConfig> implements Execution {
|
|
16
|
-
#private;
|
|
17
|
-
/**
|
|
18
|
-
* Initialize a Powerlines API instance
|
|
19
|
-
*
|
|
20
|
-
* @param options - The options to initialize the API with
|
|
21
|
-
* @returns A new instance of the Powerlines API
|
|
22
|
-
*/
|
|
23
|
-
static from<TResolvedConfig extends ResolvedConfig = ResolvedConfig>(options: ExecutionOptions, initialConfig?: TResolvedConfig["initialConfig"]): Promise<PowerlinesExecution<TResolvedConfig>>;
|
|
24
|
-
/**
|
|
25
|
-
* The Powerlines context
|
|
26
|
-
*/
|
|
27
|
-
get context(): PowerlinesExecutionContext<TResolvedConfig>;
|
|
28
|
-
/**
|
|
29
|
-
* Generate the Powerlines typescript declaration file
|
|
30
|
-
*
|
|
31
|
-
* @remarks
|
|
32
|
-
* This method will only generate the typescript declaration file for the Powerlines project. It is generally recommended to run the full `prepare` command, which will run this method as part of its process.
|
|
33
|
-
*
|
|
34
|
-
* @param inlineConfig - The inline configuration for the types command
|
|
35
|
-
*/
|
|
36
|
-
types(inlineConfig?: PartialKeys<TypesInlineConfig, "command">): Promise<void>;
|
|
37
|
-
/**
|
|
38
|
-
* Prepare the Powerlines API
|
|
39
|
-
*
|
|
40
|
-
* @remarks
|
|
41
|
-
* This method will prepare the Powerlines API for use, initializing any necessary resources.
|
|
42
|
-
*
|
|
43
|
-
* @param inlineConfig - The inline configuration for the prepare command
|
|
44
|
-
*/
|
|
45
|
-
prepare(inlineConfig?: PartialKeys<PrepareInlineConfig, "command"> | PartialKeys<TypesInlineConfig, "command"> | PartialKeys<NewInlineConfig, "command"> | PartialKeys<CleanInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command"> | PartialKeys<LintInlineConfig, "command"> | PartialKeys<TestInlineConfig, "command"> | PartialKeys<DocsInlineConfig, "command"> | PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
46
|
-
/**
|
|
47
|
-
* Create a new Powerlines project
|
|
48
|
-
*
|
|
49
|
-
* @remarks
|
|
50
|
-
* This method will create a new Powerlines project in the current directory.
|
|
51
|
-
*
|
|
52
|
-
* @param inlineConfig - The inline configuration for the new command
|
|
53
|
-
* @returns A promise that resolves when the project has been created
|
|
54
|
-
*/
|
|
55
|
-
new(inlineConfig: PartialKeys<NewInlineConfig, "command">): Promise<void>;
|
|
56
|
-
/**
|
|
57
|
-
* Clean any previously prepared artifacts
|
|
58
|
-
*
|
|
59
|
-
* @remarks
|
|
60
|
-
* This method will remove the previous Powerlines artifacts from the project.
|
|
61
|
-
*
|
|
62
|
-
* @param inlineConfig - The inline configuration for the clean command
|
|
63
|
-
* @returns A promise that resolves when the clean command has completed
|
|
64
|
-
*/
|
|
65
|
-
clean(inlineConfig?: PartialKeys<CleanInlineConfig, "command"> | PartialKeys<PrepareInlineConfig, "command">): Promise<void>;
|
|
66
|
-
/**
|
|
67
|
-
* Lint the project
|
|
68
|
-
*
|
|
69
|
-
* @param inlineConfig - The inline configuration for the lint command
|
|
70
|
-
* @returns A promise that resolves when the lint command has completed
|
|
71
|
-
*/
|
|
72
|
-
lint(inlineConfig?: PartialKeys<LintInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
73
|
-
/**
|
|
74
|
-
* Test the project source code
|
|
75
|
-
*
|
|
76
|
-
* @param inlineConfig - The inline configuration for the test command
|
|
77
|
-
* @returns A promise that resolves when the test command has completed
|
|
78
|
-
*/
|
|
79
|
-
test(inlineConfig?: PartialKeys<TestInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
80
|
-
/**
|
|
81
|
-
* Build the project
|
|
82
|
-
*
|
|
83
|
-
* @remarks
|
|
84
|
-
* This method will build the Powerlines project, generating the necessary artifacts.
|
|
85
|
-
*
|
|
86
|
-
* @param inlineConfig - The inline configuration for the build command
|
|
87
|
-
* @returns A promise that resolves when the build command has completed
|
|
88
|
-
*/
|
|
89
|
-
build(inlineConfig?: PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
90
|
-
/**
|
|
91
|
-
* Prepare the documentation for the project
|
|
92
|
-
*
|
|
93
|
-
* @param inlineConfig - The inline configuration for the docs command
|
|
94
|
-
* @returns A promise that resolves when the documentation generation has completed
|
|
95
|
-
*/
|
|
96
|
-
docs(inlineConfig?: DocsInlineConfig): Promise<void>;
|
|
97
|
-
/**
|
|
98
|
-
* Deploy the project source code
|
|
99
|
-
*
|
|
100
|
-
* @remarks
|
|
101
|
-
* This method will prepare and build the Powerlines project, generating the necessary artifacts for the deployment.
|
|
102
|
-
*
|
|
103
|
-
* @param inlineConfig - The inline configuration for the deploy command
|
|
104
|
-
*/
|
|
105
|
-
deploy(inlineConfig?: PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
106
|
-
/**
|
|
107
|
-
* Finalization/cleanup processing for the Powerlines API
|
|
108
|
-
*
|
|
109
|
-
* @remarks
|
|
110
|
-
* This step includes any final processes or clean up required by Powerlines. It will be run after each Powerlines command.
|
|
111
|
-
*
|
|
112
|
-
* @returns A promise that resolves when the finalization process has completed
|
|
113
|
-
*/
|
|
114
|
-
finalize(): Promise<void>;
|
|
115
|
-
/**
|
|
116
|
-
* Invokes the configured plugin hooks
|
|
117
|
-
*
|
|
118
|
-
* @remarks
|
|
119
|
-
* By default, it will call the `"pre"`, `"normal"`, and `"post"` ordered hooks in sequence
|
|
120
|
-
*
|
|
121
|
-
* @param hook - The hook to call
|
|
122
|
-
* @param options - The options to provide to the hook
|
|
123
|
-
* @param args - The arguments to pass to the hook
|
|
124
|
-
* @returns The result of the hook call
|
|
125
|
-
*/
|
|
126
|
-
callHook<TKey extends string>(hook: TKey, options: CallHookOptions & {
|
|
127
|
-
environment?: string | EnvironmentContext<TResolvedConfig>;
|
|
128
|
-
}, ...args: InferHookParameters<PluginContext<TResolvedConfig>, TKey>): Promise<ReturnType<_$_powerlines_core0.InferHookFunction<PluginContext<TResolvedConfig, _$_powerlines_core0.API<any>>, TKey>> | undefined>;
|
|
129
|
-
/**
|
|
130
|
-
* Create a new Powerlines API instance
|
|
131
|
-
*
|
|
132
|
-
* @param context - The Powerlines context
|
|
133
|
-
*/
|
|
134
|
-
protected constructor(context: PowerlinesExecutionContext<TResolvedConfig>);
|
|
135
|
-
/**
|
|
136
|
-
* Initialize the execution API with the provided configuration options
|
|
137
|
-
*/
|
|
138
|
-
protected init(): Promise<void>;
|
|
139
|
-
/**
|
|
140
|
-
* Add a Powerlines plugin used in the build process
|
|
141
|
-
*
|
|
142
|
-
* @param config - The import path of the plugin to add
|
|
143
|
-
*/
|
|
144
|
-
protected addPlugin(config: PluginConfig<PluginContext<TResolvedConfig>>): Promise<void>;
|
|
145
|
-
/**
|
|
146
|
-
* Get the configured environments
|
|
147
|
-
*
|
|
148
|
-
* @returns The configured environments
|
|
149
|
-
*/
|
|
150
|
-
private getEnvironments;
|
|
151
|
-
/**
|
|
152
|
-
* Execute a handler function for each environment
|
|
153
|
-
*
|
|
154
|
-
* @param handle - The handler function to execute for each environment
|
|
155
|
-
*/
|
|
156
|
-
private executeEnvironments;
|
|
157
|
-
/**
|
|
158
|
-
* Initialize a Powerlines plugin
|
|
159
|
-
*
|
|
160
|
-
* @param config - The configuration for the plugin
|
|
161
|
-
* @returns The initialized plugin instance, or null if the plugin was a duplicate
|
|
162
|
-
* @throws Will throw an error if the plugin cannot be found or is invalid
|
|
163
|
-
*/
|
|
164
|
-
private initPlugin;
|
|
165
|
-
private resolvePlugin;
|
|
166
|
-
private handleBuild;
|
|
167
|
-
/**
|
|
168
|
-
* Generate the Powerlines TypeScript declaration file
|
|
169
|
-
*
|
|
170
|
-
* @remarks
|
|
171
|
-
* This method will generate the TypeScript declaration file for the Powerlines project, including any types provided by plugins.
|
|
172
|
-
*
|
|
173
|
-
* @param context - The environment context to use for generating the TypeScript declaration file
|
|
174
|
-
* @returns A promise that resolves when the TypeScript declaration file has been generated
|
|
175
|
-
*/
|
|
176
|
-
private handleTypes;
|
|
177
|
-
}
|
|
178
|
-
//#endregion
|
|
1
|
+
import { r as ExecutionHostParams } from "./api-BgyEi2hF.mjs";
|
|
179
2
|
//#region src/api.d.ts
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
declare
|
|
189
|
-
/**
|
|
190
|
-
* Initialize a Powerlines API instance
|
|
191
|
-
*
|
|
192
|
-
* @param options - The options to initialize the API with
|
|
193
|
-
* @param initialConfig - The initial configuration for the API, which can be used to provide additional context or override certain configuration values during initialization. This is particularly useful when initializing the API from a CLI command, where the CLI flags can be passed as part of the initial configuration to ensure they are properly merged with the configuration file and made available to plugins during their setup and execution.
|
|
194
|
-
* @returns A new instance of the Powerlines API
|
|
195
|
-
*/
|
|
196
|
-
static from<TResolvedConfig extends ResolvedConfig = ResolvedConfig>(options: PartialKeys<ExecutionOptions, "executionId" | "executionIndex">, initialConfig?: TResolvedConfig["initialConfig"]): Promise<PowerlinesAPI<TResolvedConfig>>;
|
|
197
|
-
/**
|
|
198
|
-
* Generate the Powerlines typescript declaration file
|
|
199
|
-
*
|
|
200
|
-
* @remarks
|
|
201
|
-
* This method will only generate the typescript declaration file for the Powerlines project. It is generally recommended to run the full `prepare` command, which will run this method as part of its process.
|
|
202
|
-
*
|
|
203
|
-
* @param inlineConfig - The inline configuration for the types command
|
|
204
|
-
*/
|
|
205
|
-
types(inlineConfig?: PartialKeys<TypesInlineConfig, "command">): Promise<void>;
|
|
206
|
-
/**
|
|
207
|
-
* Prepare the Powerlines API
|
|
208
|
-
*
|
|
209
|
-
* @remarks
|
|
210
|
-
* This method will prepare the Powerlines API for use, initializing any necessary resources.
|
|
211
|
-
*
|
|
212
|
-
* @param inlineConfig - The inline configuration for the prepare command
|
|
213
|
-
*/
|
|
214
|
-
prepare(inlineConfig?: PartialKeys<PrepareInlineConfig, "command"> | PartialKeys<TypesInlineConfig, "command"> | PartialKeys<NewInlineConfig, "command"> | PartialKeys<CleanInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command"> | PartialKeys<LintInlineConfig, "command"> | PartialKeys<TestInlineConfig, "command"> | PartialKeys<DocsInlineConfig, "command"> | PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
215
|
-
/**
|
|
216
|
-
* Create a new Powerlines project
|
|
217
|
-
*
|
|
218
|
-
* @remarks
|
|
219
|
-
* This method will create a new Powerlines project in the current directory.
|
|
220
|
-
*
|
|
221
|
-
* @param inlineConfig - The inline configuration for the new command
|
|
222
|
-
* @returns A promise that resolves when the project has been created
|
|
223
|
-
*/
|
|
224
|
-
new(inlineConfig: PartialKeys<NewInlineConfig, "command">): Promise<void>;
|
|
225
|
-
/**
|
|
226
|
-
* Clean any previously prepared artifacts
|
|
227
|
-
*
|
|
228
|
-
* @remarks
|
|
229
|
-
* This method will remove the previous Powerlines artifacts from the project.
|
|
230
|
-
*
|
|
231
|
-
* @param inlineConfig - The inline configuration for the clean command
|
|
232
|
-
* @returns A promise that resolves when the clean command has completed
|
|
233
|
-
*/
|
|
234
|
-
clean(inlineConfig?: PartialKeys<CleanInlineConfig, "command"> | PartialKeys<PrepareInlineConfig, "command">): Promise<void>;
|
|
235
|
-
/**
|
|
236
|
-
* Lint the project
|
|
237
|
-
*
|
|
238
|
-
* @param inlineConfig - The inline configuration for the lint command
|
|
239
|
-
* @returns A promise that resolves when the lint command has completed
|
|
240
|
-
*/
|
|
241
|
-
lint(inlineConfig?: PartialKeys<LintInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
242
|
-
/**
|
|
243
|
-
* Test the project
|
|
244
|
-
*
|
|
245
|
-
* @remarks
|
|
246
|
-
* This method will run the tests for the Powerlines project.
|
|
247
|
-
*
|
|
248
|
-
* @param inlineConfig - The inline configuration for the test command
|
|
249
|
-
* @returns A promise that resolves when the test command has completed
|
|
250
|
-
*/
|
|
251
|
-
test(inlineConfig?: PartialKeys<TestInlineConfig, "command"> | PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
252
|
-
/**
|
|
253
|
-
* Build the project
|
|
254
|
-
*
|
|
255
|
-
* @remarks
|
|
256
|
-
* This method will build the Powerlines project, generating the necessary artifacts.
|
|
257
|
-
*
|
|
258
|
-
* @param inlineConfig - The inline configuration for the build command
|
|
259
|
-
* @returns A promise that resolves when the build command has completed
|
|
260
|
-
*/
|
|
261
|
-
build(inlineConfig?: PartialKeys<BuildInlineConfig, "command">): Promise<void>;
|
|
262
|
-
/**
|
|
263
|
-
* Prepare the documentation for the project
|
|
264
|
-
*
|
|
265
|
-
* @param inlineConfig - The inline configuration for the docs command
|
|
266
|
-
* @returns A promise that resolves when the documentation generation has completed
|
|
267
|
-
*/
|
|
268
|
-
docs(inlineConfig?: DocsInlineConfig): Promise<void>;
|
|
269
|
-
/**
|
|
270
|
-
* Deploy the project source code
|
|
271
|
-
*
|
|
272
|
-
* @remarks
|
|
273
|
-
* This method will prepare and build the Powerlines project, generating the necessary artifacts for the deployment.
|
|
274
|
-
*
|
|
275
|
-
* @param inlineConfig - The inline configuration for the deploy command
|
|
276
|
-
*/
|
|
277
|
-
deploy(inlineConfig?: PartialKeys<DeployInlineConfig, "command">): Promise<void>;
|
|
278
|
-
/**
|
|
279
|
-
* Finalization/cleanup processing for the Powerlines API
|
|
280
|
-
*
|
|
281
|
-
* @remarks
|
|
282
|
-
* This step includes any final processes or clean up required by Powerlines. It will be run after each Powerlines command.
|
|
283
|
-
*
|
|
284
|
-
* @returns A promise that resolves when the finalization process has completed
|
|
285
|
-
*/
|
|
286
|
-
finalize(): Promise<void>;
|
|
287
|
-
/**
|
|
288
|
-
* Dispose of the Powerlines API instance
|
|
289
|
-
*
|
|
290
|
-
* @remarks
|
|
291
|
-
* This method will finalize the Powerlines API instance, cleaning up any resources used.
|
|
292
|
-
*/
|
|
293
|
-
[Symbol.asyncDispose](): Promise<void>;
|
|
294
|
-
/**
|
|
295
|
-
* Create a new Powerlines API instance
|
|
296
|
-
*
|
|
297
|
-
* @param context - The Powerlines context
|
|
298
|
-
*/
|
|
299
|
-
protected constructor(context: PowerlinesExecutionContext<TResolvedConfig>);
|
|
300
|
-
}
|
|
3
|
+
declare const types: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
4
|
+
declare const prepare: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
5
|
+
declare const create: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
6
|
+
declare const clean: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
7
|
+
declare const lint: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
8
|
+
declare const test: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
9
|
+
declare const build: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
10
|
+
declare const docs: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
11
|
+
declare const deploy: ((params: ExecutionHostParams) => Promise<void>) | undefined;
|
|
301
12
|
//#endregion
|
|
302
|
-
export {
|
|
13
|
+
export { build, clean, create, deploy, docs, lint, prepare, test, types };
|
|
303
14
|
//# sourceMappingURL=api.d.mts.map
|
package/dist/api.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.mts","names":[],"sources":["../src/
|
|
1
|
+
{"version":3,"file":"api.d.mts","names":[],"sources":["../src/api.ts"],"mappings":";;cAyCa,KAAA,IAAK,MAAA,EAAsB,mBAAA,KAAtB,OAAA;AAAA,cACL,OAAA,IAAO,MAAA,EAAwB,mBAAA,KAAxB,OAAA;AAAA,cACP,MAAA,IAAM,MAAA,EAAuB,mBAAA,KAAvB,OAAA;AAAA,cACN,KAAA,IAAK,MAAA,EAAsB,mBAAA,KAAtB,OAAA;AAAA,cACL,IAAA,IAAI,MAAA,EAAqB,mBAAA,KAArB,OAAA;AAAA,cACJ,IAAA,IAAI,MAAA,EAAqB,mBAAA,KAArB,OAAA;AAAA,cACJ,KAAA,IAAK,MAAA,EAAsB,mBAAA,KAAtB,OAAA;AAAA,cACL,IAAA,IAAI,MAAA,EAAqB,mBAAA,KAArB,OAAA;AAAA,cACJ,MAAA,IAAM,MAAA,EAAuB,mBAAA,KAAvB,OAAA"}
|