@metasession.co/devaudit-plugin-sdk 1.9.0 → 1.11.0
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/README.md +2 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/types.d.ts +16 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -73,7 +73,8 @@ export default plugin;
|
|
|
73
73
|
| Export | Purpose |
|
|
74
74
|
|---|---|
|
|
75
75
|
| `Plugin` | The object a plugin's main module default-exports |
|
|
76
|
-
| `PluginContext` | What the CLI passes to hooks and commands at runtime |
|
|
76
|
+
| `PluginContext` | What the CLI passes to hooks and commands at runtime. Includes `getPersonalAuth()`, a read-only accessor for the person's CLI-resolved `{ token, baseUrl }` (or `null`); absent on older CLIs, so a plugin that must run there falls back to its own environment variable. Treat the token as a secret: never log or write it |
|
|
77
|
+
| `PluginPersonalAuth` | The `{ token, baseUrl }` shape `getPersonalAuth()` returns |
|
|
77
78
|
| `PluginManifest` | The `devaudit` field shape inside a plugin's `package.json` |
|
|
78
79
|
| `LifecycleHookName` | Union of supported hook names |
|
|
79
80
|
| `CommandContribution` | Shape of an entry in `manifest.devaudit.commands` |
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type { Plugin, PluginContext, PluginLogger, PluginSdlcConfigView, PluginEvent, LifecycleHook, PluginCommand, } from './types.js';
|
|
1
|
+
export type { Plugin, PluginContext, PluginPersonalAuth, PluginLogger, PluginSdlcConfigView, PluginEvent, LifecycleHook, PluginCommand, } from './types.js';
|
|
2
2
|
export type { CommandContribution } from './commands.js';
|
|
3
3
|
export { isValidCommandName } from './commands.js';
|
|
4
4
|
export { LIFECYCLE_HOOK_NAMES, isLifecycleHookName, type LifecycleHookName, } from './lifecycle.js';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,MAAM,EACN,aAAa,EACb,YAAY,EACZ,oBAAoB,EACpB,WAAW,EACX,aAAa,EACb,aAAa,GACd,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,KAAK,iBAAiB,GACvB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,MAAM,EACN,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,oBAAoB,EACpB,WAAW,EACX,aAAa,EACb,aAAa,GACd,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,KAAK,iBAAiB,GACvB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -19,12 +19,28 @@ export interface PluginEvent {
|
|
|
19
19
|
readonly type: string;
|
|
20
20
|
readonly payload?: Readonly<Record<string, unknown>>;
|
|
21
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* The person's own personal access token and portal URL, as the CLI resolves them
|
|
24
|
+
* (`DEVAUDIT_USER_TOKEN`, else the `devaudit auth login` cache). Treat the token
|
|
25
|
+
* as a secret: never log it, print it or write it to disk.
|
|
26
|
+
*/
|
|
27
|
+
export interface PluginPersonalAuth {
|
|
28
|
+
readonly token: string;
|
|
29
|
+
readonly baseUrl: string;
|
|
30
|
+
}
|
|
22
31
|
export interface PluginContext {
|
|
23
32
|
readonly projectPath: string;
|
|
24
33
|
readonly sdlcConfig: PluginSdlcConfigView;
|
|
25
34
|
readonly logger: PluginLogger;
|
|
26
35
|
readonly apiVersion: '1';
|
|
27
36
|
emit(event: PluginEvent): void;
|
|
37
|
+
/**
|
|
38
|
+
* Read-only accessor for the CLI-resolved personal auth, or `null` when the person is not
|
|
39
|
+
* logged in. Resolved exactly like `devaudit auth status`. Absent on CLIs older than this
|
|
40
|
+
* accessor: a plugin that must run there falls back to its own environment variable.
|
|
41
|
+
* (devaudit-installer#1100)
|
|
42
|
+
*/
|
|
43
|
+
getPersonalAuth?(): Promise<PluginPersonalAuth | null>;
|
|
28
44
|
}
|
|
29
45
|
export type LifecycleHook = (ctx: PluginContext) => Promise<void> | void;
|
|
30
46
|
export type PluginCommand = (ctx: PluginContext, args: readonly string[]) => Promise<void> | void;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAC1C,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,IAAI,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAC1C,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,IAAI,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/B;;;;;OAKG;IACH,eAAe,CAAC,IAAI,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;CACxD;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEzE,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAElG,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,CAAC;IACnE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;CAC7D"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metasession.co/devaudit-plugin-sdk",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.11.0",
|
|
4
4
|
"description": "DevAudit CLI plugin contract — interfaces, manifest schema, and lifecycle hooks that DevAudit plugins compile against.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -41,5 +41,8 @@
|
|
|
41
41
|
"url": "https://github.com/metasession-dev/DevAudit-Installer",
|
|
42
42
|
"directory": "plugin-sdk"
|
|
43
43
|
},
|
|
44
|
-
"license": "Apache-2.0"
|
|
44
|
+
"license": "Apache-2.0",
|
|
45
|
+
"overrides": {
|
|
46
|
+
"esbuild": "^0.28.1"
|
|
47
|
+
}
|
|
45
48
|
}
|