@ecomcx/ecomweb-admin-sdk 1.28.0 → 1.30.0

package/dist/index.d.ts

@@ -9,6 +9,13 @@ export declare const registerDashboardWidget: (w: DashboardWidget) => void;
 export declare const registerPostListColumn: (c: import("./types.js").PostListColumn) => void;
 /** Thêm hộp vào form sửa chuyên mục/thẻ (dữ liệu lưu trong term.meta). */
 export declare const registerTermMetaBox: (b: import("./types.js").TermMetaBox) => void;
+/**
+ * Thêm hộp vào trang sửa đối tượng của plugin khác (đơn hàng, mã giảm giá, dòng bảng [PluginTable] có cột [ObjectMeta]…) —
+ * giá trị đặt qua setMeta được plugin chủ lưu cùng đối tượng. CMS < 1.18.0: bỏ qua.
+ */
+export declare const registerObjectMetaBox: (b: import("./types.js").ObjectMetaBox) => void | undefined;
+/** Hộp đã đăng ký cho một đối tượng (bỏ trống = tất cả). */
+export declare const getObjectMetaBoxes: (object?: string) => import("./types.js").ObjectMetaBox[];
 /** Lấy các MetaBox đã đăng ký trong hệ thống (tùy chọn lọc theo postType). */
 export declare const getMetaBoxes: (postType?: string) => MetaBox[];
 /** Hook lấy toàn bộ state plugin UI trong host. */
@@ -241,6 +248,8 @@ export declare const Tabs: NonNullable<import("react").ComponentType<{
     }>;
 }>>;
 export declare const MetaBoxes: NonNullable<import("react").ComponentType<import("./types.js").MetaBoxesProps>>;
+/** Plugin chủ vẽ chỗ cho hộp của plugin khác trong trang sửa đối tượng của mình (CMS < 1.18.0: không vẽ gì). */
+export declare const ObjectMetaBoxes: NonNullable<import("react").ComponentType<import("./types.js").ObjectMetaBoxesProps> | undefined>;
 export declare const Slot: NonNullable<import("react").ComponentType<{
     name: string;
     props?: any;

package/dist/index.js

@@ -9,6 +9,13 @@ export const registerDashboardWidget = (w) => host().registerDashboardWidget(w);
 export const registerPostListColumn = (c) => host().registerPostListColumn(c);
 /** Thêm hộp vào form sửa chuyên mục/thẻ (dữ liệu lưu trong term.meta). */
 export const registerTermMetaBox = (b) => host().registerTermMetaBox(b);
+/**
+ * Thêm hộp vào trang sửa đối tượng của plugin khác (đơn hàng, mã giảm giá, dòng bảng [PluginTable] có cột [ObjectMeta]…) —
+ * giá trị đặt qua setMeta được plugin chủ lưu cùng đối tượng. CMS < 1.18.0: bỏ qua.
+ */
+export const registerObjectMetaBox = (b) => host().registerObjectMetaBox?.(b);
+/** Hộp đã đăng ký cho một đối tượng (bỏ trống = tất cả). */
+export const getObjectMetaBoxes = (object) => host().getObjectMetaBoxes?.(object) ?? [];
 /** Lấy các MetaBox đã đăng ký trong hệ thống (tùy chọn lọc theo postType). */
 export const getMetaBoxes = (postType) => (host().getMetaBoxes ? host().getMetaBoxes(postType) : []);
 /** Hook lấy toàn bộ state plugin UI trong host. */
@@ -137,6 +144,8 @@ export const IconButton = ui("IconButton");
 export const Section = ui("Section");
 export const Tabs = ui("Tabs");
 export const MetaBoxes = ui("MetaBoxes");
+/** Plugin chủ vẽ chỗ cho hộp của plugin khác trong trang sửa đối tượng của mình (CMS < 1.18.0: không vẽ gì). */
+export const ObjectMetaBoxes = ui("ObjectMetaBoxes", () => null);
 export const Slot = ui("Slot");
 export const Fill = ui("Fill");
 // ----- UI kit v2 (xem trang /ui-kit trong admin) -----

package/dist/types.d.ts

@@ -91,6 +91,40 @@ export interface TermMetaBox {
     taxonomies?: string[];
     component: ComponentType<TermMetaBoxProps>;
 }
+/**
+ * Đối tượng của plugin lưu trong bảng riêng (vd "ecomcx-ecommerce/order") — plugin chủ khai báo bằng ctx.Objects.Register ở backend
+ * (hoặc bảng [PluginTable] có cột [ObjectMeta]); danh sách nằm trong bootstrap của admin (`objectTypes`).
+ */
+export interface ObjectMetaBoxProps {
+    /** Tên đối tượng "{slug}/{name}". */
+    object: string;
+    /** Mã đối tượng; bỏ trống khi đang tạo mới. */
+    id?: string | number;
+    /** Dữ liệu đang sửa của đối tượng (chỉ để đọc, vd tổng tiền đơn hàng) — tuỳ plugin chủ. */
+    record?: Record<string, any>;
+    /** Meta hiện tại (đã gồm thay đổi chưa lưu). */
+    meta: Record<string, any>;
+    /** Đặt meta — plugin chủ lưu cùng đối tượng khi bấm Lưu. */
+    setMeta(key: string, value: any): void;
+}
+/** Hộp thêm vào trang sửa đối tượng của plugin khác (CMS ≥ 1.18.0), vd trường tuỳ biến cho đơn hàng. */
+export interface ObjectMetaBox {
+    id: string;
+    title: string;
+    /** Tên đối tượng "{slug}/{name}"; bỏ trống = mọi đối tượng. */
+    objects?: string[];
+    context?: "main" | "side";
+    priority?: number;
+    /** Trả false để ẩn hộp với đối tượng này (vd không có nhóm trường nào áp dụng). */
+    visible?(props: ObjectMetaBoxProps): boolean;
+    component: ComponentType<ObjectMetaBoxProps>;
+}
+/** Chỗ vẽ hộp của plugin khác trong trang sửa đối tượng của mình (plugin chủ dùng). */
+export interface ObjectMetaBoxesProps extends ObjectMetaBoxProps {
+    context?: "main" | "side" | "all";
+    excludeIds?: string[];
+    className?: string;
+}
 export interface MetaBox {
     id: string;
     title: string;
@@ -520,6 +554,8 @@ export interface UiKit {
         }>;
     }>;
     MetaBoxes: ComponentType<MetaBoxesProps>;
+    /** Hộp của plugin khác cho đối tượng trong bảng riêng (CMS ≥ 1.18.0). */
+    ObjectMetaBoxes?: ComponentType<ObjectMetaBoxesProps>;
     Slot: ComponentType<{
         name: string;
         props?: any;
@@ -686,6 +722,8 @@ export interface CmsAdmin {
     registerDashboardWidget(widget: DashboardWidget): void;
     registerPostListColumn(column: PostListColumn): void;
     registerTermMetaBox(box: TermMetaBox): void;
+    registerObjectMetaBox?(box: ObjectMetaBox): void;
+    getObjectMetaBoxes?(object?: string): ObjectMetaBox[];
     registerSlot(slot: AdminSlotItem): void;
     getSlots(slot: string, postType?: string): Array<AdminSlotItem>;
     registerPostRowAction(action: PostRowAction): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecomcx/ecomweb-admin-sdk",
-  "version": "1.28.0",
+  "version": "1.30.0",
   "description": "SDK cho phần admin của plugin: đăng ký trang, meta box, widget dashboard và dùng bộ UI của admin.",
   "type": "module",
   "main": "./dist/index.js",