@dipansrimany/mlink-sdk 0.1.0 → 0.3.0

package/README.md

@@ -1,11 +1,11 @@
-# @mantle-blinks/sdk
+# @mlink/sdk
 
 SDK for building Mantle Blinks - shareable blockchain transaction URLs for Mantle Network.
 
 ## Installation
 
 ```bash
-npm install @mantle-blinks/sdk
+npm install @dipansrimany/mlink-sdk
 ```
 
 ## Quick Start
@@ -13,7 +13,7 @@ npm install @mantle-blinks/sdk
 ### 1. Create an Action
 
 ```typescript
-import { createAction, button, input, parseEther } from '@mantle-blinks/sdk';
+import { createAction, button, input, parseEther } from '@dipansrimany/mlink-sdk';
 
 export const tipAction = createAction({
   title: 'Tip the Developer',
@@ -46,7 +46,7 @@ export const tipAction = createAction({
 
 ```typescript
 // app/api/actions/tip/route.ts
-import { createNextHandler } from '@mantle-blinks/sdk/next';
+import { createNextHandler } from '@dipansrimany/mlink-sdk/next';
 import { tipAction } from './action';
 
 export const { GET, POST, OPTIONS } = createNextHandler(tipAction);
@@ -56,7 +56,7 @@ export const { GET, POST, OPTIONS } = createNextHandler(tipAction);
 
 ```typescript
 import express from 'express';
-import { createExpressHandler } from '@mantle-blinks/sdk/express';
+import { createExpressHandler } from '@dipansrimany/mlink-sdk/express';
 import { tipAction } from './action';
 
 const app = express();

package/dist/adapters/express.d.mts

@@ -1,5 +1,6 @@
 import { Router } from 'express';
-import { k as Action } from '../builders-OoJ5KB_g.mjs';
+import { A as Action } from '../builders-CN5ijFpW.mjs';
+import '../types-CAnUIaVe.mjs';
 
 declare function createExpressHandler(action: Action, RouterClass: new () => Router): Router;
 

package/dist/adapters/express.d.ts

@@ -1,5 +1,6 @@
 import { Router } from 'express';
-import { k as Action } from '../builders-OoJ5KB_g.js';
+import { A as Action } from '../builders-CJNt88dM.js';
+import '../types-CAnUIaVe.js';
 
 declare function createExpressHandler(action: Action, RouterClass: new () => Router): Router;
 

package/dist/adapters/next.d.mts

@@ -1,5 +1,6 @@
-import { k as Action, A as ActionMetadata, a as TransactionResponse } from '../builders-OoJ5KB_g.mjs';
+import { A as ActionMetadata, a as TransactionResponse } from '../types-CAnUIaVe.mjs';
 import { NextResponse, NextRequest } from 'next/server';
+import { A as Action } from '../builders-CN5ijFpW.mjs';
 
 declare function createNextHandler(action: Action): {
     GET: () => Promise<NextResponse<ActionMetadata> | NextResponse<{

package/dist/adapters/next.d.ts

@@ -1,5 +1,6 @@
-import { k as Action, A as ActionMetadata, a as TransactionResponse } from '../builders-OoJ5KB_g.js';
+import { A as ActionMetadata, a as TransactionResponse } from '../types-CAnUIaVe.js';
 import { NextResponse, NextRequest } from 'next/server';
+import { A as Action } from '../builders-CJNt88dM.js';
 
 declare function createNextHandler(action: Action): {
     GET: () => Promise<NextResponse<ActionMetadata> | NextResponse<{

package/dist/builders-CJNt88dM.d.ts

@@ -0,0 +1,19 @@
+import { f as ActionDefinition, A as ActionMetadata, T as TransactionRequest, a as TransactionResponse, c as ActionButton } from './types-CAnUIaVe.js';
+
+declare function button(config: {
+    label: string;
+    value: string;
+    disabled?: boolean;
+}): ActionButton;
+declare function input(config: {
+    label: string;
+    placeholder?: string;
+    disabled?: boolean;
+}): ActionButton;
+interface Action {
+    getMetadata(): ActionMetadata;
+    handleRequest(request: TransactionRequest): Promise<TransactionResponse>;
+}
+declare function createAction(definition: ActionDefinition): Action;
+
+export { type Action as A, button as b, createAction as c, input as i };

package/dist/builders-CN5ijFpW.d.mts

@@ -0,0 +1,19 @@
+import { f as ActionDefinition, A as ActionMetadata, T as TransactionRequest, a as TransactionResponse, c as ActionButton } from './types-CAnUIaVe.mjs';
+
+declare function button(config: {
+    label: string;
+    value: string;
+    disabled?: boolean;
+}): ActionButton;
+declare function input(config: {
+    label: string;
+    placeholder?: string;
+    disabled?: boolean;
+}): ActionButton;
+interface Action {
+    getMetadata(): ActionMetadata;
+    handleRequest(request: TransactionRequest): Promise<TransactionResponse>;
+}
+declare function createAction(definition: ActionDefinition): Action;
+
+export { type Action as A, button as b, createAction as c, input as i };

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { V as ValidationResult, A as ActionMetadata, T as TransactionRequest, a as TransactionResponse, C as ChainConfig } from './builders-OoJ5KB_g.mjs';
-export { k as Action, c as ActionButton, g as ActionContext, f as ActionDefinition, d as ActionError, e as ActionHandler, b as ActionType, E as EVMTransaction, i as button, h as createAction, j as input } from './builders-OoJ5KB_g.mjs';
+import { V as ValidationResult, A as ActionMetadata, T as TransactionRequest, a as TransactionResponse, C as ChainConfig } from './types-CAnUIaVe.mjs';
+export { c as ActionButton, g as ActionContext, f as ActionDefinition, d as ActionError, e as ActionHandler, b as ActionType, E as EVMTransaction } from './types-CAnUIaVe.mjs';
+export { A as Action, b as button, c as createAction, i as input } from './builders-CN5ijFpW.mjs';
 import { z } from 'zod';
 
 declare const ActionMetadataSchema: z.ZodObject<{

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { V as ValidationResult, A as ActionMetadata, T as TransactionRequest, a as TransactionResponse, C as ChainConfig } from './builders-OoJ5KB_g.js';
-export { k as Action, c as ActionButton, g as ActionContext, f as ActionDefinition, d as ActionError, e as ActionHandler, b as ActionType, E as EVMTransaction, i as button, h as createAction, j as input } from './builders-OoJ5KB_g.js';
+import { V as ValidationResult, A as ActionMetadata, T as TransactionRequest, a as TransactionResponse, C as ChainConfig } from './types-CAnUIaVe.js';
+export { c as ActionButton, g as ActionContext, f as ActionDefinition, d as ActionError, e as ActionHandler, b as ActionType, E as EVMTransaction } from './types-CAnUIaVe.js';
+export { A as Action, b as button, c as createAction, i as input } from './builders-CJNt88dM.js';
 import { z } from 'zod';
 
 declare const ActionMetadataSchema: z.ZodObject<{

package/dist/react/index.d.mts

@@ -0,0 +1,208 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { E as EVMTransaction, C as ChainConfig, A as ActionMetadata } from '../types-CAnUIaVe.mjs';
+import React from 'react';
+
+type MlinkStatus = 'idle' | 'loading' | 'ready' | 'executing' | 'success' | 'error';
+interface MlinkInstance {
+    status: MlinkStatus;
+    metadata: ActionMetadata | null;
+    error: string | null;
+    url: string;
+    refresh: () => Promise<void>;
+}
+interface MlinkAdapter {
+    connect: () => Promise<string>;
+    signAndSendTransaction: (transaction: EVMTransaction) => Promise<string>;
+    isConnected: () => boolean;
+    getAddress: () => string | null;
+}
+interface WagmiAdapterConfig {
+    sendTransaction: (args: {
+        to: `0x${string}`;
+        value: bigint;
+        data: `0x${string}`;
+        chainId: number;
+    }) => Promise<`0x${string}`>;
+    address: `0x${string}` | undefined;
+    isConnected: boolean;
+    connect: () => Promise<void>;
+}
+interface EthersAdapterConfig {
+    signer: {
+        getAddress: () => Promise<string>;
+        sendTransaction: (tx: {
+            to: string;
+            value: bigint;
+            data: string;
+            chainId: number;
+        }) => Promise<{
+            hash: string;
+            wait: () => Promise<unknown>;
+        }>;
+    } | null;
+    connect: () => Promise<void>;
+}
+interface MlinkTheme {
+    '--mlink-bg-primary': string;
+    '--mlink-bg-secondary': string;
+    '--mlink-border-color': string;
+    '--mlink-text-primary': string;
+    '--mlink-text-secondary': string;
+    '--mlink-text-link': string;
+    '--mlink-button-bg': string;
+    '--mlink-button-text': string;
+    '--mlink-button-hover': string;
+    '--mlink-button-disabled': string;
+    '--mlink-input-bg': string;
+    '--mlink-input-border': string;
+    '--mlink-input-text': string;
+    '--mlink-input-placeholder': string;
+    '--mlink-success': string;
+    '--mlink-error': string;
+    '--mlink-warning': string;
+    '--mlink-border-radius': string;
+    '--mlink-button-radius': string;
+    '--mlink-input-radius': string;
+    '--mlink-shadow': string;
+}
+type MlinkThemePreset = 'light' | 'dark' | 'mantle';
+interface MlinkProviderConfig {
+    theme?: Partial<MlinkTheme> | MlinkThemePreset;
+    defaultChain?: ChainConfig;
+}
+interface MlinkProps {
+    url: string;
+    adapter: MlinkAdapter;
+    theme?: Partial<MlinkTheme> | MlinkThemePreset;
+    onSuccess?: (txHash: string, action: string) => void;
+    onError?: (error: string) => void;
+    className?: string;
+    stylePreset?: 'default' | 'compact' | 'minimal';
+}
+interface ActionButtonProps {
+    label: string;
+    value: string;
+    type: 'button' | 'input';
+    placeholder?: string;
+    disabled?: boolean;
+    loading?: boolean;
+    onClick: (value: string, input?: string) => void;
+}
+interface ExecutionResult {
+    success: boolean;
+    txHash?: string;
+    error?: string;
+    message?: string;
+}
+interface UseMlinkOptions {
+    refreshInterval?: number;
+    enabled?: boolean;
+}
+interface UseExecuteMlinkReturn {
+    execute: (action: string, input?: string) => Promise<ExecutionResult>;
+    status: MlinkStatus;
+    txHash: string | null;
+    error: string | null;
+    reset: () => void;
+}
+
+declare function Mlink({ url, adapter, theme: themeProp, onSuccess, onError, className, stylePreset, }: MlinkProps): react_jsx_runtime.JSX.Element;
+
+interface MlinkContextValue {
+    theme: MlinkTheme;
+    defaultChain: ChainConfig;
+}
+interface MlinkProviderProps extends MlinkProviderConfig {
+    children: React.ReactNode;
+}
+declare function MlinkProvider({ children, theme, defaultChain, }: MlinkProviderProps): react_jsx_runtime.JSX.Element;
+declare function useMlinkContext(): MlinkContextValue;
+
+declare function useMlink(url: string, options?: UseMlinkOptions): MlinkInstance;
+
+interface UseExecuteMlinkOptions {
+    adapter: MlinkAdapter;
+    actionUrl: string;
+    onSuccess?: (txHash: string, action: string) => void;
+    onError?: (error: string) => void;
+}
+declare function useExecuteMlink(options: UseExecuteMlinkOptions): UseExecuteMlinkReturn;
+
+/**
+ * Create a Mlink adapter from wagmi hooks
+ *
+ * @example
+ * ```tsx
+ * import { useAccount, useConnect, useSendTransaction } from 'wagmi';
+ * import { useMlinkWagmiAdapter } from '@dipansrimany/mlink-sdk/react';
+ *
+ * function MyComponent() {
+ *   const { address, isConnected } = useAccount();
+ *   const { connectAsync, connectors } = useConnect();
+ *   const { sendTransactionAsync } = useSendTransaction();
+ *
+ *   const adapter = useMlinkWagmiAdapter({
+ *     address,
+ *     isConnected,
+ *     connect: async () => {
+ *       await connectAsync({ connector: connectors[0] });
+ *     },
+ *     sendTransaction: sendTransactionAsync,
+ *   });
+ *
+ *   return <Mlink url="..." adapter={adapter} />;
+ * }
+ * ```
+ */
+declare function useMlinkWagmiAdapter(config: WagmiAdapterConfig): MlinkAdapter;
+/**
+ * Create a Mlink adapter from ethers.js signer
+ *
+ * @example
+ * ```tsx
+ * import { useSigner } from 'some-ethers-provider';
+ * import { useMlinkEthersAdapter } from '@dipansrimany/mlink-sdk/react';
+ *
+ * function MyComponent() {
+ *   const { signer, connect } = useSigner();
+ *
+ *   const adapter = useMlinkEthersAdapter({
+ *     signer,
+ *     connect,
+ *   });
+ *
+ *   return <Mlink url="..." adapter={adapter} />;
+ * }
+ * ```
+ */
+declare function useMlinkEthersAdapter(config: EthersAdapterConfig): MlinkAdapter;
+/**
+ * Create a custom Mlink adapter
+ *
+ * @example
+ * ```tsx
+ * import { createMlinkAdapter } from '@dipansrimany/mlink-sdk/react';
+ *
+ * const adapter = createMlinkAdapter({
+ *   connect: async () => {
+ *     // Your connect logic
+ *     return '0x...';
+ *   },
+ *   signAndSendTransaction: async (tx) => {
+ *     // Your transaction logic
+ *     return '0x...txHash';
+ *   },
+ *   isConnected: () => true,
+ *   getAddress: () => '0x...',
+ * });
+ * ```
+ */
+declare function createMlinkAdapter(adapter: MlinkAdapter): MlinkAdapter;
+
+declare const lightTheme: MlinkTheme;
+declare const darkTheme: MlinkTheme;
+declare const mantleTheme: MlinkTheme;
+declare const themePresets: Record<MlinkThemePreset, MlinkTheme>;
+declare function resolveTheme(theme?: Partial<MlinkTheme> | MlinkThemePreset): MlinkTheme;
+
+export { type ActionButtonProps, type EthersAdapterConfig, type ExecutionResult, Mlink, type MlinkAdapter, Mlink as MlinkComponent, type MlinkInstance, type MlinkProps, MlinkProvider, type MlinkProviderConfig, type MlinkStatus, type MlinkTheme, type MlinkThemePreset, type UseExecuteMlinkReturn, type UseMlinkOptions, type WagmiAdapterConfig, createMlinkAdapter, darkTheme, lightTheme, mantleTheme, resolveTheme, themePresets, useExecuteMlink, useMlink, useMlinkContext, useMlinkEthersAdapter, useMlinkWagmiAdapter };

package/dist/react/index.d.ts

@@ -0,0 +1,208 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { E as EVMTransaction, C as ChainConfig, A as ActionMetadata } from '../types-CAnUIaVe.js';
+import React from 'react';
+
+type MlinkStatus = 'idle' | 'loading' | 'ready' | 'executing' | 'success' | 'error';
+interface MlinkInstance {
+    status: MlinkStatus;
+    metadata: ActionMetadata | null;
+    error: string | null;
+    url: string;
+    refresh: () => Promise<void>;
+}
+interface MlinkAdapter {
+    connect: () => Promise<string>;
+    signAndSendTransaction: (transaction: EVMTransaction) => Promise<string>;
+    isConnected: () => boolean;
+    getAddress: () => string | null;
+}
+interface WagmiAdapterConfig {
+    sendTransaction: (args: {
+        to: `0x${string}`;
+        value: bigint;
+        data: `0x${string}`;
+        chainId: number;
+    }) => Promise<`0x${string}`>;
+    address: `0x${string}` | undefined;
+    isConnected: boolean;
+    connect: () => Promise<void>;
+}
+interface EthersAdapterConfig {
+    signer: {
+        getAddress: () => Promise<string>;
+        sendTransaction: (tx: {
+            to: string;
+            value: bigint;
+            data: string;
+            chainId: number;
+        }) => Promise<{
+            hash: string;
+            wait: () => Promise<unknown>;
+        }>;
+    } | null;
+    connect: () => Promise<void>;
+}
+interface MlinkTheme {
+    '--mlink-bg-primary': string;
+    '--mlink-bg-secondary': string;
+    '--mlink-border-color': string;
+    '--mlink-text-primary': string;
+    '--mlink-text-secondary': string;
+    '--mlink-text-link': string;
+    '--mlink-button-bg': string;
+    '--mlink-button-text': string;
+    '--mlink-button-hover': string;
+    '--mlink-button-disabled': string;
+    '--mlink-input-bg': string;
+    '--mlink-input-border': string;
+    '--mlink-input-text': string;
+    '--mlink-input-placeholder': string;
+    '--mlink-success': string;
+    '--mlink-error': string;
+    '--mlink-warning': string;
+    '--mlink-border-radius': string;
+    '--mlink-button-radius': string;
+    '--mlink-input-radius': string;
+    '--mlink-shadow': string;
+}
+type MlinkThemePreset = 'light' | 'dark' | 'mantle';
+interface MlinkProviderConfig {
+    theme?: Partial<MlinkTheme> | MlinkThemePreset;
+    defaultChain?: ChainConfig;
+}
+interface MlinkProps {
+    url: string;
+    adapter: MlinkAdapter;
+    theme?: Partial<MlinkTheme> | MlinkThemePreset;
+    onSuccess?: (txHash: string, action: string) => void;
+    onError?: (error: string) => void;
+    className?: string;
+    stylePreset?: 'default' | 'compact' | 'minimal';
+}
+interface ActionButtonProps {
+    label: string;
+    value: string;
+    type: 'button' | 'input';
+    placeholder?: string;
+    disabled?: boolean;
+    loading?: boolean;
+    onClick: (value: string, input?: string) => void;
+}
+interface ExecutionResult {
+    success: boolean;
+    txHash?: string;
+    error?: string;
+    message?: string;
+}
+interface UseMlinkOptions {
+    refreshInterval?: number;
+    enabled?: boolean;
+}
+interface UseExecuteMlinkReturn {
+    execute: (action: string, input?: string) => Promise<ExecutionResult>;
+    status: MlinkStatus;
+    txHash: string | null;
+    error: string | null;
+    reset: () => void;
+}
+
+declare function Mlink({ url, adapter, theme: themeProp, onSuccess, onError, className, stylePreset, }: MlinkProps): react_jsx_runtime.JSX.Element;
+
+interface MlinkContextValue {
+    theme: MlinkTheme;
+    defaultChain: ChainConfig;
+}
+interface MlinkProviderProps extends MlinkProviderConfig {
+    children: React.ReactNode;
+}
+declare function MlinkProvider({ children, theme, defaultChain, }: MlinkProviderProps): react_jsx_runtime.JSX.Element;
+declare function useMlinkContext(): MlinkContextValue;
+
+declare function useMlink(url: string, options?: UseMlinkOptions): MlinkInstance;
+
+interface UseExecuteMlinkOptions {
+    adapter: MlinkAdapter;
+    actionUrl: string;
+    onSuccess?: (txHash: string, action: string) => void;
+    onError?: (error: string) => void;
+}
+declare function useExecuteMlink(options: UseExecuteMlinkOptions): UseExecuteMlinkReturn;
+
+/**
+ * Create a Mlink adapter from wagmi hooks
+ *
+ * @example
+ * ```tsx
+ * import { useAccount, useConnect, useSendTransaction } from 'wagmi';
+ * import { useMlinkWagmiAdapter } from '@dipansrimany/mlink-sdk/react';
+ *
+ * function MyComponent() {
+ *   const { address, isConnected } = useAccount();
+ *   const { connectAsync, connectors } = useConnect();
+ *   const { sendTransactionAsync } = useSendTransaction();
+ *
+ *   const adapter = useMlinkWagmiAdapter({
+ *     address,
+ *     isConnected,
+ *     connect: async () => {
+ *       await connectAsync({ connector: connectors[0] });
+ *     },
+ *     sendTransaction: sendTransactionAsync,
+ *   });
+ *
+ *   return <Mlink url="..." adapter={adapter} />;
+ * }
+ * ```
+ */
+declare function useMlinkWagmiAdapter(config: WagmiAdapterConfig): MlinkAdapter;
+/**
+ * Create a Mlink adapter from ethers.js signer
+ *
+ * @example
+ * ```tsx
+ * import { useSigner } from 'some-ethers-provider';
+ * import { useMlinkEthersAdapter } from '@dipansrimany/mlink-sdk/react';
+ *
+ * function MyComponent() {
+ *   const { signer, connect } = useSigner();
+ *
+ *   const adapter = useMlinkEthersAdapter({
+ *     signer,
+ *     connect,
+ *   });
+ *
+ *   return <Mlink url="..." adapter={adapter} />;
+ * }
+ * ```
+ */
+declare function useMlinkEthersAdapter(config: EthersAdapterConfig): MlinkAdapter;
+/**
+ * Create a custom Mlink adapter
+ *
+ * @example
+ * ```tsx
+ * import { createMlinkAdapter } from '@dipansrimany/mlink-sdk/react';
+ *
+ * const adapter = createMlinkAdapter({
+ *   connect: async () => {
+ *     // Your connect logic
+ *     return '0x...';
+ *   },
+ *   signAndSendTransaction: async (tx) => {
+ *     // Your transaction logic
+ *     return '0x...txHash';
+ *   },
+ *   isConnected: () => true,
+ *   getAddress: () => '0x...',
+ * });
+ * ```
+ */
+declare function createMlinkAdapter(adapter: MlinkAdapter): MlinkAdapter;
+
+declare const lightTheme: MlinkTheme;
+declare const darkTheme: MlinkTheme;
+declare const mantleTheme: MlinkTheme;
+declare const themePresets: Record<MlinkThemePreset, MlinkTheme>;
+declare function resolveTheme(theme?: Partial<MlinkTheme> | MlinkThemePreset): MlinkTheme;
+
+export { type ActionButtonProps, type EthersAdapterConfig, type ExecutionResult, Mlink, type MlinkAdapter, Mlink as MlinkComponent, type MlinkInstance, type MlinkProps, MlinkProvider, type MlinkProviderConfig, type MlinkStatus, type MlinkTheme, type MlinkThemePreset, type UseExecuteMlinkReturn, type UseMlinkOptions, type WagmiAdapterConfig, createMlinkAdapter, darkTheme, lightTheme, mantleTheme, resolveTheme, themePresets, useExecuteMlink, useMlink, useMlinkContext, useMlinkEthersAdapter, useMlinkWagmiAdapter };