@platform-mesh/portal-ui-lib 0.55.1 → 0.56.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platform-mesh/portal-ui-lib",
-  "version": "0.55.1",
+  "version": "0.56.0",
   "repository": {
     "url": "git+https://github.com/platform-mesh/portal-ui-lib.git"
   },

package/types/platform-mesh-portal-ui-lib-models.d.ts

@@ -35,6 +35,62 @@ interface LogicalCluster {
     };
 }
 
+/**
+ * Action performed inside a modal, reported back on close.
+ *
+ * Extend this union when new modal outcomes are introduced (e.g. `'update'`,
+ * `'delete'`). Consumers pass the action through `goBackContext` so the host
+ * (e.g. a table) can react accordingly.
+ */
+type ModalResultAction = 'create' | 'navigate' | 'loadTableData';
+/**
+ * How the modal was closed.
+ *
+ * - `'submit'` — the user completed the modal; `action`/`resource` are honored.
+ * - `'cancelled'` — the modal was dismissed; the host performs no action.
+ */
+type ModalResultStatus = 'submit' | 'cancelled';
+/**
+ * Context passed to `LuigiClient.linkManager().goBack(context)` when a modal
+ * opened via `openAsModal` (button action `'openInModal'`) is closed. The
+ * `openAsModal` promise resolves with this value.
+ *
+ * This is the documented contract consumers use to tell the host what happened
+ * inside the modal — for example, that a resource was created and a table
+ * should reload its data.
+ *
+ * When `status` is `'cancelled'` (or absent), the host performs no action,
+ * regardless of `action` or `resource`.
+ *
+ * The interface is intentionally extensible: new outcomes are added to
+ * `ModalResultAction`, and `resource` is generic so the affected resource can
+ * be typed by the consumer.
+ *
+ * @typeParam T - Type of the affected resource.
+ */
+interface ModalResultContext<T = unknown> {
+    /** How the modal was closed. Treated as `'cancelled'` when omitted. */
+    status?: ModalResultStatus;
+    /** Action performed inside the modal (applied only when `status` is `'submit'`). */
+    action?: ModalResultAction;
+    /** Resource affected by the action (e.g. the created resource). May be undefined. */
+    resource?: T;
+}
+/**
+ * Value the `openAsModal` promise resolves with. Luigi wraps the
+ * `goBackContext` passed to `LuigiClient.linkManager().goBack(context)` in a
+ * `{ data }` envelope.
+ *
+ * The whole value may be `undefined` when the modal is closed without a
+ * `goBack` context (e.g. dismissed via the close button or ESC).
+ *
+ * @typeParam T - Type of the affected resource.
+ */
+interface ModalResult<T = unknown> {
+    /** The `goBackContext` provided when closing the modal. */
+    data?: ModalResultContext<T>;
+}
+
 interface Permission {
     actions: string[];
     resource: string;
@@ -161,4 +217,4 @@ interface ResourceListResult {
 type KubernetesScope = 'Cluster' | 'Namespaced';
 
 export { ALL_NAMESPACE, DOWNLOAD_KUBECONFIG_FROM_SECRET_REF_ACTION, ResourceOperationTypeMap, kcpRootOrgsPath };
-export type { AccountInfo, DetailView, DownloadKubeconfigFromSecretRefButtonSettings, InstancePermission, KubernetesScope, ListView, LogicalCluster, Permission, PermissionsDefinition, PlatformMeshFieldDefinition, Resource, ResourceDefinition, ResourceListResult, ResourceMeta, ResourceOperationType, ResourcePagination, ResourceSpec, ResourceStatus, ResourceSubscriptionResult, UIDefinition, UiView };
+export type { AccountInfo, DetailView, DownloadKubeconfigFromSecretRefButtonSettings, InstancePermission, KubernetesScope, ListView, LogicalCluster, ModalResult, ModalResultAction, ModalResultContext, ModalResultStatus, Permission, PermissionsDefinition, PlatformMeshFieldDefinition, Resource, ResourceDefinition, ResourceListResult, ResourceMeta, ResourceOperationType, ResourcePagination, ResourceSpec, ResourceStatus, ResourceSubscriptionResult, UIDefinition, UiView };