@visualautomate/plugin-sdk 0.7.0 → 0.8.0

package/README.md

@@ -41,13 +41,12 @@ in your manifest. `data` is what the next steps read.
 | `storage` | the account's files — `put`, `get`, `delete`, `list`, `head`, `signedUrl`, `shareUrl`, `download` |
 | `state` | values that outlive one run, scoped to the workflow — `get`, `set` (at most 128 KB, `ttlSeconds` at least 60), `delete`, `list` (`{ keys: [{ key, expiresAt }], complete }`) |
 | `media` | ffmpeg, by operation name. Absent when the server has no sandbox configured |
-| `connections` | the accounts this step was configured with. Absent when it declares none, or none was chosen |
 | `workflowId`, `nodeId`, `userId`, `executionId`, `startedAt`, `secrets` | about the run |
 
-You never see a credential and you never name a host. `connections.get("account")`
-takes the name of one of *your* properties, and the platform attaches the token
-on the way past — which is what stops a plugin pointing somebody's account
-somewhere it chose.
+There is no connected account for your steps: only VisualAutomate's own apps act
+as one (`checkManifest` refuses a `connection` property, `optionsFrom`,
+`action.connection`, a `trigger` and `auth.provider`). A step reaches an API with
+the key a user enters in a `secret` property.
 
 ## `simulate`
 
@@ -72,22 +71,9 @@ platform's have — `get` on a missing key is `null`, `put` takes a string or by
 `list` is prefix-filtered, a state value over 128 KB or a `ttlSeconds` under 60 is
 refused, and an expired value reads as `null`.
 
-`connections` and `media` are not simulated. Without a stub, `context.connections`
-is absent, as on the platform when no account was chosen, and `context.media`
-fails with a sentence saying so. Pass a stub to test the code around them:
-
-```ts
-await simulate(plugin, {
-    connections: {
-        async get() {
-            return { id: "test", async request() { return { ok: true, status: 200, body: {} } } }
-        },
-    },
-})
-```
-
-Asserting on what your plugin *asked* the provider for is a better test than any
-imitation of the provider would be.
+`media` is not simulated: `context.media` fails with a sentence saying so. Stub
+`fetch` to test the code around an API call; asserting on what your plugin
+*asked* for is a better test than any imitation of the API would be.
 
 ## The platform's code checks
 
@@ -143,8 +129,9 @@ check.errors    // why it would be refused
 check.warnings  // what it would drop or regret
 ```
 
-The SDK's own reading of the rules the portal enforces, for code steps,
-declared steps (`action`), triggers and `optionsFrom`; the portal's word is final.
+The SDK's own reading of the rules the portal enforces, for code steps and
+declared steps (`action`), and the refusal of anything that would act as a
+connected account (`accountUseIn` lists each way in); the portal's word is final.
 
 ## The platform's facts
 

package/dist/index.cjs

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ACCOUNTS_ARE_OURS: () => ACCOUNTS_ARE_OURS,
   ALLOWED_PACKAGES: () => ALLOWED_PACKAGES,
   ALLOWED_PACKAGE_NAMES: () => ALLOWED_PACKAGE_NAMES,
   BLOCKED_GLOBALS: () => BLOCKED_GLOBALS,
@@ -45,6 +46,7 @@ __export(index_exports, {
   SANDBOX_TIERS: () => SANDBOX_TIERS,
   SIGNED_URL_SECONDS: () => SIGNED_URL_SECONDS,
   STATE_LIMITS: () => STATE_LIMITS,
+  accountUseIn: () => accountUseIn,
   checkManifest: () => checkManifest,
   createLocalState: () => createLocalState,
   createLocalStorage: () => createLocalStorage,
@@ -1679,6 +1681,23 @@ var MAX_PAGES = 50;
 var MAX_MEMORY_MB = 128;
 var isObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 var isRelativePath = (path) => typeof path === "string" && path.trim() !== "" && !/^[a-z][a-z0-9+.-]*:/i.test(path) && !path.startsWith("//");
+var 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"`;
+function accountUseIn(manifest) {
+  if (!isObject(manifest)) return [];
+  const m = manifest;
+  const uses = [];
+  if (isObject(m.properties)) {
+    for (const [key, value] of Object.entries(m.properties)) {
+      if (!isObject(value)) continue;
+      if (value.type === "connection") uses.push(`properties.${key} is a connection: an account to act as`);
+      if (value.optionsFrom !== void 0) uses.push(`properties.${key}.optionsFrom reads its options as an account`);
+    }
+  }
+  if (isObject(m.action) && m.action.connection !== void 0) uses.push("action.connection makes the call as an account");
+  if (m.trigger !== void 0) uses.push("trigger watches an account");
+  if (isObject(m.auth) && typeof m.auth.provider === "string" && m.auth.provider) uses.push(`auth.provider names "${m.auth.provider}"`);
+  return uses;
+}
 function checkManifest(raw, hasCode) {
   const errors = [];
   const warnings = [];
@@ -1720,6 +1739,8 @@ function checkManifest(raw, hasCode) {
     else {
       if (typeof m.auth.type !== "string" || !AUTH_TYPES.has(m.auth.type)) {
         errors.push(`auth.type must be one of ${[...AUTH_TYPES].join(", ")}.`);
+      } else if (m.auth.type !== "none" && !m.auth.provider) {
+        errors.push(`auth.type "${m.auth.type}" needs a provider to sign in to, and only VisualAutomate's own apps name one: use { "type": "none" } and take the user's key in a property of type "secret".`);
       }
       for (const key of HOST_KEYS) {
         if (key in m.auth) errors.push(`auth.${key} is refused: a manifest may not name a host. The provider's base URL belongs to the platform.`);
@@ -1753,6 +1774,7 @@ function checkManifest(raw, hasCode) {
   if (kind === "code" && !hasCode) {
     errors.push("There is no index.js and no action or trigger block, so this step has nothing to run.");
   }
+  for (const use of accountUseIn(m)) errors.push(`${use}. ${ACCOUNTS_ARE_OURS}`);
   return { ok: errors.length === 0, kind, errors, warnings };
 }
 function checkConnectionName(where, name, typeOf, errors) {