feat: depreciate format() methods. (#1120)

feat: depreciate format methods.

.changeset/mighty-carrots-tickle.md

@@ -0,0 +1,9 @@
+---
+'@moralisweb3/common-streams-utils': minor
+'@moralisweb3/common-aptos-utils': minor
+'@moralisweb3/common-evm-utils': minor
+'@moralisweb3/common-sol-utils': minor
+'moralis': minor
+---
+
+**Breaking change**: All `format()` methods are deprecated now.

packages/common/aptosUtils/src/dataTypes/AptosAddress/AptosAddress.ts

@@ -60,12 +60,9 @@ export class AptosAddress implements MoralisData {
   public constructor(public readonly address: string) {}
 
   /**
-   * Formats the address to hex format.
-   * Currently returns a string representing the address.
-   * @example address.format(); // "0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90"
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   public format(): MoralisDataFormatted {
-    // TODO: add `format` argument
     return this.address;
   }
 

packages/common/aptosUtils/src/dataTypes/AptosNative/AptosNative.ts

@@ -102,12 +102,9 @@ export class AptosNative implements MoralisData {
   }
 
   /**
-   * Converts the AptosNative to a string.
-   * @returns the value of the AptosNative as a string
-   * @example `native.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   public format(): MoralisDataFormatted {
-    // TODO: add `format` argument
     return this.octas;
   }
 

packages/common/aptosUtils/src/dataTypes/AptosNetwork/AptosNetwork.ts

@@ -97,12 +97,9 @@ export class AptosNetwork implements MoralisData {
   private constructor(public readonly network: AptosNetworkName) {}
 
   /**
-   * Formats the network to a specific format.
-   * Currently returns a string representing the network.
-   * @example network.format(); // "mainnet"
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   public format(): MoralisDataFormatted {
-    // TODO: add `format` argument
     return this.network;
   }
 

packages/common/evmUtils/src/dataTypes/Erc20/Erc20.ts

@@ -108,13 +108,7 @@ export class Erc20Token implements MoralisDataObject {
   }
 
   /**
-   * Returns the token as JSON
-   *
-   * @returns the Erc20Token as a JSON object
-   * @example
-   * ```ts
-   * token.format();
-   * ```
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/Erc20Approval/Erc20Approval.ts

@@ -85,8 +85,7 @@ export class Erc20Approval implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON representation of the approval.
-   * @example approval.format()
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/Erc20Burn/Erc20Burn.ts

@@ -83,8 +83,7 @@ export class Erc20Burn implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON representation of the burn.
-   * @example burn.format()
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/Erc20Mint/Erc20Mint.ts

@@ -84,8 +84,7 @@ export class Erc20Mint implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON representation of the mint.
-   * @example mint.format()
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/Erc20Transfer/Erc20Transfer.ts

@@ -91,8 +91,7 @@ export class Erc20Transfer implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON represention of the transfer.
-   * @example transfer.format()
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/Erc20Value/Erc20Value.ts

@@ -156,9 +156,7 @@ export class Erc20Value implements MoralisData {
   };
 
   /**
-   * Convert the value to a string
-   * @returns the value in string format
-   * @example value.format();
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format(): string {
     return this.toString();

packages/common/evmUtils/src/dataTypes/EvmBlock/EvmBlock.ts

@@ -107,11 +107,7 @@ export class EvmBlock implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON represention of the block.
-   * @example
-   * ```
-   * block.format()
-   * ```
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmBlock/EvmSimpleBlock.ts

@@ -94,11 +94,7 @@ export class EvmSimpleBlock implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON represention of the block.
-   * @example
-   * ```
-   * block.format()
-   * ```
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmEvent/EvmEvent.ts

@@ -117,8 +117,7 @@ export class EvmEvent implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON represention of the event.
-   * @example event.format()
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmInternalTransaction/EvmInternalTransaction.ts

@@ -104,11 +104,7 @@ export class EvmInternalTransaction implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON represention of the transaction.
-   * @example
-   * ```
-   * transaction.format()
-   * ```
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmNative/EvmNative.ts

@@ -153,9 +153,7 @@ export class EvmNative implements MoralisData {
   }
 
   /**
-   * Converts the EvmNative to a string.
-   * @returns the value of the EvmNative as a string
-   * @example `native.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   public format(): string {
     return this.toString();

packages/common/evmUtils/src/dataTypes/EvmNft/EvmNft.ts

@@ -153,9 +153,7 @@ export class EvmNft implements MoralisDataObject {
   }
 
   /**
-   * Converts the EvmNft instance to a JSON object.
-   * @returns JSON object of the EvmNft instance
-   * @example `nft.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.ts

@@ -90,11 +90,7 @@ export class EvmNftCollection implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON represention of the collection.
-   * @example
-   * ```
-   * collection.format()
-   * ```
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmNftMedia/EvmNftMedia.ts

@@ -81,8 +81,7 @@ export class EvmNftMedia implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON representation of the media.
-   * @example media.format()
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmNftMetadata/EvmNftMetadata.ts

@@ -98,8 +98,7 @@ export class EvmNftMetadata implements MoralisDataObject {
   }
 
   /**
-   * @returns the data as JSON.
-   * @example metadata.format();
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmSignature/EvmSignature.ts

@@ -77,6 +77,9 @@ export class EvmSignature implements MoralisDataObject {
     };
   }
 
+  /**
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
+   */
   format() {
     return this.serialized;
   }

packages/common/evmUtils/src/dataTypes/EvmTransaction/EvmTransaction.ts

@@ -135,11 +135,7 @@ export class EvmTransaction implements MoralisDataObject {
   }
 
   /**
-   * @returns a JSON represention of the transaction.
-   * @example
-   * ```
-   * transaction.format()
-   * ```
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/evmUtils/src/dataTypes/EvmTransactionLog/EvmTransactionLog.ts

@@ -93,13 +93,7 @@ export class EvmTransactionLog implements MoralisDataObject {
   }
 
   /**
-   * Converts the log to a JSON object.
-   *
-   * @returns the EvmTransactionLog as a JSON object
-   * @example
-   * ```ts
-   * log.format();
-   * ```
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/solUtils/src/dataTypes/SolAddress/SolAddress.ts

@@ -44,12 +44,9 @@ export class SolAddress implements MoralisData {
   public constructor(public readonly address: string) {}
 
   /**
-   * Formats the address to a specific format.
-   * Currently returns a string representing the address.
-   * @example address.format(); // "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   public format(): MoralisDataFormatted {
-    // TODO: add `format` argument
     return this.address;
   }
 

packages/common/solUtils/src/dataTypes/SolNative/SolNative.ts

@@ -96,9 +96,7 @@ export class SolNative implements MoralisData {
   }
 
   /**
-   * Converts the SolNative to a string.
-   * @returns the value of the SolNative as a string
-   * @example `native.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   public format(): MoralisDataFormatted {
     // TODO: add `format` argument

packages/common/solUtils/src/dataTypes/SolNetwork/SolNetwork.ts

@@ -77,12 +77,9 @@ export class SolNetwork implements MoralisData {
   private constructor(public readonly network: SolNetworkName) {}
 
   /**
-   * Formats the network to a specific format.
-   * Currently returns a string representing the network.
-   * @example network.format(); // "mainnet"
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   public format(): MoralisDataFormatted {
-    // TODO: add `format` argument
     return this.network;
   }
 

packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.ts

@@ -108,9 +108,7 @@ export class EvmStream implements MoralisDataObject {
   }
 
   /**
-   * Converts the EvmStream instance to a JSON object.
-   * @returns JSON object of the EvmStream instance
-   * @example `evmStream.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/EvmStreamResult/EvmStreamResult.ts

@@ -101,9 +101,7 @@ export class EvmStreamResult implements MoralisDataObject {
   }
 
   /**
-   * Converts the EvmStreamResult instance to a JSON object.
-   * @returns JSON object of the EvmStreamResult instance
-   * @example `evmStreamResult.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/StreamErc20Approval/StreamErc20Approval.ts

@@ -119,9 +119,7 @@ export class StreamErc20Approval implements MoralisDataObject {
   }
 
   /**
-   * Converts the StreamErc20Approval instance to a JSON object.
-   * @returns JSON object of the StreamErc20Approval instance
-   * @example `erc20Approval.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/StreamErc20Transfer/StreamErc20Transfer.ts

@@ -119,9 +119,7 @@ export class StreamErc20Transfer implements MoralisDataObject {
   }
 
   /**
-   * Converts the StreamErc20Transfer instance to a JSON object.
-   * @returns JSON object of the StreamErc20Transfer instance
-   * @example `erc20Transfer.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/StreamErc721Approval/StreamErc721Approval.ts

@@ -128,9 +128,7 @@ export class StreamErc721Approval implements MoralisDataObject {
   }
 
   /**
-   * Converts the StreamErc721Approval instance to a JSON object.
-   * @returns JSON object of the StreamErc721Approval instance
-   * @example `evmNftApproval.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/StreamEvmInternalTransaction/StreamEvmInternalTransaction.ts

@@ -112,9 +112,7 @@ export class StreamEvmInternalTransaction implements MoralisDataObject {
   }
 
   /**
-   * Converts the StreamEvmInternalTransaction instance to a JSON object.
-   * @returns JSON object of the StreamEvmInternalTransaction instance
-   * @example `evmInternalTransaction.format()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/StreamEvmNftTransfer/StreamEvmNftTransfer.ts

@@ -128,9 +128,7 @@ export class StreamEvmNftTransfer implements MoralisDataObject {
   }
 
   /**
-   * Converts the StreamEvmNftTransfer instance to a JSON object.
-   * @returns JSON object of the StreamEvmNftTransfer instance
-   * @example `transfer.toJSON()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/StreamEvmTransaction/StreamEvmTransaction.ts

@@ -149,9 +149,7 @@ export class StreamEvmTransaction implements MoralisDataObject {
   }
 
   /**
-   * Converts the StreamEvmTransaction instance to a JSON object.
-   * @returns JSON object of the StreamEvmTransaction instance
-   * @example `transaction.toJSON()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();

packages/common/streamsUtils/src/dataTypes/StreamEvmTransactionLog/StreamEvmTransactionLog.ts

@@ -114,9 +114,7 @@ export class StreamEvmTransactionLog implements MoralisDataObject {
   }
 
   /**
-   * Converts the StreamEvmTransactionLog instance to a JSON object.
-   * @returns JSON object of the StreamEvmTransactionLog instance
-   * @example `transactionLog.toJSON()`
+   * @deprecated This method will be removed soon. To format the value, use one of the properties.
    */
   format() {
     return this.toJSON();