@rytass/bpm-core-client 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to `@rytass/bpm-core-client` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Releases are managed by [`nx release`](https://nx.dev/recipes/nx-release) with
+Conventional Commits — see `nx.json` for the release config.
+
+## 0.1.0 — Unreleased
+
+### Added
+
+- Initial published surface extracted from `apps/client` of the BPMCore
+  monorepo:
+  - Root: `requestGraphQl`, endpoint resolvers, REST auth client (`loginApi`,
+    `logoutApi`, `readApiCurrentMember`, `listApiTestMembers`), member
+    directory queries (`resolveMembers`, `searchMembers`,
+    `listMemberDirectoryPage`).
+  - `/organization`: org unit / position / membership / manager resolution
+    queries and mutations.
+  - `/form`: form definition CRUD, version management, schema rendering
+    helpers.
+  - `/template`: approval template CRUD, category management, version
+    publish / rollback.
+  - `/workflow`: instance / task / notification / attachment / signature
+    operations.
+- Endpoint defaults: `http://localhost:17603/graphql` on local hostnames,
+  same-origin `/graphql` on deployed hostnames, plus root-level
+  `/auth/*` (no `/api` prefix). Overridable through `NEXT_PUBLIC_API_URL`
+  and `NEXT_PUBLIC_API_AUTH_URL`.
+
+### Notes
+
+- `@rytass/bpm-core-shared` is a `peerDependency` (`^0.1.0`).
+- The package ships without `"type"` at source level so Next.js webpack
+  resolving the path alias to TypeScript source does not flag CJS / ESM
+  conflicts; the publish pipeline injects `"type": "commonjs"` into the
+  tarball's `package.json`.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rytass
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,191 @@
+# @rytass/bpm-core-client
+
+Framework-agnostic TypeScript client for the BPM approval workflow GraphQL
+surface published by
+[`@rytass/bpm-core-nestjs-module`](https://www.npmjs.com/package/@rytass/bpm-core-nestjs-module).
+
+This package contains:
+
+- A tiny `fetch`-based GraphQL transport (`requestGraphQl`).
+- Endpoint resolution helpers (`readGraphQlEndpoint`, `readApiBaseUrl`).
+- The BPM host auth REST client (`loginApi`, `logoutApi`, `readApiCurrentMember`, `listApiTestMembers`).
+- Pre-baked typed GraphQL operations for organization, member directory, form
+  definition, approval template, workflow instance, task, notification,
+  attachment, signature, and delegation flows.
+
+It does **not** ship React components, hooks, or UI. Hosts can call the
+functions directly from any framework (Next.js / Vite / Remix / plain Node).
+
+## Package Status
+
+Current version: `0.0.1`
+
+The package intentionally stays framework-agnostic so it can be reused from
+Next.js Server Components, Server Actions, plain React, or non-React
+runtimes. There is no Apollo Client setup.
+
+## Install
+
+```bash
+pnpm add @rytass/bpm-core-client @rytass/bpm-core-shared
+```
+
+`@rytass/bpm-core-shared` is a `peerDependency` and must be installed
+alongside.
+
+The browser bundle uses the standard Fetch API; Node 20+ also has `fetch`
+built in. No `graphql` runtime package is required.
+
+**TypeScript moduleResolution**: prefer `node16`, `nodenext`, or `bundler` in
+your `tsconfig.json` so the package's `exports` field is honored. Classic
+`moduleResolution: "node"` also works through the `typesVersions` fallback
+shipped with this package, but is on TypeScript's long-term deprecation
+path — new projects should opt in to modern resolution.
+
+## Endpoint Resolution
+
+By default the client targets the same origin (no `/api` prefix) — see
+[`docs/10-bpm-embedding-auth.md`](../../docs/10-bpm-embedding-auth.md) for the
+host contract. Endpoint resolution rules:
+
+| Source                                          | Behavior                                                                   |
+| ----------------------------------------------- | -------------------------------------------------------------------------- |
+| `process.env.NEXT_PUBLIC_API_URL`               | If set, used as the GraphQL endpoint URL.                                  |
+| `process.env.NEXT_PUBLIC_API_AUTH_URL`          | If set, used as the base URL for the REST `/auth/*` endpoints.             |
+| Browser hostname `localhost` or `127.0.0.1`     | GraphQL defaults to `http://localhost:17603/graphql`.                      |
+| Deployed hostname (anything else, or SSR)       | GraphQL defaults to same-origin `/graphql`; auth uses same-origin root.    |
+
+```ts
+import {
+  loginApi,
+  readApiCurrentMember,
+  readApiBaseUrl,
+  readGraphQlEndpoint,
+  requestGraphQl,
+} from '@rytass/bpm-core-client';
+
+console.log(readGraphQlEndpoint());
+console.log(readApiBaseUrl());
+
+const member = await loginApi({ identifier: 'member-001', password: 'demo' });
+const currentMember = await readApiCurrentMember();
+
+interface PingQueryData {
+  readonly memberCount: number;
+}
+
+const data = await requestGraphQl<PingQueryData>(`
+  query Ping {
+    memberCount
+  }
+`);
+```
+
+`requestGraphQl` always sends `credentials: 'include'`, so the HTTP-only
+session cookie issued by the BPM host's `/auth/login` flows back automatically
+on subsequent calls.
+
+## Subpath Overview
+
+| Import path                              | Contents                                                                                                |
+| ---------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| `@rytass/bpm-core-client`                | GraphQL transport, endpoint resolution, REST auth client, member directory queries.                    |
+| `@rytass/bpm-core-client/organization`   | Org unit CRUD, position CRUD, membership CRUD, manager resolution.                                     |
+| `@rytass/bpm-core-client/form`           | Form definition CRUD, form version management, schema parsing helpers (`form-rendering`).              |
+| `@rytass/bpm-core-client/template`       | Approval template CRUD, category management, version publish/revert.                                   |
+| `@rytass/bpm-core-client/workflow`       | Instance submit / decide / cancel, task queries, notification queries, attachment & signature reads.   |
+
+Every subpath uses the same `requestGraphQl` transport from the root. Hosts
+can mix and match — for example a read-only dashboard might only import
+`workflow` queries, never reaching for `/organization` mutations.
+
+## Auth REST Endpoints
+
+The BPM wrapper-host exposes the following endpoints under the host root (no
+`/api` prefix; do not enable Nest `setGlobalPrefix` on a BPM host):
+
+| Method | Path                  | Function                                  |
+| ------ | --------------------- | ----------------------------------------- |
+| GET    | `/auth/test-members`  | `listApiTestMembers()`                    |
+| POST   | `/auth/login`         | `loginApi({ identifier, password })`      |
+| GET    | `/auth/me`            | `readApiCurrentMember()` (returns `null` on `401`) |
+| POST   | `/auth/logout`        | `logoutApi()`                             |
+
+If your production host names its auth endpoints differently, set
+`NEXT_PUBLIC_API_AUTH_URL` so the client points at the right base URL, and
+implement those paths server-side.
+
+## GraphQL Operations
+
+Each subpath exports typed wrapper functions over `requestGraphQl`. Records
+returned from these functions match the BPM GraphQL schema field-by-field.
+Examples:
+
+```ts
+import { resolveMembers, searchMembers } from '@rytass/bpm-core-client';
+import {
+  listApprovalInstances,
+  decideTask,
+  submitApprovalInstance,
+} from '@rytass/bpm-core-client/workflow';
+import { listApprovalTemplates } from '@rytass/bpm-core-client/template';
+import { listFormDefinitions } from '@rytass/bpm-core-client/form';
+import { listOrgUnits, listPositions } from '@rytass/bpm-core-client/organization';
+
+const members = await resolveMembers(['member-001', 'member-002']);
+const templates = await listApprovalTemplates({ status: 'PUBLISHED' });
+const inbox = await listApprovalInstances({ assigneeMemberId: members[0]?.memberId ?? null });
+```
+
+The available operations track the BPM resolvers; consult the GraphQL schema
+file generated by the host's `GraphQLModule` (`autoSchemaFile`) for the
+authoritative list.
+
+## React / Next.js Integration
+
+The client is intentionally hookless. Hosts compose their own hook layer on
+top — for example with React Query or SWR:
+
+```ts
+'use client';
+
+import { useQuery } from '@tanstack/react-query';
+import { resolveMembers } from '@rytass/bpm-core-client';
+
+export function useMembers(memberIds: readonly string[]) {
+  return useQuery({
+    queryKey: ['members', memberIds],
+    queryFn: () => resolveMembers(memberIds),
+    enabled: memberIds.length > 0,
+  });
+}
+```
+
+For Next.js App Router, call the same functions from Server Components or
+Server Actions — they only need standard `fetch`.
+
+## Local Development
+
+From this monorepo the client is automatically available through the
+`@rytass/bpm-core-client` TypeScript path alias; no `pnpm link` step is
+required.
+
+External consumers should run against a host built with
+`@rytass/bpm-core-nestjs-module` (sample host: `apps/api` in this repo). The
+sample host exposes:
+
+- `http://localhost:17603/graphql`
+- `http://localhost:17603/auth/*`
+- `http://localhost:17603/attachments/:id/download`
+
+## Verification
+
+```bash
+pnpm nx typecheck bpm-core-client
+pnpm nx test bpm-core-client
+pnpm nx build bpm-core-client
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@rytass/bpm-core-client",
+  "version": "0.1.0",
+  "description": "Framework-agnostic TypeScript client for the Rytass BPM approval workflow GraphQL surface: fetch-based GraphQL transport, REST auth client, pre-baked typed operations for organization, member, form, template, and workflow.",
+  "keywords": [
+    "bpm",
+    "approval",
+    "workflow",
+    "graphql",
+    "client",
+    "fetch",
+    "nextjs",
+    "react",
+    "rytass"
+  ],
+  "homepage": "https://github.com/Rytass/BPMCore#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rytass/BPMCore.git",
+    "directory": "libs/bpm-core-client"
+  },
+  "bugs": {
+    "url": "https://github.com/Rytass/BPMCore/issues"
+  },
+  "author": "Rytass <hello@rytass.com>",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "form": [
+        "./src/lib/form/index.d.ts"
+      ],
+      "organization": [
+        "./src/lib/organization/index.d.ts"
+      ],
+      "template": [
+        "./src/lib/template/index.d.ts"
+      ],
+      "workflow": [
+        "./src/lib/workflow/index.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./package.json": "./package.json",
+    "./organization": {
+      "types": "./src/lib/organization/index.d.ts",
+      "default": "./src/lib/organization/index.js"
+    },
+    "./form": {
+      "types": "./src/lib/form/index.d.ts",
+      "default": "./src/lib/form/index.js"
+    },
+    "./template": {
+      "types": "./src/lib/template/index.d.ts",
+      "default": "./src/lib/template/index.js"
+    },
+    "./workflow": {
+      "types": "./src/lib/workflow/index.d.ts",
+      "default": "./src/lib/workflow/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@rytass/bpm-core-shared": "^0.1.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/api-auth-client';
+export * from './lib/graphql-client';
+export * from './lib/member-api';

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/api-auth-client"), exports);
+tslib_1.__exportStar(require("./lib/graphql-client"), exports);
+tslib_1.__exportStar(require("./lib/member-api"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/bpm-core-client/src/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC;AACtC,+DAAqC;AACrC,2DAAiC"}

package/src/lib/api-auth-client.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Authenticated BPM member returned by {@link loginApi} and
+ * {@link readApiCurrentMember}.
+ *
+ * Mirrors the shape that BPM-compatible wrapper hosts emit from their
+ * `POST /auth/login` and `GET /auth/me` endpoints. Roles and permissions
+ * are used by BPM's `BPMAdminGuard` / `BPMDesignerGuard`.
+ */
+export interface ApiMember {
+    readonly email: string;
+    readonly expiresAt: string;
+    readonly memberId: string;
+    readonly name: string;
+    readonly permissions: readonly string[];
+    readonly roles: readonly string[];
+}
+/**
+ * Reduced member shape returned by {@link listApiTestMembers}. Excludes
+ * `permissions` and `expiresAt` because the test-members endpoint is meant
+ * for picker UIs in dev / demo, not for session establishment.
+ */
+export interface ApiPublicMember {
+    readonly email: string;
+    readonly memberId: string;
+    readonly name: string;
+    readonly roles: readonly string[];
+}
+/**
+ * Lists seeded test members exposed by the host's `/auth/test-members`
+ * endpoint. Hosts targeting production typically disable this endpoint or
+ * gate it behind a feature flag.
+ */
+export declare function listApiTestMembers(): Promise<readonly ApiPublicMember[]>;
+/**
+ * Performs a login against the host's `POST /auth/login` endpoint. On
+ * success the host issues an HTTP-only session cookie that subsequent
+ * {@link requestGraphQl} calls automatically carry, because
+ * {@link requestApi} uses `credentials: 'include'`.
+ *
+ * Throws on HTTP errors with a message extracted from the response body
+ * when available.
+ *
+ * @param input.identifier - Member id, email, or any other identifier the
+ *                           host understands.
+ * @param input.password   - Cleartext credential — TLS is the consumer's
+ *                           responsibility.
+ */
+export declare function loginApi(input: {
+    readonly identifier: string;
+    readonly password: string;
+}): Promise<ApiMember>;
+/**
+ * Calls `POST /auth/logout` on the host. The host clears the session
+ * cookie. Safe to call when not logged in (host should return 200).
+ */
+export declare function logoutApi(): Promise<void>;
+/**
+ * Reads the currently authenticated member from `GET /auth/me`.
+ *
+ * Returns `null` when the host replies `401`, which is the conventional
+ * way to signal "no active session". Any other HTTP failure throws.
+ */
+export declare function readApiCurrentMember(): Promise<ApiMember | null>;
+/**
+ * Resolves the base URL used by the REST `/auth/*` calls.
+ *
+ * Resolution order:
+ * 1. `process.env.NEXT_PUBLIC_API_AUTH_URL` if non-empty.
+ * 2. Derived from {@link readGraphQlEndpoint}'s origin — the host is
+ *    assumed to expose both `/graphql` and `/auth/*` at the same origin.
+ */
+export declare function readApiBaseUrl(): string;
+export declare function resolveApiBaseUrlFromGraphQlEndpoint(graphQlEndpoint: string): string;

package/src/lib/api-auth-client.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listApiTestMembers = listApiTestMembers;
+exports.loginApi = loginApi;
+exports.logoutApi = logoutApi;
+exports.readApiCurrentMember = readApiCurrentMember;
+exports.readApiBaseUrl = readApiBaseUrl;
+exports.resolveApiBaseUrlFromGraphQlEndpoint = resolveApiBaseUrlFromGraphQlEndpoint;
+const graphql_client_1 = require("./graphql-client");
+/**
+ * Lists seeded test members exposed by the host's `/auth/test-members`
+ * endpoint. Hosts targeting production typically disable this endpoint or
+ * gate it behind a feature flag.
+ */
+async function listApiTestMembers() {
+    return requestApi('/auth/test-members');
+}
+/**
+ * Performs a login against the host's `POST /auth/login` endpoint. On
+ * success the host issues an HTTP-only session cookie that subsequent
+ * {@link requestGraphQl} calls automatically carry, because
+ * {@link requestApi} uses `credentials: 'include'`.
+ *
+ * Throws on HTTP errors with a message extracted from the response body
+ * when available.
+ *
+ * @param input.identifier - Member id, email, or any other identifier the
+ *                           host understands.
+ * @param input.password   - Cleartext credential — TLS is the consumer's
+ *                           responsibility.
+ */
+async function loginApi(input) {
+    return requestApi('/auth/login', {
+        body: JSON.stringify(input),
+        headers: { 'Content-Type': 'application/json' },
+        method: 'POST',
+    });
+}
+/**
+ * Calls `POST /auth/logout` on the host. The host clears the session
+ * cookie. Safe to call when not logged in (host should return 200).
+ */
+async function logoutApi() {
+    await requestApi('/auth/logout', {
+        method: 'POST',
+    });
+}
+/**
+ * Reads the currently authenticated member from `GET /auth/me`.
+ *
+ * Returns `null` when the host replies `401`, which is the conventional
+ * way to signal "no active session". Any other HTTP failure throws.
+ */
+async function readApiCurrentMember() {
+    try {
+        return await requestApi('/auth/me');
+    }
+    catch (error) {
+        if (error instanceof ApiRequestError && error.status === 401) {
+            return null;
+        }
+        throw error;
+    }
+}
+/**
+ * Resolves the base URL used by the REST `/auth/*` calls.
+ *
+ * Resolution order:
+ * 1. `process.env.NEXT_PUBLIC_API_AUTH_URL` if non-empty.
+ * 2. Derived from {@link readGraphQlEndpoint}'s origin — the host is
+ *    assumed to expose both `/graphql` and `/auth/*` at the same origin.
+ */
+function readApiBaseUrl() {
+    const explicitApiBaseUrl = process.env.NEXT_PUBLIC_API_AUTH_URL?.trim();
+    if (explicitApiBaseUrl) {
+        return explicitApiBaseUrl.replace(/\/$/, '');
+    }
+    const graphQlEndpoint = (0, graphql_client_1.readGraphQlEndpoint)();
+    return resolveApiBaseUrlFromGraphQlEndpoint(graphQlEndpoint);
+}
+function resolveApiBaseUrlFromGraphQlEndpoint(graphQlEndpoint) {
+    if (!isAbsoluteUrl(graphQlEndpoint)) {
+        return '';
+    }
+    const endpoint = new URL(graphQlEndpoint);
+    endpoint.pathname = '/';
+    endpoint.search = '';
+    endpoint.hash = '';
+    return endpoint.toString().replace(/\/$/, '');
+}
+async function requestApi(path, init) {
+    const response = await fetch(`${readApiBaseUrl()}${path}`, {
+        credentials: 'include',
+        ...init,
+    });
+    if (!response.ok) {
+        throw new ApiRequestError(response.status, await readError(response));
+    }
+    return (await response.json());
+}
+async function readError(response) {
+    try {
+        const payload = (await response.json());
+        return typeof payload.message === 'string'
+            ? payload.message
+            : `BPM API request failed with HTTP ${response.status}`;
+    }
+    catch {
+        return `BPM API request failed with HTTP ${response.status}`;
+    }
+}
+class ApiRequestError extends Error {
+    constructor(status, message) {
+        super(message);
+        this.status = status;
+    }
+}
+function isAbsoluteUrl(value) {
+    return value.startsWith('http://') || value.startsWith('https://');
+}
+//# sourceMappingURL=api-auth-client.js.map

package/src/lib/api-auth-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-auth-client.js","sourceRoot":"","sources":["../../../../../libs/bpm-core-client/src/lib/api-auth-client.ts"],"names":[],"mappings":";;AAoCA,gDAIC;AAgBD,4BASC;AAMD,8BAIC;AAQD,oDAUC;AAUD,wCAUC;AAED,oFAYC;AA/HD,qDAAuD;AA+BvD;;;;GAIG;AACI,KAAK,UAAU,kBAAkB;IAGtC,OAAO,UAAU,CAA6B,oBAAoB,CAAC,CAAC;AACtE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,QAAQ,CAAC,KAG9B;IACC,OAAO,UAAU,CAAY,aAAa,EAAE;QAC1C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAC3B,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;QAC/C,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,SAAS;IAC7B,MAAM,UAAU,CAAwB,cAAc,EAAE;QACtD,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB;IACxC,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAAY,UAAU,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,IAAI,KAAK,YAAY,eAAe,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC7D,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc;IAC5B,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,IAAI,EAAE,CAAC;IAExE,IAAI,kBAAkB,EAAE,CAAC;QACvB,OAAO,kBAAkB,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,oCAAmB,GAAE,CAAC;IAE9C,OAAO,oCAAoC,CAAC,eAAe,CAAC,CAAC;AAC/D,CAAC;AAED,SAAgB,oCAAoC,CAClD,eAAuB;IAEvB,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,CAAC;QACpC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;IAC1C,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC;IACxB,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC;IACrB,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAC;IACnB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAChD,CAAC;AAED,KAAK,UAAU,UAAU,CACvB,IAAY,EACZ,IAAkB;IAElB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,cAAc,EAAE,GAAG,IAAI,EAAE,EAAE;QACzD,WAAW,EAAE,SAAS;QACtB,GAAG,IAAI;KACR,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAU,CAAC;AAC1C,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,QAAkB;IACzC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmC,CAAC;QAE1E,OAAO,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;YACxC,CAAC,CAAC,OAAO,CAAC,OAAO;YACjB,CAAC,CAAC,oCAAoC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,oCAAoC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,MAAM,eAAgB,SAAQ,KAAK;IACjC,YACW,MAAc,EACvB,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAC;QAHN,WAAM,GAAN,MAAM,CAAQ;IAIzB,CAAC;CACF;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AACrE,CAAC"}

package/src/lib/form/form-api.d.ts

@@ -0,0 +1,48 @@
+import { FormDefinitionSchema, FormFieldDefinition, FormUiSchema } from '@rytass/bpm-core-shared/form';
+export interface FormDefinitionRecord {
+    readonly currentVersionId: string | null;
+    readonly currentVersionCreatedAt: string | null;
+    readonly currentVersionNumber: number | null;
+    readonly currentVersionPublishedAt: string | null;
+    readonly description: string | null;
+    readonly id: string;
+    readonly name: string;
+    readonly updatedAt: string;
+}
+export type FormDefinitionListStatus = 'DRAFT' | 'PUBLISHED';
+export interface FormDefinitionVersionRecord {
+    readonly id: string;
+    readonly publishedAt: string | null;
+    readonly schema: FormDefinitionSchema;
+    readonly schemaJson: string;
+    readonly status: 'ARCHIVED' | 'DRAFT' | 'PUBLISHED';
+    readonly uiSchema: FormUiSchema;
+    readonly uiSchemaJson: string;
+    readonly updatedAt: string;
+    readonly version: number;
+}
+export interface FormBuilderRecord {
+    readonly definition: FormDefinitionRecord;
+    readonly versions: readonly FormDefinitionVersionRecord[];
+}
+export interface FormSchemaLintResult {
+    readonly errors: readonly string[];
+    readonly valid: boolean;
+}
+export declare function listFormDefinitions(): Promise<readonly FormDefinitionRecord[]>;
+export declare function listFormDefinitionsPage({ page, pageSize, status, }: {
+    readonly page: number;
+    readonly pageSize: number;
+    readonly status?: FormDefinitionListStatus | null;
+}): Promise<{
+    readonly forms: readonly FormDefinitionRecord[];
+    readonly totalCount: number;
+}>;
+export declare function createFormDefinition(name: string): Promise<string>;
+export declare function updateFormDefinition(id: string, name: string): Promise<FormDefinitionRecord>;
+export declare function readFormBuilder(formDefinitionId: string): Promise<FormBuilderRecord>;
+export declare function updateFormDefinitionDraft(versionId: string, schema: FormDefinitionSchema, uiSchema: FormUiSchema): Promise<FormDefinitionVersionRecord>;
+export declare function publishFormDefinitionVersion(versionId: string): Promise<FormDefinitionVersionRecord>;
+export declare function forkFormDefinition(formDefinitionId: string): Promise<FormDefinitionVersionRecord>;
+export declare function lintFormSchema(schema: FormDefinitionSchema, uiSchema: FormUiSchema): Promise<FormSchemaLintResult>;
+export declare function createFieldDefinition(type: FormFieldDefinition['type'], index: number): FormFieldDefinition;