@stacknet/keyutils 0.3.1 → 0.4.1

package/dist/types/index.d.ts

@@ -0,0 +1,128 @@
+interface NodeKeyInfo {
+    id: string;
+    keyIndex?: number | null;
+    key: string;
+    userId: string;
+    status: 'active' | 'inactive' | 'expired' | 'closed' | 'listed';
+    tokenBalance: number;
+    maxTokens: number;
+    createdAt: string;
+    expiresAt?: string;
+    label?: string;
+    paperWork?: string;
+    stackId?: string;
+    stackName?: string;
+}
+interface LedgerEntry {
+    id: string;
+    keyId: string;
+    type: 'credit' | 'debit' | 'mint' | 'reward';
+    amount: number;
+    description: string;
+    createdAt: string;
+    metadata?: Record<string, unknown>;
+}
+interface PricingInfo {
+    priceUsd: number;
+    priceCents: number;
+    priceSol?: number;
+    tokenAllocation: number;
+    tokenAllocationFormatted: string;
+    currentDay: number;
+    currentEpoch: number;
+    nextHalvingDate: number;
+    daysUntilHalving: number;
+    keysSold: number;
+    saleActive: boolean;
+    saleStartDate: number;
+}
+interface MintResult {
+    success: boolean;
+    key?: NodeKeyInfo;
+    transactionId?: string;
+    error?: string;
+}
+type PaymentMethod = 'solana' | 'stripe';
+interface KeyListing {
+    id: string;
+    keyId: string;
+    keyIndex?: number | null;
+    sellerId: string;
+    askPriceCents: number;
+    currency: string;
+    tokenBalance: number;
+    maxTokens: number;
+    paperWork?: string;
+    stackId?: string;
+    stackName?: string;
+    status: 'active' | 'sold' | 'cancelled';
+    createdAt: number;
+}
+interface ListingResult {
+    listingId: string;
+    keyId: string;
+    askPriceCents: number;
+    currency: string;
+    status: string;
+}
+interface DirectTransferResult {
+    keyId: string;
+    fromUserId: string;
+    toUserId: string;
+    transferredAt: number;
+}
+type FilingStatus = 'submitted' | 'validated' | 'paid' | 'failed';
+interface FilingResult {
+    keyId: string;
+    fileHash: string;
+    txSignature?: string;
+    paperAmount: number;
+    status: FilingStatus;
+    beneficiary: string;
+    filedAt: string;
+}
+interface FilingHistoryEntry extends FilingResult {
+    proofPda?: string;
+    memo?: string;
+}
+/** A NodeKeyInfo that has a non-empty paperWork payload ready to file. */
+type EligibleKey = NodeKeyInfo & {
+    paperWork: string;
+};
+type Platform = 'ios' | 'android' | 'windows' | 'mac' | 'linux';
+interface PlatformDownload {
+    platform: Platform;
+    label: string;
+    url: string;
+    compatible: boolean;
+}
+type KeyWidgetTab = 'buy' | 'use' | 'keys';
+interface KeyUtilsConfig {
+    apiBaseUrl: string;
+    stackId?: string;
+    stackName?: string;
+    paymentMethods?: PaymentMethod[];
+    merchantWallet?: string;
+    protocolTreasuryWallet?: string;
+    protocolFeeBps?: number;
+    stripePublicKey?: string;
+    theme?: 'light' | 'dark' | 'system';
+    maxQuantity?: number;
+    keyImage?: string;
+    keyImageClass?: string;
+    aispImage?: string;
+    termsUrl?: string;
+    solanaRpcUrl?: string;
+}
+interface KeyUtilsCallbacks {
+    onMintSuccess?: (result: MintResult) => void;
+    onMintError?: (error: Error) => void;
+    onPaymentStart?: (method: PaymentMethod) => void;
+    onPaymentComplete?: (method: PaymentMethod, transactionId: string) => void;
+    onListingCreated?: (listing: ListingResult) => void;
+    onTransferComplete?: (result: DirectTransferResult) => void;
+    onFilingComplete?: (result: FilingResult) => void;
+    onFilingError?: (error: Error) => void;
+}
+
+export type { DirectTransferResult, EligibleKey, FilingHistoryEntry, FilingResult, FilingStatus, KeyListing, KeyUtilsCallbacks, KeyUtilsConfig, KeyWidgetTab, LedgerEntry, ListingResult, MintResult, NodeKeyInfo, PaymentMethod, Platform, PlatformDownload, PricingInfo };

package/dist/utils/index.cjs

@@ -0,0 +1 @@
+'use strict';var clsx=require('clsx'),tailwindMerge=require('tailwind-merge');function i(){if(typeof document>"u")return {};let r=document.cookie.match(/(?:^|;\s*)__csrf=([^;]*)/);return r?{"x-csrf-token":r[1]}:{}}var s=500;function o(r,e){if(typeof r!="string"||r.length===0)return e;let t=r.replace(/[\u0000-\u001F\u007F]/g," ");return t.length>500?t.slice(0,500)+"\u2026":t}async function u(r,e){try{let t=await r.json();if(t&&typeof t=="object"&&"error"in t)return o(t.error,e)}catch{}return e}function f(r,e="#"){if(!r||typeof r!="string")return e;let t=r.trim();if(t===""||t==="#")return e;if(t.startsWith("/")||t.startsWith("./")||t.startsWith("../"))return t;try{let n=new URL(t);if(n.protocol==="http:"||n.protocol==="https:")return n.toString()}catch{}return e}function _(...r){return tailwindMerge.twMerge(clsx.clsx(r))}function x(r){return r==null?"0":r>=1e9?`${(r/1e9).toFixed(1)}B`:r>=1e6?`${(r/1e6).toFixed(1)}M`:r>=1e3?`${(r/1e3).toFixed(1)}K`:r.toLocaleString()}function h(r,e){return e<=0?0:Math.min(100,Math.round(r/e*100))}function y(r){return r>=70?"bg-green-500":r>=30?"bg-yellow-500":"bg-red-500"}function R(r){let e=typeof r=="string"&&/^\d+$/.test(r)?Number(r):r,t=new Date(e);return isNaN(t.getTime())?String(r):t.toLocaleDateString("en-US",{month:"short",day:"numeric",year:"numeric"})}function E(){if(typeof navigator>"u")return "mac";let r=navigator.userAgent.toLowerCase();return /iphone|ipad|ipod/.test(r)?"ios":/android/.test(r)?"android":/win/.test(r)?"windows":/linux/.test(r)?"linux":"mac"}exports.MAX_ERROR_LEN=s;exports.calculateBalancePercentage=h;exports.clampErrorMessage=o;exports.cn=_;exports.csrfHeaders=i;exports.detectPlatform=E;exports.formatDate=R;exports.formatTokens=x;exports.getBalanceColor=y;exports.readErrorMessage=u;exports.safeUrl=f;

package/dist/utils/index.d.cts

@@ -0,0 +1,40 @@
+import { ClassValue } from 'clsx';
+import { Platform } from '../types/index.cjs';
+
+/** Read __csrf cookie and return as x-csrf-token header for mutations */
+declare function csrfHeaders(): Record<string, string>;
+
+/**
+ * Safely extract a bounded error message from a fetch Response body.
+ *
+ * Caps the message at MAX_ERROR_LEN to prevent a malicious or misbehaving
+ * backend from injecting an arbitrarily large string into the UI. The
+ * fallback message is used if the body is not JSON or has no `error` field.
+ */
+declare const MAX_ERROR_LEN = 500;
+declare function clampErrorMessage(msg: unknown, fallback: string): string;
+declare function readErrorMessage(res: Response, fallback: string): Promise<string>;
+
+/**
+ * Returns a safe href value for an anchor or image source.
+ *
+ * Allows: relative paths (starting with /, ./, ../), and absolute http(s) URLs.
+ * Blocks: javascript:, data:, file:, vbscript:, mailto:, etc.
+ *
+ * React only sanitizes `javascript:` in href attributes by default; this
+ * helper closes the gap for `data:` (which can carry HTML/JS) and any other
+ * non-network protocol that a misconfigured or malicious config could supply.
+ *
+ * Returns the supplied `fallback` (default '#') for any input that fails
+ * validation, so the markup never renders an unsafe URL.
+ */
+declare function safeUrl(url: string | undefined | null, fallback?: string): string;
+
+declare function cn(...inputs: ClassValue[]): string;
+declare function formatTokens(amount: number | undefined | null): string;
+declare function calculateBalancePercentage(current: number, max: number): number;
+declare function getBalanceColor(percentage: number): string;
+declare function formatDate(dateString: string | number): string;
+declare function detectPlatform(): Platform;
+
+export { MAX_ERROR_LEN, calculateBalancePercentage, clampErrorMessage, cn, csrfHeaders, detectPlatform, formatDate, formatTokens, getBalanceColor, readErrorMessage, safeUrl };

package/dist/utils/index.d.ts

@@ -0,0 +1,40 @@
+import { ClassValue } from 'clsx';
+import { Platform } from '../types/index.js';
+
+/** Read __csrf cookie and return as x-csrf-token header for mutations */
+declare function csrfHeaders(): Record<string, string>;
+
+/**
+ * Safely extract a bounded error message from a fetch Response body.
+ *
+ * Caps the message at MAX_ERROR_LEN to prevent a malicious or misbehaving
+ * backend from injecting an arbitrarily large string into the UI. The
+ * fallback message is used if the body is not JSON or has no `error` field.
+ */
+declare const MAX_ERROR_LEN = 500;
+declare function clampErrorMessage(msg: unknown, fallback: string): string;
+declare function readErrorMessage(res: Response, fallback: string): Promise<string>;
+
+/**
+ * Returns a safe href value for an anchor or image source.
+ *
+ * Allows: relative paths (starting with /, ./, ../), and absolute http(s) URLs.
+ * Blocks: javascript:, data:, file:, vbscript:, mailto:, etc.
+ *
+ * React only sanitizes `javascript:` in href attributes by default; this
+ * helper closes the gap for `data:` (which can carry HTML/JS) and any other
+ * non-network protocol that a misconfigured or malicious config could supply.
+ *
+ * Returns the supplied `fallback` (default '#') for any input that fails
+ * validation, so the markup never renders an unsafe URL.
+ */
+declare function safeUrl(url: string | undefined | null, fallback?: string): string;
+
+declare function cn(...inputs: ClassValue[]): string;
+declare function formatTokens(amount: number | undefined | null): string;
+declare function calculateBalancePercentage(current: number, max: number): number;
+declare function getBalanceColor(percentage: number): string;
+declare function formatDate(dateString: string | number): string;
+declare function detectPlatform(): Platform;
+
+export { MAX_ERROR_LEN, calculateBalancePercentage, clampErrorMessage, cn, csrfHeaders, detectPlatform, formatDate, formatTokens, getBalanceColor, readErrorMessage, safeUrl };

package/dist/utils/index.js

@@ -0,0 +1 @@
+import {clsx}from'clsx';import {twMerge}from'tailwind-merge';function i(){if(typeof document>"u")return {};let r=document.cookie.match(/(?:^|;\s*)__csrf=([^;]*)/);return r?{"x-csrf-token":r[1]}:{}}var s=500;function o(r,e){if(typeof r!="string"||r.length===0)return e;let t=r.replace(/[\u0000-\u001F\u007F]/g," ");return t.length>500?t.slice(0,500)+"\u2026":t}async function u(r,e){try{let t=await r.json();if(t&&typeof t=="object"&&"error"in t)return o(t.error,e)}catch{}return e}function f(r,e="#"){if(!r||typeof r!="string")return e;let t=r.trim();if(t===""||t==="#")return e;if(t.startsWith("/")||t.startsWith("./")||t.startsWith("../"))return t;try{let n=new URL(t);if(n.protocol==="http:"||n.protocol==="https:")return n.toString()}catch{}return e}function _(...r){return twMerge(clsx(r))}function x(r){return r==null?"0":r>=1e9?`${(r/1e9).toFixed(1)}B`:r>=1e6?`${(r/1e6).toFixed(1)}M`:r>=1e3?`${(r/1e3).toFixed(1)}K`:r.toLocaleString()}function h(r,e){return e<=0?0:Math.min(100,Math.round(r/e*100))}function y(r){return r>=70?"bg-green-500":r>=30?"bg-yellow-500":"bg-red-500"}function R(r){let e=typeof r=="string"&&/^\d+$/.test(r)?Number(r):r,t=new Date(e);return isNaN(t.getTime())?String(r):t.toLocaleDateString("en-US",{month:"short",day:"numeric",year:"numeric"})}function E(){if(typeof navigator>"u")return "mac";let r=navigator.userAgent.toLowerCase();return /iphone|ipad|ipod/.test(r)?"ios":/android/.test(r)?"android":/win/.test(r)?"windows":/linux/.test(r)?"linux":"mac"}export{s as MAX_ERROR_LEN,h as calculateBalancePercentage,o as clampErrorMessage,_ as cn,i as csrfHeaders,E as detectPlatform,R as formatDate,x as formatTokens,y as getBalanceColor,u as readErrorMessage,f as safeUrl};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacknet/keyutils",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "Reusable components for buying and managing StackNet node keys",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -31,6 +31,11 @@
       "types": "./dist/utils/index.d.ts",
       "import": "./dist/utils/index.js",
       "require": "./dist/utils/index.cjs"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js",
+      "require": "./dist/core/index.cjs"
     }
   },
   "files": [