@0xsequence/marketplace-sdk 0.10.0 → 1.0.0

package/public/mockServiceWorker.js

@@ -0,0 +1,344 @@
+/* eslint-disable */
+/* tslint:disable */
+
+/**
+ * Mock Service Worker.
+ * @see https://github.com/mswjs/msw
+ * - Please do NOT modify this file.
+ */
+
+const PACKAGE_VERSION = '2.10.2';
+const INTEGRITY_CHECKSUM = 'f5825c521429caf22a4dd13b66e243af';
+const IS_MOCKED_RESPONSE = Symbol('isMockedResponse');
+const activeClientIds = new Set();
+
+addEventListener('install', () => {
+	self.skipWaiting();
+});
+
+addEventListener('activate', (event) => {
+	event.waitUntil(self.clients.claim());
+});
+
+addEventListener('message', async (event) => {
+	const clientId = Reflect.get(event.source || {}, 'id');
+
+	if (!clientId || !self.clients) {
+		return;
+	}
+
+	const client = await self.clients.get(clientId);
+
+	if (!client) {
+		return;
+	}
+
+	const allClients = await self.clients.matchAll({
+		type: 'window',
+	});
+
+	switch (event.data) {
+		case 'KEEPALIVE_REQUEST': {
+			sendToClient(client, {
+				type: 'KEEPALIVE_RESPONSE',
+			});
+			break;
+		}
+
+		case 'INTEGRITY_CHECK_REQUEST': {
+			sendToClient(client, {
+				type: 'INTEGRITY_CHECK_RESPONSE',
+				payload: {
+					packageVersion: PACKAGE_VERSION,
+					checksum: INTEGRITY_CHECKSUM,
+				},
+			});
+			break;
+		}
+
+		case 'MOCK_ACTIVATE': {
+			activeClientIds.add(clientId);
+
+			sendToClient(client, {
+				type: 'MOCKING_ENABLED',
+				payload: {
+					client: {
+						id: client.id,
+						frameType: client.frameType,
+					},
+				},
+			});
+			break;
+		}
+
+		case 'MOCK_DEACTIVATE': {
+			activeClientIds.delete(clientId);
+			break;
+		}
+
+		case 'CLIENT_CLOSED': {
+			activeClientIds.delete(clientId);
+
+			const remainingClients = allClients.filter((client) => {
+				return client.id !== clientId;
+			});
+
+			// Unregister itself when there are no more clients
+			if (remainingClients.length === 0) {
+				self.registration.unregister();
+			}
+
+			break;
+		}
+	}
+});
+
+addEventListener('fetch', (event) => {
+	// Bypass navigation requests.
+	if (event.request.mode === 'navigate') {
+		return;
+	}
+
+	// Opening the DevTools triggers the "only-if-cached" request
+	// that cannot be handled by the worker. Bypass such requests.
+	if (
+		event.request.cache === 'only-if-cached' &&
+		event.request.mode !== 'same-origin'
+	) {
+		return;
+	}
+
+	// Bypass all requests when there are no active clients.
+	// Prevents the self-unregistered worked from handling requests
+	// after it's been deleted (still remains active until the next reload).
+	if (activeClientIds.size === 0) {
+		return;
+	}
+
+	const requestId = crypto.randomUUID();
+	event.respondWith(handleRequest(event, requestId));
+});
+
+/**
+ * @param {FetchEvent} event
+ * @param {string} requestId
+ */
+async function handleRequest(event, requestId) {
+	const client = await resolveMainClient(event);
+	const requestCloneForEvents = event.request.clone();
+	const response = await getResponse(event, client, requestId);
+
+	// Send back the response clone for the "response:*" life-cycle events.
+	// Ensure MSW is active and ready to handle the message, otherwise
+	// this message will pend indefinitely.
+	if (client && activeClientIds.has(client.id)) {
+		const serializedRequest = await serializeRequest(requestCloneForEvents);
+
+		// Clone the response so both the client and the library could consume it.
+		const responseClone = response.clone();
+
+		sendToClient(
+			client,
+			{
+				type: 'RESPONSE',
+				payload: {
+					isMockedResponse: IS_MOCKED_RESPONSE in response,
+					request: {
+						id: requestId,
+						...serializedRequest,
+					},
+					response: {
+						type: responseClone.type,
+						status: responseClone.status,
+						statusText: responseClone.statusText,
+						headers: Object.fromEntries(responseClone.headers.entries()),
+						body: responseClone.body,
+					},
+				},
+			},
+			responseClone.body ? [serializedRequest.body, responseClone.body] : [],
+		);
+	}
+
+	return response;
+}
+
+/**
+ * Resolve the main client for the given event.
+ * Client that issues a request doesn't necessarily equal the client
+ * that registered the worker. It's with the latter the worker should
+ * communicate with during the response resolving phase.
+ * @param {FetchEvent} event
+ * @returns {Promise<Client | undefined>}
+ */
+async function resolveMainClient(event) {
+	const client = await self.clients.get(event.clientId);
+
+	if (activeClientIds.has(event.clientId)) {
+		return client;
+	}
+
+	if (client?.frameType === 'top-level') {
+		return client;
+	}
+
+	const allClients = await self.clients.matchAll({
+		type: 'window',
+	});
+
+	return allClients
+		.filter((client) => {
+			// Get only those clients that are currently visible.
+			return client.visibilityState === 'visible';
+		})
+		.find((client) => {
+			// Find the client ID that's recorded in the
+			// set of clients that have registered the worker.
+			return activeClientIds.has(client.id);
+		});
+}
+
+/**
+ * @param {FetchEvent} event
+ * @param {Client | undefined} client
+ * @param {string} requestId
+ * @returns {Promise<Response>}
+ */
+async function getResponse(event, client, requestId) {
+	// Clone the request because it might've been already used
+	// (i.e. its body has been read and sent to the client).
+	const requestClone = event.request.clone();
+
+	function passthrough() {
+		// Cast the request headers to a new Headers instance
+		// so the headers can be manipulated with.
+		const headers = new Headers(requestClone.headers);
+
+		// Remove the "accept" header value that marked this request as passthrough.
+		// This prevents request alteration and also keeps it compliant with the
+		// user-defined CORS policies.
+		const acceptHeader = headers.get('accept');
+		if (acceptHeader) {
+			const values = acceptHeader.split(',').map((value) => value.trim());
+			const filteredValues = values.filter(
+				(value) => value !== 'msw/passthrough',
+			);
+
+			if (filteredValues.length > 0) {
+				headers.set('accept', filteredValues.join(', '));
+			} else {
+				headers.delete('accept');
+			}
+		}
+
+		return fetch(requestClone, { headers });
+	}
+
+	// Bypass mocking when the client is not active.
+	if (!client) {
+		return passthrough();
+	}
+
+	// Bypass initial page load requests (i.e. static assets).
+	// The absence of the immediate/parent client in the map of the active clients
+	// means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
+	// and is not ready to handle requests.
+	if (!activeClientIds.has(client.id)) {
+		return passthrough();
+	}
+
+	// Notify the client that a request has been intercepted.
+	const serializedRequest = await serializeRequest(event.request);
+	const clientMessage = await sendToClient(
+		client,
+		{
+			type: 'REQUEST',
+			payload: {
+				id: requestId,
+				...serializedRequest,
+			},
+		},
+		[serializedRequest.body],
+	);
+
+	switch (clientMessage.type) {
+		case 'MOCK_RESPONSE': {
+			return respondWithMock(clientMessage.data);
+		}
+
+		case 'PASSTHROUGH': {
+			return passthrough();
+		}
+	}
+
+	return passthrough();
+}
+
+/**
+ * @param {Client} client
+ * @param {any} message
+ * @param {Array<Transferable>} transferrables
+ * @returns {Promise<any>}
+ */
+function sendToClient(client, message, transferrables = []) {
+	return new Promise((resolve, reject) => {
+		const channel = new MessageChannel();
+
+		channel.port1.onmessage = (event) => {
+			if (event.data && event.data.error) {
+				return reject(event.data.error);
+			}
+
+			resolve(event.data);
+		};
+
+		client.postMessage(message, [
+			channel.port2,
+			...transferrables.filter(Boolean),
+		]);
+	});
+}
+
+/**
+ * @param {Response} response
+ * @returns {Response}
+ */
+function respondWithMock(response) {
+	// Setting response status code to 0 is a no-op.
+	// However, when responding with a "Response.error()", the produced Response
+	// instance will have status code set to 0. Since it's not possible to create
+	// a Response instance with status code 0, handle that use-case separately.
+	if (response.status === 0) {
+		return Response.error();
+	}
+
+	const mockedResponse = new Response(response.body, response);
+
+	Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
+		value: true,
+		enumerable: true,
+	});
+
+	return mockedResponse;
+}
+
+/**
+ * @param {Request} request
+ */
+async function serializeRequest(request) {
+	return {
+		url: request.url,
+		mode: request.mode,
+		method: request.method,
+		headers: Object.fromEntries(request.headers.entries()),
+		cache: request.cache,
+		credentials: request.credentials,
+		destination: request.destination,
+		integrity: request.integrity,
+		redirect: request.redirect,
+		referrer: request.referrer,
+		referrerPolicy: request.referrerPolicy,
+		body: await request.arrayBuffer(),
+		keepalive: request.keepalive,
+	};
+}

package/src/react/_internal/api/__mocks__/builder.msw.ts

@@ -72,6 +72,8 @@ export const mockShopCollections = [
 		bannerUrl: 'https://example.com/shop-banner.png',
 		saleBannerUrl: 'https://example.com/shop-sale-banner.png',
 		tokenIds: ['1', '2', '3'],
+		customTokenIds: [],
+		private: false,
 		createdAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 		updatedAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 	},
@@ -85,6 +87,8 @@ export const mockShopCollections = [
 		bannerUrl: 'https://example.com/polygon-shop-banner.png',
 		saleBannerUrl: 'https://example.com/polygon-shop-sale-banner.png',
 		tokenIds: ['4', '5', '6'],
+		customTokenIds: [],
+		private: false,
 		createdAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 		updatedAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 	},
@@ -152,6 +156,7 @@ export const mockConfig = {
 					},
 				],
 			},
+			private: false,
 			createdAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 			updatedAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 		},
@@ -179,6 +184,7 @@ export const mockConfig = {
 					},
 				],
 			},
+			private: false,
 			createdAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 			updatedAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 		},

package/src/react/_internal/api/__mocks__/metadata.msw.ts

@@ -132,7 +132,13 @@ export const mockFilters = [
 	},
 ];
 
-type Endpoint = Capitalize<keyof Metadata>;
+type Endpoint =
+	| 'GetContractInfo'
+	| 'GetContractInfoBatch'
+	| 'GetTokenMetadata'
+	| 'GetTokenMetadataPropertyFilters'
+	| 'SearchTokenMetadata';
+
 type EndpointReturn<E extends Endpoint> = Awaited<
 	ReturnType<Metadata[Uncapitalize<E>]>
 >;
@@ -164,6 +170,11 @@ export const handlers = [
 		filters: mockPropertyFilters,
 	}),
 
+	mockMetadataHandler('SearchTokenMetadata', {
+		tokenMetadata: [mockTokenMetadata],
+		page: { page: 1, pageSize: 10, more: false },
+	}),
+
 	http.post(mockMetadataEndpoint('GetContractInfoBatch'), async (request) => {
 		const body = (await request.request.json()) as GetContractInfoBatchArgs;
 		const chainId = Number(body.chainID);

package/src/react/_internal/api/builder.gen.ts

@@ -5,8 +5,6 @@
 //
 // webrpc-gen -schema=builder.main.ridl -target=typescript -client -out=../../webapp/src/rpc/proto/builder.gen.ts
 
-import type { OrderbookKind } from "./marketplace.gen";
-
 export const WebrpcHeader = "Webrpc";
 export const WebrpcHeaderValue =
   "webrpc@v0.26.0;gen-typescript@v0.17.0;sequence-builder@v0.1.0";
@@ -29,6 +27,7 @@ export enum FilterCondition {
 export interface LookupMarketplaceArgs {
   projectId?: number;
   domain?: string;
+  userAddress?: string;
 }
 
 export interface LookupMarketplaceReturn {
@@ -59,10 +58,10 @@ export interface MarketplaceSettings {
 }
 
 export interface MarketplacePage {
-  enabled: boolean
-  bannerUrl: string
-  ogImage: string
-  private: boolean
+  enabled: boolean;
+  bannerUrl: string;
+  ogImage: string;
+  private: boolean;
 }
 
 export interface MarketplaceSocials {
@@ -110,8 +109,10 @@ export interface MarketCollection {
   bannerUrl: string;
   feePercentage: number;
   currencyOptions: Array<string>;
-  destinationMarketplace: OrderbookKind;
+  destinationMarketplace: string;
   filterSettings?: CollectionFilterSettings;
+  sortOrder?: number;
+  private: boolean;
   createdAt?: string;
   updatedAt?: string;
 }
@@ -136,6 +137,9 @@ export interface ShopCollection {
   name: string;
   bannerUrl: string;
   tokenIds: Array<string>;
+  customTokenIds: Array<string>;
+  sortOrder?: number;
+  private: boolean;
   createdAt?: string;
   updatedAt?: string;
 }

package/src/react/_internal/databeat/index.ts

@@ -2,7 +2,7 @@ import type { Event as DatabeatEvent } from '@databeat/tracker';
 import { Databeat } from '@databeat/tracker';
 import { useContext } from 'react';
 
-import { MarketplaceSdkContext } from '../../provider';
+import { MarketplaceSdkContext } from '../../providers';
 import type {
 	EventType,
 	TrackBuyModalOpened,

package/src/react/_internal/databeat/types.ts

@@ -50,6 +50,7 @@ type BuyModalOpenedProps = Omit<
 	| 'chainId'
 	| 'skipNativeBalanceCheck'
 	| 'nativeTokenAddress'
+	| 'successActionButtons'
 > & {
 	buyAnalyticsId: string;
 };

package/src/react/_internal/query-meta.ts

@@ -0,0 +1,3 @@
+export const persistentQueryMeta = {
+	persistent: true,
+};

package/src/react/_internal/utils.ts

@@ -16,6 +16,7 @@ export interface SignatureStep {
 
 export interface TransactionStep {
 	id:
+		| StepType.tokenApproval
 		| StepType.buy
 		| StepType.sell
 		| StepType.cancel
@@ -43,6 +44,7 @@ export function isSignatureStep(step: Step): step is SignatureStep {
 
 export function isTransactionStep(step: Step): step is TransactionStep {
 	return [
+		StepType.tokenApproval,
 		StepType.buy,
 		StepType.sell,
 		StepType.cancel,

package/src/react/_internal/wagmi/create-config.ts

@@ -2,7 +2,7 @@ import { getDefaultChains } from '@0xsequence/connect';
 import { allNetworks, findNetworkConfig } from '@0xsequence/network';
 import type { Chain, Transport } from 'viem';
 import { cookieStorage, createConfig, createStorage, http } from 'wagmi';
-import type { Env, SdkConfig } from '../../../types';
+import type { Env, SdkConfig } from '../../../types/index';
 import type { MarketplaceConfig } from '../../../types/new-marketplace-types';
 import { DEFAULT_NETWORK } from '../consts';
 import { getConnectors } from './get-connectors';

package/src/react/_internal/wagmi/get-connectors.ts

@@ -17,7 +17,7 @@ import {
 } from '@0xsequence/connect';
 import React, { type FunctionComponent } from 'react';
 import type { CreateConnectorFn } from 'wagmi';
-import type { Env, SdkConfig } from '../../../types';
+import type { Env, SdkConfig } from '../../../types/index';
 import type { MarketplaceConfig } from '../../../types/new-marketplace-types';
 import { MissingConfigError } from '../../../utils/_internal/error/transaction';
 import { MarketplaceWalletType } from '../api/builder.gen';

package/src/react/hooks/{__tests__ → config}/__snapshots__/useMarketplaceConfig.test.tsx.snap

@@ -32,6 +32,7 @@ exports[`useMarketplaceConfig > should fetch marketplace config and styles succe
         "id": 1,
         "itemsAddress": "0x0000000000000000000000000000000000000000",
         "marketplaceType": "market",
+        "private": false,
         "projectId": 1,
         "updatedAt": "2025-03-16T13:04:16.098Z",
       },
@@ -66,6 +67,7 @@ exports[`useMarketplaceConfig > should fetch marketplace config and styles succe
         "id": 2,
         "itemsAddress": "0x1234567890123456789012345678901234567890",
         "marketplaceType": "market",
+        "private": false,
         "projectId": 1,
         "updatedAt": "2025-03-16T13:04:16.098Z",
       },
@@ -105,10 +107,12 @@ exports[`useMarketplaceConfig > should fetch marketplace config and styles succe
         "bannerUrl": "https://example.com/shop-banner.png",
         "chainId": 1,
         "createdAt": "2025-03-16T13:04:16.098Z",
+        "customTokenIds": [],
         "id": 1,
         "itemsAddress": "0x0000000000000000000000000000000000000000",
         "marketplaceType": "shop",
         "name": "Mock Shop Collection",
+        "private": false,
         "projectId": 1,
         "saleAddress": "0x0000000000000000000000000000000000000000",
         "saleBannerUrl": "https://example.com/shop-sale-banner.png",
@@ -123,10 +127,12 @@ exports[`useMarketplaceConfig > should fetch marketplace config and styles succe
         "bannerUrl": "https://example.com/polygon-shop-banner.png",
         "chainId": 137,
         "createdAt": "2025-03-16T13:04:16.098Z",
+        "customTokenIds": [],
         "id": 2,
         "itemsAddress": "0x1234567890123456789012345678901234567890",
         "marketplaceType": "shop",
         "name": "Polygon Shop Collection",
+        "private": false,
         "projectId": 1,
         "saleAddress": "0x1234567890123456789012345678901234567890",
         "saleBannerUrl": "https://example.com/polygon-shop-sale-banner.png",

package/src/react/hooks/config/index.ts

@@ -0,0 +1,3 @@
+export * from './useConfig';
+export * from './useConnectorMetadata';
+export * from './useMarketplaceConfig';

package/src/react/hooks/{useConfig.tsx → config/useConfig.tsx}

@@ -2,8 +2,8 @@
 
 import { useContext } from 'react';
 
-import { MarketplaceSdkProviderNotFoundError } from '../../utils/_internal/error/context';
-import { MarketplaceSdkContext } from '../provider';
+import { MarketplaceSdkProviderNotFoundError } from '../../../utils/_internal/error/context';
+import { MarketplaceSdkContext } from '../../providers';
 
 export function useConfig() {
 	const context = useContext(MarketplaceSdkContext);

package/src/react/hooks/config/useConnectorMetadata.tsx

@@ -0,0 +1,16 @@
+import { useAccount } from 'wagmi';
+import { WalletKind } from '../../_internal/api';
+
+export const useConnectorMetadata = () => {
+	const { connector } = useAccount();
+
+	const isWaaS = connector?.id.endsWith('waas') ?? false;
+	const isSequence = connector?.id.includes('sequence');
+	const walletKind = isSequence ? WalletKind.sequence : WalletKind.unknown;
+
+	return {
+		isWaaS,
+		isSequence,
+		walletKind,
+	};
+};

package/src/react/hooks/{__tests__ → config}/useMarketplaceConfig.test.tsx

@@ -2,7 +2,7 @@ import { renderHook, server, waitFor } from '@test';
 import { describe, expect, it } from 'vitest';
 import { createLookupMarketplaceErrorHandler } from '../../_internal/api/__mocks__/builder.msw';
 
-import { useMarketplaceConfig } from '../useMarketplaceConfig';
+import { useMarketplaceConfig } from './useMarketplaceConfig';
 
 describe('useMarketplaceConfig', () => {
 	it('should fetch marketplace config and styles successfully', async () => {

package/src/react/hooks/{useMarketplaceConfig.tsx → config/useMarketplaceConfig.tsx}

@@ -1,6 +1,6 @@
 import { useQuery } from '@tanstack/react-query';
-import { marketplaceConfigOptions } from '../queries/marketplaceConfig';
-import { useConfig } from './useConfig';
+import { marketplaceConfigOptions } from '../../queries/marketplaceConfig';
+import { useConfig } from '../config/useConfig';
 
 export const useMarketplaceConfig = () => {
 	const config = useConfig();

package/src/react/hooks/contracts/index.ts

@@ -0,0 +1 @@
+export * from './useSalesContractABI';