@friggframework/core 2.0.0--canary.697.20e3e54.0 → 2.0.0--canary.698.b1a2d30.0

package/integrations/data-defined/capabilities/salesforce.capabilities.json

@@ -321,30 +321,44 @@
     "scope": "installation",
     "topic": "{{body.payload.ChangeEventHeader.entityName}}.{{body.payload.ChangeEventHeader.changeType}}",
     "eventId": "{{body.id}}",
-    "verify": "verifyWebhookSignature"
+    "verify": "verifyWebhookSignature",
+    "status": "unimplemented",
+    "note": "The salesforce Api has no verifyWebhookSignature method; webhook signatures cannot be checked until the module adds one."
   },
   "capabilities": {
     "lead.get": {
       "kind": "read",
-      "method": "getLead",
+      "method": "get",
       "input": {
         "id": {
           "type": "string",
           "required": true
         }
       },
-      "output": "lead"
+      "output": "lead",
+      "args": [
+        {
+          "value": "Lead"
+        },
+        "id"
+      ]
     },
     "lead.create": {
       "kind": "write",
-      "method": "createLead",
+      "method": "create",
       "input": {
         "fields": {
           "type": "object",
           "required": true
         }
       },
-      "output": "lead"
+      "output": "lead",
+      "args": [
+        {
+          "value": "Lead"
+        },
+        "fields"
+      ]
     },
     "lead.update": {
       "kind": "write",
@@ -359,7 +373,9 @@
           "required": true
         }
       },
-      "output": "void"
+      "output": "void",
+      "status": "unimplemented",
+      "note": "Api.update(object, data) needs the record id inside data (data.Id); the capability passes the id separately, so there is no way to call it."
     },
     "person.searchByEmail": {
       "kind": "search",
@@ -371,18 +387,26 @@
           "required": true
         }
       },
-      "output": "{ leads: lead[], contacts: contact[] }"
+      "output": "{ leads: lead[], contacts: contact[] }",
+      "status": "unimplemented",
+      "note": "Api.find(object, filter) searches one sObject at a time; searching Lead and Contact together would need two calls."
     },
     "event.create": {
       "kind": "write",
-      "method": "createEvent",
+      "method": "create",
       "input": {
         "fields": {
           "type": "object",
           "required": true
         }
       },
-      "output": "event"
+      "output": "event",
+      "args": [
+        {
+          "value": "Event"
+        },
+        "fields"
+      ]
     },
     "event.update": {
       "kind": "write",
@@ -397,18 +421,26 @@
           "required": true
         }
       },
-      "output": "void"
+      "output": "void",
+      "status": "unimplemented",
+      "note": "Api.update(object, data) needs the record id inside data (data.Id); the capability passes the id separately, so there is no way to call it."
     },
     "opportunity.get": {
       "kind": "read",
-      "method": "getOpportunity",
+      "method": "get",
       "input": {
         "id": {
           "type": "string",
           "required": true
         }
       },
-      "output": "opportunity"
+      "output": "opportunity",
+      "args": [
+        {
+          "value": "Opportunity"
+        },
+        "id"
+      ]
     },
     "opportunity.update": {
       "kind": "write",
@@ -423,18 +455,26 @@
           "required": true
         }
       },
-      "output": "void"
+      "output": "void",
+      "status": "unimplemented",
+      "note": "Api.update(object, data) needs the record id inside data (data.Id); the capability passes the id separately, so there is no way to call it."
     },
     "task.create": {
       "kind": "write",
-      "method": "createTask",
+      "method": "create",
       "input": {
         "fields": {
           "type": "object",
           "required": true
         }
       },
-      "output": "task"
+      "output": "task",
+      "args": [
+        {
+          "value": "Task"
+        },
+        "fields"
+      ]
     },
     "file.attach": {
       "kind": "write",
@@ -457,7 +497,9 @@
           "required": true
         }
       },
-      "output": "contentVersion"
+      "output": "contentVersion",
+      "status": "unimplemented",
+      "note": "Api has the generic create(object, data) only; ContentVersion field names differ from this capability's inputs."
     },
     "note.create": {
       "kind": "write",
@@ -476,7 +518,9 @@
           "required": true
         }
       },
-      "output": "contentNote"
+      "output": "contentNote",
+      "status": "unimplemented",
+      "note": "Api has the generic create(object, data) only; ContentNote field names differ from this capability's inputs."
     },
     "user.list": {
       "kind": "read",
@@ -486,7 +530,9 @@
           "type": "boolean"
         }
       },
-      "output": "user[]"
+      "output": "user[]",
+      "status": "unimplemented",
+      "note": "Api has find(object, filter) but no user listing with an activeOnly filter."
     }
   },
   "options": {

package/integrations/data-defined/capabilities/slack.capabilities.json

@@ -206,7 +206,9 @@
       "body": {
         "challenge": "$.body.challenge"
       }
-    }
+    },
+    "status": "unimplemented",
+    "note": "The slack Api has no verifyWebhookSignature method; webhook signatures cannot be checked until the module adds one."
   },
   "capabilities": {
     "message.post": {
@@ -285,7 +287,7 @@
     },
     "message.permalink": {
       "kind": "read",
-      "method": "getPermalink",
+      "method": "getMessagePermalink",
       "label": "chat.getPermalink",
       "input": {
         "channel": {
@@ -301,7 +303,7 @@
     },
     "channel.list": {
       "kind": "read",
-      "method": "listConversations",
+      "method": "listChannels",
       "label": "conversations.list",
       "input": {
         "types": {
@@ -325,7 +327,9 @@
           "type": "number"
         }
       },
-      "output": "user[]"
+      "output": "user[]",
+      "status": "unimplemented",
+      "note": "Api has lookupUserByEmail, getUserById and getUserProfileById, but no user listing."
     },
     "user.lookupByEmail": {
       "kind": "read",
@@ -337,7 +341,10 @@
           "required": true
         }
       },
-      "output": "user"
+      "output": "user",
+      "args": [
+        "email"
+      ]
     }
   },
   "options": {

package/integrations/data-defined/capabilities/stripe.capabilities.json

@@ -471,7 +471,9 @@
     "topic": "{{body.type}}",
     "eventId": "{{body.id}}",
     "account": "{{body.account}}",
-    "verify": "verifyWebhookSignature"
+    "verify": "verifyWebhookSignature",
+    "status": "unimplemented",
+    "note": "The stripe Api has no verifyWebhookSignature method; webhook signatures cannot be checked until the module adds one."
   },
   "capabilities": {
     "customer.get": {
@@ -483,7 +485,9 @@
           "required": true
         }
       },
-      "output": "customer"
+      "output": "customer",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "customer.list": {
       "kind": "read",
@@ -499,7 +503,9 @@
           "type": "string"
         }
       },
-      "output": "page<customer>"
+      "output": "page<customer>",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "customer.search": {
       "kind": "search",
@@ -510,7 +516,9 @@
           "required": true
         }
       },
-      "output": "customer[]"
+      "output": "customer[]",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "customer.create": {
       "kind": "write",
@@ -521,7 +529,9 @@
           "required": true
         }
       },
-      "output": "customer"
+      "output": "customer",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "customer.update": {
       "kind": "write",
@@ -536,7 +546,9 @@
           "required": true
         }
       },
-      "output": "customer"
+      "output": "customer",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "paymentIntent.get": {
       "kind": "read",
@@ -550,7 +562,9 @@
           "type": "array"
         }
       },
-      "output": "paymentIntent"
+      "output": "paymentIntent",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "refund.get": {
       "kind": "read",
@@ -561,7 +575,9 @@
           "required": true
         }
       },
-      "output": "refund"
+      "output": "refund",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "payout.list": {
       "kind": "read",
@@ -580,11 +596,13 @@
           "type": "number"
         }
       },
-      "output": "payout[]"
+      "output": "payout[]",
+      "status": "unimplemented",
+      "note": "Api wraps balance transactions, charges, accounts and webhook endpoints only; customers, payment intents, refunds and payouts are not exposed."
     },
     "balanceTransaction.list": {
       "kind": "read",
-      "method": "listBalanceTransactions",
+      "method": "getBalanceTransactions",
       "input": {
         "payout": {
           "type": "string",

package/integrations/data-defined/data-defined-integration.js

@@ -18,7 +18,7 @@
  */
 const crypto = require('crypto');
 const { compile, routeWebhook, eventName } = require('./compile');
-const { makePorts, runWorkflow, resumeWorkflow, runQuery, renderSurface, runLifecycle, resolveOptions, installContext } = require('./runtime');
+const { argumentsFor, makePorts, runWorkflow, resumeWorkflow, runQuery, renderSurface, runLifecycle, resolveOptions, installContext } = require('./runtime');
 const { createSyncEngine } = require('./sync-engine');
 const { eventsIn, handshakeFor, modulesFor } = require('./webhooks');
 const { buildConfigForm, missingRequired } = require('./config-form');
@@ -252,7 +252,7 @@ function makeClass({ name, defaultId, definitions, manifests, runCode, Integrati
                     return runCode(ref, args);
                 },
                 // The shared class registers modules by module name; a definition may name them by its own keys.
-                callApi: (moduleKey, method, args) => this.moduleFor(moduleKey).api[method](args),
+                callApi: (moduleKey, method, args, order) => this.moduleFor(moduleKey).api[method](...argumentsFor(args, order)),
                 store: this.mappingStore(),
             });
         }

package/integrations/data-defined/examples/asana-slack.definition.json

@@ -35,7 +35,7 @@
       "options": {
         "source": "asana.project",
         "with": {
-          "workspaceGid": "$.settings.workspace"
+          "workspace": "$.settings.workspace"
         }
       },
       "label": "Project to announce completed tasks from",
@@ -163,8 +163,7 @@
           "id": "task",
           "use": "asana.task.get",
           "with": {
-            "taskGid": "$.record.gid",
-            "opt_fields": "name,completed,completed_by.name,assignee.name,permalink_url"
+            "taskGid": "$.record.gid"
           }
         },
         {

package/integrations/data-defined/examples/klaviyo-hubspot.definition.json

@@ -239,10 +239,7 @@
           "id": "contact",
           "use": "hubspot.contact.get",
           "with": {
-            "id": "$.record.objectId",
-            "properties": [
-              "email"
-            ]
+            "id": "$.record.objectId"
           }
         },
         {

package/integrations/data-defined/examples/phone-hubspot.definition.json

@@ -243,11 +243,7 @@
           "id": "full",
           "use": "hubspot.contact.get",
           "with": {
-            "id": "$.steps.contact.hubspot",
-            "properties": [
-              "hubspot_owner_id",
-              "firstname"
-            ]
+            "id": "$.steps.contact.hubspot"
           }
         },
         {

package/integrations/data-defined/manifests.js

@@ -40,6 +40,23 @@ function validateManifest(m) {
         if (!KINDS.has(c?.kind)) err(`${p}.kind`, [...KINDS].join(', '));
         if (!/^[A-Za-z_$][\w$]*$/.test(c?.method || '')) err(`${p}.method`, 'Name of a method on the module\'s Api class');
         for (const [arg, spec] of Object.entries(c?.input || {})) if (!spec?.type) err(`${p}.input.${arg}`, 'Input needs a type');
+        if (c?.status !== undefined && c.status !== 'unimplemented') err(`${p}.status`, 'Only "unimplemented" (the module\'s Api has no such method)');
+        if (c?.args !== undefined) {
+            if (!Array.isArray(c.args)) err(`${p}.args`, 'An ordered list: input names, "$rest", or { value }');
+            else {
+                const named = new Set();
+                c.args.forEach((a, i) => {
+                    if (typeof a === 'string' && a !== '$rest') {
+                        if (!(a in (c.input || {}))) err(`${p}.args[${i}]`, `"${a}" is not an input of this capability`);
+                        else if (named.has(a)) err(`${p}.args[${i}]`, `"${a}" is passed twice`);
+                        named.add(a);
+                    } else if (a === '$rest') { if (c.args.indexOf('$rest') !== i) err(`${p}.args[${i}]`, '"$rest" appears once'); }
+                    else if (!(a && typeof a === 'object' && 'value' in a)) err(`${p}.args[${i}]`, 'An input name, "$rest" or { value }');
+                });
+                // An input that is never passed would be accepted and silently dropped.
+                if (!c.args.includes('$rest')) for (const k of Object.keys(c.input || {})) if (!named.has(k)) err(`${p}.args`, `Input "${k}" is declared but never passed to ${c.method}; list it in args or use "$rest"`);
+            }
+        }
     }
 
     // How a sync reads and writes an object (sync-engine.js). Each operation names a capability of the right kind on
@@ -140,6 +157,7 @@ function validateManifest(m) {
         if (w.account) tpl(w.account, 'webhook.account');
         const batch = w.batch == null ? [] : Array.isArray(w.batch) ? w.batch : [w.batch];
         if (batch.length > 2 || batch.some((b) => typeof b !== 'string')) err('webhook.batch', 'A path to the array of events, or [outer, inner] for two levels');
+        if (w.status !== undefined && w.status !== 'unimplemented') err('webhook.status', 'Only "unimplemented" (the module\'s Api has no verify method)');
         if (w.verify != null && !/^[A-Za-z_$][\w$]*$/.test(w.verify)) err('webhook.verify', 'Name of an Api method that checks the signature');
         if (w.handshake) {
             try { parseCondition(w.handshake.when); } catch (e) { err('webhook.handshake.when', e.message); }

package/integrations/data-defined/runtime.js

@@ -21,6 +21,21 @@ const { TRANSFORMS } = require('./transforms');
  *        Backed by IntegrationMapping: get = getMapping, put = upsertMapping, claim = createMapping (insert-only; false if it existed)
  * @param {(ref:string, args:object) => Promise<any>} [p.runCode]
  */
+/**
+ * The arguments an Api method is called with. A capability with no `args` takes one object holding every input; one
+ * with `args` (manifest `args`) takes them positionally: an input by name, "$rest" (an object of the inputs not
+ * named in the list) or { value } (a constant, e.g. the sObject name of Salesforce's generic create/get).
+ */
+function argumentsFor(input, order) {
+    if (!Array.isArray(order)) return [input];
+    const named = new Set(order.filter((a) => typeof a === 'string' && a !== '$rest'));
+    return order.map((a) => {
+        if (a === '$rest') return Object.fromEntries(Object.entries(input || {}).filter(([k]) => !named.has(k)));
+        if (a && typeof a === 'object') return a.value;
+        return input?.[a];
+    });
+}
+
 function makePorts({ def, manifests, callApi, store, runCode }) {
     const manifestFor = (key) => manifests[def.modules[key]?.module];
     const normalise = (set, key, value) => {
@@ -39,7 +54,7 @@ function makePorts({ def, manifests, callApi, store, runCode }) {
         async call(moduleKey, capability, args) {
             const c = manifestFor(moduleKey)?.capabilities?.[capability];
             if (!c) throw new Error(`${moduleKey}.${capability} is not declared by the module manifest`);
-            return callApi(moduleKey, c.method, args);
+            return callApi(moduleKey, c.method, args, c.args);
         },
         links: {
             /** By one side's id: link:<set>:<module>:<id>. By identity key: idx:<set>:<key>:<normalised value>. */
@@ -250,4 +265,4 @@ function defaultsOf(settings) {
     return Object.fromEntries(Object.entries(settings || {}).filter(([, s]) => s.default !== undefined).map(([k, s]) => [k, s.default]));
 }
 
-module.exports = { makePorts, runWorkflow, resumeWorkflow, runQuery, renderSurface, resolveView, runLifecycle, resolveOptions, installContext, recordOf, defaultsOf };
+module.exports = { argumentsFor, makePorts, runWorkflow, resumeWorkflow, runQuery, renderSurface, resolveView, runLifecycle, resolveOptions, installContext, recordOf, defaultsOf };

package/integrations/data-defined/schema/capability-manifest.v0.1.schema.json

@@ -411,6 +411,15 @@
             "body": {}
           },
           "description": "Answered at receipt, before anything is queued (Slack url_verification, Asana X-Hook-Secret)."
+        },
+        "status": {
+          "enum": [
+            "unimplemented"
+          ],
+          "description": "The module's Api has no `verify` method (or none that checks a signature). Every delivery fails verification until it does, so definitions that trigger on this module's events validate with a warning."
+        },
+        "note": {
+          "type": "string"
         }
       }
     },
@@ -445,6 +454,37 @@
           },
           "output": {
             "type": "string"
+          },
+          "args": {
+            "type": "array",
+            "description": "How the Api method takes its arguments, when it is not one object holding every input. Each entry is an input name (passed positionally), \"$rest\" (an object of every input not named elsewhere in the list) or {\"value\": x} (a constant, such as the sObject name of a generic Api). Omitted: the method is called with one object of all inputs.",
+            "items": {
+              "oneOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "object",
+                  "required": [
+                    "value"
+                  ],
+                  "additionalProperties": false,
+                  "properties": {
+                    "value": {}
+                  }
+                }
+              ]
+            }
+          },
+          "status": {
+            "enum": [
+              "unimplemented"
+            ],
+            "description": "The module's real Api class has no method that does this (or none shaped so the call can be made). Definitions that use it validate with a warning, never an error."
+          },
+          "note": {
+            "type": "string",
+            "description": "What the real method does differently, or what is missing upstream."
           }
         }
       }