@multiplatform.one/backoffice 7.6.2 → 7.7.0

package/src/form/formActions.ts

@@ -1,285 +1,14 @@
 /**
- * Desk form RPC helpers — thin wrappers over the whitelisted methods the
- * stock desk form view calls. Every payload here was probed against a live
- * bench (frappe v15) before implementation:
+ * Desk RPC helpers — moved to
+ * `@multiplatform.one/frappe-ui/src/formEngine/formActions` (MPO-15),
+ * because useFormEngine consumes them and the engine now lives there.
  *
- *   frappe.desk.form.assign_to.add        {doctype, name, assign_to: [..], description?}
- *   frappe.desk.form.assign_to.remove     {doctype, name, assign_to: "user"}
- *   frappe.desk.form.utils.add_comment    {reference_doctype, reference_name, content,
- *                                          comment_email, comment_by}
- *   frappe.desk.doctype.tag.tag.add_tag   {tag, dt, dn}
- *   frappe.desk.doctype.tag.tag.remove_tag{tag, dt, dn}
- *   frappe.desk.like.toggle_like          {doctype, name, add: "Yes"|"No"}
- *   frappe.desk.form.document_follow.follow_document / unfollow_document
- *                                         {doctype, doc_name, user}
- *   frappe.model.rename_doc.update_document_title
- *                                         {doctype, docname, name, merge: 0} → new name
- *                                         (what desk calls — syncs the title field too)
- *   frappe.client.submit                  {doc} (full doc incl. modified — OCC enforced)
- *   frappe.client.cancel                  {doctype, name}
- *   frappe.client.get_count               {doctype, filters}
- *   frappe.client.validate_link           {doctype, docname, fields: [..]} →
- *                                         {name, <field>: value} (fetch_from preview)
- *   frappe.core.doctype.communication.email.make
- *                                         {doctype, name, recipients, subject, content,
- *                                          send_email: 1}
- *   frappe.desk.form.utils.remove_attach  {fid, dt, dn}
+ * Deep-import only on both sides: these utility names collide with the list
+ * and shell surfaces, so neither barrel carries them.
  */
 
-import { HttpClient, FileModule, type AuthConfig } from "@multiplatform.one/frappe";
-import type { FixtureProvider } from "@multiplatform.one/frappe";
-
-/**
- * Connection shape shared by every form loader/action — structurally
- * compatible with frappe-ui's FrappeConfig and the frappe package's
- * UseFrappeCollectionConfig (function tokens included).
- */
-export interface FrappeConnection {
-  baseURL: string;
-  socketPort?: number;
-  /** Same-origin socket override (see FrappeConfig.socketBaseURL). */
-  socketBaseURL?: string;
-  /** Frappe site name — the realtime Socket.IO namespace. */
-  siteName?: string;
-  auth?: {
-    useToken?: boolean;
-    token?: string | (() => string | Promise<string>);
-    type?: string;
-  };
-  // biome-ignore lint: matches FrappeConfig.syncOptions
-  syncOptions?: any;
-  fixtures?: FixtureProvider;
-}
-
-export function createHttpClient(connection: FrappeConnection): HttpClient {
-  const auth: AuthConfig | undefined = connection.auth
-    ? {
-        useToken: connection.auth.useToken,
-        token: connection.auth.token,
-        type: connection.auth.type as AuthConfig["type"],
-      }
-    : undefined;
-  return new HttpClient(connection.baseURL, auth);
-}
-
-async function post<T = unknown>(
-  http: HttpClient,
-  method: string,
-  body: Record<string, unknown>,
-): Promise<T | undefined> {
-  const response = await http.post<{ message?: T }>(`/api/method/${method}`, body);
-  return response.payload?.message;
-}
-
-// ---------------------------------------------------------------------------
-// Assignments
-// ---------------------------------------------------------------------------
-
-export function addAssignment(
-  http: HttpClient,
-  doctype: string,
-  name: string,
-  users: string[],
-  description?: string,
-) {
-  return post(http, "frappe.desk.form.assign_to.add", {
-    doctype,
-    name,
-    assign_to: users,
-    description: description || undefined,
-  });
-}
-
-export function removeAssignment(http: HttpClient, doctype: string, name: string, user: string) {
-  return post(http, "frappe.desk.form.assign_to.remove", { doctype, name, assign_to: user });
-}
-
-// ---------------------------------------------------------------------------
-// Comments
-// ---------------------------------------------------------------------------
-
-export function addComment(
-  http: HttpClient,
-  args: {
-    doctype: string;
-    name: string;
-    content: string;
-    commentEmail: string;
-    commentBy?: string;
-  },
-) {
-  return post(http, "frappe.desk.form.utils.add_comment", {
-    reference_doctype: args.doctype,
-    reference_name: args.name,
-    content: args.content,
-    comment_email: args.commentEmail,
-    comment_by: args.commentBy ?? args.commentEmail,
-  });
-}
-
-// ---------------------------------------------------------------------------
-// Tags
-// ---------------------------------------------------------------------------
-
-export function addTag(http: HttpClient, doctype: string, name: string, tag: string) {
-  return post(http, "frappe.desk.doctype.tag.tag.add_tag", { tag, dt: doctype, dn: name });
-}
-
-export function removeTag(http: HttpClient, doctype: string, name: string, tag: string) {
-  return post(http, "frappe.desk.doctype.tag.tag.remove_tag", { tag, dt: doctype, dn: name });
-}
-
-// ---------------------------------------------------------------------------
-// Like / Follow
-// ---------------------------------------------------------------------------
-
-export function toggleLike(http: HttpClient, doctype: string, name: string, add: boolean) {
-  return post(http, "frappe.desk.like.toggle_like", {
-    doctype,
-    name,
-    add: add ? "Yes" : "No",
-  });
-}
-
-export function followDocument(http: HttpClient, doctype: string, name: string, user: string) {
-  return post(http, "frappe.desk.form.document_follow.follow_document", {
-    doctype,
-    doc_name: name,
-    user,
-  });
-}
-
-export function unfollowDocument(http: HttpClient, doctype: string, name: string, user: string) {
-  return post(http, "frappe.desk.form.document_follow.unfollow_document", {
-    doctype,
-    doc_name: name,
-    user,
-  });
-}
-
-// ---------------------------------------------------------------------------
-// Document lifecycle
-// ---------------------------------------------------------------------------
-
-/**
- * Rename a document; resolves with the new name. Uses desk's own
- * `update_document_title` (handles title-field sync; the bare
- * `frappe.rename_doc` does not). Pass a `title` argument instead of `name`
- * to retitle without renaming — not needed here yet.
- */
-export async function renameDoc(
-  http: HttpClient,
-  doctype: string,
-  oldName: string,
-  newName: string,
-): Promise<string> {
-  const result = await post<string>(http, "frappe.model.rename_doc.update_document_title", {
-    doctype,
-    docname: oldName,
-    name: newName,
-    merge: 0,
-  });
-  return result ?? newName;
-}
-
-/** Submit a saved draft (docstatus 0 → 1). Requires the current full doc for OCC. */
-export function submitDoc(http: HttpClient, doc: Record<string, unknown>) {
-  return post<Record<string, unknown>>(http, "frappe.client.submit", { doc });
-}
-
-/** Cancel a submitted doc (docstatus 1 → 2). */
-export function cancelDoc(http: HttpClient, doctype: string, name: string) {
-  return post<Record<string, unknown>>(http, "frappe.client.cancel", { doctype, name });
-}
-
-/** Direct REST insert — returns the created doc (with its server-issued name). */
-export async function insertDoc(
-  http: HttpClient,
-  doctype: string,
-  values: Record<string, unknown>,
-): Promise<Record<string, unknown>> {
-  const response = await http.post<{ data?: Record<string, unknown> }>(
-    `/api/resource/${encodeURIComponent(doctype)}`,
-    values,
-  );
-  const data = response.payload?.data;
-  if (!data) throw new Error(`Insert into ${doctype} returned no document`);
-  return data;
-}
-
-/**
- * Validate a link value and fetch columns off the linked doc in one call —
- * what desk's Link control uses to drive fetch_from previews. Resolves with
- * `{name, <field>: value, ...}`; rejects when the target doc is missing.
- */
-export async function validateLink(
-  http: HttpClient,
-  doctype: string,
-  docname: string,
-  fields: string[],
-): Promise<Record<string, unknown>> {
-  const result = await post<Record<string, unknown>>(http, "frappe.client.validate_link", {
-    doctype,
-    docname,
-    fields,
-  });
-  return result ?? {};
-}
-
-// ---------------------------------------------------------------------------
-// Misc
-// ---------------------------------------------------------------------------
-
-export async function getCount(
-  http: HttpClient,
-  doctype: string,
-  filters: Record<string, unknown>,
-): Promise<number> {
-  const response = await http.get<{ message?: number }>("/api/method/frappe.client.get_count", {
-    doctype,
-    filters: JSON.stringify(filters),
-  });
-  return response.payload?.message ?? 0;
-}
-
-let cachedUser: string | undefined;
-export async function getLoggedUser(http: HttpClient): Promise<string> {
-  if (cachedUser) return cachedUser;
-  const response = await http.get<{ message?: string }>("/api/method/frappe.auth.get_logged_user");
-  cachedUser = response.payload?.message ?? "Guest";
-  return cachedUser;
-}
-
-export function removeAttachment(http: HttpClient, fileId: string, doctype: string, name: string) {
-  return post(http, "frappe.desk.form.utils.remove_attach", { fid: fileId, dt: doctype, dn: name });
-}
-
-export function uploadAttachment(
-  http: HttpClient,
-  file: File | Blob,
-  doctype: string,
-  name: string,
-): Promise<unknown> {
-  const files = new FileModule(http);
-  return files.uploadFile(file, { doctype, docname: name });
-}
-
-export function sendEmail(
-  http: HttpClient,
-  args: {
-    doctype: string;
-    name: string;
-    recipients: string;
-    subject: string;
-    content: string;
-  },
-) {
-  return post(http, "frappe.core.doctype.communication.email.make", {
-    doctype: args.doctype,
-    name: args.name,
-    recipients: args.recipients,
-    subject: args.subject,
-    content: args.content,
-    send_email: 1,
-  });
-}
+// Dedicated "./formActions" subpath (see frappe-ui package.json exports),
+// following the ./dependsOn precedent: a deep, extension-less
+// "@multiplatform.one/frappe-ui/src/*" import does NOT resolve under the
+// storybook workspace aliases (bare-name alias -> src/index.ts).
+export * from "@multiplatform.one/frappe-ui/formActions";

package/src/form/formEngineShim.spec.ts

@@ -0,0 +1,122 @@
+/**
+ * MPO-15 — the form-engine seam, from this side.
+ *
+ * The engine moved down to `@multiplatform.one/frappe-ui`
+ * (`src/formEngine/*`). The move must be invisible to anyone importing this
+ * package: the barrel keeps the same names, and the
+ * `@multiplatform.one/backoffice/src/form/*` deep imports keep resolving
+ * (the GNOME shim deep-imports `form/fieldPermissions` and
+ * `form/createPrefill`; `DocFormScreen` deep-imports `form/formActions`).
+ *
+ * Source-level on purpose: importing the backoffice barrel here would drag
+ * the whole desk UI into a node-ish spec run to prove a re-export.
+ */
+import fs from "node:fs";
+import path from "node:path";
+import { describe, expect, it } from "vitest";
+
+const srcDir = path.resolve(__dirname, "..");
+
+function read(rel: string): string {
+  return fs.readFileSync(path.resolve(srcDir, rel), "utf-8");
+}
+
+/** module path (relative to src/) → names it must still hand out. */
+const SHIMS: Record<string, string[]> = {
+  "form/formLayout.ts": [
+    "buildCopyValues",
+    "buildCreateDefaults",
+    "buildFormTabs",
+    "isPromptNamed",
+    "BuildTabsOptions",
+    "FormTab",
+  ],
+  "form/useFormEngine.ts": ["useFormEngine", "FormEngine"],
+  "form/fieldPermissions.ts": [
+    "buildPermLevelMatrix",
+    "canReadLevel",
+    "canWriteLevel",
+    "LevelPerm",
+    "PermLevelMatrix",
+  ],
+  "form/fetchFrom.ts": [
+    "applyFetchedValues",
+    "buildFetchMap",
+    "isFetchLocked",
+    "FetchMap",
+    "FetchRule",
+  ],
+  "form/dirtyTracking.ts": ["computeDirtyFields", "isEmptyValue", "isSameValue"],
+  "form/createPrefill.ts": ["setCreatePrefill", "takeCreatePrefill"],
+};
+
+describe("form engine shims (MPO-15)", () => {
+  it("re-exports every hoisted name from its old path", () => {
+    for (const [rel, names] of Object.entries(SHIMS)) {
+      const source = read(rel);
+      expect(source, `${rel} must source from frappe-ui`).toMatch(
+        /from ["']@multiplatform\.one\/frappe-ui["']/,
+      );
+      for (const name of names) {
+        expect(source, `${rel} must still hand out "${name}"`).toContain(name);
+      }
+      // A shim that grew an implementation back is the drift this guards.
+      expect(source, `${rel} is a re-export, not an implementation`).not.toMatch(
+        /^(export )?function |^const |^class /m,
+      );
+    }
+  });
+
+  it("reaches formActions through its dedicated subpath, not src/*", () => {
+    // A deep, extension-less "@multiplatform.one/frappe-ui/src/*" import does
+    // NOT resolve under the storybook workspace aliases (bare-name alias →
+    // src/index.ts) — the same trap ./dependsOn already documents.
+    const source = read("form/formActions.ts");
+    expect(source).toMatch(/from ["']@multiplatform\.one\/frappe-ui\/formActions["']/);
+    expect(source).not.toMatch(/from ["']@multiplatform\.one\/frappe-ui\/src\//);
+  });
+
+  it("stops declaring the meta shapes and re-exports them instead", () => {
+    const source = read("shared/useDoctypeMeta.ts");
+    for (const name of ["DocFieldMeta", "DocLinkMeta", "DocPermissionRule", "DoctypeMeta"]) {
+      expect(source, `${name} must no longer be declared here`).not.toContain(
+        `export interface ${name} {`,
+      );
+    }
+    expect(source, "the shapes still leave this module").toMatch(
+      /export type \{[\s\S]*DocFieldMeta[\s\S]*\} from "@multiplatform\.one\/frappe-ui"/,
+    );
+    // The loader hook itself stays — it needs the backoffice app context.
+    expect(source).toContain("export function useDoctypeMeta");
+    expect(source).toContain("export interface DoctypeMetaBundle");
+  });
+
+  it("keeps the barrel surface unchanged", () => {
+    const barrel = read("index.ts");
+    const names = [
+      "buildPermLevelMatrix",
+      "canReadLevel",
+      "canWriteLevel",
+      "applyFetchedValues",
+      "buildFetchMap",
+      "isFetchLocked",
+      "computeDirtyFields",
+      "isEmptyValue",
+      "isSameValue",
+      "setCreatePrefill",
+      "takeCreatePrefill",
+      "buildCopyValues",
+      "buildCreateDefaults",
+      "buildFormTabs",
+      "isPromptNamed",
+      "useFormEngine",
+      "DocFieldMeta",
+      "DocLinkMeta",
+      "DocPermissionRule",
+      "DoctypeMeta",
+    ];
+    for (const name of names) {
+      expect(barrel, `the backoffice barrel must still export "${name}"`).toContain(name);
+    }
+  });
+});