Types.mo

// https://github.com/dfinity/examples/blob/master/motoko/dip-721-nft-container/src/Types.mo
import Nat "mo:base/Nat";
import Nat8 "mo:base/Nat8";
import Nat16 "mo:base/Nat16";
import Nat32 "mo:base/Nat32";
import Nat64 "mo:base/Nat64";
import Blob "mo:base/Blob";
import Principal "mo:base/Principal";
import List "mo:base/List";
import AssocList "mo:base/AssocList";

module {
  public type Dip721NonFungibleToken = {
    logo: LogoResult;
    name: Text;
    symbol: Text;
    maxLimit : Nat16;
  };

  public type ApiError = {
    #Unauthorized;
    #InvalidTokenId;
    #ZeroAddress;
    #Other: Text;
  };

  public type Result<S, E> = {
    #Ok : S;
    #Err : E;
  };

  public type OwnerResult = Result<Principal, ApiError>;
  public type TxReceipt = Result<Nat, ApiError>;
  
  public type TransactionId = Nat;
  public type TokenId = Nat64;

  public type InterfaceId = {
    #Approval;
    #TransactionHistory;
    #Mint;
    #Burn;
    #TransferNotification;
  };

  public type LogoResult = {
    logo_type: Text;
    data: Text;
  };

  public type Nft = {
    owner: Principal;
    id: TokenId;
    metadata: MetadataDesc;
  };

  public type NftResult = Result<Nft, ApiError>;

  public type ExtendedMetadataResult = Result<{
    metadata_desc: MetadataDesc;
    token_id: TokenId;
  }, ApiError>;

  public type MetadataResult = Result<MetadataDesc, ApiError>;

  public type MetadataDesc = [MetadataPart];

  public type MetadataPart = {
    purpose: MetadataPurpose;
    key_val_data: [MetadataKeyVal];
    data: Blob;
  };

  public type MetadataPurpose = {
    #Preview;
    #Rendered;
  };
  
  public type MetadataKeyVal = {
    key: Text;
    val: MetadataVal;
  };

  public type MetadataVal = {
    #TextContent : Text;
    #BlobContent : Blob;
    #NatContent : Nat;
    #Nat8Content: Nat8;
    #Nat16Content: Nat16;
    #Nat32Content: Nat32;
    #Nat64Content: Nat64;
    #PrincipalContent: Principal; // added
    #TextArrayContent: [Text]; // added
    #TextToTextAssocListContent: AssocList.AssocList<Text, Text>; // added
  };

  public type HiddenNftRecord = {
    id: TokenId;
    deleted_by: Principal;
    deletion_time: Nat64;
  };

  public type MintReceipt = Result<MintReceiptPart, ApiError>;

  public type MintReceiptPart = {
    token_id: TokenId;
    id: Nat;
  };

  public type UpdateMetadataValuesInput = {
    id: TokenId;
    updatedOwnerName: Text;
    updatedOwnerContactInfo: Text;
    updatedSpaceDescription: Text;
    updatedSpaceName: Text;
    updatedAboutDescription : Text;
    updatedSpaceData: ?Text;
  };

  public type SignUpFormInput = {
    emailAddress: Text; // provided by user on signup
    pageSubmittedFrom: Text; // capture for analytics
  };

  public type EmailSubscriber = {
    emailAddress: Text;
    pageSubmittedFrom: Text;
    subscribedAt: Nat64;
  };
};