@ar.io/sdk 2.3.3-alpha.1 → 2.4.0-alpha.10

package/lib/types/common/io.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 import Arweave from 'arweave';
-import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoArNSNameData, AoEpochData, AoEpochSettings, AoGateway, AoIORead, AoIOWrite, AoRegistrationFees, EpochInput } from '../types/io.js';
+import { AoArNSNameDataWithName, AoArNSReservedNameData, AoAuction, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
+import { AoArNSNameData, AoAuctionPriceData, AoEpochData, AoEpochSettings, AoGateway, AoGatewayDelegate, AoIORead, AoIOWrite, AoRegistrationFees, EpochInput } from '../types/io.js';
 import { mIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class IO {
@@ -55,7 +55,7 @@ export declare class IOReadable implements AoIORead {
     getArNSRecord({ name, }: {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
-    getArNSRecords(pageParams?: PaginationParams): Promise<PaginationResult<AoArNSNameDataWithName>>;
+    getArNSRecords(params?: PaginationParams<AoArNSNameDataWithName>): Promise<PaginationResult<AoArNSNameDataWithName>>;
     getArNSReservedNames(): Promise<Record<string, AoArNSReservedNameData> | Record<string, never>>;
     getArNSReservedName({ name, }: {
         name: string;
@@ -63,11 +63,17 @@ export declare class IOReadable implements AoIORead {
     getBalance({ address }: {
         address: WalletAddress;
     }): Promise<number>;
-    getBalances(pageParams?: PaginationParams): Promise<PaginationResult<AoBalanceWithAddress>>;
+    getBalances(params?: PaginationParams<AoBalanceWithAddress>): Promise<PaginationResult<AoBalanceWithAddress>>;
     getGateway({ address, }: {
         address: WalletAddress;
     }): Promise<AoGateway | undefined>;
-    getGateways(pageParams?: PaginationParams): Promise<PaginationResult<AoGatewayWithAddress>>;
+    getGatewayDelegates({ address, ...pageParams }: {
+        address: WalletAddress;
+    } & PaginationParams<AoGatewayDelegate>): Promise<PaginationResult<AoGatewayDelegate>>;
+    getGatewayDelegateAllowList({ address, ...pageParams }: {
+        address: WalletAddress;
+    } & PaginationParams<WalletAddress>): Promise<PaginationResult<WalletAddress>>;
+    getGateways(pageParams?: PaginationParams<AoGatewayWithAddress>): Promise<PaginationResult<AoGatewayWithAddress>>;
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<AoWeightedObserver[]>;
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;
@@ -75,7 +81,7 @@ export declare class IOReadable implements AoIORead {
     getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
     getTokenCost(params: {
         intent: 'Buy-Record';
-        purchaseType: 'permabuy' | 'lease';
+        type: 'permabuy' | 'lease';
         years: number;
         name: string;
     }): Promise<number>;
@@ -91,6 +97,28 @@ export declare class IOReadable implements AoIORead {
     }): Promise<number>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
     getDemandFactor(): Promise<number>;
+    getArNSAuctions(params?: PaginationParams<AoAuction>): Promise<PaginationResult<AoAuction>>;
+    getArNSAuction({ name, }: {
+        name: string;
+    }): Promise<AoAuction | undefined>;
+    /**
+     * Get auction prices for a given auction at the provided intervals
+     *
+     * @param {Object} params - The parameters for fetching auction prices
+     * @param {string} params.name - The name of the auction
+     * @param {('permabuy'|'lease')} [params.type='lease'] - The type of purchase
+     * @param {number} [params.years=1] - The number of years for lease (only applicable if type is 'lease')
+     * @param {number} [params.timestamp=Date.now()] - The timestamp to fetch prices for
+     * @param {number} [params.intervalMs=900000] - The interval in milliseconds between price points (default is 15 minutes)
+     * @returns {Promise<AoAuctionPriceData>} The auction price data
+     */
+    getArNSAuctionPrices({ name, type, years, timestamp, intervalMs, }: {
+        name: string;
+        type?: 'permabuy' | 'lease';
+        years?: number;
+        timestamp?: number;
+        intervalMs?: number;
+    }): Promise<AoAuctionPriceData>;
 }
 export declare class IOWriteable extends IOReadable implements AoIOWrite {
     protected process: AOProcess;
@@ -104,9 +132,9 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         target: string;
         qty: number | mIOToken;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    joinNetwork({ operatorStake, allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
+    joinNetwork({ operatorStake, allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
     leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
-    updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
+    updateGatewaySettings({ allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
     delegateStake(params: {
         target: string;
         stakeQty: number | mIOToken;
@@ -114,6 +142,19 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
     decreaseDelegateStake(params: {
         target: string;
         decreaseQty: number | mIOToken;
+        instant?: boolean;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * Initiates an instant withdrawal from a gateway.
+     *
+     * @param {Object} params - The parameters for initiating an instant withdrawal
+     * @param {string} params.address - The gateway address of the withdrawal, if not provided, the signer's address will be used
+     * @param {string} params.vaultId - The vault ID of the withdrawal
+     * @returns {Promise<AoMessageResult>} The result of the withdrawal
+     */
+    instantWithdrawal(params: {
+        gatewayAddress?: string;
+        vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     increaseOperatorStake(params: {
         increaseQty: number | mIOToken;
@@ -131,6 +172,26 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         type: 'lease' | 'permabuy';
         processId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * Upgrades an existing leased record to a permabuy.
+     *
+     * @param {Object} params - The parameters for upgrading a record
+     * @param {string} params.name - The name of the record to upgrade
+     * @param {Object} [options] - The options for the upgrade
+     * @returns {Promise<AoMessageResult>} The result of the upgrade
+     */
+    upgradeRecord(params: {
+        name: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * Extends the lease of an existing leased record.
+     *
+     * @param {Object} params - The parameters for extending a lease
+     * @param {string} params.name - The name of the record to extend
+     * @param {number} params.years - The number of years to extend the lease
+     * @param {Object} [options] - The options for the extension
+     * @returns {Promise<AoMessageResult>} The result of the extension
+     */
     extendLease(params: {
         name: string;
         years: number;
@@ -139,8 +200,24 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         name: string;
         increaseCount: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    cancelDelegateWithdrawal(params: {
-        address: string;
+    /**
+     * Cancel a withdrawal from a gateway.
+     *
+     * @param {Object} params - The parameters for cancelling a withdrawal
+     * @param {string} [params.address] - The address of the withdrawal (optional). If not provided, the signer's address will be used.
+     * @param {string} params.vaultId - The vault ID of the withdrawal.
+     * @param {Object} [options] - The options for the cancellation
+     * @returns {Promise<AoMessageResult>} The result of the cancellation
+     */
+    cancelWithdrawal(params: {
+        gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions | undefined): Promise<AoMessageResult>;
+    submitAuctionBid(params: {
+        name: string;
+        processId: string;
+        quantity?: number;
+        type?: 'lease' | 'permabuy';
+        years?: number;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }

package/lib/types/types/ant.d.ts

@@ -29,6 +29,8 @@ import { AoMessageResult, WalletAddress, WriteOptions } from './common.js';
  */
 export declare const ArweaveTxIdSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare const IntegerStringSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const AntDescriptionSchema: z.ZodString;
+export declare const AntKeywordsSchema: z.ZodArray<z.ZodString, "many">;
 export declare const AntRecordSchema: z.ZodObject<{
     transactionId: z.ZodEffects<z.ZodString, string, string>;
     ttlSeconds: z.ZodNumber;
@@ -55,6 +57,8 @@ export declare const AntBalancesSchema: z.ZodRecord<z.ZodEffects<z.ZodString, st
 export declare const AntStateSchema: z.ZodObject<{
     Name: z.ZodString;
     Ticker: z.ZodString;
+    Description: z.ZodString;
+    Keywords: z.ZodArray<z.ZodString, "many">;
     Denomination: z.ZodNumber;
     Owner: z.ZodEffects<z.ZodString, string, string>;
     Controllers: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
@@ -77,6 +81,8 @@ export declare const AntStateSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: number;
     Owner: string;
     Controllers: string[];
@@ -92,6 +98,8 @@ export declare const AntStateSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: number;
     Owner: string;
     Controllers: string[];
@@ -113,6 +121,8 @@ export declare const AntInfoSchema: z.ZodObject<{
     "Source-Code-TX-ID": z.ZodEffects<z.ZodString, string, string>;
     Ticker: z.ZodString;
     "Total-Supply": z.ZodEffects<z.ZodString, string, string>;
+    Description: z.ZodString;
+    Keywords: z.ZodArray<z.ZodString, "many">;
     Logo: z.ZodEffects<z.ZodString, string, string>;
     Denomination: z.ZodEffects<z.ZodString, string, string>;
     Handlers: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>>;
@@ -121,6 +131,8 @@ export declare const AntInfoSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: string;
     Owner: string;
     Logo: string;
@@ -131,6 +143,8 @@ export declare const AntInfoSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: string;
     Owner: string;
     Logo: string;
@@ -184,7 +198,22 @@ export interface AoANTWrite extends AoANTRead {
     setTicker({ ticker }: {
         ticker: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    setDescription({ description }: {
+        description: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    setKeywords({ keywords }: {
+        keywords: string[];
+    }, options?: WriteOptions): Promise<AoMessageResult>;
     setName({ name }: {
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    releaseName({ name, ioProcessId }: {
+        name: string;
+        ioProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    reassignName({ name, ioProcessId, antProcessId, }: {
+        name: string;
+        ioProcessId: string;
+        antProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }

package/lib/types/types/io.d.ts

@@ -16,17 +16,17 @@
 import { AOProcess } from '../common/index.js';
 import { AoMessageResult, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
 import { mIOToken } from './token.js';
-export type PaginationParams = {
+export type PaginationParams<T = Record<string, never>> = {
     cursor?: string;
     limit?: number;
-    sortBy?: string;
+    sortBy?: keyof T extends never ? string : keyof T;
     sortOrder?: 'asc' | 'desc';
 };
 export type PaginationResult<T> = {
     items: T[];
     nextCursor: string | undefined;
     totalItems: number;
-    sortBy: keyof T;
+    sortBy?: keyof T;
     sortOrder: 'asc' | 'desc';
     hasMore: boolean;
 };
@@ -142,10 +142,11 @@ export type AoGatewayService = {
 export type AoGatewayServices = {
     bundlers: AoGatewayService[];
 } | undefined;
+export type AoGatewayDelegates = Record<WalletAddress, AoGatewayDelegate>;
+export type AoGatewayDelegateAllowList = WalletAddress[];
 export type AoGateway = {
     settings: AoGatewaySettings;
     stats: AoGatewayStats;
-    delegates: Record<WalletAddress, AoGatewayDelegate>;
     totalDelegatedStake: number;
     vaults: Record<WalletAddress, AoVaultData>;
     startTimestamp: Timestamp;
@@ -188,8 +189,9 @@ export type AoGatewayDelegate = {
     vaults: Record<WalletAddress, AoVaultData>;
 };
 export type AoGatewaySettings = {
-    allowDelegatedStaking: boolean;
+    allowDelegatedStaking: boolean | 'allowlist';
     delegateRewardShareRatio: number;
+    allowedDelegates: WalletAddress[];
     minDelegatedStake: number;
     autoStake: boolean;
     label: string;
@@ -203,6 +205,27 @@ export type AoBalanceWithAddress = {
     address: WalletAddress;
     balance: number;
 };
+export type AoAuctionSettings = {
+    durationMs: number;
+    decayRate: number;
+    scalingExponent: number;
+    startPriceMultiplier: number;
+};
+export type AoAuction = {
+    name: string;
+    startTimestamp: Timestamp;
+    endTimestamp: Timestamp;
+    initiator: string;
+    baseFee: number;
+    demandFactor: number;
+    settings: AoAuctionSettings;
+};
+export type AoAuctionPriceData = {
+    type: 'lease' | 'permabuy';
+    years?: number;
+    prices: Record<string, number>;
+    currentPrice: number;
+};
 export type AoJoinNetworkParams = Pick<AoGateway, 'operatorStake' | 'observerAddress'> & Partial<AoGatewaySettings>;
 export type AoUpdateGatewaySettingsParams = AtLeastOne<AoJoinNetworkParams>;
 export interface AoIORead {
@@ -219,28 +242,45 @@ export interface AoIORead {
     getGateway({ address, }: {
         address: WalletAddress;
     }): Promise<AoGateway | undefined>;
-    getGateways(params?: PaginationParams): Promise<PaginationResult<AoGatewayWithAddress>>;
+    getGatewayDelegates(params: {
+        address: WalletAddress;
+    } & PaginationParams<AoGatewayDelegate>): Promise<PaginationResult<AoGatewayDelegate>>;
+    getGatewayDelegateAllowList(params?: PaginationParams<WalletAddress> & {
+        address: WalletAddress;
+    }): Promise<PaginationResult<WalletAddress>>;
+    getGateways(params?: PaginationParams<AoGatewayWithAddress>): Promise<PaginationResult<AoGatewayWithAddress>>;
     getBalance(params: {
         address: WalletAddress;
     }): Promise<number>;
-    getBalances(params?: PaginationParams): Promise<PaginationResult<AoBalanceWithAddress>>;
+    getBalances(params?: PaginationParams<AoBalanceWithAddress>): Promise<PaginationResult<AoBalanceWithAddress>>;
     getArNSRecord({ name, }: {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
-    getArNSRecords(params?: PaginationParams): Promise<PaginationResult<AoArNSNameDataWithName>>;
+    getArNSRecords(params?: PaginationParams<AoArNSNameDataWithName>): Promise<PaginationResult<AoArNSNameDataWithName>>;
     getArNSReservedNames(): Promise<Record<string, AoArNSReservedNameData> | Record<string, never>>;
     getArNSReservedName({ name, }: {
         name: string;
     }): Promise<AoArNSReservedNameData | undefined>;
+    getArNSAuctions(params?: PaginationParams<AoAuction>): Promise<PaginationResult<AoAuction>>;
+    getArNSAuction({ name }: {
+        name: string;
+    }): Promise<AoAuction | undefined>;
+    getArNSAuctionPrices({ name, type, years, timestamp, intervalMs, }: {
+        name: string;
+        type: 'lease' | 'permabuy';
+        years?: number;
+        timestamp?: number;
+        intervalMs?: number;
+    }): Promise<AoAuctionPriceData>;
     getEpoch(epoch?: EpochInput): Promise<AoEpochData>;
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<AoWeightedObserver[]>;
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;
     getObservations(epoch?: EpochInput): Promise<AoEpochObservationData>;
     getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
-    getTokenCost({ intent, purchaseType, years, name, quantity, }: {
+    getTokenCost({ intent, type, years, name, quantity, }: {
         intent: 'Buy-Record' | 'Extend-Lease' | 'Increase-Undername-Limit';
-        purchaseType?: 'permabuy' | 'lease';
+        type?: 'permabuy' | 'lease';
         years?: number;
         name?: string;
         quantity?: number;
@@ -253,9 +293,9 @@ export interface AoIOWrite extends AoIORead {
         target: WalletAddress;
         qty: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    joinNetwork({ operatorStake, allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
+    joinNetwork(params: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
     leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
-    updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
+    updateGatewaySettings(params: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
     increaseOperatorStake(params: {
         increaseQty: number | mIOToken;
     }, options?: WriteOptions): Promise<AoMessageResult>;
@@ -269,6 +309,11 @@ export interface AoIOWrite extends AoIORead {
     decreaseDelegateStake(params: {
         target: WalletAddress;
         decreaseQty: number | mIOToken;
+        instant?: boolean;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    instantWithdrawal(params: {
+        gatewayAddress?: WalletAddress;
+        vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     saveObservations(params: {
         reportTxId: TransactionId;
@@ -280,6 +325,9 @@ export interface AoIOWrite extends AoIORead {
         type: 'lease' | 'permabuy';
         processId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    upgradeRecord(params: {
+        name: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
     extendLease(params: {
         name: string;
         years: number;
@@ -288,10 +336,17 @@ export interface AoIOWrite extends AoIORead {
         name: string;
         increaseCount: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    cancelDelegateWithdrawal(params: {
-        address: string;
+    cancelWithdrawal(params: {
+        gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    submitAuctionBid(params: {
+        name: string;
+        processId: string;
+        quantity?: number;
+        type?: 'lease' | 'permabuy';
+        years?: number;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }
 export declare function isProcessConfiguration(config: object): config is {
     process: AOProcess;

package/lib/types/utils/arweave.d.ts

@@ -1,3 +1,10 @@
 import { BlockHeight } from '../types/common.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
+export declare const pruneTags: (tags: {
+    name: string;
+    value: string | undefined;
+}[]) => {
+    name: string;
+    value: string;
+}[];

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "2.3.2";
+export declare const version = "2.4.0-alpha.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "2.3.3-alpha.1",
+  "version": "2.4.0-alpha.10",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -66,16 +66,18 @@
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
     "test": "yarn test:unit && yarn test:e2e",
-    "test:cjs": "yarn test:link && cd ./tests/e2e/cjs && yarn && yarn test",
-    "test:esm": "yarn test:link && cd ./tests/e2e/esm && yarn && yarn test",
-    "test:web": "yarn test:link && cd ./tests/e2e/web && yarn && yarn test",
+    "test:cjs": "yarn build:cjs && yarn link && cd ./tests/e2e/cjs && yarn && yarn test",
+    "test:esm": "yarn build:esm && yarn link && cd ./tests/e2e/esm && yarn && yarn test",
+    "test:web": "yarn build:esm && yarn link && cd ./tests/e2e/web && yarn && yarn test",
     "test:unit": "NODE_OPTIONS=\"--import=./register.mjs\" node --test tests/unit/**.test.ts",
     "test:link": "yarn build && yarn link",
     "test:e2e": "yarn test:cjs && yarn test:esm && yarn test:web",
     "prepare": "husky install",
+    "docs:update": "markdown-toc-gen insert README.md",
     "example:esm": "cd examples/esm && yarn && node index.mjs",
-    "example:cjs": "yarn test:link && cd examples/cjs && yarn && node index.cjs",
-    "example:web": "yarn test:link && build:web && http-server --port 8080 --host -o examples/web"
+    "example:cjs": "yarn build:cjs && yarn link && cd examples/cjs && yarn && node index.cjs",
+    "example:web": "yarn build:web && http-server --port 8080 --host -o examples/web",
+    "example:vite": "yarn build:esm && yarn link && cd examples/vite && yarn && yarn start"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.1.2",