@orderly.network/portfolio 2.0.1-alpha.6 → 2.0.1-alpha.8

package/dist/index.d.mts

@@ -1,11 +1,36 @@
+import { FC, PropsWithChildren } from 'react';
+import { LayoutProps, SideBarProps, SideMenuItem } from '@orderly.network/ui-scaffold';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _orderly_network_types from '@orderly.network/types';
 import { API } from '@orderly.network/types';
-import { TableColumn, PaginationMeta } from '@orderly.network/ui';
-import * as react from 'react';
-import { FC, PropsWithChildren } from 'react';
-import { LayoutProps } from '@orderly.network/ui-scaffold';
+import * as _orderly_network_ui from '@orderly.network/ui';
+import { Column } from '@orderly.network/ui';
 import { PositionsProps } from '@orderly.network/ui-positions';
+import { SharePnLConfig, SharePnLParams } from '@orderly.network/ui-share';
+
+type PortfolioLayoutProps = LayoutProps & {
+    hideSideBar?: boolean;
+    /** @deprecated use leftSideProps.items instead */
+    items?: SideBarProps["items"];
+};
+declare const PortfolioLayout: FC<PropsWithChildren<PortfolioLayoutProps>>;
+
+type PortfolioLayoutWidgetProps = PortfolioLayoutProps;
+declare const PortfolioLayoutWidget: FC<PropsWithChildren<PortfolioLayoutWidgetProps>>;
+
+type UseLayoutBuilderOptions = {
+    current?: string;
+};
+declare const usePortfolioLayoutScript: (props: UseLayoutBuilderOptions) => {
+    items: {
+        name: string;
+        href: string;
+        icon: react_jsx_runtime.JSX.Element;
+    }[];
+    current: string;
+    hideSideBar: boolean;
+    onItemSelect: (item: SideMenuItem) => void;
+};
 
 type Props = {
     connected?: boolean;
@@ -68,16 +93,10 @@ declare const useAssetsLineChartScript: () => {
 
 declare const HistoryDataGroupWidget: () => react_jsx_runtime.JSX.Element;
 
-declare const useAssetHistoryColumns: () => TableColumn[];
+declare const useAssetHistoryColumns: () => Column[];
 
 declare const useAssetHistoryHook: () => {
     dataSource: _orderly_network_types.API.AssetHistoryRow[];
-    meta: {
-        count: number;
-        page: number;
-        pageSize: number;
-        pageTotal: number;
-    };
     total: number | undefined;
     isLoading: boolean;
     queryParameter: {
@@ -88,9 +107,7 @@ declare const useAssetHistoryHook: () => {
         name: string;
         value: any;
     }) => void;
-    setPage: react.Dispatch<react.SetStateAction<number>>;
-    setPageSize: (size: number) => void;
-    pagination: PaginationMeta;
+    pagination: _orderly_network_ui.PaginationMeta;
 };
 
 type UseAssetHistoryReturn = ReturnType<typeof useAssetHistoryHook>;
@@ -142,12 +159,6 @@ declare const useFundingHistoryHook: () => {
     readonly dataSource: (_orderly_network_types.API.FundingFeeRow & {
         annual_rate: number;
     })[] | null;
-    readonly meta: {
-        count: number;
-        page: number;
-        pageSize: number;
-        pageTotal: number;
-    };
     readonly isLoading: boolean;
     readonly isValidating: boolean;
     readonly queryParameter: {
@@ -158,12 +169,10 @@ declare const useFundingHistoryHook: () => {
         name: string;
         value: any;
     }) => void;
-    readonly setPage: react.Dispatch<react.SetStateAction<number>>;
-    readonly setPageSize: (size: number) => void;
-    readonly pagination: PaginationMeta;
+    readonly pagination: _orderly_network_ui.PaginationMeta;
 };
 
-declare const useFundingHistoryColumns: () => TableColumn<API.FundingFeeRow & {
+declare const useFundingHistoryColumns: () => Column<API.FundingFeeRow & {
     annual_rate: number;
 }>[];
 
@@ -173,12 +182,6 @@ declare const useDistributionHistoryHook: () => {
     readonly dataSource: (_orderly_network_types.API.FundingFeeRow & {
         annual_rate: number;
     })[];
-    readonly meta: {
-        count: number;
-        page: number;
-        pageSize: number;
-        pageTotal: number;
-    };
     readonly isLoading: boolean;
     readonly isValidating: boolean;
     readonly queryParameter: {
@@ -189,9 +192,7 @@ declare const useDistributionHistoryHook: () => {
         name: string;
         value: any;
     }) => void;
-    readonly setPage: react.Dispatch<react.SetStateAction<number>>;
-    readonly setPageSize: (size: number) => void;
-    readonly pagination: PaginationMeta;
+    readonly pagination: _orderly_network_ui.PaginationMeta;
 };
 type useDistributionHistoryHookReturn = ReturnType<typeof useDistributionHistoryHook>;
 
@@ -227,11 +228,9 @@ declare namespace index$3 {
   export { index$3_AssetHistory as AssetHistory, index$3_AssetHistoryWidget as AssetHistoryWidget, index$3_AssetWidget as AssetWidget, index$3_AssetsChartWidget as AssetsChartWidget, index$3_AssetsUI as AssetsUI, index$3_DistributionHistoryUI as DistributionHistoryUI, index$3_DistributionHistoryWidget as DistributionHistoryWidget, index$3_FundingHistoryWidget as FundingHistoryWidget, index$3_HistoryDataGroupWidget as HistoryDataGroupWidget, index$3_OverviewContextProvider as OverviewContextProvider, index$3_OverviewPage as OverviewPage, index$3_PerformanceUI as PerformanceUI, index$3_PerformanceWidget as PerformanceWidget, index$3_useAssetHistoryColumns as useAssetHistoryColumns, index$3_useAssetHistoryHook as useAssetHistoryHook, index$3_useAssetsLineChartScript as useAssetsLineChartScript, index$3_useFundingHistoryColumns as useFundingHistoryColumns, index$3_useFundingHistoryHook as useFundingHistoryHook, index$3_usePerformanceScript as usePerformanceScript };
 }
 
-declare const PortfolioLayoutWidget: (props: PropsWithChildren<LayoutProps>) => react_jsx_runtime.JSX.Element;
-
 type UseFeeTierScriptOptions = {
-    dataAdapter?: (columns: TableColumn[], dataSource: any[]) => {
-        columns: TableColumn[];
+    dataAdapter?: (columns: Column[], dataSource: any[]) => {
+        columns: Column[];
         dataSource: any[];
     };
     onRow?: (record: any, index: number) => {
@@ -257,16 +256,30 @@ declare namespace page$1 {
   export { page$1_PositionsPage as PositionsPage };
 }
 
-declare const OrdersPage: () => react_jsx_runtime.JSX.Element;
+declare const OrdersPage: (props: {
+    sharePnLConfig?: SharePnLConfig & Partial<Omit<SharePnLParams, "position" | "refCode" | "leverage">>;
+}) => react_jsx_runtime.JSX.Element;
 
 declare const page_OrdersPage: typeof OrdersPage;
 declare namespace page {
   export { page_OrdersPage as OrdersPage };
 }
 
-declare const APIManagerWidget: () => react_jsx_runtime.JSX.Element;
+declare const APIManagerWidget: (props?: {
+    filterTags?: [string];
+    keyStatus?: string;
+}) => react_jsx_runtime.JSX.Element;
 
-declare const APIManagerPage: () => react_jsx_runtime.JSX.Element;
+/**
+ * API key manager page
+ * @param filterTags filterTags
+ * @param keyStatus filterTags default is "ACTIVE"
+ * @returns
+ */
+declare const APIManagerPage: (props: {
+    filterTags?: [string];
+    keyStatus?: string;
+}) => react_jsx_runtime.JSX.Element;
 
 declare const index$1_APIManagerPage: typeof APIManagerPage;
 declare const index$1_APIManagerWidget: typeof APIManagerWidget;
@@ -284,4 +297,4 @@ declare namespace index {
   export { index_SettingPage as SettingPage, index_SettingWidget as SettingWidget };
 }
 
-export { index$1 as APIManagerModule, index$2 as FeeTierModule, page as OrdersModule, index$3 as OverviewModule, PortfolioLayoutWidget, page$1 as PositionsModule, index as SettingModule };
+export { index$1 as APIManagerModule, index$2 as FeeTierModule, page as OrdersModule, index$3 as OverviewModule, PortfolioLayout, type PortfolioLayoutProps, PortfolioLayoutWidget, type PortfolioLayoutWidgetProps, page$1 as PositionsModule, index as SettingModule, usePortfolioLayoutScript };

package/dist/index.d.ts

@@ -1,11 +1,36 @@
+import { FC, PropsWithChildren } from 'react';
+import { LayoutProps, SideBarProps, SideMenuItem } from '@orderly.network/ui-scaffold';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _orderly_network_types from '@orderly.network/types';
 import { API } from '@orderly.network/types';
-import { TableColumn, PaginationMeta } from '@orderly.network/ui';
-import * as react from 'react';
-import { FC, PropsWithChildren } from 'react';
-import { LayoutProps } from '@orderly.network/ui-scaffold';
+import * as _orderly_network_ui from '@orderly.network/ui';
+import { Column } from '@orderly.network/ui';
 import { PositionsProps } from '@orderly.network/ui-positions';
+import { SharePnLConfig, SharePnLParams } from '@orderly.network/ui-share';
+
+type PortfolioLayoutProps = LayoutProps & {
+    hideSideBar?: boolean;
+    /** @deprecated use leftSideProps.items instead */
+    items?: SideBarProps["items"];
+};
+declare const PortfolioLayout: FC<PropsWithChildren<PortfolioLayoutProps>>;
+
+type PortfolioLayoutWidgetProps = PortfolioLayoutProps;
+declare const PortfolioLayoutWidget: FC<PropsWithChildren<PortfolioLayoutWidgetProps>>;
+
+type UseLayoutBuilderOptions = {
+    current?: string;
+};
+declare const usePortfolioLayoutScript: (props: UseLayoutBuilderOptions) => {
+    items: {
+        name: string;
+        href: string;
+        icon: react_jsx_runtime.JSX.Element;
+    }[];
+    current: string;
+    hideSideBar: boolean;
+    onItemSelect: (item: SideMenuItem) => void;
+};
 
 type Props = {
     connected?: boolean;
@@ -68,16 +93,10 @@ declare const useAssetsLineChartScript: () => {
 
 declare const HistoryDataGroupWidget: () => react_jsx_runtime.JSX.Element;
 
-declare const useAssetHistoryColumns: () => TableColumn[];
+declare const useAssetHistoryColumns: () => Column[];
 
 declare const useAssetHistoryHook: () => {
     dataSource: _orderly_network_types.API.AssetHistoryRow[];
-    meta: {
-        count: number;
-        page: number;
-        pageSize: number;
-        pageTotal: number;
-    };
     total: number | undefined;
     isLoading: boolean;
     queryParameter: {
@@ -88,9 +107,7 @@ declare const useAssetHistoryHook: () => {
         name: string;
         value: any;
     }) => void;
-    setPage: react.Dispatch<react.SetStateAction<number>>;
-    setPageSize: (size: number) => void;
-    pagination: PaginationMeta;
+    pagination: _orderly_network_ui.PaginationMeta;
 };
 
 type UseAssetHistoryReturn = ReturnType<typeof useAssetHistoryHook>;
@@ -142,12 +159,6 @@ declare const useFundingHistoryHook: () => {
     readonly dataSource: (_orderly_network_types.API.FundingFeeRow & {
         annual_rate: number;
     })[] | null;
-    readonly meta: {
-        count: number;
-        page: number;
-        pageSize: number;
-        pageTotal: number;
-    };
     readonly isLoading: boolean;
     readonly isValidating: boolean;
     readonly queryParameter: {
@@ -158,12 +169,10 @@ declare const useFundingHistoryHook: () => {
         name: string;
         value: any;
     }) => void;
-    readonly setPage: react.Dispatch<react.SetStateAction<number>>;
-    readonly setPageSize: (size: number) => void;
-    readonly pagination: PaginationMeta;
+    readonly pagination: _orderly_network_ui.PaginationMeta;
 };
 
-declare const useFundingHistoryColumns: () => TableColumn<API.FundingFeeRow & {
+declare const useFundingHistoryColumns: () => Column<API.FundingFeeRow & {
     annual_rate: number;
 }>[];
 
@@ -173,12 +182,6 @@ declare const useDistributionHistoryHook: () => {
     readonly dataSource: (_orderly_network_types.API.FundingFeeRow & {
         annual_rate: number;
     })[];
-    readonly meta: {
-        count: number;
-        page: number;
-        pageSize: number;
-        pageTotal: number;
-    };
     readonly isLoading: boolean;
     readonly isValidating: boolean;
     readonly queryParameter: {
@@ -189,9 +192,7 @@ declare const useDistributionHistoryHook: () => {
         name: string;
         value: any;
     }) => void;
-    readonly setPage: react.Dispatch<react.SetStateAction<number>>;
-    readonly setPageSize: (size: number) => void;
-    readonly pagination: PaginationMeta;
+    readonly pagination: _orderly_network_ui.PaginationMeta;
 };
 type useDistributionHistoryHookReturn = ReturnType<typeof useDistributionHistoryHook>;
 
@@ -227,11 +228,9 @@ declare namespace index$3 {
   export { index$3_AssetHistory as AssetHistory, index$3_AssetHistoryWidget as AssetHistoryWidget, index$3_AssetWidget as AssetWidget, index$3_AssetsChartWidget as AssetsChartWidget, index$3_AssetsUI as AssetsUI, index$3_DistributionHistoryUI as DistributionHistoryUI, index$3_DistributionHistoryWidget as DistributionHistoryWidget, index$3_FundingHistoryWidget as FundingHistoryWidget, index$3_HistoryDataGroupWidget as HistoryDataGroupWidget, index$3_OverviewContextProvider as OverviewContextProvider, index$3_OverviewPage as OverviewPage, index$3_PerformanceUI as PerformanceUI, index$3_PerformanceWidget as PerformanceWidget, index$3_useAssetHistoryColumns as useAssetHistoryColumns, index$3_useAssetHistoryHook as useAssetHistoryHook, index$3_useAssetsLineChartScript as useAssetsLineChartScript, index$3_useFundingHistoryColumns as useFundingHistoryColumns, index$3_useFundingHistoryHook as useFundingHistoryHook, index$3_usePerformanceScript as usePerformanceScript };
 }
 
-declare const PortfolioLayoutWidget: (props: PropsWithChildren<LayoutProps>) => react_jsx_runtime.JSX.Element;
-
 type UseFeeTierScriptOptions = {
-    dataAdapter?: (columns: TableColumn[], dataSource: any[]) => {
-        columns: TableColumn[];
+    dataAdapter?: (columns: Column[], dataSource: any[]) => {
+        columns: Column[];
         dataSource: any[];
     };
     onRow?: (record: any, index: number) => {
@@ -257,16 +256,30 @@ declare namespace page$1 {
   export { page$1_PositionsPage as PositionsPage };
 }
 
-declare const OrdersPage: () => react_jsx_runtime.JSX.Element;
+declare const OrdersPage: (props: {
+    sharePnLConfig?: SharePnLConfig & Partial<Omit<SharePnLParams, "position" | "refCode" | "leverage">>;
+}) => react_jsx_runtime.JSX.Element;
 
 declare const page_OrdersPage: typeof OrdersPage;
 declare namespace page {
   export { page_OrdersPage as OrdersPage };
 }
 
-declare const APIManagerWidget: () => react_jsx_runtime.JSX.Element;
+declare const APIManagerWidget: (props?: {
+    filterTags?: [string];
+    keyStatus?: string;
+}) => react_jsx_runtime.JSX.Element;
 
-declare const APIManagerPage: () => react_jsx_runtime.JSX.Element;
+/**
+ * API key manager page
+ * @param filterTags filterTags
+ * @param keyStatus filterTags default is "ACTIVE"
+ * @returns
+ */
+declare const APIManagerPage: (props: {
+    filterTags?: [string];
+    keyStatus?: string;
+}) => react_jsx_runtime.JSX.Element;
 
 declare const index$1_APIManagerPage: typeof APIManagerPage;
 declare const index$1_APIManagerWidget: typeof APIManagerWidget;
@@ -284,4 +297,4 @@ declare namespace index {
   export { index_SettingPage as SettingPage, index_SettingWidget as SettingWidget };
 }
 
-export { index$1 as APIManagerModule, index$2 as FeeTierModule, page as OrdersModule, index$3 as OverviewModule, PortfolioLayoutWidget, page$1 as PositionsModule, index as SettingModule };
+export { index$1 as APIManagerModule, index$2 as FeeTierModule, page as OrdersModule, index$3 as OverviewModule, PortfolioLayout, type PortfolioLayoutProps, PortfolioLayoutWidget, type PortfolioLayoutWidgetProps, page$1 as PositionsModule, index as SettingModule, usePortfolioLayoutScript };