@flowscripter/dynamic-cli-framework-api 2.2.1 → 2.3.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.
Files changed (4) hide show
  1. package/dist/src/service/core/PluginService.d.ts +11 -1
  2. package/dist/src/service/core/PluginService.d.ts.map +1 -1
  3. package/package.json +1 -1
  4. package/src/service/core/PluginService.ts +12 -1
package/dist/src/service/core/PluginService.d.ts CHANGED
@@ -8,7 +8,7 @@ export declare const PLUGIN_SERVICE_ID = "PLUGIN_SERVICE";
8
8
  /**
9
9
  * Service providing plugin lifecycle management for a CLI with dynamic plugin support.
10
10
  *
11
- * Exposes search, install, uninstall, list, and update operations backed by a
11
+ * Exposes search, availability-check, install, uninstall, list, and update operations backed by a
12
12
  * `MarketplacePluginManager` (see dynamic-plugin-framework). Provided by
13
13
  * `DefaultPluginServiceProvider` when plugin support is enabled via
14
14
  * `DynamicPluginRuntimeCLI` (see dynamic-cli-framework).
@@ -24,6 +24,16 @@ export default interface PluginService {
24
24
  * @returns an async iterable of matching {@link VersionedPluginDescriptor} entries.
25
25
  */
26
26
  search(query: Readonly<SearchQuery>): AsyncIterable<Readonly<VersionedPluginDescriptor>>;
27
+ /**
28
+ * Check whether a plugin, optionally at a specific version, is available from the remote
29
+ * marketplace, without installing it.
30
+ *
31
+ * @param pluginId the package identifier of the plugin to check (e.g. `@scope/my-plugin`).
32
+ * @param version an optional specific version to check for; if omitted, checks whether the
33
+ * plugin is available at any version.
34
+ * @returns `true` if the plugin (and version, if specified) is available, `false` otherwise.
35
+ */
36
+ checkAvailable(pluginId: string, version?: string): Promise<boolean>;
27
37
  /**
28
38
  * Install a plugin from the remote marketplace into the local plugin store.
29
39
  *
package/dist/src/service/core/PluginService.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"PluginService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/PluginService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,WAAW,EACZ,MAAM,wCAAwC,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAEzF;;;;OAIG;IACH,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,yBAAyB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;OAIG;IACH,aAAa,IAAI,aAAa,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,eAAe,IAAI,aAAa,CAAC;QAC/B,UAAU,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAChD,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC,CAAC;CACJ"}
1
+ {"version":3,"file":"PluginService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/PluginService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,WAAW,EACZ,MAAM,wCAAwC,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAEzF;;;;;;;;OAQG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErE;;;;OAIG;IACH,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,yBAAyB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;OAIG;IACH,aAAa,IAAI,aAAa,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,eAAe,IAAI,aAAa,CAAC;QAC/B,UAAU,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAChD,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC,CAAC;CACJ"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowscripter/dynamic-cli-framework-api",
3
- "version": "2.2.1",
3
+ "version": "2.3.0",
4
4
  "description": "API for https://github.com/flowscripter/dynamic-cli-framework",
5
5
  "keywords": [
6
6
  "bun",
package/src/service/core/PluginService.ts CHANGED
@@ -13,7 +13,7 @@ export const PLUGIN_SERVICE_ID = "PLUGIN_SERVICE";
13
13
  /**
14
14
  * Service providing plugin lifecycle management for a CLI with dynamic plugin support.
15
15
  *
16
- * Exposes search, install, uninstall, list, and update operations backed by a
16
+ * Exposes search, availability-check, install, uninstall, list, and update operations backed by a
17
17
  * `MarketplacePluginManager` (see dynamic-plugin-framework). Provided by
18
18
  * `DefaultPluginServiceProvider` when plugin support is enabled via
19
19
  * `DynamicPluginRuntimeCLI` (see dynamic-cli-framework).
@@ -30,6 +30,17 @@ export default interface PluginService {
30
30
  */
31
31
  search(query: Readonly<SearchQuery>): AsyncIterable<Readonly<VersionedPluginDescriptor>>;
32
32
 
33
+ /**
34
+ * Check whether a plugin, optionally at a specific version, is available from the remote
35
+ * marketplace, without installing it.
36
+ *
37
+ * @param pluginId the package identifier of the plugin to check (e.g. `@scope/my-plugin`).
38
+ * @param version an optional specific version to check for; if omitted, checks whether the
39
+ * plugin is available at any version.
40
+ * @returns `true` if the plugin (and version, if specified) is available, `false` otherwise.
41
+ */
42
+ checkAvailable(pluginId: string, version?: string): Promise<boolean>;
43
+
33
44
  /**
34
45
  * Install a plugin from the remote marketplace into the local plugin store.
35
46
  *