@aragon/gov-ui-kit 1.0.49

package/dist/types/src/core/components/tooltip/tooltip.d.ts

@@ -0,0 +1,44 @@
+import type React from 'react';
+import { type ReactNode } from 'react';
+export type TooltipVariant = 'neutral' | 'info' | 'warning' | 'critical' | 'success';
+export interface ITooltipProps {
+    /**
+     * Content of the tooltip
+     */
+    content: ReactNode;
+    /**
+     * Defines the variant of the tooltip
+     * @default neutral
+     */
+    variant?: TooltipVariant;
+    /**
+     * The open state of the tooltip when it is initially rendered. Use when you do not need to control its open state.
+     */
+    defaultOpen?: boolean;
+    /**
+     * The controlled open state of the tooltip. Must be used in conjunction with `onOpenChange`.
+     */
+    open?: boolean;
+    /**
+     * Event handler called when the open state of the tooltip changes.
+     */
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * The duration from when the mouse enters the trigger until the tooltip opens.
+     * @default 300
+     */
+    delayDuration?: number;
+    /**
+     * When `true`, hovering the content will keep the tooltip open.
+     */
+    disableHoverableContent?: boolean;
+    /**
+     * Additional class names for the tooltip content.
+     */
+    className?: string;
+    /**
+     * Children elements to trigger the tooltip.
+     */
+    children?: ReactNode;
+}
+export declare const Tooltip: React.FC<ITooltipProps>;

package/dist/types/src/core/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useDebouncedValue';
+export * from './useRandomId';

package/dist/types/src/core/hooks/useDebouncedValue/index.d.ts

@@ -0,0 +1 @@
+export { useDebouncedValue, type IUseDebouncedValueParams, type IUseDebouncedValueResult } from './useDebouncedValue';

package/dist/types/src/core/hooks/useDebouncedValue/useDebouncedValue.d.ts

@@ -0,0 +1,18 @@
+export interface IUseDebouncedValueParams {
+    /**
+     * Debounce time period in milliseconds.
+     * @default 500
+     */
+    delay?: number;
+}
+export type IUseDebouncedValueResult<TValue> = [
+    /**
+     * Debounced value.
+     */
+    TValue,
+    /**
+     * Setter for the debounced value.
+     */
+    (value: TValue) => void
+];
+export declare const useDebouncedValue: <TValue>(value: TValue, params?: IUseDebouncedValueParams) => IUseDebouncedValueResult<TValue>;

package/dist/types/src/core/hooks/useRandomId/index.d.ts

@@ -0,0 +1 @@
+export { useRandomId } from './useRandomId';

package/dist/types/src/core/hooks/useRandomId/useRandomId.d.ts

@@ -0,0 +1 @@
+export declare const useRandomId: (id?: string) => string;

package/dist/types/src/core/index.d.ts

@@ -0,0 +1,5 @@
+export * from './assets';
+export * from './components';
+export * from './hooks';
+export * from './types';
+export * from './utils';

package/dist/types/src/core/test/globalSetup.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => void;
+export default _default;

package/dist/types/src/core/test/index.d.ts

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

package/dist/types/src/core/test/setup.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/types/src/core/test/utils/createRangeMock.d.ts

@@ -0,0 +1 @@
+export declare const createRangeMock: () => void;

package/dist/types/src/core/test/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { createRangeMock } from './createRangeMock';
+export { testLogger } from './testLogger';

package/dist/types/src/core/test/utils/testLogger.d.ts

@@ -0,0 +1,9 @@
+declare class TestLogger {
+    private shouldSuppressErrors;
+    private originalConsoleError;
+    private testErrorLogger;
+    setup: () => void;
+    suppressErrors: () => void;
+}
+export declare const testLogger: TestLogger;
+export {};

package/dist/types/src/core/types/index.d.ts

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

package/dist/types/src/core/types/responsive.d.ts

@@ -0,0 +1,33 @@
+export type Breakpoint = 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
+/**
+ * Size key of a component that is responsive.
+ */
+export type ResponsiveSizeKey = string | symbol | number;
+/**
+ * Defines the component property which is responsive.
+ */
+export type ResponsiveAttribute<TSize> = Partial<Record<Breakpoint, TSize>>;
+/**
+ * Defines the structure to build the responsive classes for each breakpoint.
+ *
+ * Example:
+ *
+ * type ButtonSize = 'big' | 'small';
+ * type Breakpoint = 'default' | 'sm' | 'md' | 'lg';
+ *
+ * const responsiveButtonSizeClassNames: ResponsiveAttributeClassMap<ButtonSize> = {
+ *      'big': {
+ *          'default': 'w-40',
+ *          'sm': 'sm:w-40',
+ *          'md': 'md:w-40',
+ *          'lg': 'lg:w-40',
+ *      },
+ *      'small': {
+ *          'default': 'w-20',
+ *          'sm': 'sm:w-20',
+ *          'md': 'md:w-20',
+ *          'lg': 'lg-w-20',
+ *      }
+ * }
+ */
+export type ResponsiveAttributeClassMap<TSize extends ResponsiveSizeKey> = Record<TSize, Record<Breakpoint, string>>;

package/dist/types/src/core/utils/clipboardUtils/clipboardUtils.d.ts

@@ -0,0 +1,12 @@
+export interface IClipboardUtilsParams {
+    /**
+     * Callback called on paste error.
+     */
+    onError?: (error: unknown) => void;
+}
+declare class ClipboardUtils {
+    copy: (value: string, params?: IClipboardUtilsParams) => Promise<void>;
+    paste: (params?: IClipboardUtilsParams) => Promise<string>;
+}
+export declare const clipboardUtils: ClipboardUtils;
+export {};

package/dist/types/src/core/utils/clipboardUtils/index.d.ts

@@ -0,0 +1 @@
+export { clipboardUtils, type IClipboardUtilsParams } from './clipboardUtils';

package/dist/types/src/core/utils/formatterUtils/formatterUtils.d.ts

@@ -0,0 +1,32 @@
+import { DateTime } from 'luxon';
+import { DateFormat, NumberFormat, type INumberFormat } from './formatterUtilsDefinitions';
+export interface IFormatNumberOptions extends INumberFormat {
+    /**
+     * Number format to use.
+     * @default GENERIC_LONG
+     */
+    format?: NumberFormat;
+}
+export interface IFormatDateOptions {
+    /**
+     * Date format to use.
+     * @default YEAR_MONTH_DAY_TIME
+     */
+    format?: DateFormat;
+}
+declare class FormatterUtils {
+    numberLocale: string;
+    dateLocale: string;
+    currencyLocale: string;
+    private baseSymbolRanges;
+    private relativeDateOrder;
+    formatNumber: (value: number | string | null | undefined, options?: IFormatNumberOptions) => string | null;
+    formatDate: (value: DateTime | number | string | undefined, options?: IFormatDateOptions) => string | null;
+    private isYesterdayTodayTomorrow;
+    private getDateLiteral;
+    private getDynamicOption;
+    private getDecimalPlaces;
+    private significantDigitsToFractionDigits;
+}
+export declare const formatterUtils: FormatterUtils;
+export {};

package/dist/types/src/core/utils/formatterUtils/formatterUtilsDefinitions.d.ts

@@ -0,0 +1,82 @@
+import { type DateTimeFormatOptions } from 'luxon';
+export type DynamicOptionFunction<TValue, TOptionValue> = (value: TValue) => TOptionValue | undefined;
+export type DynamicOption<TValue = number, TOptionValue extends string | number | boolean = number> = TOptionValue | DynamicOptionFunction<TValue, TOptionValue>;
+export interface INumberFormat {
+    /**
+     * Fixed fraction digits to use to format the number.
+     */
+    fixedFractionDigits?: DynamicOption;
+    /**
+     * Maximum fraction digits to use to format the number.
+     */
+    maxFractionDigits?: number;
+    /**
+     * Maximum number of significant digits displayed.
+     */
+    maxSignificantDigits?: DynamicOption;
+    /**
+     * Minimum fraction digits to use to format the number.
+     */
+    minFractionDigits?: number;
+    /**
+     * Uses the base symbol (K, M, B, T) when set to true.
+     */
+    useBaseSymbol?: boolean;
+    /**
+     * Format the number with the default currency when set to true.
+     */
+    isCurrency?: boolean;
+    /**
+     * Format the number as a percentage when set to true.
+     */
+    isPercentage?: boolean;
+    /**
+     * Always displays the number sign on the formatted number when set to true.
+     */
+    withSign?: boolean;
+    /**
+     * Fallback to display in case the value is null.
+     */
+    fallback?: string;
+    /**
+     * Displays the specified fallback when this function returns true, by default the formatter will display
+     * the fallback when the value is NaN.
+     */
+    displayFallback?: (value: number) => boolean;
+}
+export declare enum NumberFormat {
+    GENERIC_SHORT = "GENERIC_SHORT",
+    GENERIC_LONG = "GENERIC_LONG",
+    FIAT_TOTAL_SHORT = "FIAT_TOTAL_SHORT",
+    FIAT_TOTAL_LONG = "FIAT_TOTAL_LONG",
+    TOKEN_AMOUNT_SHORT = "TOKEN_AMOUNT_SHORT",
+    TOKEN_AMOUNT_LONG = "TOKEN_AMOUNT_LONG",
+    TOKEN_PRICE = "TOKEN_PRICE",
+    PERCENTAGE_SHORT = "PERCENTAGE_SHORT",
+    PERCENTAGE_LONG = "PERCENTAGE_LONG"
+}
+export declare const numberFormats: Record<NumberFormat, INumberFormat>;
+export declare enum DateFormat {
+    YEAR_MONTH_DAY_TIME = "YEAR_MONTH_DAY_TIME",
+    YEAR_MONTH_DAY = "YEAR_MONTH_DAY",
+    YEAR_MONTH = "YEAR_MONTH",
+    DURATION = "DURATION",
+    RELATIVE = "RELATIVE"
+}
+export interface IDateFormat extends DateTimeFormatOptions {
+    /**
+     * Formats the date as relative calendar (yesterday, today, tomorrow, ..) when set to true. The date is formatted
+     * to a relative date only when the specified date is either yesterday, today or tomorrow. When the option is set
+     * to "with-time", the time is also added to the relative date.
+     */
+    useRelativeCalendar?: 'default' | 'with-time';
+    /**
+     * Formats the date as relative (1 day ago, in 2 days, 2 hours ago, ..) when set to true.
+     */
+    useRelativeDate?: boolean;
+    /**
+     * Returns the absolute date diff using the biggest unit greater than 1 (1 day, 7 hours, 22 seconds) when set to true.
+     */
+    isDuration?: boolean;
+}
+export declare const dateFormats: Record<DateFormat, IDateFormat>;

package/dist/types/src/core/utils/formatterUtils/index.d.ts

@@ -0,0 +1,2 @@
+export { formatterUtils, type IFormatDateOptions, type IFormatNumberOptions } from './formatterUtils';
+export { DateFormat, NumberFormat, dateFormats, numberFormats, type IDateFormat, type INumberFormat, } from './formatterUtilsDefinitions';

package/dist/types/src/core/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './clipboardUtils';
+export * from './formatterUtils';
+export * from './invariant';
+export * from './mergeRefs';
+export * from './responsiveUtils';
+export * from './ssrUtils';

package/dist/types/src/core/utils/invariant/index.d.ts

@@ -0,0 +1 @@
+export { invariant, invariantError } from './invariant';

package/dist/types/src/core/utils/invariant/invariant.d.ts

@@ -0,0 +1,2 @@
+export declare const invariantError = "Invariant";
+export declare function invariant(condition: boolean, message: string): asserts condition;

package/dist/types/src/core/utils/mergeRefs/index.d.ts

@@ -0,0 +1 @@
+export { mergeRefs } from './mergeRefs';

package/dist/types/src/core/utils/mergeRefs/mergeRefs.d.ts

@@ -0,0 +1,5 @@
+import type { LegacyRef, MutableRefObject, RefCallback } from 'react';
+/**
+ * Utility to merge multiple React refs, inspired by https://github.com/gregberge/react-merge-refs
+ */
+export declare const mergeRefs: <T = unknown>(refs: Array<MutableRefObject<T> | LegacyRef<T> | undefined | null>) => RefCallback<T>;

package/dist/types/src/core/utils/responsiveUtils/index.d.ts

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

package/dist/types/src/core/utils/responsiveUtils/responsiveUtils.d.ts

@@ -0,0 +1,6 @@
+import type { ResponsiveAttribute, ResponsiveAttributeClassMap, ResponsiveSizeKey } from '../../types';
+declare class ResponsiveUtils {
+    generateClassNames<TSize extends ResponsiveSizeKey>(size: TSize, responsiveSize: ResponsiveAttribute<TSize> | undefined, classes: ResponsiveAttributeClassMap<TSize>): string;
+}
+export declare const responsiveUtils: ResponsiveUtils;
+export {};

package/dist/types/src/core/utils/ssrUtils/index.d.ts

@@ -0,0 +1 @@
+export { ssrUtils } from './ssrUtils';

package/dist/types/src/core/utils/ssrUtils/ssrUtils.d.ts

@@ -0,0 +1,8 @@
+declare class SsrUtils {
+    /**
+     * Checks if code is running on a server environment.
+     */
+    isServer: () => boolean;
+}
+export declare const ssrUtils: SsrUtils;
+export {};

package/dist/types/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './core';
+export * from './modules';

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

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

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

@@ -0,0 +1,170 @@
+/**
+ * Object representing the structure of copy texts used in various parts of the GovKit Modules package.
+ * Each property in the object corresponds to a specific component or feature, containing the necessary
+ * text labels or functions that return text strings.
+ */
+export declare const modulesCopy: {
+    addressInput: {
+        clear: string;
+        paste: string;
+    };
+    assetDataListItemStructure: {
+        unknown: string;
+    };
+    memberDataListItemStructure: {
+        yourDelegate: string;
+        you: string;
+        delegations: string;
+        votingPower: string;
+    };
+    approvalThresholdResult: {
+        stage: string;
+        outOf: (threshold: string) => string;
+    };
+    majorityVotingResult: {
+        winningOption: string;
+        stage: string;
+    };
+    proposalActionsContainer: {
+        collapse: string;
+        expand: string;
+        empty: {
+            heading: string;
+        };
+    };
+    proposalActionsAction: {
+        dropdownLabel: string;
+        notVerified: string;
+        nativeSendAlert: string;
+        nativeSendDescription: (amount: string) => string;
+    };
+    proposalActionsActionDecodedView: {
+        valueHelper: string;
+        valueLabel: string;
+    };
+    proposalActionsActionRawView: {
+        to: string;
+        data: string;
+        value: string;
+        copyButton: string;
+    };
+    proposalActionsActionViewAsMenu: {
+        basic: string;
+        dropdownLabel: string;
+        decoded: string;
+        raw: string;
+    };
+    proposalActionChangeMembers: {
+        summary: string;
+        added: string;
+        removed: string;
+        members: string;
+        adjustMemberCount: {
+            addMembers: string;
+            removeMembers: string;
+        };
+        existingMembers: string;
+        blockNote: string;
+    };
+    proposalActionsChangeSettings: {
+        existingToggle: string;
+        proposedToggle: string;
+    };
+    proposalActionsUpdateMetadata: {
+        logoTerm: string;
+        nameTerm: string;
+        linkTerm: string;
+        descriptionTerm: string;
+        existingToggle: string;
+        proposedToggle: string;
+    };
+    proposalActionsTokenMint: {
+        summaryHeading: string;
+        newTokensTerm: string;
+        newHoldersTerm: string;
+        totalTokenSupplyTerm: string;
+        totalHoldersTerm: string;
+    };
+    proposalDataListItemStatus: {
+        voted: string;
+        ago: string;
+        left: string;
+        statusLabel: {
+            ACCEPTED: string;
+            ACTIVE: string;
+            CHALLENGED: string;
+            DRAFT: string;
+            EXECUTED: string;
+            EXPIRED: string;
+            FAILED: string;
+            PARTIALLY_EXECUTED: string;
+            PENDING: string;
+            EXECUTABLE: string;
+            REJECTED: string;
+            VETOED: string;
+        };
+    };
+    proposalDataListItemStructure: {
+        by: string;
+        creators: string;
+    };
+    proposalVotingTabs: {
+        breakdown: string;
+        votes: string;
+        details: string;
+    };
+    proposalVotingBreakdownMultisig: {
+        name: string;
+        description: (count: string | null) => string;
+    };
+    proposalVotingBreakdownToken: {
+        option: {
+            yes: string;
+            no: string;
+            abstain: string;
+        };
+        support: {
+            name: string;
+            description: (value: string) => string;
+        };
+        minParticipation: {
+            name: string;
+            description: (value: string) => string;
+        };
+    };
+    proposalVotingStageStatus: {
+        main: {
+            proposal: string;
+            stage: string;
+        };
+        secondary: {
+            pending: string;
+            active: string;
+            accepted: string;
+            rejected: string;
+            unreached: string;
+        };
+        status: {
+            accepted: string;
+            rejected: string;
+        };
+    };
+    proposalVotingDetails: {
+        voting: string;
+        governance: string;
+    };
+    proposalVotingStage: {
+        stage: (index: number) => string;
+    };
+    voteDataListItemStructure: {
+        yourDelegate: string;
+        you: string;
+    };
+    voteProposalDataListItemStructure: {
+        voted: string;
+    };
+    wallet: {
+        connect: string;
+    };
+};
+export type ModulesCopy = typeof modulesCopy;

package/dist/types/src/modules/assets/index.d.ts

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

package/dist/types/src/modules/components/address/addressInput/addressInput.d.ts

@@ -0,0 +1,29 @@
+import { type IInputComponentProps } from '../../../../core';
+import type { IWeb3ComponentProps } from '../../../types';
+export interface IAddressInputResolvedValue {
+    /**
+     * Address value.
+     */
+    address?: string;
+    /**
+     * ENS name linked to the given address.
+     */
+    name?: string;
+}
+export interface IAddressInputProps extends Omit<IInputComponentProps<HTMLTextAreaElement>, 'maxLength' | 'value' | 'onChange'>, IWeb3ComponentProps {
+    /**
+     * Current value of the address input.
+     */
+    value?: string;
+    /**
+     * Callback called whenever the current input value (address or ens) changes.
+     */
+    onChange?: (value?: string) => void;
+    /**
+     * Callback called with the address value object when the user input is valid. The component will output the address
+     * in checksum format and the ENS name normalised. The value will be set to undefined when the user input is not a
+     * valid address nor a valid ens name.
+     */
+    onAccept?: (value?: IAddressInputResolvedValue) => void;
+}
+export declare const AddressInput: import("react").ForwardRefExoticComponent<IAddressInputProps & import("react").RefAttributes<HTMLTextAreaElement>>;

package/dist/types/src/modules/components/address/addressInput/index.d.ts

@@ -0,0 +1 @@
+export { AddressInput, type IAddressInputProps } from './addressInput';

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

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

package/dist/types/src/modules/components/asset/assetDataListItem/assetDataListItemSkeleton/assetDataListItemSkeleton.d.ts

@@ -0,0 +1,4 @@
+import type React from 'react';
+import { type IDataListItemProps } from '../../../../../core';
+export type IAssetDataListItemSkeletonProps = IDataListItemProps;
+export declare const AssetDataListItemSkeleton: React.FC<IAssetDataListItemSkeletonProps>;

package/dist/types/src/modules/components/asset/assetDataListItem/assetDataListItemSkeleton/index.d.ts

@@ -0,0 +1 @@
+export { AssetDataListItemSkeleton, type IAssetDataListItemSkeletonProps } from './assetDataListItemSkeleton';

package/dist/types/src/modules/components/asset/assetDataListItem/assetDataListItemStructure/assetDataListItemStructure.d.ts

@@ -0,0 +1,30 @@
+import type React from 'react';
+import { type IDataListItemProps } from '../../../../../core';
+export type IAssetDataListItemStructureProps = IDataListItemProps & {
+    /**
+     * The name of the asset.
+     */
+    name: string;
+    /**
+     * The symbol of the asset.
+     */
+    symbol: string;
+    /**
+     * The amount of the asset.
+     */
+    amount: number | string;
+    /**
+     * The logo source of the asset
+     */
+    logoSrc?: string;
+    /**
+     * The fiat price of the asset.
+     */
+    fiatPrice?: number | string;
+    /**
+     * The price change in percentage of the asset.
+     * @default 0
+     */
+    priceChange?: number;
+};
+export declare const AssetDataListItemStructure: React.FC<IAssetDataListItemStructureProps>;

package/dist/types/src/modules/components/asset/assetDataListItem/assetDataListItemStructure/index.d.ts

@@ -0,0 +1 @@
+export { AssetDataListItemStructure, type IAssetDataListItemStructureProps } from './assetDataListItemStructure';

package/dist/types/src/modules/components/asset/assetDataListItem/index.d.ts

@@ -0,0 +1,6 @@
+export declare const AssetDataListItem: {
+    Structure: import("react").FC<import("./assetDataListItemStructure").IAssetDataListItemStructureProps>;
+    Skeleton: import("react").FC<import("../../../..").IDataListItemProps>;
+};
+export * from './assetDataListItemSkeleton';
+export * from './assetDataListItemStructure';

package/dist/types/src/modules/components/asset/assetTransfer/assetTransfer.d.ts

@@ -0,0 +1,36 @@
+import { type ICompositeAddress, type IWeb3ComponentProps } from '../../../types';
+export interface IAssetTransferProps extends IWeb3ComponentProps {
+    /**
+     * Sender of the transaction.
+     */
+    sender: ICompositeAddress;
+    /**
+     * Recipient of the transaction.
+     */
+    recipient: ICompositeAddress;
+    /**
+     * Name of the asset transferred.
+     */
+    assetName: string;
+    /**
+     * Icon URL of the transferred asset.
+     */
+    assetIconSrc?: string;
+    /**
+     * Asset amount that was transferred.
+     */
+    assetAmount: number | string;
+    /**
+     * Symbol of the asset transferred. Example: ETH, DAI, etc.
+     */
+    assetSymbol: string;
+    /**
+     * Price per asset in fiat.
+     */
+    assetFiatPrice?: number | string;
+    /**
+     * Transaction hash.
+     */
+    hash: string;
+}
+export declare const AssetTransfer: React.FC<IAssetTransferProps>;

package/dist/types/src/modules/components/asset/assetTransfer/assetTransferAddress/assetTransferAddress.d.ts

@@ -0,0 +1,17 @@
+import { type ICompositeAddress } from '../../../../types';
+export type TxRole = 'sender' | 'recipient';
+export interface IAssetTransferAddressProps {
+    /**
+     * Role of the transaction participant.
+     */
+    txRole: TxRole;
+    /**
+     * Participant of the transfer to display the details for.
+     */
+    participant: ICompositeAddress;
+    /**
+     * URL of the block explorer.
+     */
+    addressUrl?: string;
+}
+export declare const AssetTransferAddress: React.FC<IAssetTransferAddressProps>;