@visualautomate/plugin-sdk 0.7.0 → 0.8.0

package/dist/manifest-check.d.ts

@@ -13,4 +13,14 @@ export interface ManifestCheck {
  * Check `raw`, the parsed manifest.json. `hasCode` says whether an index.js
  * (or plugin.ts) sits beside it.
  */
+/**
+ * Why a developer's step cannot use a connected account, and what to do instead.
+ *
+ * Only VisualAutomate's own apps act as somebody's mailbox, workspace or store.
+ * A step built with this SDK reaches an API at its own address, with a key the
+ * user enters in a `secret` property.
+ */
+export declare const ACCOUNTS_ARE_OURS = "Only VisualAutomate's own apps act as a connected account: call the API at its own address instead (action.baseUrl, or fetch in code), with a key the user enters in a property of type \"secret\"";
+/** Each way a manifest would use a connected account, in words. Empty when it uses none. */
+export declare function accountUseIn(manifest: unknown): string[];
 export declare function checkManifest(raw: unknown, hasCode: boolean): ManifestCheck;

package/dist/simulate.d.ts

@@ -53,6 +53,10 @@ export interface SimulateOptions {
      * Give `connections` a fake that answers the requests your plugin makes,
      * and assert on what it was asked for — that is a better test of an
      * integration step than any simulation of a provider would be.
+     *
+     * @deprecated for `connections`: only VisualAutomate's own apps act as a
+     * connected account, so a step you build is never given one. Stub `fetch`
+     * through loadPluginCode instead.
      */
     connections?: PluginConnections;
     media?: PluginMedia;

package/dist/types.d.ts

@@ -207,7 +207,14 @@ export interface PluginContext {
     state: PluginState;
     /** ffmpeg. Absent when the server has no sandbox or storage configured. */
     media?: PluginMedia;
-    /** The accounts this step was configured with. Absent when it has none. */
+    /**
+     * The accounts this step was configured with. Absent when it has none.
+     *
+     * @deprecated Only VisualAutomate's own apps act as a connected account, so
+     * a step you build never has this: the platform refuses a step that names
+     * an account. Take the user's key in a property of type "secret" and send
+     * it to the API's own host with fetch.
+     */
     connections?: PluginConnections;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visualautomate/plugin-sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Types and a local runner for building VisualAutomate plugins.",
   "license": "MIT",
   "type": "module",