@frontera-sdk/workflow 1.51.0 → 1.51.1

package/README.md

@@ -71,6 +71,24 @@ await workflows.run('supplier-onboarding', {
 })
 ```
 
+An input of type `files` takes several files. Put a list of `File` values under
+that input and each file goes as its own part under the input's name, in list
+order.
+
+```ts
+await workflows.run('delivery-intake', {
+  input: {
+    carrier: 'globex-logistics',
+    scans: [new File([page1], 'page-1.pdf'), new File([page2], 'page-2.pdf')],
+  },
+})
+```
+
+The list must hold only `File` values. A list that mixes `File` values with
+references to files that are already uploaded is not sent as file parts, and
+the service refuses it. An input takes 20 files unless the workflow sets another limit, and
+50 at most.
+
 ## Author a workflow
 
 A definition is a plain object typed as `WorkflowDefinition`, so the step kinds,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontera-sdk/workflow",
-  "version": "1.51.0",
+  "version": "1.51.1",
   "description": "Typed headless client for starting, inspecting, waiting on and cancelling Frontera workflow runs from a script or backend.",
   "keywords": [
     "frontera",
@@ -38,8 +38,8 @@
     "typecheck": "bunx tsc --noEmit"
   },
   "dependencies": {
-    "@frontera-sdk/core": "1.51.0",
-    "@frontera-sdk/functions": "1.51.0"
+    "@frontera-sdk/core": "1.51.1",
+    "@frontera-sdk/functions": "1.51.1"
   },
   "devDependencies": {
     "@types/bun": "^1.3.14",

package/src/definition.ts

@@ -140,12 +140,39 @@ export type AgentTrigger = {
   description?: string
 }
 
+/** Started by something that happened in a connected Plugin account, such as a new email. */
+export type PluginTrigger = {
+  kind: 'plugin'
+  description?: string
+  /** The Plugin install, the same reference a `plugin` node uses. */
+  resourceId: string
+  /** Event name the install's Plugin kind offers, e.g. `new_email`. */
+  event: string
+  /** Whose connection the trigger reads: the shared workspace account, or one named person's own account. */
+  account: { kind: 'workspace' } | { kind: 'user'; userId: string }
+  /** Provider-side selection, validated by the event's own schema. Gmail `new_email`: `{ labelId?: string }`. */
+  config?: Record<string, unknown>
+  /** JSONata over `$event`. A run starts only when the result is truthy. Absent: every event. */
+  filter?: string
+  /** Skip automatic replies and delivery failures. Default true. */
+  ignoreAutoReplies?: boolean
+  /** JSONata over `$event`, giving the run input object. Absent: the keys of `$event.data` that are declared inputs. */
+  input?: string
+  /** JSONata over `$event`, giving the subject pk. Required iff the definition has a subject. */
+  subject?: string
+  /** The declared list-of-files input that receives the event's attachments. Absent: attachments are not downloaded. */
+  attachmentsInput?: string
+  /** Most runs this trigger may start in any 24 hours, 1 to 5000. Events over it wait. Default 200. */
+  maxRunsPerDay?: number
+}
+
 export type WorkflowTrigger =
   | ManualTrigger
   | CronTrigger
   | WorkflowCallTrigger
   | AgentTrigger
   | WebhookTrigger
+  | PluginTrigger
 
 // ─── Shared node settings ────────────────────────────────────────────────────
 

package/src/types.ts

@@ -211,7 +211,8 @@ export interface VersionLineage {
 export interface RunRequest {
   /**
    * A `File` value here is sent as its own multipart part, named after the
-   * `file` input it fills; everything else travels as JSON.
+   * `file` input it fills. A list of `File`s fills a `files` input: one part
+   * per file, all under that input's name. Everything else travels as JSON.
    */
   input?: Record<string, unknown>
   subject?: { pk: string }

package/src/workflow-client.ts

@@ -307,24 +307,31 @@ export class WorkflowClient {
   }
 }
 
+/** The `File`s one input value carries: itself, or a non-empty list of nothing but `File`s. */
+function filesOf(value: unknown): File[] {
+  if (value instanceof File) return [value]
+  return Array.isArray(value) && value.length > 0 && value.every((item) => item instanceof File) ? value : []
+}
+
 /**
- * The run body, JSON unless a `file` input carries an actual `File`.
+ * The run body, JSON unless a `file` or `files` input carries an actual `File`.
  *
- * A `file` input cannot travel as JSON, so one turns the whole request
- * multipart: the non-file fields go in an `input` part as JSON and each file
- * gets a part named after its field, which is the shape the service's
- * `readMultipartRun` expects. `subject` and `version` are serialised because a
- * multipart part is text — the route parses both back. The content type is
- * left alone deliberately: only `FormData` can generate the boundary, and
- * naming the type here would lose it.
+ * A `File` cannot travel as JSON, so one turns the whole request multipart:
+ * the non-file fields go in an `input` part as JSON and each file gets a part
+ * named after its field, which is the shape the service's `readMultipartRun`
+ * expects. A list of `File`s under one key, for a `files` input, is sent as
+ * that part name repeated, in list order. `subject` and `version` are
+ * serialised because a multipart part is text — the route parses both back.
+ * The content type is left alone deliberately: only `FormData` can generate
+ * the boundary, and naming the type here would lose it.
  */
 function runBody(request: RunRequest): RunRequest | FormData {
   const input = request.input ?? {}
-  const files = Object.entries(input).filter((entry): entry is [string, File] => entry[1] instanceof File)
+  const files = Object.entries(input).flatMap(([field, value]) => filesOf(value).map((file) => [field, file] as const))
   if (files.length === 0) return request
 
   const form = new FormData()
-  const rest = Object.fromEntries(Object.entries(input).filter(([, value]) => !(value instanceof File)))
+  const rest = Object.fromEntries(Object.entries(input).filter(([, value]) => filesOf(value).length === 0))
   form.append('input', JSON.stringify(rest))
   for (const [field, file] of files) form.append(field, file)
   if (request.subject) form.append('subject', JSON.stringify(request.subject))