@aragon/gov-ui-kit 2.5.2 → 2.7.0

package/dist/types/src/modules/assets/copy/modulesCopy.d.ts

@@ -203,5 +203,25 @@ export declare const modulesCopy: {
             contract: string;
         };
     };
+    transactionDataListItemStructure: {
+        received: string;
+        sent: string;
+        action: string;
+        executed: string;
+        actionCount: (count: number) => string;
+    };
+    transactionDetailSummary: {
+        executedBy: string;
+        proposal: string;
+        totalActions: string;
+        transaction: string;
+        executedOn: string;
+    };
+    transactionDetail: {
+        title: string;
+        more: string;
+        expand: string;
+        collapse: string;
+    };
 };
 export type ModulesCopy = typeof modulesCopy;

package/dist/types/src/modules/components/transaction/index.d.ts

@@ -1 +1,3 @@
 export * from './transactionDataListItem';
+export * from './transactionDetail';
+export * from './transactionDetailSummary';

package/dist/types/src/modules/components/transaction/transactionDataListItem/transactionDataListItemStructure/index.d.ts

@@ -1,2 +1,2 @@
 export { TransactionDataListItemStructure } from './transactionDataListItemStructure';
-export { type ITransactionDataListItemProps, TransactionStatus, TransactionType, } from './transactionDataListItemStructure.api';
+export { type ITransactionDataListItemProps, TransactionStatus, type TransactionTransferType, TransactionType, } from './transactionDataListItemStructure.api';

package/dist/types/src/modules/components/transaction/transactionDataListItem/transactionDataListItemStructure/transactionDataListItemStructure.api.d.ts

@@ -8,21 +8,15 @@ export declare enum TransactionStatus {
 export declare enum TransactionType {
     DEPOSIT = "DEPOSIT",
     WITHDRAW = "WITHDRAW",
-    ACTION = "ACTION"
+    ACTION = "ACTION",
+    EXECUTION = "EXECUTION"
 }
-export type ITransactionDataListItemProps = IDataListItemProps & {
+export type TransactionTransferType = Exclude<TransactionType, TransactionType.EXECUTION>;
+type TransactionDataListItemBaseProps = IDataListItemProps & {
     /**
      * The chain ID of the transaction.
      */
     chainId: number;
-    /**
-     * The symbol of the token (e.g. 'ETH').
-     */
-    tokenSymbol: string;
-    /**
-     * The token value in the transaction.
-     */
-    tokenAmount?: number | string;
     /**
      * The price of the transaction in USD.
      */
@@ -50,3 +44,52 @@ export type ITransactionDataListItemProps = IDataListItemProps & {
      */
     hash?: Hash;
 };
+export type ITransactionDataListItemTransferProps = TransactionDataListItemBaseProps & {
+    /**
+     * The symbol of the token (e.g. 'ETH').
+     */
+    tokenSymbol: string;
+    /**
+     * The token value in the transaction.
+     */
+    tokenAmount?: number | string;
+    /**
+     * The type of transaction.
+     * @default TransactionType.ACTION
+     */
+    type?: TransactionTransferType;
+    /**
+     * Executor labels are only rendered for `TransactionType.EXECUTION` transactions.
+     */
+    label?: never;
+    /**
+     * Action counts are only rendered for `TransactionType.EXECUTION` transactions.
+     */
+    actionCount?: never;
+};
+export type ITransactionDataListItemExecutionProps = TransactionDataListItemBaseProps & {
+    /**
+     * Execution transaction type.
+     */
+    type: TransactionType.EXECUTION;
+    /**
+     * Label of the executor for `TransactionType.EXECUTION` transactions, rendered as `Executed {label}`. Accepts a
+     * human-readable plugin name (e.g. 'Token Voting') or an address, which gets truncated automatically.
+     */
+    label?: string;
+    /**
+     * Number of actions bundled in a `TransactionType.EXECUTION` transaction. Rendered as the right-side value
+     * (e.g. '5 actions') in place of the token amount.
+     */
+    actionCount: number;
+    /**
+     * Token amounts are not rendered for execution transactions.
+     */
+    tokenAmount?: never;
+    /**
+     * Token symbols are not rendered for execution transactions.
+     */
+    tokenSymbol?: never;
+};
+export type ITransactionDataListItemProps = ITransactionDataListItemTransferProps | ITransactionDataListItemExecutionProps;
+export {};

package/dist/types/src/modules/components/transaction/transactionDetail/index.d.ts

@@ -0,0 +1,4 @@
+export declare const TransactionDetail: {
+    Root: import("react").FC<import("./transactionDetailRoot").ITransactionDetailRootProps>;
+};
+export * from './transactionDetailRoot';

package/dist/types/src/modules/components/transaction/transactionDetail/transactionDetailRoot/index.d.ts

@@ -0,0 +1 @@
+export * from './transactionDetailRoot';

package/dist/types/src/modules/components/transaction/transactionDetail/transactionDetailRoot/transactionDetailRoot.d.ts

@@ -0,0 +1,17 @@
+import type { ComponentPropsWithoutRef } from 'react';
+export interface ITransactionDetailRootProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Title displayed in the dialog header. Defaults to the localized "Executed" copy.
+     */
+    title?: string;
+    /**
+     * Callback triggered on close-button click. The close button is hidden when the property is not set.
+     */
+    onClose?: () => void;
+}
+/**
+ * The `<TransactionDetail.Root />` component renders the dialog header and the scrollable content shell of an
+ * execution detail dialog. Compose it with `<TransactionDetailSummary />` and an action-list component such as
+ * `<ProposalActions />` for decoded execution actions. It must be rendered inside a `<Dialog.Root />`.
+ */
+export declare const TransactionDetailRoot: React.FC<ITransactionDetailRootProps>;

package/dist/types/src/modules/components/transaction/transactionDetailSummary/index.d.ts

@@ -0,0 +1,2 @@
+export { TransactionDetailSummary } from './transactionDetailSummary';
+export type * from './transactionDetailSummary.api';

package/dist/types/src/modules/components/transaction/transactionDetailSummary/transactionDetailSummary.api.d.ts

@@ -0,0 +1,60 @@
+import type { ComponentPropsWithoutRef } from 'react';
+import type { Hash } from 'viem';
+/**
+ * Entity that executed the transaction, rendered on the `Executed by` row.
+ *
+ * The three states from the design map onto these fields:
+ * - Not an active-process execution: set `label` (plugin name or address) and `address`; omit `href` so the label
+ *   links to the block explorer, and omit `helptext`.
+ * - Active-process execution: set `label` to the process name, `helptext` to the plugin name and version (e.g.
+ *   'SPP v1.3') and `href` to the process detail page.
+ */
+export interface ITransactionDetailSummaryExecutedBy {
+    /**
+     * Address of the executor. Builds the block-explorer link (unless `href` is set) and the copy button, and is used
+     * as the label (truncated) when `label` is not provided.
+     */
+    address?: string;
+    /**
+     * Label displayed for the executor (e.g. a process or plugin name). Defaults to the truncated `address`.
+     */
+    label?: string;
+    /**
+     * Helptext displayed below the label (e.g. the plugin name and version, 'SPP v1.3'). Hidden when not provided.
+     */
+    helptext?: string;
+    /**
+     * Internal link applied to the label (e.g. the process detail page). Takes precedence over the block-explorer link.
+     */
+    href?: string;
+}
+export interface ITransactionDetailSummaryProps extends ComponentPropsWithoutRef<'dl'> {
+    /**
+     * Chain ID of the transaction, used to build the block-explorer links.
+     */
+    chainId: number;
+    /**
+     * Entity that executed the transaction, rendered on the `Executed by` row.
+     */
+    executedBy: ITransactionDetailSummaryExecutedBy;
+    /**
+     * Identifier of the proposal that triggered the execution (e.g. 'CRE-54'). The row is omitted when not set.
+     */
+    proposalId?: string;
+    /**
+     * Internal link applied to the proposal identifier (e.g. the proposal detail page).
+     */
+    proposalHref?: string;
+    /**
+     * Total number of actions bundled in the execution.
+     */
+    totalActions: number;
+    /**
+     * Hash of the execution transaction. Rendered truncated with an explorer link and a copy button.
+     */
+    transactionHash: Hash;
+    /**
+     * Date of the execution in ISO format or as a timestamp.
+     */
+    date: number | string;
+}

package/dist/types/src/modules/components/transaction/transactionDetailSummary/transactionDetailSummary.d.ts

@@ -0,0 +1,2 @@
+import type { ITransactionDetailSummaryProps } from './transactionDetailSummary.api';
+export declare const TransactionDetailSummary: React.FC<ITransactionDetailSummaryProps>;

package/dist/types/src/modules/utils/addressUtils/addressUtils.d.ts

@@ -20,6 +20,13 @@ declare class AddressUtils {
      * @returns The truncated address when the address input is valid, the address input as is otherwise.
      */
     truncateAddress: (address?: string) => string;
+    /**
+     * Truncates the input hash (e.g. a merkle root, transaction or block hash) by displaying the first 10 and last 8 characters.
+     * @param hash The 32-byte hash to truncate
+     * @returns The truncated hash when the input is a valid 32-byte hash, the input as is otherwise.
+     */
+    truncateHash: (hash?: string) => string;
+    private truncate;
     /**
      * Returns the address on its checksum format
      * @param address The address to be formatted

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aragon/gov-ui-kit",
-  "version": "2.5.2",
+  "version": "2.7.0",
   "description": "Implementation of the Aragon's Governance UI Kit",
   "main": "dist/index.es.js",
   "types": "dist/types/src/index.d.ts",
@@ -130,7 +130,7 @@
     "vite-plugin-static-copy": "^4.1.0",
     "vite-plugin-svgr": "^5.2.0",
     "wagmi": "^3.6.14",
-    "zod": "^3.25.76"
+    "zod": "^4.4.3"
   },
   "bugs": {
     "url": "https://github.com/aragon/gov-ui-kit/issues"