@dipansrimany/mlink-sdk 0.3.1 → 0.4.1

package/dist/types-DD9rJ58Y.d.mts

@@ -0,0 +1,214 @@
+type ActionType = 'button' | 'input';
+interface ActionButton {
+    label: string;
+    value: string;
+    type: ActionType;
+    placeholder?: string;
+    disabled?: boolean;
+}
+interface ActionError {
+    message: string;
+}
+/**
+ * Parameter types supported by linked actions
+ * Similar to HTML input types + blockchain-specific types
+ */
+type ActionParameterType = 'text' | 'number' | 'email' | 'url' | 'date' | 'datetime-local' | 'textarea' | 'select' | 'radio' | 'checkbox' | 'address' | 'token' | 'amount';
+/**
+ * Selectable parameter types that require options array
+ */
+type SelectableParameterType = 'select' | 'radio' | 'checkbox';
+/**
+ * Option for select/radio/checkbox parameters
+ */
+interface ActionParameterOption {
+    label: string;
+    value: string;
+    selected?: boolean;
+}
+/**
+ * Base action parameter (non-selectable types)
+ */
+interface ActionParameterBase {
+    /** Parameter name - used as placeholder key in href template */
+    name: string;
+    /** Display label for the input */
+    label?: string;
+    /** Whether this parameter is required */
+    required?: boolean;
+    /** Regex pattern for validation */
+    pattern?: string;
+    /** Description of what the pattern expects */
+    patternDescription?: string;
+    /** Minimum value (for number/date types) */
+    min?: string | number;
+    /** Maximum value (for number/date types) */
+    max?: string | number;
+}
+/**
+ * Non-selectable parameter (text, number, etc.)
+ */
+interface ActionParameter extends ActionParameterBase {
+    type?: Exclude<ActionParameterType, SelectableParameterType>;
+}
+/**
+ * Selectable parameter (select, radio, checkbox)
+ */
+interface ActionParameterSelectable extends ActionParameterBase {
+    type: SelectableParameterType;
+    /** Options for selection */
+    options: ActionParameterOption[];
+}
+/**
+ * Union type for all parameter types
+ */
+type TypedActionParameter = ActionParameter | ActionParameterSelectable;
+/**
+ * Linked action type
+ */
+type LinkedActionType = 'transaction' | 'post' | 'external-link';
+/**
+ * Linked action with href template and parameters
+ * Similar to Solana's LinkedAction
+ */
+interface LinkedAction {
+    /** Type of action (defaults to 'transaction') */
+    type?: LinkedActionType;
+    /** URL template with {parameter} placeholders */
+    href: string;
+    /** Button label */
+    label: string;
+    /** Whether this action is disabled */
+    disabled?: boolean;
+    /** Parameters to collect from user */
+    parameters?: TypedActionParameter[];
+}
+/**
+ * Links section containing linked actions
+ */
+interface ActionLinks {
+    /** Array of linked actions */
+    actions: LinkedAction[];
+}
+/**
+ * POST callback for next action after transaction confirms
+ */
+interface PostNextActionLink {
+    type: 'post';
+    /** Callback URL to get next action */
+    href: string;
+}
+/**
+ * Inline next action (embedded in response)
+ */
+interface InlineNextActionLink {
+    type: 'inline';
+    /** Next action metadata */
+    action: ActionMetadata;
+}
+/**
+ * Next action link (for chaining)
+ */
+type NextActionLink = PostNextActionLink | InlineNextActionLink;
+/**
+ * GET response - action metadata
+ * Enhanced with optional links.actions for Solana-style linked actions
+ */
+interface ActionMetadata {
+    /** Action type (defaults to 'action') */
+    type?: 'action' | 'completed';
+    /** Action title */
+    title: string;
+    /** Icon URL or base64 image */
+    icon: string;
+    /** Action description */
+    description: string;
+    /** Primary button label (used when no linked actions) */
+    label?: string;
+    /** Legacy actions array (for backwards compatibility) */
+    actions?: ActionButton[];
+    /** Linked actions with parameters (Solana-style) */
+    links?: ActionLinks;
+    /** Whether the entire action is disabled */
+    disabled?: boolean;
+    /** Error to display */
+    error?: ActionError;
+}
+/**
+ * POST body - transaction request
+ * Enhanced to support parameter data
+ */
+interface TransactionRequest {
+    /** User's wallet address */
+    account: string;
+    /** Selected action value or href */
+    action: string;
+    /** Legacy single input value */
+    input?: string;
+    /** Parameter values collected from form (Solana-style) */
+    data?: Record<string, string | string[]>;
+}
+interface EVMTransaction {
+    to: string;
+    value: string;
+    data: string;
+    chainId: number;
+}
+/**
+ * POST response - Enhanced to support multiple transactions and chaining
+ */
+interface TransactionResponse {
+    /** Single transaction (for simple cases) */
+    transaction?: EVMTransaction;
+    /** Multiple transactions (for batch/multi-contract) */
+    transactions?: EVMTransaction[];
+    /** Message to display to user */
+    message?: string;
+    /** Next action for chaining */
+    links?: {
+        next?: NextActionLink;
+    };
+}
+/**
+ * Context passed to handler
+ * Enhanced to support parameter data
+ */
+interface ActionContext {
+    /** User's wallet address */
+    account: string;
+    /** Selected action value or href */
+    action: string;
+    /** Legacy single input value */
+    input?: string;
+    /** Parameter values from form (Solana-style) */
+    data?: Record<string, string | string[]>;
+}
+type ActionHandler = (context: ActionContext) => Promise<TransactionResponse>;
+interface ActionDefinition {
+    title: string;
+    icon: string;
+    description: string;
+    actions: ActionButton[];
+    disabled?: boolean;
+    handler: ActionHandler;
+}
+interface ChainConfig {
+    chainId: number;
+    name: string;
+    rpcUrl: string;
+    explorerUrl: string;
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+}
+type ValidationResult<T> = {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    error: string;
+};
+
+export type { ActionMetadata as A, ChainConfig as C, EVMTransaction as E, InlineNextActionLink as I, LinkedAction as L, NextActionLink as N, PostNextActionLink as P, SelectableParameterType as S, TransactionRequest as T, ValidationResult as V, TransactionResponse as a, TypedActionParameter as b, ActionType as c, ActionButton as d, ActionError as e, ActionHandler as f, ActionDefinition as g, ActionContext as h, ActionParameterType as i, ActionParameterOption as j, ActionParameterBase as k, ActionParameter as l, ActionParameterSelectable as m, LinkedActionType as n, ActionLinks as o };

package/dist/types-DD9rJ58Y.d.ts

@@ -0,0 +1,214 @@
+type ActionType = 'button' | 'input';
+interface ActionButton {
+    label: string;
+    value: string;
+    type: ActionType;
+    placeholder?: string;
+    disabled?: boolean;
+}
+interface ActionError {
+    message: string;
+}
+/**
+ * Parameter types supported by linked actions
+ * Similar to HTML input types + blockchain-specific types
+ */
+type ActionParameterType = 'text' | 'number' | 'email' | 'url' | 'date' | 'datetime-local' | 'textarea' | 'select' | 'radio' | 'checkbox' | 'address' | 'token' | 'amount';
+/**
+ * Selectable parameter types that require options array
+ */
+type SelectableParameterType = 'select' | 'radio' | 'checkbox';
+/**
+ * Option for select/radio/checkbox parameters
+ */
+interface ActionParameterOption {
+    label: string;
+    value: string;
+    selected?: boolean;
+}
+/**
+ * Base action parameter (non-selectable types)
+ */
+interface ActionParameterBase {
+    /** Parameter name - used as placeholder key in href template */
+    name: string;
+    /** Display label for the input */
+    label?: string;
+    /** Whether this parameter is required */
+    required?: boolean;
+    /** Regex pattern for validation */
+    pattern?: string;
+    /** Description of what the pattern expects */
+    patternDescription?: string;
+    /** Minimum value (for number/date types) */
+    min?: string | number;
+    /** Maximum value (for number/date types) */
+    max?: string | number;
+}
+/**
+ * Non-selectable parameter (text, number, etc.)
+ */
+interface ActionParameter extends ActionParameterBase {
+    type?: Exclude<ActionParameterType, SelectableParameterType>;
+}
+/**
+ * Selectable parameter (select, radio, checkbox)
+ */
+interface ActionParameterSelectable extends ActionParameterBase {
+    type: SelectableParameterType;
+    /** Options for selection */
+    options: ActionParameterOption[];
+}
+/**
+ * Union type for all parameter types
+ */
+type TypedActionParameter = ActionParameter | ActionParameterSelectable;
+/**
+ * Linked action type
+ */
+type LinkedActionType = 'transaction' | 'post' | 'external-link';
+/**
+ * Linked action with href template and parameters
+ * Similar to Solana's LinkedAction
+ */
+interface LinkedAction {
+    /** Type of action (defaults to 'transaction') */
+    type?: LinkedActionType;
+    /** URL template with {parameter} placeholders */
+    href: string;
+    /** Button label */
+    label: string;
+    /** Whether this action is disabled */
+    disabled?: boolean;
+    /** Parameters to collect from user */
+    parameters?: TypedActionParameter[];
+}
+/**
+ * Links section containing linked actions
+ */
+interface ActionLinks {
+    /** Array of linked actions */
+    actions: LinkedAction[];
+}
+/**
+ * POST callback for next action after transaction confirms
+ */
+interface PostNextActionLink {
+    type: 'post';
+    /** Callback URL to get next action */
+    href: string;
+}
+/**
+ * Inline next action (embedded in response)
+ */
+interface InlineNextActionLink {
+    type: 'inline';
+    /** Next action metadata */
+    action: ActionMetadata;
+}
+/**
+ * Next action link (for chaining)
+ */
+type NextActionLink = PostNextActionLink | InlineNextActionLink;
+/**
+ * GET response - action metadata
+ * Enhanced with optional links.actions for Solana-style linked actions
+ */
+interface ActionMetadata {
+    /** Action type (defaults to 'action') */
+    type?: 'action' | 'completed';
+    /** Action title */
+    title: string;
+    /** Icon URL or base64 image */
+    icon: string;
+    /** Action description */
+    description: string;
+    /** Primary button label (used when no linked actions) */
+    label?: string;
+    /** Legacy actions array (for backwards compatibility) */
+    actions?: ActionButton[];
+    /** Linked actions with parameters (Solana-style) */
+    links?: ActionLinks;
+    /** Whether the entire action is disabled */
+    disabled?: boolean;
+    /** Error to display */
+    error?: ActionError;
+}
+/**
+ * POST body - transaction request
+ * Enhanced to support parameter data
+ */
+interface TransactionRequest {
+    /** User's wallet address */
+    account: string;
+    /** Selected action value or href */
+    action: string;
+    /** Legacy single input value */
+    input?: string;
+    /** Parameter values collected from form (Solana-style) */
+    data?: Record<string, string | string[]>;
+}
+interface EVMTransaction {
+    to: string;
+    value: string;
+    data: string;
+    chainId: number;
+}
+/**
+ * POST response - Enhanced to support multiple transactions and chaining
+ */
+interface TransactionResponse {
+    /** Single transaction (for simple cases) */
+    transaction?: EVMTransaction;
+    /** Multiple transactions (for batch/multi-contract) */
+    transactions?: EVMTransaction[];
+    /** Message to display to user */
+    message?: string;
+    /** Next action for chaining */
+    links?: {
+        next?: NextActionLink;
+    };
+}
+/**
+ * Context passed to handler
+ * Enhanced to support parameter data
+ */
+interface ActionContext {
+    /** User's wallet address */
+    account: string;
+    /** Selected action value or href */
+    action: string;
+    /** Legacy single input value */
+    input?: string;
+    /** Parameter values from form (Solana-style) */
+    data?: Record<string, string | string[]>;
+}
+type ActionHandler = (context: ActionContext) => Promise<TransactionResponse>;
+interface ActionDefinition {
+    title: string;
+    icon: string;
+    description: string;
+    actions: ActionButton[];
+    disabled?: boolean;
+    handler: ActionHandler;
+}
+interface ChainConfig {
+    chainId: number;
+    name: string;
+    rpcUrl: string;
+    explorerUrl: string;
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+}
+type ValidationResult<T> = {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    error: string;
+};
+
+export type { ActionMetadata as A, ChainConfig as C, EVMTransaction as E, InlineNextActionLink as I, LinkedAction as L, NextActionLink as N, PostNextActionLink as P, SelectableParameterType as S, TransactionRequest as T, ValidationResult as V, TransactionResponse as a, TypedActionParameter as b, ActionType as c, ActionButton as d, ActionError as e, ActionHandler as f, ActionDefinition as g, ActionContext as h, ActionParameterType as i, ActionParameterOption as j, ActionParameterBase as k, ActionParameter as l, ActionParameterSelectable as m, LinkedActionType as n, ActionLinks as o };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dipansrimany/mlink-sdk",
-  "version": "0.3.1",
-  "description": "SDK for building Mantle links - shareable blockchain transaction URLs with React UI components",
+  "version": "0.4.1",
+  "description": "SDK for building Mantle links - shareable blockchain transaction URLs with React UI components. Supports Solana-style linked actions with parameters.",
   "author": "Mlink",
   "repository": {
     "type": "git",

package/dist/builders-CJNt88dM.d.ts

@@ -1,19 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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/types-CAnUIaVe.d.mts

@@ -1,68 +0,0 @@
-type ActionType = 'button' | 'input';
-interface ActionButton {
-    label: string;
-    value: string;
-    type: ActionType;
-    placeholder?: string;
-    disabled?: boolean;
-}
-interface ActionError {
-    message: string;
-}
-interface ActionMetadata {
-    title: string;
-    icon: string;
-    description: string;
-    actions: ActionButton[];
-    disabled?: boolean;
-    error?: ActionError;
-}
-interface TransactionRequest {
-    account: string;
-    action: string;
-    input?: string;
-}
-interface EVMTransaction {
-    to: string;
-    value: string;
-    data: string;
-    chainId: number;
-}
-interface TransactionResponse {
-    transaction: EVMTransaction;
-    message?: string;
-}
-interface ActionContext {
-    account: string;
-    action: string;
-    input?: string;
-}
-type ActionHandler = (context: ActionContext) => Promise<TransactionResponse>;
-interface ActionDefinition {
-    title: string;
-    icon: string;
-    description: string;
-    actions: ActionButton[];
-    disabled?: boolean;
-    handler: ActionHandler;
-}
-interface ChainConfig {
-    chainId: number;
-    name: string;
-    rpcUrl: string;
-    explorerUrl: string;
-    nativeCurrency: {
-        name: string;
-        symbol: string;
-        decimals: number;
-    };
-}
-type ValidationResult<T> = {
-    success: true;
-    data: T;
-} | {
-    success: false;
-    error: string;
-};
-
-export type { ActionMetadata as A, ChainConfig as C, EVMTransaction as E, TransactionRequest as T, ValidationResult as V, TransactionResponse as a, ActionType as b, ActionButton as c, ActionError as d, ActionHandler as e, ActionDefinition as f, ActionContext as g };

package/dist/types-CAnUIaVe.d.ts

@@ -1,68 +0,0 @@
-type ActionType = 'button' | 'input';
-interface ActionButton {
-    label: string;
-    value: string;
-    type: ActionType;
-    placeholder?: string;
-    disabled?: boolean;
-}
-interface ActionError {
-    message: string;
-}
-interface ActionMetadata {
-    title: string;
-    icon: string;
-    description: string;
-    actions: ActionButton[];
-    disabled?: boolean;
-    error?: ActionError;
-}
-interface TransactionRequest {
-    account: string;
-    action: string;
-    input?: string;
-}
-interface EVMTransaction {
-    to: string;
-    value: string;
-    data: string;
-    chainId: number;
-}
-interface TransactionResponse {
-    transaction: EVMTransaction;
-    message?: string;
-}
-interface ActionContext {
-    account: string;
-    action: string;
-    input?: string;
-}
-type ActionHandler = (context: ActionContext) => Promise<TransactionResponse>;
-interface ActionDefinition {
-    title: string;
-    icon: string;
-    description: string;
-    actions: ActionButton[];
-    disabled?: boolean;
-    handler: ActionHandler;
-}
-interface ChainConfig {
-    chainId: number;
-    name: string;
-    rpcUrl: string;
-    explorerUrl: string;
-    nativeCurrency: {
-        name: string;
-        symbol: string;
-        decimals: number;
-    };
-}
-type ValidationResult<T> = {
-    success: true;
-    data: T;
-} | {
-    success: false;
-    error: string;
-};
-
-export type { ActionMetadata as A, ChainConfig as C, EVMTransaction as E, TransactionRequest as T, ValidationResult as V, TransactionResponse as a, ActionType as b, ActionButton as c, ActionError as d, ActionHandler as e, ActionDefinition as f, ActionContext as g };