@frontera-sdk/functions 1.49.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Sebati
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,122 @@
+# @frontera-sdk/automation
+
+Author a Frontera automation: a named, triggered handler the platform runs on
+your behalf, deployed with `frontera automation deploy`.
+
+```bash
+bun add @frontera-sdk/automation
+```
+
+```ts
+import { automation } from '@frontera-sdk/automation'
+
+export default automation(
+  {
+    name: 'late-shipment-digest',
+    trigger: { cron: '0 8 * * 1-5' },
+    grants: ['blueprint:read'],
+  },
+  async (ctx) => {
+    const late = await ctx.blueprint.query('Shipment', {
+      where: { property: 'deliveryStatus', op: 'eq', value: 'late' },
+    })
+    await ctx.log(`${late.rows.length} late`, { hasMore: late.hasMore })
+  },
+)
+```
+
+A trigger is `{ cron }` or `{ manual: true }`, never both — the type refuses
+the ambiguous shape rather than leaving the runner to decide what it means.
+`ctx.log` never rejects: telemetry must not be able to fail a run.
+
+## Steps
+
+`ctx.step.run(name, fn)` makes a piece of work durable. The platform stores the
+result, and if the run is retried the step is not run again — it returns what it
+returned the first time.
+
+```ts
+async (ctx) => {
+  const overdue = await ctx.step.run('load-overdue', () =>
+    ctx.blueprint.query('Invoice', {
+      where: { property: 'status', op: 'eq', value: 'overdue' },
+    }),
+  )
+
+  for (const [i, row] of overdue.rows.entries()) {
+    await ctx.step.run(`notify:${i}`, () =>
+      ctx.http.fetch({ url: 'https://hooks.example.com/notify', method: 'POST',
+        body: JSON.stringify({ invoiceId: row.id }) }),
+    )
+  }
+
+  return { notified: overdue.rows.length }
+}
+```
+
+Three rules, and each one is a real failure mode rather than a style note:
+
+- **Names are unique within a run.** The platform memoizes by name, so reusing
+  one would hand back the first step's result. It is refused instead, naming the
+  collision — inside a loop, put the index in the name.
+- **Results are JSON.** A step's result is stored and replayed, so a `Date`
+  comes back as a string. Return data, not objects with behaviour.
+- **Code outside a step re-runs.** After each step the handler restarts from the
+  top, with completed steps returning their stored results. A `ctx.http` call
+  that is not inside a step therefore fires once per step and spends its call
+  budget every time.
+
+Each step is recorded on the run, and every `ctx` call made inside one records
+the step it belongs to — so a run's trail is a tree of named work rather than a
+flat list.
+
+The Console reads your deployed code and draws the whole shape: every step, both
+arms of every `if` with the condition on the edge, and a loop as a single node.
+A step named with a template shows as its pattern (`items:${i}`), because one
+loop in the code is one step in the picture however many times it runs. Each
+card names what the step reaches — Blueprint, Agent, HTTP — read from the `ctx`
+calls in its body, and clicking one shows that step's source.
+
+`automation()` freezes the manifest it returns, including a copy of the
+trigger — a later mutation of the object you passed in cannot silently change
+the schedule the runner registers.
+
+`validateManifest` is the same check the CLI runs before deploy, exported so
+you can run it in your own tests: names are kebab-case segments, and a cron
+expression is parsed rather than pattern-matched.
+
+## Testing a handler
+
+`createTestContext` gives you a `ctx` to call your handler with, so a branch can
+be exercised without deploying and waiting for a day with the right data.
+
+```ts
+import { createTestContext } from '@frontera-sdk/automation'
+import handler from './index'
+
+const empty = createTestContext({ grants: ['blueprint:read'] })
+expect(await handler.handler(empty.ctx)).toEqual({ handled: 0 })
+expect(empty.steps).toEqual(['load', 'nothing-to-do'])
+
+const busy = createTestContext({
+  grants: ['blueprint:read', 'agent:ava:run'],
+  blueprint: { Invoice: { rows: [{ id: 'INV-1' }], hasMore: false } },
+  agents: { ava: () => ({ text: 'looks fine' }) },
+})
+await handler.handler(busy.ctx)
+expect(busy.calls.map((c) => c.kind)).toContain('agent')
+```
+
+It refuses what the platform refuses, in the same words: a grant your manifest
+does not declare, and a step name used twice. An agent or an HTTP call you did
+not stub throws rather than answering — a fabricated `200` or an empty agent
+reply is a test that passes while asserting nothing. An object type you did not
+stub returns no rows, because that is a real answer and usually the branch worth
+testing.
+
+What it does not simulate is resumption: in production your handler is re-entered
+after every step, and here it runs once, straight through.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@frontera-sdk/functions",
+  "version": "1.49.0",
+  "description": "Author Frontera functions: manifest, triggers and the typed handler contract.",
+  "keywords": [
+    "frontera",
+    "function",
+    "cron"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "files": [
+    "src",
+    "!src/__tests__",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
+    },
+    "./runtime": {
+      "types": "./src/runtime-context.ts",
+      "import": "./src/runtime-context.ts"
+    },
+    "./inputs": {
+      "types": "./src/inputs.ts",
+      "import": "./src/inputs.ts"
+    }
+  },
+  "scripts": {
+    "test": "bun test",
+    "typecheck": "bunx tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.14",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@frontera-sdk/blueprint": "1.49.0",
+    "cron-parser": "^5.0.6"
+  }
+}

package/src/define.ts

@@ -0,0 +1,60 @@
+import type {
+  AutomationDescriptor,
+  AutomationHandler,
+  AutomationManifest,
+  AutomationTrigger,
+  InputsSchema,
+} from './types'
+
+/**
+ * Declare a Function: a manifest and the handler the runner executes.
+ *
+ * Named `automation` until the rename; that name is still exported below as a
+ * deprecated alias, because a project scaffolded before the rename imports it
+ * and `frontera function pull` replays a stored archive verbatim.
+ */
+export function defineFunction(
+  manifest: AutomationManifest,
+  handler: AutomationHandler,
+): AutomationDescriptor {
+  if (!manifest?.name) throw new Error('Automation name is required')
+  if (typeof handler !== 'function') throw new Error('Automation handler must be a function')
+
+  // Copied, not aliased. `{ ...manifest }` is shallow, so without this the
+  // frozen manifest would still hold a live reference to the caller's trigger
+  // object — and a later mutation of it would silently change the schedule the
+  // runner registers.
+  const trigger: AutomationTrigger = { ...manifest.trigger }
+
+  let inputs: Readonly<InputsSchema> | undefined
+  if (manifest.inputs) {
+    try {
+      inputs = Object.freeze(structuredClone(manifest.inputs))
+    } catch {
+      // `structuredClone` throws a raw `DataCloneError` DOMException on a
+      // function/symbol/etc default, which names neither the automation nor
+      // the field — useless in a deploy log. Rethrow with both.
+      throw new Error(`Automation "${manifest.name}": input defaults must be JSON-serializable values`)
+    }
+  }
+
+  return Object.freeze({
+    manifest: Object.freeze({
+      ...manifest,
+      trigger: Object.freeze(trigger),
+      grants: Object.freeze([...(manifest.grants ?? [])]),
+      ...(inputs ? { inputs } : {}),
+      concurrency: manifest.concurrency ?? 1,
+      retries: manifest.retries ?? 0,
+    }),
+    handler,
+  })
+}
+
+/**
+ * @deprecated Use `defineFunction`. Kept so a project written against
+ * `@frontera-sdk/functions` still compiles after `frontera function pull`
+ * hydrates it, and so a bundle built from one still parses — `step-graph.ts`
+ * matches both names for exactly this reason.
+ */
+export const automation = defineFunction

package/src/index.ts

@@ -0,0 +1,27 @@
+export { automation, defineFunction } from './define'
+export { validateManifest } from './manifest'
+export type { ValidationResult } from './manifest'
+export {
+  duplicateStepMessage,
+  duplicateSubmissionMessage,
+  emptySubmissionKeyMessage,
+  lostStepRowMessage,
+  missingGrantMessage,
+  submitOutsideStepMessage,
+} from './messages'
+export { createTestContext } from './testing'
+export type { TestCall, TestContext, TestContextOptions } from './testing'
+export {
+  MAX_INPUT_BYTES,
+  redactedInputKeys,
+  sanitizeInputsSchema,
+  validateInputValue,
+} from './inputs'
+export type { InputValidation } from './inputs'
+export {
+  EVENT_TRIGGER_SOURCES,
+  TICKETED_TRIGGER_SOURCES,
+  isEventTriggerSource,
+  isTicketedTriggerSource,
+} from './types'
+export type * from './types'