@lunnoa/client 0.0.0-development

package/LICENSE

@@ -0,0 +1,202 @@
+"Commons Clause" License Condition v1.0
+
+The Software is provided to you by the Licensor under the License, as defined
+below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights under
+the License will not include, and the License does not grant to you, the
+right to Sell the Software.
+
+For purposes of the foregoing, "Sell" means practicing any or all of the
+rights granted to you under the License to provide to third parties, for a
+fee or other consideration (including without limitation fees for hosting or
+consulting/ support services related to the Software), a product or service
+whose value derives, entirely or substantially, from the functionality of the
+Software. Any license notice or attribution required by the License must also
+include this Commons Clause License Condition notice.
+
+Software: @lunnoa/client
+
+License: Apache License, Version 2.0
+(http://www.apache.org/licenses/LICENSE-2.0)
+
+Licensor: Lunnoa Labs
+
+---
+
+                                 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

package/README.md

@@ -0,0 +1,338 @@
+# @lunnoa/client
+
+TypeScript SDK for building applications **on top of** [Lunnoa Automate](https://github.com/lunnoa-automate/lunnoa_automate).
+
+[![npm version](https://img.shields.io/npm/v/@lunnoa/client)](https://www.npmjs.com/package/@lunnoa/client)
+[![license](https://img.shields.io/badge/license-Apache--2.0%20with%20Commons%20Clause-blue)](https://www.npmjs.com/package/@lunnoa/client)
+
+## What is this?
+
+`@lunnoa/client` is the official consumption SDK for the Lunnoa Automate **Public API**: a typed client for agents and chat (with SSE streaming), workflows and executions, entities (Objects), knowledge, queues, variables, connections, and projects — plus a codegen command that types the SDK against **your** deployment's entity types, workflows, and agents.
+
+**The boundary with the other Lunnoa SDK:** [`@lunnoa/toolkit`](https://github.com/lunnoa-automate/lunnoa_toolkit) is for building integration apps that run *inside* the platform (`createAction` / `createApp`); **`@lunnoa/client` is for building applications *on top of* the platform** — including `define*` factories, `runs.start`, and CLI deploy of workflows/agents.
+
+The SDK is deliberately **presentation-free** at the core: no components or widgets. Optional **headless** React hooks ship as `@lunnoa/client/react`. You build fully custom UIs in your own design system; the SDK encodes the platform knowledge (protocols, schemas, conventions). A frontend-authoring skill for AI coding agents ships with the package (see [`.cursor/skills/lunnoa-client/SKILL.md`](./.cursor/skills/lunnoa-client/SKILL.md)).
+
+## Installation
+
+```bash
+npm install @lunnoa/client
+```
+
+**Requirements:** Node.js ≥ 20 (or any runtime with `fetch` and web streams).
+
+## Quickstart
+
+```typescript
+import { LunnoaClient } from '@lunnoa/client';
+
+const lunnoa = new LunnoaClient({
+  baseUrl: 'https://lunnoa.your-company.example',
+  apiKey: process.env.LUNNOA_API_KEY, // lna_... — server-side only
+});
+
+const { data: invoices } = await lunnoa.entities.list({
+  objectTypeSlug: 'invoice',
+  state: 'pending',
+  expansion: ['attributes'],
+});
+```
+
+A SuperAdmin creates API keys in **Adminspace → API keys**, choosing the workspace and an RBAC role for the key's service account. The role is the key's entire capability model — grant the minimum permission set, not Admin.
+
+## Two auth patterns
+
+| Pattern | Credential | Where |
+|---|---|---|
+| **A. Backend holds the key** | `apiKey: 'lna_...'` via `createServerClient` | Your server, background jobs, server-rendered pages. The key acts as a workspace-scoped service account. |
+| **B. End users are Lunnoa users** | User JWT via `createBrowserClient` + `lunnoa.auth.*` | Browser apps. Login, 2FA, refresh, and SSO discovery are wrapped; per-user permissions apply. |
+
+```typescript
+import {
+  createBrowserClient,
+  createServerClient,
+  isLoginRequires2FA,
+} from '@lunnoa/client';
+
+// Pattern A — server-side
+const server = createServerClient({
+  baseUrl,
+  apiKey: process.env.LUNNOA_API_KEY!,
+});
+
+// Pattern B — browser (tokens in localStorage by default; auto-refresh on 401)
+const lunnoa = createBrowserClient({ baseUrl });
+const result = await lunnoa.auth.login({ email, password });
+if (isLoginRequires2FA(result)) {
+  await lunnoa.auth.verify2faLogin({
+    sessionToken: result.sessionToken,
+    token: totpCode,
+  });
+}
+const me = await lunnoa.auth.me();
+```
+
+**API keys never ship to browsers.** The SDK enforces this: constructing a client with an `lna_` key while `window` exists throws immediately. Browser apps either use Pattern B or call your own backend, which holds the key (backend-for-frontend).
+
+For Pattern B the deployment must allow your origin via its `CORS_ALLOWED_ORIGINS` configuration. See the Authentication guide under `guides/develop/client/auth` in Lunnoa Docs for SSO redirect constraints and token stores.
+
+### React (optional)
+
+```tsx
+import {
+  LunnoaAuthProvider,
+  useLunnoaAuth,
+  useLunnoaClient,
+  useExecutionProgress,
+  useNeedsInput,
+  useAgentChat,
+  useApprovalsInbox,
+  useEntityList,
+} from '@lunnoa/client/react';
+
+<LunnoaAuthProvider baseUrl={baseUrl}>
+  <App />
+</LunnoaAuthProvider>
+
+const { user, status, login, logout } = useLunnoaAuth();
+const lunnoa = useLunnoaClient();
+const { progress, status: progressStatus } = useExecutionProgress(executionId);
+const { waiting, pendingInput, submitInput } = useNeedsInput(progress);
+const { messages, send, stop, taskId } = useAgentChat(agentId); // needs @ai-sdk/react
+const { items, decide } = useApprovalsInbox({ pollIntervalMs: 15_000 });
+const { data, page, setPage } = useEntityList({ objectTypeSlug: 'invoice' });
+```
+
+Peers: `react` ≥ 18 (required for `/react`); `@ai-sdk/react` only for `useAgentChat`. Core `@lunnoa/client` stays headless.
+
+## Resources
+
+Most namespaces map to the Public API surface (`openapi.public.json`):
+
+`auth` · `agents` · `tasks` · `agentChat` (SSE streaming) · `workflows` · `executions` · `actions` · `entities` · `entityTypes` · `knowledge` · `queues` · `queueItems` · `variables` · `connections` · `projects` · `workflowApps` · `discovery`
+
+`approvals` uses the authenticated **workspace** API (`/api/approvals/...`), not Public API v1. The inbox is filtered to requests where the current user is an eligible approver.
+
+Errors are `LunnoaApiError` with `status`, `body`, and convenience flags (`isUnauthorized`, `isForbidden`, `isRateLimited`). Paginated lists have async iteration (`entities.iterate(...)`, `queueItems.iterate(...)`).
+
+## Worked examples
+
+Runnable versions live in [`examples/`](./examples).
+
+### Query and create entities
+
+```typescript
+const invoiceType = await lunnoa.entityTypes.getBySlug('invoice', {
+  expansion: ['attributeSchema', 'stateSchema'],
+});
+
+const created = await lunnoa.entities.create({
+  name: 'INV-2026-0042',
+  objectTypeId: invoiceType.id,
+  attributes: { amount: 1250.5, currency: 'CHF' }, // keyed by field ID
+});
+
+for await (const invoice of lunnoa.entities.iterate({ objectTypeSlug: 'invoice' })) {
+  // pages fetched lazily
+}
+```
+
+### Trigger a workflow and wait for the result
+
+```typescript
+const { id } = await lunnoa.workflows.execute(workflowId, { customerEmail: 'x@y.z' });
+const execution = await lunnoa.executions.waitUntilFinished(id); // poll with backoff
+console.log(execution.status, execution.output);
+
+// or in one call:
+const done = await lunnoa.workflows.executeAndWait(workflowId, inputs);
+```
+
+### Run a single app action (ad-hoc Execution)
+
+Creates a one-step Execution with `source: SDK` (same inbox as workflow runs). Discover `appId` / `actionId` / `inputConfig` via `workflowApps.list()`. Pass `connectionId` (the Connection instance UUID from Connections) when the action needs a connection and more than one exists for the app.
+
+```typescript
+const result = await lunnoa.actions.run({
+  appId: 'http',
+  actionId: 'http_action_send-request',
+  // connectionId: '...', // Connection.id UUID when needed
+  input: { method: 'GET', url: 'https://example.com' },
+});
+console.log(result.status, result.output, result.executionPath);
+
+// Same record via the Executions API:
+const again = await lunnoa.executions.get(result.id, {
+  expansion: ['status', 'source', 'executionPath'],
+});
+```
+
+### Resume a NEEDS_INPUT execution from a custom form
+
+Workflows can pause and wait for human input. Render a form for the waiting step and resume:
+
+```typescript
+const execution = await lunnoa.executions.get(executionId, {
+  expansion: ['status', 'executionPath'],
+});
+const waiting = execution.executionPath?.find((s) => s.status === 'NEEDS_INPUT');
+
+await lunnoa.executions.submitInput(executionId, waiting!.nodeId, {
+  approved: true,
+  comment: 'Release the payment.',
+});
+const finished = await lunnoa.executions.waitUntilFinished(executionId);
+```
+
+The `executionPath` expansion is the business-readable step list (labels, per-step status, timings, loop iterations) custom UIs render progress from.
+
+### Approvals inbox (Request Approval nodes)
+
+List pending approvals the authenticated user can decide, then approve or reject. Prefer a user JWT (pattern B) so eligibility matches a real person. Requires `approvals:read` / `approvals:decide`.
+
+```typescript
+const { items } = await lunnoa.approvals.inbox(); // pending + partially_approved
+
+for (const person of items[0]?.eligibleApprovers ?? []) {
+  console.log(person.email, person.name); // who can still decide
+}
+
+await lunnoa.approvals.decide(items[0]!.approvalId, {
+  decision: 'approved',
+  comment: 'Within policy limits.',
+});
+
+// Or by execution + node when you already have those IDs:
+await lunnoa.executions.submitApproval(executionId, nodeId, {
+  decision: 'rejected',
+  comment: 'Amount exceeds limit.',
+});
+```
+
+Do not use `submitInput` for Request Approval nodes; that path is for generic `NEEDS_INPUT` forms.
+
+### Stream agent chat
+
+The streaming module is hand-written (code generators handle SSE poorly) and speaks the same wire protocol as the bundled UI: AI SDK `UIMessage` chunks, SSE-framed, resumable.
+
+```typescript
+const taskId = crypto.randomUUID(); // first message creates the task
+const stream = await lunnoa.agentChat.streamMessage(agentId, taskId, 'Hello!');
+
+for await (const chunk of stream) {
+  if (chunk.type === 'text-delta') process.stdout.write(chunk.delta);
+}
+
+// Reattach after a disconnect (returns null when nothing is running):
+const resumed = await lunnoa.agentChat.resumeStream(agentId, taskId);
+
+// Cancel a running turn (optionally persisting the partial reply):
+await lunnoa.agentChat.stop(agentId, taskId);
+```
+
+`stream.toUIMessageStream()` returns a `ReadableStream<UIMessageChunk>` ready for the AI SDK's `readUIMessageStream` when you want assembled `UIMessage` snapshots for rendering.
+
+## Deployment-specific codegen
+
+Entity types, workflow inputs, and agents are defined per deployment, so the generic SDK can only type them loosely. The codegen command queries your deployment and emits typed accessors — the same developer experience as Prisma client or Supabase type generation:
+
+```bash
+npx @lunnoa/client codegen --url https://lunnoa.your-company.example --api-key lna_... --out ./src/lunnoa
+```
+
+This writes `lunnoa.generated.ts`:
+
+```typescript
+import { LunnoaClient } from '@lunnoa/client';
+import { createDeploymentClient } from './lunnoa/lunnoa.generated';
+
+const lunnoa = createDeploymentClient(new LunnoaClient({ baseUrl, apiKey }));
+
+// Entity attributes and states are compile-time checked:
+const open = await lunnoa.entities.invoice.list({ state: 'pending' });
+await lunnoa.entities.invoice.create({
+  name: 'INV-1',
+  attributes: { amount: 99.5, status: 'pending' },
+});
+
+// Workflow inputs typed from the manual trigger's input schema:
+await lunnoa.workflows.processInvoice.executeAndWait({ invoiceId: 'abc' });
+
+// Agents by name:
+const stream = await lunnoa.agents.supportAgent.streamMessage(taskId, 'Hi');
+```
+
+Re-run codegen whenever entity types, workflows, or agents change on the deployment.
+
+## Define, run, and CLI deploy
+
+Author local definitions with `defineWorkflow` / `defineAgent`, run linear chains with `lunnoa.runs.start`, and upsert into a project with the CLI (prefer CLI over calling upsert from app code):
+
+```bash
+npx @lunnoa/client workflows deploy ./workflows/sync-orders.ts \
+  --url https://lunnoa.example --api-key lna_... --project-id <uuid>
+npx @lunnoa/client agents deploy ./agents/triage.ts \
+  --url https://lunnoa.example --api-key lna_... --project-id <uuid>
+```
+
+`defineAction` binds catalogue actions only; toolkit `createAction` is for in-platform apps. See Lunnoa Docs under `guides/develop/client/define`, `runs`, and `cli-deploy`.
+
+## Regenerating the API types
+
+The generic types are generated from the deployment's public OpenAPI spec (`spec/openapi.public.json`, produced by the platform's `export-openapi --public`):
+
+```bash
+npm run codegen:spec
+```
+
+## AI-assisted UI building
+
+The repo ships a frontend-authoring skill at [`.cursor/skills/lunnoa-client/SKILL.md`](./.cursor/skills/lunnoa-client/SKILL.md) that teaches coding agents (Cursor, Claude) how to build custom UIs against this SDK: auth patterns, discovery, codegen, and the four worked recipes above. Copy it into your app's `.cursor/skills/` folder.
+
+## Versioning and stability
+
+This package follows [semantic versioning](https://semver.org/). It targets the Lunnoa Automate **Public API v1**: endpoints marked stable by the platform's `x-public` contract. Public endpoints only change additively; breaking platform changes come with a deprecation window.
+
+## License
+
+Licensed under **Apache-2.0 with Commons Clause**.
+
+You may use, modify, and distribute the software under Apache 2.0 terms, with one additional restriction: you may not sell the software itself (the SDK as a standalone product). Building and operating applications that *use* the SDK is permitted.
+
+## Development
+
+```bash
+git clone https://github.com/lunnoa-automate/lunnoa_client.git
+cd lunnoa_client
+pnpm install
+pnpm test
+pnpm build
+```
+
+Build output (ESM + CJS + type declarations) is written to `dist/`. Only `dist/` is included in the published npm tarball.
+
+## Publishing
+
+Releases are fully automated with [semantic-release](https://github.com/semantic-release/semantic-release), the same setup as `@lunnoa/toolkit`: merge [Conventional Commits](https://www.conventionalcommits.org/) to `master`/`main`, CI runs tests and build, and the Release workflow computes the version, updates `CHANGELOG.md`, tags, creates the GitHub release, and publishes to npm via trusted publishing (OIDC).
+
+| Commit prefix | Version bump |
+| --- | --- |
+| `fix:` | Patch |
+| `feat:` | Minor |
+| `feat!:` / `BREAKING CHANGE:` | Major |
+
+### npm trusted publishing (OIDC)
+
+Publishing uses [npm trusted publishers](https://docs.npmjs.com/trusted-publishers/) via GitHub Actions OIDC — no `NPM_TOKEN` secret is required.
+
+Before the first release, configure a **Trusted Publisher** on [npmjs.com](https://www.npmjs.com) (org admin login for `@lunnoa`):
+
+| Field | Value |
+| --- | --- |
+| Package | `@lunnoa/client` |
+| Organization / user | `lunnoa-automate` |
+| Repository | `lunnoa_client` |
+| Workflow filename | `release.yml` |
+| Environment | *(leave empty)* |
+
+The release workflow grants `id-token: write` and uses **semantic-release v25** with Node 24.