Merge pull request #760 from inplayer-org/add-nft-endpoints

Add NFT endpoints

Author: mirovladimitrovski

.eslintignore

@@ -2,5 +2,6 @@
 webpack.config.js
 node_modules
 coverage
+clientside_test
 *.lock
 *.log

.eslintrc

@@ -55,7 +55,10 @@
     "@typescript-eslint/no-empty-interface": "off",
     "class-methods-use-this": "off",
     "no-throw-literal": "off",
-    "no-shadow": "warn",
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": [
+      "warn"
+    ],
   },
   "settings": {
     "import/resolver": {

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+# [3.13.0] - 26-06-2022
+
+### Added
+
+- Introduced a new object `NFTs` with NFT-related endpoints
+
 # [3.12.8] - 05-05-2022
 
 ### Changes

index.d.ts

@@ -1,6 +1,5 @@
 import { AxiosResponse } from 'axios';
 
-// eslint-disable-next-line no-shadow
 export enum Env {
   Development = 'development',
   Production = 'production',
@@ -450,7 +449,6 @@ export interface RequestDataCaptureAccessData {
 }
 
 export declare class Asset {
-  // eslint-disable-next-line no-shadow
   constructor(config: Record<string, unknown>, Account: Account);
 
   checkAccessForAsset(id: number): Promise<AxiosResponse<GetItemAccessV1>>;
@@ -703,7 +701,6 @@ export declare interface GoogleOrApplePaymentData {
   voucherCode?: string;
 }
 
-// eslint-disable-next-line no-shadow
 export enum ReceiptValidationPlatform {
   AMAZON = 'amazon',
   APPLE = 'apple',
@@ -744,7 +741,6 @@ type ReceiptData =
 export type ValidateReceiptData = CommonPlatformData & ReceiptData;
 
 export declare class Payment {
-  // eslint-disable-next-line no-shadow
   constructor(config: Record<string, unknown>, Account: Account);
 
   getPaymentMethods(): Promise<AxiosResponse<MerchantPaymentMethod[]>>;
@@ -860,7 +856,6 @@ export interface ChangeSubscriptionPlanResponse {
   message: string;
 }
 export declare class Subscription {
-  // eslint-disable-next-line no-shadow
   constructor(config: Record<string, unknown>, Account: Account);
 
   getSubscriptions(
@@ -891,12 +886,108 @@ export interface VoucherDiscountPrice {
 }
 
 export declare class Voucher {
-  // eslint-disable-next-line no-shadow
   constructor(config: Record<string, unknown>, Account: Account);
 
   getDiscount(data: DiscountData): Promise<AxiosResponse<VoucherDiscountPrice>>;
 }
 
+type FiatCurrency = string;
+
+export enum CryptoCurrency {
+  ETH = 'ETH',
+  MATIC = 'MATIC',
+  USDC = 'USDC',
+}
+
+export interface GetMerchantMarketplaceResponse {
+  id: number;
+  merchant_uuid: string;
+  name: string;
+  logo_url: string;
+  banner_url: string;
+  created_at: number;
+  updated_at: number;
+  engagement_mode: boolean;
+  url: string;
+  currency: FiatCurrency;
+}
+
+export interface CryptoPrice {
+  amount: number;
+  currency: CryptoCurrency;
+}
+
+export enum Prices {
+  CRYPTO = 'crypto',
+  FIAT = 'fiat',
+}
+
+export interface GetMerchantNFTResponse {
+  id: number;
+  title: string;
+  description: string;
+  thumbnail: string;
+  token_uri: string;
+  merchant_uuid: string;
+  prices: Partial<{
+    [Prices.CRYPTO]: CryptoPrice;
+    [Prices.FIAT]: GetAccessFee
+  }>;
+  published: boolean;
+  supply: number;
+  created_at: number;
+  updated_at: number;
+}
+
+export interface GetMerchantNFTListResponse {
+  collection: GetMerchantNFTResponse[] | null;
+  page: number;
+  size: number;
+  total: number;
+}
+
+interface ExchangeRate {
+  asset_id_quote: CryptoCurrency;
+  rate: number;
+}
+
+export interface GetExchangeRatesResponse {
+  asset_id_base: FiatCurrency;
+  rates: ExchangeRate[];
+}
+
+export type GetUserBoughtNFTsResponse = GetMerchantNFTListResponse;
+
+export interface MakeReservationResponse {
+  created_at: number;
+  updated_at: number;
+  description: string;
+  id: number;
+  merchant_uuid: string;
+  prices: Record<string, unknown>;
+  published: boolean;
+  reservation_expires_at: number;
+  reservation_id: number;
+  reservation_owner_id: number;
+  supply: number;
+  thumbnail: string;
+  title: string;
+  token_id: number;
+  token_uri: string;
+}
+
+export declare class NFTs {
+  constructor(config: Record<string, unknown>, Account: Account);
+
+  getMerchantMarketplace(merchantUuid: string): Promise<AxiosResponse<GetMerchantMarketplaceResponse>>;
+  getMerchantNFTList(merchantUuid: string, page?: number, size?: number, filter?: string):
+    Promise<AxiosResponse<GetMerchantNFTListResponse>>;
+  getMerchantNFT(merchantUuid: string, nftId: number): Promise<AxiosResponse<GetMerchantNFTResponse>>;
+  getExchangeRates(fiat: string, invert?: boolean): Promise<AxiosResponse<GetExchangeRatesResponse>>;
+  getUserBoughtNFTs(page?: number, size?: number): Promise<AxiosResponse<GetUserBoughtNFTsResponse>>;
+  makeReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeReservationResponse>>;
+}
+
 export interface ApiEndpoints {
   // Account
   signIn: string;
@@ -956,6 +1047,13 @@ export interface ApiEndpoints {
   getDiscount: string;
   // Branding
   getBranding: (clientId: string, brandingId: string) => string;
+  // NFTs
+  getMerchantMarketplace: (merchantUuid: string) => string,
+  getMerchantNFTList: (merchantUuid: string, page: number, size: number, filter: string) => string;
+  getMerchantNFT: (merchantUuid: string, nftId: number) => string;
+  getExchangeRates: (fiat: string, invert: boolean) => string;
+  getUserBoughtNFTs: (page: number, size: number) => string;
+  makeReservation: (merchantUuid: string, nftId: number) => string;
 }
 
 export interface ApiConfig {
@@ -970,7 +1068,6 @@ export interface ApiConfig {
 export declare const API: ApiEndpoints;
 
 export declare class Notifications {
-  // eslint-disable-next-line no-shadow
   constructor(config: Record<string, unknown>, Account: Account);
 
   getIotToken(): Promise<Record<string, unknown>>;
@@ -1003,6 +1100,7 @@ declare const InPlayer: {
   Subscription: Subscription;
   Voucher: Voucher;
   Branding: Branding;
+  NFTs: NFTs;
   Notifications: Notifications;
   tokenStorage: TokenStorageType;
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inplayer-org/inplayer.js",
-  "version": "3.12.8",
+  "version": "3.13.0",
   "author": "InPlayer",
   "license": "MIT",
   "description": "A Javascript SDK for Inplayer's RESTful API",
@@ -21,7 +21,7 @@
     "prebuild": "rimraf dist",
     "build:dev": "cross-env NODE_ENV=development webpack --config ./webpack.config.js",
     "build:prod": "cross-env NODE_ENV=production webpack --config ./webpack.config.js",
-    "lint": "eslint 'src/**/*.{js,ts,tsx}' --quiet --fix",
+    "lint": "eslint \"src/**/*.{js,ts,tsx}\" --quiet --fix",
     "lint:js:fix": "eslint src/** --fix",
     "analyze-bundle": "babel-node ./tools/analyzeBundle.js",
     "prepublishOnly": "yarn build:prod",

src/constants/index.ts

@@ -107,4 +107,14 @@ export const API = {
   // Branding
   getBranding: (clientId: string, brandingId: string | number): string =>
     `/branding/paywall/${clientId}/${brandingId}`,
+
+  // NFTs
+  getMerchantMarketplace: (merchantUuid: string): string => `/v2/nfts/marketplaces/${merchantUuid}`,
+  getMerchantNFTList: (merchantUuid: string, page: number, size: number, filter: string): string =>
+    `/v2/nfts/${merchantUuid}?filter=${filter}&page=${page}&size=${size}`,
+  getMerchantNFT: (merchantUuid: string, nftId: number): string => `/v2/nfts/${merchantUuid}/${nftId}`,
+  getExchangeRates: (fiat: string, invert: boolean): string =>
+    `/v2/nfts/exchange-rate/${fiat}${invert ? '?invert=true' : ''}`,
+  getUserBoughtNFTs: (page: number, size: number): string => `/v2/nfts?page=${page}&size=${size}`,
+  makeReservation: (merchantUuid: string, nftId: number): string => `/v2/nfts/${merchantUuid}/${nftId}/reserve`,
 };

src/endpoints/nfts.ts

@@ -0,0 +1,115 @@
+import { AxiosResponse } from 'axios';
+import { ApiConfig, Request } from '../models/Config';
+import BaseExtend from '../extends/base';
+import { API } from '../constants';
+import {
+  GetMerchantMarketplaceResponse,
+  GetMerchantNFTListResponse,
+  GetMerchantNFTResponse,
+  GetExchangeRatesResponse,
+  GetMyNFTsResponse,
+  MakeNFTReservationResponse,
+} from '../models/INFTs';
+
+/**
+ * Contains all Requests connected with NFTs
+ *
+ * @class NFTs
+ */
+class NFTs extends BaseExtend {
+  constructor(config: ApiConfig, request: Request) {
+    super(config, request);
+  }
+
+  /**
+   * Returns a merchant's Marketplace data if there is one
+   * @method getMerchantMarketplace
+   * @async
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @returns Promise<AxiosResponse<GetMerchantMarketplaceResponse>>
+   */
+  async getMerchantMarketplace(merchantUuid: string): Promise<AxiosResponse<GetMerchantMarketplaceResponse>> {
+    return this.request.get(API.getMerchantMarketplace(merchantUuid));
+  }
+
+  /**
+   * Returns a list of NFT items sold by a merchant
+   * @method getMerchantNFTList
+   * @async
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @param {number} page The current page number.
+   * If it is not set the starting page will be returned. Defaults to 1
+   * @param {number} size The maximum mumber of items returned in the response. Defaults to 50
+   * @param {string} filter Parameter by which the returned items in the list to be filtered. Defaults to "published"
+   * @returns Promise<AxiosResponse<GetMerchantNFTListResponse>>
+   */
+  async getMerchantNFTList(
+    merchantUuid: string,
+    page = 1,
+    size = 50,
+    filter = 'published',
+  ): Promise<AxiosResponse<GetMerchantNFTListResponse>> {
+    return this.request.get(API.getMerchantNFTList(merchantUuid, page, size, filter));
+  }
+
+  /**
+   * Returns a specific NFT item sold by a merchant
+   * @method getMerchantNFT
+   * @async
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @param {number} nftId The unique NFT identifier
+   * @returns Promise<AxiosResponse<GetMerchantNFTResponse>>
+   */
+  async getMerchantNFT(merchantUuid: string, nftId: number): Promise<AxiosResponse<GetMerchantNFTResponse>> {
+    return this.request.get(API.getMerchantNFT(merchantUuid, nftId));
+  }
+
+  /**
+   * Returns exchange rates of a specific FIAT currency in respect to a list crypto currencies
+   * @method getExchangeRates
+   * @param {string} fiat The FIAT currency
+   * @param {boolean} invert Whether the returned rates to be in their inverted exchange rates
+   * @returns Promise<AxiosResponse<GetExchangeRatesResponse>>
+   */
+  async getExchangeRates(fiat: string, invert = false): Promise<AxiosResponse<GetExchangeRatesResponse>> {
+    return this.request.get(API.getExchangeRates(fiat, invert));
+  }
+
+  /**
+   * Returns a list of NFTs bought and owned by an authenticated user
+   * @method getUserBoughtNFTs
+   * @param {number} page The current page number.
+   * If it is not set the starting page will be returned. Defaults to 1
+   * @param {number} size The maximum mumber of items returned in the response. Defaults to 50
+   * @returns Promise<AxiosResponse<GetMyNFTsResponse>>
+   */
+  async getUserBoughtNFTs(page = 1, size = 50): Promise<AxiosResponse<GetMyNFTsResponse>> {
+    const tokenObject = await this.request.getToken();
+
+    return this.request.authenticatedGet(API.getUserBoughtNFTs(page, size), {
+      headers: {
+        Authorization: `Bearer ${tokenObject.token}`,
+      },
+    });
+  }
+
+  /**
+   * Makes a reservation request for a specific NFT and returns the relevant data when
+   * that reservation is completed successfully
+   * @method makeReservation
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @param {number} nftId The unique NFT identifier
+   * @returns Promise<AxiosResponse<MakeNFTReservationResponse>>
+   */
+  async makeReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeNFTReservationResponse>> {
+    const tokenObject = await this.request.getToken();
+
+    return this.request.authenticatedPost(API.makeReservation(merchantUuid, nftId), {
+      headers: {
+        Authorization: `Bearer ${tokenObject.token}`,
+      },
+    });
+  }
+}
+
+export default NFTs;

src/index.ts

@@ -7,6 +7,7 @@ import Payment from './endpoints/payment';
 import Subscription from './endpoints/subscription';
 import Branding from './endpoints/branding';
 import Voucher from './endpoints/voucher';
+import NFTs from './endpoints/nfts';
 import Notifications from './factories/notifications';
 import RequestFactory from './factories/request';
 import tokenStorage, { TokenStorageType } from './factories/tokenStorage';
@@ -23,6 +24,7 @@ import { Asset as AssetType } from './models/IAsset&Access';
 import { Payment as PaymentType } from './models/IPayment';
 import { Subscription as SubscriptionType } from './models/ISubscription';
 import { Voucher as VoucherType } from './models/IVoucher&Promotion';
+import { NFTs as NFTsType } from './models/INFTs';
 import { Branding as BrandingType } from './models/IBrand';
 
 /**
@@ -44,6 +46,8 @@ export class InPlayer {
   /** @internal */
   Voucher: VoucherType;
   /** @internal */
+  NFTs: NFTsType;
+  /** @internal */
   Branding: BrandingType;
   /** @internal */
   Notifications: NotificationsType;
@@ -62,6 +66,7 @@ export class InPlayer {
     this.Voucher = new Voucher(this.config, this.request);
     this.Branding = new Branding(this.config, this.request);
     this.Notifications = new Notifications(this.config, this.request);
+    this.NFTs = new NFTs(this.config, this.request);
   }
 
   /**