@storm-stack/plugin-system - npm Package Compare versions

Comparing version 1.3.8 to 1.4.0

dist/index.d.ts

@@ -0,1 +1,2 @@
+import { ExecaReturnValue } from 'execa';
 import { Temporal } from '@js-temporal/polyfill';
@@ -9,3 +10,3 @@
  */
-declare const createResolver: (rootPath?: string, tsconfig?: string) => (request: string) => Promise<string>;
+declare const createResolver: (rootPath?: string, tsconfig?: string, autoInstall?: boolean) => (request: string) => Promise<string>;
 export { createResolver }
@@ -89,2 +90,6 @@ export { createResolver as createResolver_alias_1 }
 
+export declare const execute: (command: string, rootPath: string) => Promise<ExecaReturnValue<string>>;
+
+export declare const install: (name: string, rootPath: string) => Promise<void>;
+
 /**
@@ -96,3 +101,3 @@ * A plugin loader that can be used to load a plugin module.
     isValid: (module: TPluginModule) => boolean;
-    execute: (instance: PluginInstance, context: TContext, options: Record<string, any>) => Promise<void>;
+    process: (context: TContext, instance: PluginInstance, options: Record<string, any>) => Promise<void>;
 }
@@ -322,6 +327,8 @@ export { IPluginLoader }
 declare abstract class PluginLoader<TContext = any, TPluginModule extends IPluginModule<TContext> = IPluginModule<TContext>> implements IPluginLoader<TContext, TPluginModule> {
-    readonly tsconfig: string;
+    readonly rootPath?: string | undefined;
+    readonly tsconfig?: string | undefined;
+    readonly autoInstall?: boolean | undefined;
     protected resolver: (request: string) => Promise<string>;
-    constructor(tsconfig: string);
-    abstract execute: (instance: PluginInstance<TContext, TPluginModule>, context: TContext, options: Record<string, any>) => Promise<void>;
+    constructor(rootPath?: string | undefined, tsconfig?: string | undefined, autoInstall?: boolean | undefined);
+    abstract process: (context: TContext, instance: PluginInstance<TContext, TPluginModule>, options: Record<string, any>) => Promise<void>;
     load: (definition: PluginDefinition, options?: Record<string, any>) => Promise<PluginInstance<TContext, TPluginModule>>;
@@ -418,2 +425,8 @@ isValid: (module: TPluginModule) => boolean;
     /**
+     * Should auto-install be used to discover plugins?
+     *
+     * @default true
+     */
+    autoInstall: boolean;
+    /**
      * A mode specifying how plugins should be discovered from the local filesystem.
@@ -420,0 +433,0 @@ *

package.json

 {
   "name": "@storm-stack/plugin-system",
-  "version": "1.3.8",
+  "version": "1.4.0",
   "private": false,
@@ -5,0 +5,0 @@ "description": "A library used to create and manage a plugin-styled architecture in a TypeScript application.",

README.md

@@ -19,3 +19,3 @@ <!-- START header -->
 
-[![Version](https://img.shields.io/badge/version-1.3.6-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-1.3.8-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
 [![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
@@ -22,0 +22,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Debug access

Supply chain risk

Uses debug, reflection and dynamic code execution features.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 9 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 2 instances in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3261521

increased by11.94%

Lines of code

9376

increased by12.07%

Number of low quality alerts

1

decreased by-50%

Number of low supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes