@frontera-sdk/automation 0.1.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,42 @@
+# @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.
+
+`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.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@frontera-sdk/automation",
+  "version": "0.1.0",
+  "description": "Author Frontera automations: manifest, triggers and the typed handler contract.",
+  "keywords": [
+    "frontera",
+    "automation",
+    "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"
+    }
+  },
+  "scripts": {
+    "test": "bun test",
+    "typecheck": "bunx tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@frontera-sdk/blueprint": "0.1.0",
+    "cron-parser": "^5.0.6"
+  }
+}

package/src/define.ts

@@ -0,0 +1,30 @@
+import type {
+  AutomationDescriptor,
+  AutomationHandler,
+  AutomationManifest,
+  AutomationTrigger,
+} from './types'
+
+export function automation(
+  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 }
+
+  return Object.freeze({
+    manifest: Object.freeze({
+      ...manifest,
+      trigger: Object.freeze(trigger),
+      grants: Object.freeze([...(manifest.grants ?? [])]),
+      concurrency: manifest.concurrency ?? 1,
+    }),
+    handler,
+  })
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export { automation } from './define'
+export { validateManifest } from './manifest'
+export type { ValidationResult } from './manifest'
+export type * from './types'

package/src/manifest.ts

@@ -0,0 +1,125 @@
+import { CronExpressionParser } from 'cron-parser'
+
+const SEGMENT = '[a-z][a-z0-9]*(?:-[a-z0-9]+)*'
+const NAME_RE = new RegExp(`^${SEGMENT}$`)
+
+/**
+ * Runtime gate for a grant: `<namespace>:<name>[:<action>]`, every segment
+ * sharing NAME_RE's grammar so the whole vocabulary is consistent.
+ *
+ * WIDER than the `Grant` union on namespaces — a server must not reject
+ * `notify:email` merely because this build predates it. NARROWER than the
+ * union's `agent:${string}:run` arm on the slug, which admits `agent::run` and
+ * `agent:AGENT:run`; both are rejected here. No legitimate slug is affected —
+ * this repo's agent slugs are already lowercase-kebab.
+ */
+const GRANT_RE = new RegExp(`^${SEGMENT}:${SEGMENT}(?::${SEGMENT})?$`)
+
+const KNOWN_KEYS = new Set(['name', 'trigger', 'grants', 'concurrency', 'description'])
+
+export interface ValidationResult {
+  valid: boolean
+  errors: string[]
+  /**
+   * Non-fatal. An unknown manifest key lands here rather than in `errors`:
+   * a newer SDK must be able to add a field without an older service refusing
+   * the deploy. The CLI prints these, so a typo like `concurrancy: 100` — which
+   * would otherwise deploy "successfully" with the default of 1 — is caught at
+   * author time, where the SDK and the manifest are the same version.
+   */
+  warnings: string[]
+}
+
+/**
+ * Takes `unknown`, on purpose.
+ *
+ * The authoritative call site is the service, validating a manifest that
+ * arrived over HTTP — untrusted, and not yet known to have any shape. Typing
+ * the parameter as `AutomationManifest` would force every honest caller to
+ * launder untrusted input through a cast, which is how a validator ends up
+ * trusting the thing it exists to check.
+ *
+ * The regexes here are deliberately wider than the `Grant` union in `types.ts`:
+ * that union is an author-time affordance, this is a runtime gate, and a server
+ * must not reject a grant merely because this build predates it.
+ */
+export function validateManifest(input: unknown): ValidationResult {
+  const errors: string[] = []
+  const warnings: string[] = []
+  const m = (input ?? {}) as {
+    name?: unknown
+    trigger?: unknown
+    grants?: unknown
+    concurrency?: unknown
+  }
+
+  if (typeof m.name !== 'string' || !NAME_RE.test(m.name)) {
+    errors.push('name must be lowercase kebab-case')
+  } else if (m.name.length > 64) {
+    errors.push('name must be 64 characters or fewer')
+  }
+
+  const trigger = m.trigger as { cron?: string; manual?: boolean } | undefined
+  if (!trigger || (trigger.cron === undefined && trigger.manual !== true)) {
+    errors.push('trigger must be { cron } or { manual: true }')
+  } else if (trigger.cron !== undefined) {
+    if (typeof trigger.cron !== 'string') {
+      errors.push('invalid cron expression: must be a string')
+    } else {
+      // Both field-count branches exist because `cron-parser` accepts an
+      // off-count expression rather than throwing, so neither case would ever
+      // reach the `catch` below:
+      //   `* * * * * *` -> reads field 1 as SECONDS and fires sub-minute.
+      //   `0 7 * *`     -> left-pads, scheduling something the author never wrote.
+      // Only an exactly-5-field expression means what it looks like it means.
+      const fields = trigger.cron.trim().split(/\s+/).length
+      if (fields !== 5) {
+        // One message shape for one class of fault. Splitting it meant a
+        // 7-field expression was told it was "sub-minute" — a diagnosis
+        // asserted rather than derived — while a 4-field one got no diagnosis
+        // at all.
+        errors.push(
+          `invalid cron expression: expected 5 fields, got ${fields}` +
+            (fields > 5 ? '; sub-minute schedules are not supported' : ''),
+        )
+      } else {
+        try {
+          CronExpressionParser.parse(trigger.cron, { tz: 'UTC' })
+        } catch (err) {
+          errors.push(`invalid cron expression: ${(err as Error).message}`)
+        }
+      }
+    }
+  }
+
+  if (m.grants !== undefined && !Array.isArray(m.grants)) {
+    errors.push('grants must be an array')
+  } else {
+    for (const g of (m.grants as unknown[]) ?? []) {
+      // String(g), not `${g}` — a template literal THROWS on a symbol, and a
+      // validator that exists to absorb hostile input must not have a throwing
+      // path. The message names the fix, not just the verdict.
+      if (typeof g !== 'string' || !GRANT_RE.test(g)) {
+        errors.push(
+          `malformed grant "${String(g)}" — expected "<namespace>:<action>", ` +
+            'e.g. "blueprint:read" or "agent:risk-analyst:run"',
+        )
+      }
+    }
+  }
+
+  const c = m.concurrency
+  if (c !== undefined && (!Number.isInteger(c) || (c as number) < 1 || (c as number) > 50)) {
+    errors.push('concurrency must be an integer between 1 and 50')
+  }
+
+  if (input && typeof input === 'object' && !Array.isArray(input)) {
+    for (const key of Object.keys(input)) {
+      if (!KNOWN_KEYS.has(key)) {
+        warnings.push(`unknown manifest key "${key}" — ignored`)
+      }
+    }
+  }
+
+  return { valid: errors.length === 0, errors, warnings }
+}

package/src/types.ts

@@ -0,0 +1,117 @@
+// `import type`, so this is erased at compile time and adds no runtime import —
+// but `@frontera-sdk/blueprint` is still a real `dependencies` entry, because
+// `WhereNode` is part of this package's PUBLIC type surface: anyone consuming
+// `AutomationContext` needs it to resolve. See the packaging note in
+// docs/superpowers/specs/2026-07-29-automations-ctx-blueprint-query-design.md —
+// a subset install that cannot resolve it aborts `bun install` outright.
+import type { WhereNode } from '@frontera-sdk/blueprint/types'
+
+/**
+ * Cron and manual only for now; event and webhook land with Event Triggers.
+ *
+ * The `?: never` members are load-bearing. Without them `{ cron, manual }`
+ * typechecks — TypeScript's excess-property check admits any key present on
+ * *some* member of a union — and the runner would have to decide at runtime
+ * what a both-shaped trigger means.
+ */
+export type AutomationTrigger =
+  | { cron: string; manual?: never }
+  | { cron?: never; manual: true }
+
+/**
+ * An author-time affordance, not a validation gate.
+ *
+ * `blueprint:read` is a literal, so the compiler completes it and offers "Did
+ * you mean 'blueprint:read'?" on a typo. `agent:${string}:run` admits any slug
+ * — including one that names no agent — so the union cannot be read as proof
+ * that a grant is well-formed. The runtime gate is `validateManifest` in
+ * `manifest.ts`; this exists to guide the author as they type.
+ *
+ * Widening it later (adding `notify:*`, `governed:*` with Governed Writes) is a
+ * non-breaking change. Narrowing `string` to a union later would break every
+ * automation already written, so it starts narrow.
+ */
+export type Grant =
+  | 'blueprint:read'
+  | `agent:${string}:run`
+
+export interface AutomationManifest {
+  name: string
+  trigger: AutomationTrigger
+  grants?: readonly Grant[]
+  concurrency?: number
+  description?: string
+}
+
+/**
+ * What `automation()` guarantees once defaults are applied — nothing optional
+ * left for a consumer to re-handle. Downstream code takes this, not
+ * `AutomationManifest`, so it never re-derives a fact already established.
+ */
+export interface ResolvedAutomationManifest extends AutomationManifest {
+  // Every member is readonly, not just the two with defaults. `Object.freeze`
+  // in `define.ts` freezes the whole object at runtime, so leaving `name` or
+  // `description` mutable in the type means `d.manifest.name = 'x'` compiles
+  // and then throws — the same compile-clean/throw-at-runtime gap that the
+  // removed `as string[]` cast used to create.
+  readonly name: string
+  readonly trigger: Readonly<AutomationTrigger>
+  readonly grants: readonly Grant[]
+  readonly concurrency: number
+  readonly description?: string
+}
+
+export interface AgentHandle {
+  run(prompt: string): Promise<{ text: string }>
+}
+
+/** Read-only for now. `governed`/`notify` arrive with Governed Writes. */
+export interface AutomationContext {
+  runId: string
+  workspaceId: string
+  /** Never rejects — telemetry must not be able to fail a run. */
+  log(message: string, data?: Record<string, unknown>): Promise<void>
+  agent(slug: string): AgentHandle
+  blueprint: {
+    query<T = Record<string, unknown>>(
+      objectType: string,
+      options?: BlueprintQueryOptions,
+    ): Promise<BlueprintQueryResult<T>>
+  }
+}
+
+export interface BlueprintQueryOptions {
+  /** The real Blueprint filter DSL, not a shorthand — `and`/`or`/`not`, ranges
+   *  and date presets all work. A convenience subset with no escape hatch is the
+   *  thing the first "overdue OR flagged" automation would have to work around. */
+  where?: WhereNode
+  select?: string[]
+  /** `dir`, not `direction` — matches `QueryRequest` exactly. */
+  orderBy?: Array<{ property: string; dir: 'asc' | 'desc' }>
+  /** Default 100, clamped to 1000. Exceeding the cap sets `hasMore`; it never
+   *  truncates silently. */
+  limit?: number
+  /** Opaque. Pass back the previous result's `nextPageToken`; absent means the
+   *  first page. Cursor-based, so a scan stays correct while the table moves
+   *  underneath it — which a cron-driven automation's table always does. */
+  pageToken?: string
+}
+
+export interface BlueprintQueryResult<T = Record<string, unknown>> {
+  rows: T[]
+  /** True when the query matched more rows than were returned. */
+  hasMore: boolean
+  /** Present iff `hasMore`. Feed to the next call's `pageToken`.
+   *
+   *  Forwarded rather than narrowed away on purpose: `hasMore` on its own is a
+   *  fact the author can do nothing about, which is how a digest over the first
+   *  500 of 5,000 rows reports success. */
+  nextPageToken?: string
+}
+
+export type AutomationHandler = (ctx: AutomationContext) => Promise<unknown>
+
+export interface AutomationDescriptor {
+  readonly manifest: ResolvedAutomationManifest
+  readonly handler: AutomationHandler
+}