Do not edit this file. It is a report generated by API Extractor.
import Ajv from 'ajv';
import type { Emitter } from 'mitt';
import { ErrorObject } from 'ajv';
import { FuncKeywordDefinition } from 'ajv';
import { JSONSchemaType } from 'ajv';
import { KeywordDefinition } from 'ajv';
// @public
export type AbstractTypedSchema<T> = {
schema: JSONSchema<T>;
validate: ValidateFunction<T>;
};
// Warning: (ae-missing-release-tag) "Account" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Account" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Account = {
id: string;
address: string;
sales: number;
purchases: number;
spent: string;
earned: string;
royalties: string;
collections: number;
};
// @public (undocumented)
export namespace Account {
const // (undocumented)
schema: JSONSchema<Account>;
const // (undocumented)
validate: ValidateFunction<Account>;
}
// Warning: (ae-missing-release-tag) "AccountFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type AccountFilters = {
first?: number;
skip?: number;
sortBy?: AccountSortBy;
id?: string;
address?: string[];
network?: Network;
};
// Warning: (ae-missing-release-tag) "AccountSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum AccountSortBy {
// (undocumented)
MOST_COLLECTIONS = "most_collections",
// (undocumented)
MOST_EARNED = "most_earned",
// (undocumented)
MOST_PURCHASES = "most_purchases",
// (undocumented)
MOST_ROYALTIES = "most_royalties",
// (undocumented)
MOST_SALES = "most_sales",
// (undocumented)
MOST_SPENT = "most_spent"
}
// @public (undocumented)
type Actions = typeof SCENE_UPDATE | typeof UPDATE;
// Warning: (ae-missing-release-tag) "AddMappingError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AddMappingError extends Error {
// Warning: (ae-incompatible-release-tags) The symbol "__constructor" is marked as @public, but its signature references "Mapping" which is marked as @alpha
constructor(message: string, existingMapping: Mapping, conflictingMapping: Mapping);
// Warning: (ae-incompatible-release-tags) The symbol "conflictingMapping" is marked as @public, but its signature references "Mapping" which is marked as @alpha
//
// (undocumented)
conflictingMapping: Mapping;
// Warning: (ae-incompatible-release-tags) The symbol "existingMapping" is marked as @public, but its signature references "Mapping" which is marked as @alpha
//
// (undocumented)
existingMapping: Mapping;
}
export { Ajv }
// Warning: (ae-missing-release-tag) "AnalyticsDayData" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type AnalyticsDayData = {
id: string;
date: number;
sales: number;
volume: string;
creatorsEarnings: string;
daoEarnings: string;
};
// Warning: (ae-missing-release-tag) "AnalyticsDayDataFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type AnalyticsDayDataFilters = {
from?: number;
network?: Network;
};
// Warning: (ae-missing-release-tag) "AnalyticsDayDataSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum AnalyticsDayDataSortBy {
// (undocumented)
DATE = "date",
// (undocumented)
MOST_SALES = "most_sales"
}
// @alpha
export type AnyMapping = {
type: MappingType.ANY;
};
// @alpha
export namespace AnyMapping {
const // (undocumented)
schema: JSONSchema<AnyMapping>;
const // (undocumented)
validate: ValidateFunction<Mapping>;
}
// @public
export type AuthChain = AuthLink[];
// @public (undocumented)
export namespace AuthChain {
const // (undocumented)
schema: JSONSchema<AuthChain>;
const // (undocumented)
validate: ValidateFunction<AuthChain>;
}
// @public (undocumented)
export type AuthLink = {
type: AuthLinkType;
payload: string;
signature?: string;
};
// @public (undocumented)
export namespace AuthLink {
const // (undocumented)
schema: JSONSchema<AuthLink>;
const // (undocumented)
validate: ValidateFunction<AuthLink>;
}
// @public (undocumented)
export enum AuthLinkType {
'ECDSA_EIP_1654_EPHEMERAL' = "ECDSA_EIP_1654_EPHEMERAL",
'ECDSA_EIP_1654_SIGNED_ENTITY' = "ECDSA_EIP_1654_SIGNED_ENTITY",
// (undocumented)
'ECDSA_PERSONAL_EPHEMERAL' = "ECDSA_EPHEMERAL",
// (undocumented)
'ECDSA_PERSONAL_SIGNED_ENTITY' = "ECDSA_SIGNED_ENTITY",
// (undocumented)
'SIGNER' = "SIGNER"
}
// @alpha
export type Avatar = {
userId: string;
name: string;
description: string;
links?: Link[];
country?: string;
employmentStatus?: string;
gender?: string;
pronouns?: string;
relationshipStatus?: string;
sexualOrientation?: string;
language?: string;
profession?: string;
birthdate?: number;
realName?: string;
hobbies?: string;
ethAddress: EthAddress;
version: number;
tutorialStep: number;
email?: string;
blocked?: string[];
muted?: string[];
interests?: string[];
hasClaimedName: boolean;
avatar: AvatarInfo;
hasConnectedWeb3?: boolean;
};
// @alpha
export namespace Avatar {
const // (undocumented)
schema: JSONSchema<Avatar>;
const // (undocumented)
validate: ValidateFunction<Avatar>;
}
// @alpha
export type AvatarInfo = {
bodyShape: WearableId;
eyes: {
color: Color3;
};
hair: {
color: Color3;
};
skin: {
color: Color3;
};
wearables: WearableId[];
forceRender?: WearableCategory[];
emotes?: {
slot: number;
urn: string;
}[];
snapshots: Snapshots;
};
// @alpha
export namespace AvatarInfo {
const // (undocumented)
schema: JSONSchema<AvatarInfo>;
const // (undocumented)
validate: ValidateFunction<AvatarInfo>;
}
// Warning: (ae-missing-release-tag) "BadgeGrantedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "BadgeGrantedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BadgeGrantedEvent = BaseEvent & {
type: Events.Type.BADGE;
subType: Events.SubType.Badge.GRANTED;
metadata: {
badgeId: string;
badgeName: string;
badgeTierName?: string;
badgeImageUrl: string;
address: string;
};
};
// @public (undocumented)
export namespace BadgeGrantedEvent {
const // (undocumented)
schema: JSONSchema<BadgeGrantedEvent>;
const // (undocumented)
validate: ValidateFunction<BadgeGrantedEvent>;
}
// Warning: (ae-missing-release-tag) "BaseBid" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BaseBid = {
id: string;
bidder: string;
seller: string;
price: string;
status: ListingStatus;
expiresAt: number;
createdAt: number;
updatedAt: number;
contractAddress: string;
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
fingerprint: string;
};
// Warning: (ae-missing-release-tag) "BaseEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BaseEvent = {
type: Events.Type;
subType: Events.SubType.Blockchain | Events.SubType.CatalystDeployment | Events.SubType.Client | Events.SubType.Marketplace | Events.SubType.Rewards | Events.SubType.Badge;
key: string;
timestamp: number;
};
// Warning: (ae-missing-release-tag) "BaseTradeAsset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BaseTradeAsset = {
assetType: TradeAssetType;
contractAddress: string;
extra: string;
};
// Warning: (ae-missing-release-tag) "Bid" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Bid" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Bid = LegacyBid | BidTrade;
// @public (undocumented)
export namespace Bid {
const // (undocumented)
schema: JSONSchema<Bid>;
const // (undocumented)
validate: ValidateFunction<Bid>;
}
// Warning: (ae-missing-release-tag) "BidAcceptedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "BidAcceptedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BidAcceptedEvent = BaseEvent & {
type: Events.Type.BLOCKCHAIN;
subType: Events.SubType.Blockchain.BID_ACCEPTED;
metadata: BidEventMetadata;
};
// @public (undocumented)
export namespace BidAcceptedEvent {
const // (undocumented)
schema: JSONSchema<BidAcceptedEvent>;
const // (undocumented)
validate: ValidateFunction<BidAcceptedEvent>;
}
// Warning: (ae-missing-release-tag) "BidEventMetadata" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BidEventMetadata = {
address: string;
image: string;
seller: string;
category: string;
rarity?: string;
link: string;
nftName?: string;
price: string;
title: string;
description: string;
network: string;
};
// Warning: (ae-missing-release-tag) "BidFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BidFilters = {
first?: number;
skip?: number;
sortBy?: BidSortBy;
bidAddress?: string;
bidder?: string;
seller?: string;
contractAddress?: string;
tokenId?: string;
status?: ListingStatus;
network?: Network;
};
// Warning: (ae-missing-release-tag) "BidReceivedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "BidReceivedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BidReceivedEvent = BaseEvent & {
type: Events.Type.MARKETPLACE;
subType: Events.SubType.Marketplace.BID_RECEIVED;
metadata: BidEventMetadata;
};
// @public (undocumented)
export namespace BidReceivedEvent {
const // (undocumented)
schema: JSONSchema<BidReceivedEvent>;
const // (undocumented)
validate: ValidateFunction<BidReceivedEvent>;
}
// Warning: (ae-missing-release-tag) "BidSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum BidSortBy {
// (undocumented)
MOST_EXPENSIVE = "most_expensive",
// (undocumented)
RECENTLY_OFFERED = "recently_offered",
// (undocumented)
RECENTLY_UPDATED = "recently_updated"
}
// Warning: (ae-missing-release-tag) "BidTrade" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type BidTrade = NFTBid | ItemBid;
// Warning: (ae-missing-release-tag) "BodyPartCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "BodyPartCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum BodyPartCategory {
// (undocumented)
HANDS = "hands",
// (undocumented)
HEAD = "head"
}
// @public (undocumented)
export namespace BodyPartCategory {
const // (undocumented)
schema: JSONSchema<BodyPartCategory>;
const // (undocumented)
validate: ValidateFunction<BodyPartCategory>;
}
// @alpha (undocumented)
export enum BodyShape {
// (undocumented)
FEMALE = "urn:decentraland:off-chain:base-avatars:BaseFemale",
// (undocumented)
MALE = "urn:decentraland:off-chain:base-avatars:BaseMale"
}
// @alpha (undocumented)
export namespace BodyShape {
const // (undocumented)
schema: JSONSchema<BodyShape>;
const // (undocumented)
validate: ValidateFunction<BodyShape>;
}
// Warning: (ae-missing-release-tag) "CampaignGasPriceHigherThanExpectedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "CampaignGasPriceHigherThanExpectedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CampaignGasPriceHigherThanExpectedEvent = BaseEvent & {
type: Events.Type.REWARDS;
subType: Events.SubType.Rewards.CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED;
metadata: CampaignWellKnownIssueEventMetadata;
};
// @public (undocumented)
export namespace CampaignGasPriceHigherThanExpectedEvent {
const // (undocumented)
schema: JSONSchema<CampaignGasPriceHigherThanExpectedEvent>;
const // (undocumented)
validate: ValidateFunction<CampaignGasPriceHigherThanExpectedEvent>;
}
// Warning: (ae-missing-release-tag) "CampaignOutOfFundsEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "CampaignOutOfFundsEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CampaignOutOfFundsEvent = BaseEvent & {
type: Events.Type.REWARDS;
subType: Events.SubType.Rewards.CAMPAIGN_OUT_OF_FUNDS;
metadata: CampaignWellKnownIssueEventMetadata;
};
// @public (undocumented)
export namespace CampaignOutOfFundsEvent {
const // (undocumented)
schema: JSONSchema<CampaignOutOfFundsEvent>;
const // (undocumented)
validate: ValidateFunction<CampaignOutOfFundsEvent>;
}
// Warning: (ae-missing-release-tag) "CampaignOutOfStockEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "CampaignOutOfStockEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CampaignOutOfStockEvent = BaseEvent & {
type: Events.Type.REWARDS;
subType: Events.SubType.Rewards.CAMPAIGN_OUT_OF_STOCK;
metadata: CampaignWellKnownIssueEventMetadata;
};
// @public (undocumented)
export namespace CampaignOutOfStockEvent {
const // (undocumented)
schema: JSONSchema<CampaignOutOfStockEvent>;
const // (undocumented)
validate: ValidateFunction<CampaignOutOfStockEvent>;
}
// Warning: (ae-forgotten-export) The symbol "BaseEventMetadata" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "CampaignWellKnownIssueEventMetadata" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CampaignWellKnownIssueEventMetadata = BaseEventMetadata & {
owner: EthAddress;
campaignId: string;
campaignName: string;
};
// @public
export type CatalogFilters = Pick<ItemFilters, 'ids' | 'first' | 'skip' | 'category' | 'creator' | 'isSoldOut' | 'isOnSale' | 'search' | 'isWearableHead' | 'isWearableSmart' | 'isWearableAccessory' | 'isWearableAccessory' | 'wearableCategory' | 'rarities' | 'wearableGenders' | 'emoteCategory' | 'emoteGenders' | 'emotePlayMode' | 'contractAddresses' | 'itemId' | 'network' | 'minPrice' | 'maxPrice' | 'urns' | 'emoteHasGeometry' | 'emoteHasSound'> & {
onlyMinting?: boolean;
onlyListing?: boolean;
sortBy?: CatalogSortBy;
sortDirection?: CatalogSortDirection;
limit?: number;
offset?: number;
};
// @public
export enum CatalogSortBy {
// (undocumented)
CHEAPEST = "cheapest",
// (undocumented)
MOST_EXPENSIVE = "most_expensive",
// (undocumented)
NEWEST = "newest",
// (undocumented)
RECENTLY_LISTED = "recently_listed",
// (undocumented)
RECENTLY_SOLD = "recently_sold"
}
// @public
export enum CatalogSortDirection {
// (undocumented)
ASC = "asc",
// (undocumented)
DESC = "desc"
}
// Warning: (ae-missing-release-tag) "CatalystDeploymentEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "CatalystDeploymentEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CatalystDeploymentEvent = BaseEvent & {
type: Events.Type.CATALYST_DEPLOYMENT;
subType: Events.SubType.CatalystDeployment;
entity: Entity;
authChain: AuthChain;
};
// @public (undocumented)
export namespace CatalystDeploymentEvent {
const // (undocumented)
schema: JSONSchema<CatalystDeploymentEvent>;
const // (undocumented)
validate: ValidateFunction<CatalystDeploymentEvent>;
}
// @alpha
export enum ChainId {
// (undocumented)
ARBITRUM_MAINNET = 42161,
// (undocumented)
AVALANCHE_MAINNET = 43114,
// (undocumented)
BSC_MAINNET = 56,
// (undocumented)
ETHEREUM_GOERLI = 5,
// (undocumented)
ETHEREUM_KOVAN = 42,
// (undocumented)
ETHEREUM_MAINNET = 1,
// (undocumented)
ETHEREUM_RINKEBY = 4,
// (undocumented)
ETHEREUM_ROPSTEN = 3,
// (undocumented)
ETHEREUM_SEPOLIA = 11155111,
// (undocumented)
FANTOM_MAINNET = 250,
// (undocumented)
MATIC_AMOY = 80002,
// (undocumented)
MATIC_MAINNET = 137,
// (undocumented)
MATIC_MUMBAI = 80001,
// (undocumented)
OPTIMISM_MAINNET = 10
}
// @alpha (undocumented)
export namespace ChainId {
const // (undocumented)
schema: JSONSchema<ChainId>;
const // (undocumented)
validate: ValidateFunction<ChainId>;
}
// @alpha
export enum ChainName {
// (undocumented)
ARBITRUM_MAINNET = "Arbitrum",
// (undocumented)
AVALANCHE_MAINNET = "Avalanche",
// (undocumented)
BINANCE_MAINNET = "Binance Smart Chain",
// (undocumented)
ETHEREUM_GOERLI = "Goerli",
// (undocumented)
ETHEREUM_KOVAN = "Kovan",
// (undocumented)
ETHEREUM_MAINNET = "Ethereum Mainnet",
// (undocumented)
ETHEREUM_RINKEBY = "Rinkeby",
// (undocumented)
ETHEREUM_ROPSTEN = "Ropsten",
// (undocumented)
ETHEREUM_SEPOLIA = "Sepolia",
// (undocumented)
FANTOM_MAINNET = "Fantom",
// (undocumented)
MATIC_AMOY = "Amoy",
// (undocumented)
MATIC_MAINNET = "Polygon",
// (undocumented)
MATIC_MUMBAI = "Mumbai",
// (undocumented)
OPTIMISM_MAINNET = "Optimism"
}
// @alpha (undocumented)
export namespace ChainName {
const // (undocumented)
schema: JSONSchema<ChainName>;
const // (undocumented)
validate: ValidateFunction<ChainName>;
}
// Warning: (ae-missing-release-tag) "Collection" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Collection" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Collection = {
urn: string;
name: string;
creator: string;
contractAddress: string;
isOnSale: boolean;
size: number;
createdAt: number;
updatedAt: number;
reviewedAt: number;
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
firstListedAt: number | null;
};
// @public (undocumented)
export namespace Collection {
const // (undocumented)
schema: JSONSchema<Collection>;
const // (undocumented)
validate: ValidateFunction<Collection>;
}
// Warning: (ae-missing-release-tag) "CollectionCreatedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "CollectionCreatedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CollectionCreatedEvent = BaseEvent & {
type: Events.Type.BLOCKCHAIN;
subType: Events.SubType.Blockchain.COLLECTION_CREATED;
metadata: {
creator: string;
name: string;
};
};
// @public (undocumented)
export namespace CollectionCreatedEvent {
const // (undocumented)
schema: JSONSchema<CollectionCreatedEvent>;
const // (undocumented)
validate: ValidateFunction<CollectionCreatedEvent>;
}
// Warning: (ae-missing-release-tag) "CollectionFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CollectionFilters = {
first?: number;
skip?: number;
sortBy?: CollectionSortBy;
name?: string;
search?: string;
creator?: string;
contractAddress?: string;
urn?: string;
isOnSale?: boolean;
network?: Network;
};
// Warning: (ae-missing-release-tag) "CollectionItemTradeAsset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type CollectionItemTradeAsset = BaseTradeAsset & {
assetType: TradeAssetType.COLLECTION_ITEM;
itemId: string;
};
// Warning: (ae-missing-release-tag) "CollectionSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum CollectionSortBy {
// (undocumented)
NAME = "name",
// (undocumented)
NEWEST = "newest",
// (undocumented)
RECENTLY_LISTED = "recently_listed",
// (undocumented)
RECENTLY_REVIEWED = "recently_reviewed",
// (undocumented)
SIZE = "size"
}
// @alpha
export type Color3 = {
r: number;
g: number;
b: number;
};
// @alpha
export namespace Color3 {
const // (undocumented)
schema: JSONSchema<Color3>;
const // (undocumented)
validate: ValidateFunction<Color3>;
}
// @public
export type ContentMapping = {
file: string;
hash: IPFSv1 | IPFSv2;
};
// @public (undocumented)
export namespace ContentMapping {
const // (undocumented)
schema: JSONSchema<ContentMapping>;
const // (undocumented)
validate: ValidateFunction<ContentMapping>;
}
// Warning: (ae-missing-release-tag) "Contract" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Contract" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Contract = {
name: string;
address: string;
category: NFTCategory;
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
};
// @public (undocumented)
export namespace Contract {
const // (undocumented)
schema: JSONSchema<Contract>;
const // (undocumented)
validate: ValidateFunction<Contract>;
}
// @alpha
export type ContractAddress = string;
// Warning: (ae-missing-release-tag) "ContractFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ContractFilters = {
category?: NFTCategory;
network?: Network;
};
// @alpha
export enum ContractNetwork {
// (undocumented)
AMOY = "amoy",
// (undocumented)
MAINNET = "mainnet",
// (undocumented)
MATIC = "matic",
// (undocumented)
SEPOLIA = "sepolia"
}
// Warning: (ae-missing-release-tag) "ContractSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum ContractSortBy {
// (undocumented)
NAME = "name"
}
// Warning: (ae-incompatible-release-tags) The symbol "createMappingsHelper" is marked as @public, but its signature references "Mappings" which is marked as @alpha
// Warning: (ae-missing-release-tag) "createMappingsHelper" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function createMappingsHelper(initial?: Mappings): MappingsHelper;
// Warning: (tsdoc-missing-deprecation-message) The @deprecated block must include a deprecation message, e.g. describing the recommended alternative
//
// @public @deprecated
export type DeploymentWithAuthChain = {
entityId: string;
entityType: string;
pointers: string[];
localTimestamp: number;
authChain: AuthChain;
};
// @public @deprecated (undocumented)
export namespace DeploymentWithAuthChain {
const // (undocumented)
schema: JSONSchema<DeploymentWithAuthChain>;
const // (undocumented)
validate: ValidateFunction<DeploymentWithAuthChain>;
}
// @public
export type DisplayableDeployment = {
menuBarIcon?: string;
};
// @public
export type Email = string;
// @public
export namespace Email {
const // (undocumented)
schema: JSONSchema<Email>;
const // (undocumented)
validate: ValidateFunction<Email>;
}
// Warning: (ae-forgotten-export) The symbol "EmoteADR74" needs to be exported by the entry point index.d.ts
//
// @alpha (undocumented)
export type Emote = EmoteADR74;
// @alpha (undocumented)
export namespace Emote {
const // (undocumented)
schema: JSONSchema<Emote>;
const // (undocumented)
validate: ValidateFunction<EmoteADR74>;
}
// Warning: (ae-missing-release-tag) "EmoteCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "EmoteCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum EmoteCategory {
// (undocumented)
DANCE = "dance",
// (undocumented)
FUN = "fun",
// (undocumented)
GREETINGS = "greetings",
// (undocumented)
HORROR = "horror",
// (undocumented)
MISCELLANEOUS = "miscellaneous",
// (undocumented)
POSES = "poses",
// (undocumented)
REACTIONS = "reactions",
// (undocumented)
STUNT = "stunt"
}
// @public (undocumented)
export namespace EmoteCategory {
const // (undocumented)
schema: JSONSchema<EmoteCategory>;
const // (undocumented)
validate: ValidateFunction<EmoteCategory>;
}
// Warning: (ae-missing-release-tag) "EmoteDataADR74" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "EmoteDataADR74" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type EmoteDataADR74 = {
category: EmoteCategory;
representations: EmoteRepresentationADR74[];
tags: string[];
loop: boolean;
};
// @public (undocumented)
export namespace EmoteDataADR74 {
const // (undocumented)
schema: JSONSchema<EmoteDataADR74>;
const // (undocumented)
validate: ValidateFunction<EmoteDataADR74>;
}
// Warning: (ae-incompatible-release-tags) The symbol "EmoteDefinition" is marked as @public, but its signature references "Emote" which is marked as @alpha
// Warning: (ae-missing-release-tag) "EmoteDefinition" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type EmoteDefinition = Omit<Emote, 'emoteDataADR74'> & {
emoteDataADR74: Omit<Emote['emoteDataADR74'], 'representations'> & {
representations: EmoteRepresentationDefinition[];
};
};
// Warning: (ae-missing-release-tag) "EmoteEvents" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type EmoteEvents = {
[PreviewEmoteEventType.ANIMATION_PLAY]: void;
[PreviewEmoteEventType.ANIMATION_PAUSE]: void;
[PreviewEmoteEventType.ANIMATION_LOOP]: void;
[PreviewEmoteEventType.ANIMATION_END]: void;
[PreviewEmoteEventType.ANIMATION_PLAYING]: {
length: number;
};
};
// Warning: (ae-missing-release-tag) "EmotePlayMode" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "EmotePlayMode" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum EmotePlayMode {
// (undocumented)
LOOP = "loop",
// (undocumented)
SIMPLE = "simple"
}
// @public (undocumented)
export namespace EmotePlayMode {
const // (undocumented)
schema: JSONSchema<EmotePlayMode>;
const // (undocumented)
validate: ValidateFunction<EmotePlayMode>;
}
// @alpha (undocumented)
export type EmoteRepresentationADR74 = {
bodyShapes: BodyShape[];
mainFile: string;
contents: string[];
};
// @alpha (undocumented)
export namespace EmoteRepresentationADR74 {
const // (undocumented)
schema: JSONSchema<EmoteRepresentationADR74>;
const // (undocumented)
validate: ValidateFunction<EmoteRepresentationADR74>;
}
// @alpha (undocumented)
export type EmoteRepresentationDefinition = Omit<EmoteRepresentationADR74, 'contents'> & {
contents: {
key: string;
url: string;
}[];
};
// @alpha (undocumented)
export type EmoteRepresentationWithBlobs = Omit<EmoteRepresentationDefinition, 'contents'> & {
contents: {
key: string;
blob: any;
}[];
};
// @alpha (undocumented)
export type EmoteWithBlobs = Omit<EmoteDefinition, 'emoteDataADR74'> & {
emoteDataADR74: Omit<EmoteDefinition['emoteDataADR74'], 'representations'> & {
representations: EmoteRepresentationWithBlobs[];
};
};
// @public
export type Entity = {
version: string;
id: IPFSv1 | IPFSv2;
type: EntityType;
pointers: string[];
timestamp: number;
content: ContentMapping[];
metadata?: any;
};
// @public (undocumented)
export namespace Entity {
const // (undocumented)
schema: JSONSchema<Entity>;
const // (undocumented)
validate: ValidateFunction<Entity>;
}
// @public
export enum EntityType {
// (undocumented)
EMOTE = "emote",
// (undocumented)
OUTFITS = "outfits",
// (undocumented)
PROFILE = "profile",
// (undocumented)
SCENE = "scene",
// (undocumented)
STORE = "store",
// (undocumented)
WEARABLE = "wearable"
}
// Warning: (ae-missing-release-tag) "ERC20TradeAsset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ERC20TradeAsset = BaseTradeAsset & {
assetType: TradeAssetType.ERC20;
amount: string;
};
// Warning: (ae-missing-release-tag) "ERC721TradeAsset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ERC721TradeAsset = BaseTradeAsset & {
assetType: TradeAssetType.ERC721;
tokenId: string;
};
// @public
export type EthAddress = string;
// @public
export namespace EthAddress {
const // (undocumented)
schema: JSONSchema<EthAddress>;
const // (undocumented)
validate: ValidateFunction<EthAddress>;
}
// Warning: (ae-missing-release-tag) "Event" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Event = BadgeGrantedEvent | BidAcceptedEvent | BidReceivedEvent | CampaignGasPriceHigherThanExpectedEvent | CampaignOutOfFundsEvent | CampaignOutOfStockEvent | CatalystDeploymentEvent | CollectionCreatedEvent | ItemPublishedEvent | ItemSoldEvent | MoveToParcelEvent | PassportOpenedEvent | RentalEndedEvent | RentalStartedEvent | RewardAssignedEvent | RewardDelayedEvent | RewardInProgressEvent | RoyaltiesEarnedEvent | UsedEmoteEvent | VerticalHeightReachedEvent | WalkedDistanceEvent;
// Warning: (ae-missing-release-tag) "Events" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export namespace Events {
// (undocumented)
export namespace SubType {
// (undocumented)
export enum Badge {
// (undocumented)
GRANTED = "badge-granted"
}
// (undocumented)
export enum Blockchain {
// (undocumented)
BID_ACCEPTED = "bid-accepted",
// (undocumented)
COLLECTION_CREATED = "collection-created",
// (undocumented)
ITEM_PUBLISHED = "item-published",
// (undocumented)
ITEM_SOLD = "item-sold",
// (undocumented)
RENTAL_ENDED = "land-rental-ended",
// (undocumented)
RENTAL_STARTED = "land-rental-started",
// (undocumented)
ROYALTIES_EARNED = "royalties-earned"
}
// (undocumented)
export enum CatalystDeployment {
// (undocumented)
EMOTE = "emote",
// (undocumented)
OUTFITS = "outfits",
// (undocumented)
PROFILE = "profile",
// (undocumented)
SCENE = "scene",
// (undocumented)
STORE = "store",
// (undocumented)
WEARABLE = "wearable"
}
// (undocumented)
export enum Client {
// (undocumented)
MOVE_TO_PARCEL = "move-to-parcel",
// (undocumented)
PASSPORT_OPENED = "passport-opened",
// (undocumented)
USED_EMOTE = "used-emote",
// (undocumented)
VERTICAL_HEIGHT_REACHED = "vertical-height-reached",
// (undocumented)
WALKED_DISTANCE = "walked-distance"
}
// (undocumented)
export enum Marketplace {
// (undocumented)
BID_RECEIVED = "bid-received"
}
// (undocumented)
export enum Rewards {
// (undocumented)
CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED = "campaign-gas-price-higher-than-expected",
// (undocumented)
CAMPAIGN_OUT_OF_FUNDS = "campaign-out-of-funds",
// (undocumented)
CAMPAIGN_OUT_OF_STOCK = "campaign-out-of-stock",
// (undocumented)
REWARD_ASSIGNED = "reward-assigned",
// (undocumented)
REWARD_DELAYED = "reward-delayed",
// (undocumented)
REWARD_IN_PROGRESS = "reward-in-progress"
}
}
// (undocumented)
export enum Type {
// (undocumented)
BADGE = "badge",
// (undocumented)
BLOCKCHAIN = "blockchain",
// (undocumented)
CATALYST_DEPLOYMENT = "catalyst-deployment",
// (undocumented)
CLIENT = "client",
// (undocumented)
MARKETPLACE = "marketplace",
// (undocumented)
REWARDS = "rewards"
}
}
// @alpha (undocumented)
export type FeatureToggles = {
voiceChat?: EnabledDisabled;
portableExperiences?: EnabledDisabled | PortableExperiencesToggles;
};
// @alpha (undocumented)
export namespace FeatureToggles {
const // (undocumented)
schema: JSONSchema<FeatureToggles>;
const // (undocumented)
validate: ValidateFunction<FeatureToggles>;
}
// Warning: (ae-missing-release-tag) "GenderFilterOption" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum GenderFilterOption {
// (undocumented)
FEMALE = "female",
// (undocumented)
MALE = "male",
// (undocumented)
UNISEX = "unisex"
}
// @public
export function generateLazyValidator<T>(schema: JSONSchema<T>, keywordDefinitions?: KeywordDefinition[]): ValidateFunction<T>;
// Warning: (ae-missing-release-tag) "GetBidsParameters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type GetBidsParameters = PaginatedParameters & {
bidder?: string;
seller?: string;
sortBy?: BidSortBy;
contractAddress?: string;
tokenId?: string;
status?: ListingStatus;
network?: Network;
itemId?: string;
bidAddress?: string;
};
// @alpha
export function getChainId(chainName: ChainName): ChainId | null;
// @alpha
export function getChainName(chainId: ChainId): ChainName | null;
// @alpha
export function getURNProtocol(chainId: ChainId): string;
// @alpha
export function getWorld(): World;
// Warning: (ae-missing-release-tag) "HideableWearableCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "HideableWearableCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type HideableWearableCategory = WearableCategory | BodyPartCategory;
// @public (undocumented)
export namespace HideableWearableCategory {
const // (undocumented)
schema: JSONSchema<BodyPartCategory>;
const // (undocumented)
validate: ValidateFunction<BodyPartCategory>;
}
// @alpha (undocumented)
export type I18N = {
code: Locale;
text: string;
};
// @alpha (undocumented)
export namespace I18N {
const // (undocumented)
schema: JSONSchema<I18N>;
const // (undocumented)
validate: ValidateFunction<I18N>;
}
// Warning: (ae-missing-release-tag) "IEmoteController" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface IEmoteController {
// (undocumented)
disableSound(): Promise<void>;
// (undocumented)
enableSound(): Promise<void>;
// (undocumented)
events: Emitter<EmoteEvents>;
// (undocumented)
getLength(): Promise<number>;
// (undocumented)
goTo(seconds: number): Promise<void>;
// (undocumented)
hasSound(): Promise<boolean>;
// (undocumented)
isPlaying(): Promise<boolean>;
// (undocumented)
pause(): Promise<void>;
// (undocumented)
play(): Promise<void>;
// (undocumented)
stop(): Promise<void>;
}
// @public (undocumented)
export type IPFSv1 = string;
// @public
export namespace IPFSv1 {
const // (undocumented)
schema: JSONSchema<IPFSv1>;
const // (undocumented)
validate: ValidateFunction<IPFSv1>;
}
// @public
export type IPFSv2 = string;
// @public
export namespace IPFSv2 {
const // (undocumented)
schema: JSONSchema<IPFSv2>;
const // (undocumented)
validate: ValidateFunction<IPFSv2>;
}
// Warning: (ae-missing-release-tag) "IPreviewController" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface IPreviewController {
// (undocumented)
emote: IEmoteController;
// (undocumented)
scene: ISceneController;
}
// Warning: (ae-missing-release-tag) "ISceneController" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface ISceneController {
// (undocumented)
changeCameraPosition(position: {
alpha?: number;
beta?: number;
radius?: number;
}): Promise<void>;
// (undocumented)
changeZoom(zoom: number): Promise<void>;
// Warning: (ae-incompatible-release-tags) The symbol "getMetrics" is marked as @public, but its signature references "Metrics" which is marked as @alpha
//
// (undocumented)
getMetrics(): Promise<Metrics>;
// (undocumented)
getScreenshot(width: number, height: number): Promise<string>;
// (undocumented)
panCamera(offset: {
x?: number;
y?: number;
z?: number;
}): Promise<void>;
}
// @alpha
export function isInsideWorldLimits(x: number, y: number): boolean;
// Warning: (ae-forgotten-export) The symbol "BaseItem" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "isStandard" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function isStandard<T extends BaseItem>(item: T): item is T & StandardProps;
// Warning: (ae-missing-release-tag) "isThirdParty" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function isThirdParty<T extends BaseItem>(item: T): item is T & ThirdPartyProps;
// Warning: (ae-missing-release-tag) "Item" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Item" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Item = {
id: string;
name: string;
thumbnail: string;
url: string;
category: NFTCategory;
contractAddress: string;
itemId: string;
rarity: Rarity;
price: string;
available: number;
isOnSale: boolean;
creator: string;
beneficiary: string | null;
createdAt: number;
updatedAt: number;
reviewedAt: number;
soldAt: number;
data: NFT['data'];
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
urn: string;
firstListedAt: number | null;
picks?: {
pickedByUser?: boolean;
count: number;
};
minPrice?: string;
minListingPrice?: string | null;
maxListingPrice?: string | null;
listings?: number | null;
owners?: number | null;
utility?: string;
tradeId?: string;
tradeExpiresAt?: number;
};
// @public (undocumented)
export namespace Item {
const // (undocumented)
schema: JSONSchema<Item>;
const // (undocumented)
validate: ValidateFunction<Item>;
}
// Warning: (ae-missing-release-tag) "ItemBid" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ItemBid = BaseBid & {
tradeId: string;
itemId: string;
};
// Warning: (ae-missing-release-tag) "ItemFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ItemFilters = {
first?: number;
skip?: number;
sortBy?: ItemSortBy;
category?: NFTCategory;
creator?: string | string[];
rarities?: Rarity[];
isSoldOut?: boolean;
isOnSale?: boolean;
search?: string;
isWearableHead?: boolean;
isWearableAccessory?: boolean;
isWearableSmart?: boolean;
wearableCategory?: WearableCategory;
wearableGenders?: (WearableGender | GenderFilterOption)[];
emoteCategory?: EmoteCategory;
emoteGenders?: (WearableGender | GenderFilterOption)[];
emotePlayMode?: EmotePlayMode | EmotePlayMode[];
ids?: string[];
contractAddresses?: string[];
itemId?: string;
network?: Network;
minPrice?: string;
maxPrice?: string;
urns?: string[];
emoteHasSound?: boolean;
emoteHasGeometry?: boolean;
};
// Warning: (ae-missing-release-tag) "ItemPublishedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "ItemPublishedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ItemPublishedEvent = BaseEvent & {
type: Events.Type.BLOCKCHAIN;
subType: Events.SubType.Blockchain.ITEM_PUBLISHED;
metadata: {
creator: string;
category: string;
itemId: string;
urn: string;
network: string;
rarity?: string;
};
};
// @public (undocumented)
export namespace ItemPublishedEvent {
const // (undocumented)
schema: JSONSchema<ItemPublishedEvent>;
const // (undocumented)
validate: ValidateFunction<ItemPublishedEvent>;
}
// Warning: (ae-missing-release-tag) "ItemSoldEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "ItemSoldEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ItemSoldEvent = BaseEvent & {
type: Events.Type.BLOCKCHAIN;
subType: Events.SubType.Blockchain.ITEM_SOLD;
metadata: {
address: string;
image: string;
buyer: string;
seller: string;
category: string;
rarity?: string;
link: string;
nftName?: string;
tokenId: string;
network: string;
title: string;
description: string;
};
};
// @public (undocumented)
export namespace ItemSoldEvent {
const // (undocumented)
schema: JSONSchema<ItemSoldEvent>;
const // (undocumented)
validate: ValidateFunction<ItemSoldEvent>;
}
// Warning: (ae-missing-release-tag) "ItemSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum ItemSortBy {
// (undocumented)
CHEAPEST = "cheapest",
// (undocumented)
NAME = "name",
// (undocumented)
NEWEST = "newest",
// (undocumented)
RECENTLY_LISTED = "recently_listed",
// (undocumented)
RECENTLY_REVIEWED = "recently_reviewed",
// (undocumented)
RECENTLY_SOLD = "recently_sold"
}
// @public
export type JSONSchema<T> = JSONSchemaType<T>;
// Warning: (ae-missing-release-tag) "LegacyBid" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type LegacyBid = BaseBid & {
bidAddress: string;
blockchainId: string;
blockNumber: string;
tokenId: string;
};
// @alpha
export type Link = {
title: string;
url: LinkUrl;
};
// @alpha
export namespace Link {
const // (undocumented)
schema: JSONSchema<Link>;
}
// Warning: (ae-missing-release-tag) "LinkerAuthorization" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type LinkerAuthorization = {
name: string;
desc: string;
startDate?: string;
endDate?: string;
contactInfo: {
name: string;
[key: string]: string;
};
onlyDev?: boolean;
addresses: string[];
plots: string[];
};
// @public (undocumented)
export namespace LinkerAuthorization {
const // (undocumented)
schema: JSONSchema<LinkerAuthorization>;
const // (undocumented)
validate: ValidateFunction<LinkerAuthorization>;
}
// @alpha
export type LinkUrl = string;
// @alpha
export namespace LinkUrl {
const // (undocumented)
schema: JSONSchema<LinkUrl>;
const // (undocumented)
validate: ValidateFunction<LinkUrl>;
}
// Warning: (ae-missing-release-tag) "ListingStatus" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "ListingStatus" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum ListingStatus {
// (undocumented)
CANCELLED = "cancelled",
// (undocumented)
OPEN = "open",
// (undocumented)
SOLD = "sold"
}
// @public (undocumented)
export namespace ListingStatus {
const // (undocumented)
schema: JSONSchema<ListingStatus>;
const // (undocumented)
validate: ValidateFunction<ListingStatus>;
}
// @alpha (undocumented)
export enum Locale {
// (undocumented)
EN = "en",
// (undocumented)
ES = "es"
}
// @alpha (undocumented)
export namespace Locale {
const // (undocumented)
schema: JSONSchema<Locale>;
const // (undocumented)
validate: ValidateFunction<Locale>;
}
// @alpha
export type Mapping = SingleMapping | AnyMapping | RangeMapping | MultipleMapping;
// @alpha
export namespace Mapping {
const // (undocumented)
schema: JSONSchema<Mapping>;
const // (undocumented)
validate: ValidateFunction<Mapping>;
}
// @alpha
export type Mappings = Partial<Record<ContractNetwork, Record<ContractAddress, Mapping[]>>>;
// @alpha
export namespace Mappings {
const // (undocumented)
_isMappingsValid: FuncKeywordDefinition;
const // (undocumented)
innerSchema: JSONSchema<Record<ContractAddress, Mapping[]>>;
const // (undocumented)
schema: JSONSchema<Mappings>;
const // (undocumented)
validate: ValidateFunction<Mappings>;
}
// Warning: (ae-missing-release-tag) "MappingsHelper" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type MappingsHelper = {
getMappings(): Mappings;
addMapping(network: ContractNetwork, contractAddress: ContractAddress, mapping: Mapping): void;
includesNft(network: ContractNetwork, contractAddress: ContractAddress, tokenId: string): boolean;
};
// @alpha
export enum MappingType {
// (undocumented)
ANY = "any",
// (undocumented)
MULTIPLE = "multiple",
// (undocumented)
RANGE = "range",
// (undocumented)
SINGLE = "single"
}
// @alpha
export type MerkleProof = {
proof: string[];
index: number;
hashingKeys: string[];
entityHash: string;
};
// @alpha
export namespace MerkleProof {
const // (undocumented)
schema: JSONSchema<MerkleProof>;
const // (undocumented)
validate: ValidateFunction<MerkleProof>;
}
// @public (undocumented)
type Messages = SceneUpdate | Update;
// @alpha
export type MetaTransaction = {
from: string;
params: [string, string];
};
// @alpha (undocumented)
export namespace MetaTransaction {
const // (undocumented)
schema: JSONSchema<MetaTransaction>;
const // (undocumented)
validate: ValidateFunction<MetaTransaction>;
}
// @alpha (undocumented)
export type Metrics = {
triangles: number;
materials: number;
textures: number;
meshes: number;
bodies: number;
entities: number;
};
// @alpha (undocumented)
export namespace Metrics {
const // (undocumented)
schema: JSONSchema<Metrics>;
const // (undocumented)
validate: ValidateFunction<Metrics>;
}
// Warning: (ae-missing-release-tag) "Mint" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Mint" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Mint = {
id: string;
creator: string;
beneficiary: string;
minter: string;
itemId: string;
tokenId: string;
issuedId: string;
contractAddress: string;
price: string | null;
timestamp: number;
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
};
// @public (undocumented)
export namespace Mint {
const // (undocumented)
schema: JSONSchema<Mint>;
const // (undocumented)
validate: ValidateFunction<Mint>;
}
// Warning: (ae-missing-release-tag) "MintFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type MintFilters = {
first?: number;
skip?: number;
sortBy?: MintSortBy;
creator?: string;
beneficiary?: string;
minter?: string;
contractAddress?: string;
itemId?: string;
tokenId?: string;
issuedId?: string;
isSale?: boolean;
network?: Network;
};
// Warning: (ae-missing-release-tag) "MintSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum MintSortBy {
// (undocumented)
MOST_EXPENSIVE = "most_expensive",
// (undocumented)
RECENTLY_MINTED = "recently_minted"
}
// Warning: (ae-missing-release-tag) "MoveToParcelEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type MoveToParcelEvent = BaseEvent & {
type: Events.Type.CLIENT;
subType: Events.SubType.Client.MOVE_TO_PARCEL;
metadata: ClientBaseMetadata & {
parcel: {
isEmptyParcel: boolean;
newParcel: string;
oldParcel: string;
sceneHash: string;
};
};
};
// @alpha
export type MultipleMapping = {
type: MappingType.MULTIPLE;
ids: string[];
};
// @alpha
export namespace MultipleMapping {
const // (undocumented)
schema: JSONSchema<MultipleMapping>;
const // (undocumented)
validate: ValidateFunction<Mapping>;
}
// @alpha
export enum Network {
// (undocumented)
ARBITRUM = "ARBITRUM",
// (undocumented)
AVALANCHE = "AVALANCHE",
// (undocumented)
BSC = "BINANCE SMART CHAIN",
// (undocumented)
ETHEREUM = "ETHEREUM",
// (undocumented)
FANTOM = "FANTOM",
// (undocumented)
MATIC = "MATIC",
// (undocumented)
OPTIMISM = "OPTIMISM"
}
// @alpha (undocumented)
export namespace Network {
const // (undocumented)
schema: JSONSchema<Network>;
const // (undocumented)
validate: ValidateFunction<Network>;
}
// Warning: (ae-missing-release-tag) "NFT" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "NFT" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type NFT = {
id: string;
contractAddress: string;
tokenId: string;
activeOrderId: string | null;
openRentalId: string | null;
owner: string;
name: string;
category: NFTCategory;
image: string;
url: string;
issuedId: string | null;
itemId: string | null;
data: {
parcel?: {
x: string;
y: string;
description: string | null;
estate: {
tokenId: string;
name: string;
} | null;
};
estate?: {
size: number;
parcels: {
x: number;
y: number;
}[];
description: string | null;
};
wearable?: {
description: string;
category: WearableCategory;
rarity: Rarity;
bodyShapes: BodyShape[];
isSmart: boolean;
};
ens?: {
subdomain: string;
};
emote?: {
description: string;
category: EmoteCategory;
rarity: Rarity;
bodyShapes: BodyShape[];
loop: boolean;
hasSound: boolean;
hasGeometry: boolean;
};
};
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
createdAt: number;
updatedAt: number;
soldAt: number;
urn?: string;
utility?: string;
};
// @public (undocumented)
export namespace NFT {
const // (undocumented)
schema: JSONSchema<NFT>;
const // (undocumented)
validate: ValidateFunction<NFT>;
}
// Warning: (ae-missing-release-tag) "NFTBid" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type NFTBid = BaseBid & {
tradeId: string;
tokenId: string;
};
// Warning: (ae-missing-release-tag) "NFTCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "NFTCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum NFTCategory {
// (undocumented)
EMOTE = "emote",
// (undocumented)
ENS = "ens",
// (undocumented)
ESTATE = "estate",
// (undocumented)
PARCEL = "parcel",
// (undocumented)
WEARABLE = "wearable"
}
// @public (undocumented)
export namespace NFTCategory {
const // (undocumented)
schema: JSONSchema<NFTCategory>;
const // (undocumented)
validate: ValidateFunction<NFTCategory>;
}
// Warning: (ae-missing-release-tag) "NFTFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type NFTFilters = {
first?: number;
skip?: number;
sortBy?: NFTSortBy;
category?: NFTCategory;
owner?: string;
isOnSale?: boolean;
isOnRent?: boolean;
search?: string;
itemRarities?: Rarity[];
isLand?: boolean;
isWearableHead?: boolean;
isWearableAccessory?: boolean;
isWearableSmart?: boolean;
wearableCategory?: WearableCategory;
wearableGenders?: (WearableGender | GenderFilterOption)[];
emoteCategory?: EmoteCategory;
emoteGenders?: (WearableGender | GenderFilterOption)[];
emotePlayMode?: EmotePlayMode | EmotePlayMode[];
contractAddresses?: string[];
creator?: string | string[];
tokenId?: string;
itemId?: string;
network?: Network;
rentalStatus?: RentalsListingsFilterBy['status'];
ids?: string[];
minPrice?: string;
maxPrice?: string;
minEstateSize?: number;
maxEstateSize?: number;
minDistanceToPlaza?: number;
maxDistanceToPlaza?: number;
adjacentToRoad?: boolean;
rentalDays?: number[];
emoteHasSound?: boolean;
emoteHasGeometry?: boolean;
} & Pick<RentalsListingsFilterBy, 'tenant'>;
// Warning: (ae-missing-release-tag) "NFTSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum NFTSortBy {
// (undocumented)
CHEAPEST = "cheapest",
// (undocumented)
MAX_RENTAL_PRICE = "max_rental_price",
// (undocumented)
MIN_RENTAL_PRICE = "min_rental_price",
// (undocumented)
NAME = "name",
// (undocumented)
NEWEST = "newest",
// (undocumented)
RECENTLY_LISTED = "recently_listed",
// (undocumented)
RECENTLY_SOLD = "recently_sold",
// (undocumented)
RENTAL_DATE = "rented_date",
// (undocumented)
RENTAL_LISTING_DATE = "rental_listing_date"
}
// @alpha
export type NotificationChannelType = {
email: boolean;
in_app: boolean;
};
// @alpha
export enum NotificationType {
// (undocumented)
BADGE_GRANTED = "badge_granted",
// (undocumented)
BID_ACCEPTED = "bid_accepted",
// (undocumented)
BID_RECEIVED = "bid_received",
// (undocumented)
EVENTS_STARTED = "events_started",
// (undocumented)
EVENTS_STARTS_SOON = "events_starts_soon",
// (undocumented)
GOVERNANCE_ANNOUNCEMENT = "governance_announcement",
// (undocumented)
GOVERNANCE_AUTHORED_PROPOSAL_FINISHED = "governance_authored_proposal_finished",
// (undocumented)
GOVERNANCE_CLIFF_ENDED = "governance_cliff_ended",
// (undocumented)
GOVERNANCE_COAUTHOR_REQUESTED = "governance_coauthor_requested",
// (undocumented)
GOVERNANCE_NEW_COMMENT_ON_PROJECT_UPDATE = "governance_new_comment_on_project_update",
// (undocumented)
GOVERNANCE_NEW_COMMENT_ON_PROPOSAL = "governance_new_comment_on_proposal",
// (undocumented)
GOVERNANCE_PITCH_PASSED = "governance_pitch_passed",
// (undocumented)
GOVERNANCE_PROPOSAL_ENACTED = "governance_proposal_enacted",
// (undocumented)
GOVERNANCE_TENDER_PASSED = "governance_tender_passed",
// (undocumented)
GOVERNANCE_VOTED_ON_BEHALF = "governance_voted_on_behalf",
// (undocumented)
GOVERNANCE_VOTING_ENDED_VOTER = "governance_voting_ended_voter",
// (undocumented)
GOVERNANCE_WHALE_VOTE = "governance_whale_vote",
// (undocumented)
ITEM_PUBLISHED = "item_published",
// (undocumented)
ITEM_SOLD = "item_sold",
// (undocumented)
LAND_RENTAL_ENDED = "rental_ended",
// (undocumented)
LAND_RENTED = "rental_started",
// (undocumented)
REWARD_ASSIGNED = "reward_assignment",
// (undocumented)
REWARD_CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED = "reward_campaign_gas_price_higher_than_expected",
// (undocumented)
REWARD_CAMPAIGN_OUT_OF_FUNDS = "reward_campaign_out_of_funds",
// (undocumented)
REWARD_CAMPAIGN_OUT_OF_STOCK = "reward_campaign_out_of_stock",
// (undocumented)
REWARD_DELAYED = "reward_delayed",
// (undocumented)
REWARD_IN_PROGRESS = "reward_in_progress",
// (undocumented)
ROYALTIES_EARNED = "royalties_earned",
// (undocumented)
WORLDS_ACCESS_RESTORED = "worlds_access_restored",
// (undocumented)
WORLDS_ACCESS_RESTRICTED = "worlds_access_restricted",
// (undocumented)
WORLDS_MISSING_RESOURCES = "worlds_missing_resources",
// (undocumented)
WORLDS_PERMISSION_GRANTED = "worlds_permission_granted",
// (undocumented)
WORLDS_PERMISSION_REVOKED = "worlds_permission_revoked"
}
// Warning: (ae-missing-release-tag) "OnChainTrade" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type OnChainTrade = {
signer: string;
signature: string;
checks: TradeChecks & {
allowedProof: string[];
};
sent: OnChainTradeAsset[];
received: OnChainTradeAsset[];
};
// Warning: (ae-missing-release-tag) "OnChainTradeAsset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type OnChainTradeAsset = {
assetType: TradeAssetType;
contractAddress: string;
value: string;
extra: string;
beneficiary: string;
};
// Warning: (ae-missing-release-tag) "Order" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Order" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Order = {
id: string;
marketplaceAddress: string;
contractAddress: string;
tokenId: string;
owner: string;
buyer: string | null;
price: string;
status: ListingStatus;
expiresAt: number;
createdAt: number;
updatedAt: number;
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
issuedId: string;
tradeId?: string;
};
// @public (undocumented)
export namespace Order {
const // (undocumented)
schema: JSONSchema<Order>;
const // (undocumented)
validate: ValidateFunction<Order>;
}
// Warning: (ae-missing-release-tag) "OrderFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type OrderFilters = {
first?: number;
skip?: number;
sortBy?: OrderSortBy;
marketplaceAddress?: string;
owner?: string;
buyer?: string;
contractAddress?: string;
tokenId?: string;
status?: ListingStatus;
network?: Network;
itemId?: string;
nftName?: string;
};
// Warning: (ae-missing-release-tag) "OrderSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum OrderSortBy {
// (undocumented)
CHEAPEST = "cheapest",
// (undocumented)
ISSUED_ID_ASC = "issued_id_asc",
// (undocumented)
ISSUED_ID_DESC = "issued_id_desc",
// (undocumented)
OLDEST = "oldest",
// (undocumented)
RECENTLY_LISTED = "recently_listed",
// (undocumented)
RECENTLY_UPDATED = "recently_updated"
}
// @alpha (undocumented)
export type Outfit = {
bodyShape: WearableId;
eyes: {
color: Color3;
};
hair: {
color: Color3;
};
skin: {
color: Color3;
};
wearables: WearableId[];
forceRender?: WearableCategory[];
};
// @alpha
export namespace Outfit {
const // (undocumented)
schema: JSONSchema<Outfit>;
const // (undocumented)
validate: ValidateFunction<Outfit>;
}
// @alpha (undocumented)
export type Outfits = {
outfits: {
slot: number;
outfit: Outfit;
}[];
namesForExtraSlots: string[];
};
// @alpha
export namespace Outfits {
const // (undocumented)
schema: JSONSchema<Outfits>;
const // (undocumented)
validate: ValidateFunction<Outfits>;
}
// Warning: (ae-missing-release-tag) "PaginatedParameters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type PaginatedParameters = {
limit?: number;
offset?: number;
};
// Warning: (ae-missing-release-tag) "PaginatedResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type PaginatedResponse<T> = {
results: T[];
total: number;
page: number;
pages: number;
limit: number;
};
// Warning: (ae-missing-release-tag) "PassportOpenedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type PassportOpenedEvent = BaseEvent & {
type: Events.Type.CLIENT;
subType: Events.SubType.Client.PASSPORT_OPENED;
metadata: ClientBaseMetadata & {
passport: {
receiver: EthAddress;
};
};
};
// Warning: (ae-missing-release-tag) "PeriodCreation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "PeriodCreation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type PeriodCreation = {
minDays: number;
maxDays: number;
pricePerDay: string;
};
// @public (undocumented)
export namespace PeriodCreation {
const // (undocumented)
schema: JSONSchemaType<PeriodCreation>;
const // (undocumented)
validate: ValidateFunction<PeriodCreation>;
}
// @public
export type PointerChangesSyncDeployment = SnapshotSyncDeployment & {
localTimestamp: number;
};
// @public (undocumented)
export namespace PointerChangesSyncDeployment {
const // (undocumented)
schema: JSONSchema<PointerChangesSyncDeployment>;
const // (undocumented)
validate: ValidateFunction<PointerChangesSyncDeployment>;
}
// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag
// Warning: (ae-missing-release-tag) "PreviewCamera" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum PreviewCamera {
// (undocumented)
INTERACTIVE = "interactive",
// (undocumented)
STATIC = "static"
}
// @alpha (undocumented)
export namespace PreviewCamera {
const // (undocumented)
schema: JSONSchema<PreviewCamera>;
const // (undocumented)
validate: ValidateFunction<PreviewCamera>;
}
// Warning: (ae-missing-release-tag) "PreviewConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type PreviewConfig = {
item?: WearableDefinition | EmoteDefinition;
wearables: WearableDefinition[];
bodyShape: BodyShape;
skin: string;
hair: string;
eyes: string;
zoom: number;
type: PreviewType;
face: boolean;
background: {
image?: string;
color: string;
transparent: boolean;
};
emote: PreviewEmote | null;
camera: PreviewCamera;
projection: PreviewProjection;
autoRotateSpeed: number;
centerBoundingBox: boolean;
fadeEffect: boolean;
showSceneBoundaries?: boolean;
showThumbnailBoundaries?: boolean;
offsetX: number;
offsetY: number;
offsetZ: number;
cameraX: number;
cameraY: number;
cameraZ: number;
wheelZoom: number;
wheelPrecision: number;
wheelStart: number;
panning: boolean;
lockAlpha: boolean;
lockBeta: boolean;
lockRadius: boolean;
forceRender?: Array<string>;
};
// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag
// Warning: (ae-missing-release-tag) "PreviewEmote" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum PreviewEmote {
// (undocumented)
CLAP = "clap",
// (undocumented)
DAB = "dab",
// (undocumented)
DANCE = "dance",
// (undocumented)
FASHION = "fashion",
// (undocumented)
FASHION_2 = "fashion-2",
// (undocumented)
FASHION_3 = "fashion-3",
// (undocumented)
FASHION_4 = "fashion-4",
// (undocumented)
FIST_PUMP = "fist-pump",
// (undocumented)
HEAD_EXPLODE = "head-explode",
// (undocumented)
IDLE = "idle",
// (undocumented)
JUMP = "jump",
// (undocumented)
LOVE = "love",
// (undocumented)
MONEY = "money",
// (undocumented)
RUN = "run",
// (undocumented)
WALK = "walk",
// (undocumented)
WAVE = "wave"
}
// @alpha (undocumented)
export namespace PreviewEmote {
const // (undocumented)
schema: JSONSchema<PreviewEmote>;
const // (undocumented)
validate: ValidateFunction<PreviewEmote>;
}
// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag
// Warning: (ae-missing-release-tag) "PreviewEmoteEventType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum PreviewEmoteEventType {
// (undocumented)
ANIMATION_END = "animation_end",
// (undocumented)
ANIMATION_LOOP = "animation_loop",
// (undocumented)
ANIMATION_PAUSE = "animation_pause",
// (undocumented)
ANIMATION_PLAY = "animation_play",
// (undocumented)
ANIMATION_PLAYING = "animation_playing"
}
// @alpha (undocumented)
export namespace PreviewEmoteEventType {
const // (undocumented)
schema: JSONSchema<PreviewEmoteEventType>;
const // (undocumented)
validate: ValidateFunction<PreviewEmoteEventType>;
}
// Warning: (ae-missing-release-tag) "PreviewMessagePayload" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type PreviewMessagePayload<T extends PreviewMessageType> = T extends PreviewMessageType.READY ? null : T extends PreviewMessageType.LOAD ? null : T extends PreviewMessageType.ERROR ? {
message: string;
} : T extends PreviewMessageType.UPDATE ? {
options: PreviewOptions;
} : T extends PreviewMessageType.CONTROLLER_REQUEST ? {
id: string;
namespace: 'scene' | 'emote';
method: 'getScreenshot' | 'getMetrics' | 'changeZoom' | 'changeCameraPosition' | 'panCamera' | 'getLength' | 'isPlaying' | 'play' | 'pause' | 'stop' | 'goTo' | 'enableSound' | 'disableSound' | 'hasSound';
params: any[];
} : T extends PreviewMessageType.CONTROLLER_RESPONSE ? {
id: string;
ok: true;
result: any;
} | {
id: string;
ok: false;
error: string;
} : T extends PreviewMessageType.EMOTE_EVENT ? {
type: PreviewEmoteEventType;
payload: EmoteEventPayload<PreviewEmoteEventType>;
} : unknown;
// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag
// Warning: (ae-missing-release-tag) "PreviewMessageType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum PreviewMessageType {
// (undocumented)
CONTROLLER_REQUEST = "controller_request",
// (undocumented)
CONTROLLER_RESPONSE = "controller_response",
// (undocumented)
EMOTE_EVENT = "emote_event",
// (undocumented)
ERROR = "error",
// (undocumented)
LOAD = "load",
// (undocumented)
READY = "ready",
// (undocumented)
UPDATE = "update"
}
// @alpha (undocumented)
export namespace PreviewMessageType {
const // (undocumented)
schema: JSONSchema<PreviewMessageType>;
const // (undocumented)
validate: ValidateFunction<PreviewMessageType>;
}
// @alpha (undocumented)
export type PreviewOptions = {
contractAddress?: string | null;
tokenId?: string | null;
itemId?: string | null;
profile?: string | null;
bodyShape?: BodyShape | null;
type?: PreviewType | null;
skin?: string | null;
hair?: string | null;
eyes?: string | null;
urns?: string[] | null;
urls?: string[] | null;
base64s?: string[] | null;
blob?: WearableWithBlobs | EmoteWithBlobs | null;
zoom?: number | null;
zoomScale?: number | null;
emote?: PreviewEmote | null;
camera?: PreviewCamera | null;
projection?: PreviewProjection | null;
autoRotateSpeed?: number | null;
offsetX?: number | null;
offsetY?: number | null;
offsetZ?: number | null;
cameraX?: number | null;
cameraY?: number | null;
cameraZ?: number | null;
wheelZoom?: number | null;
wheelPrecision?: number | null;
wheelStart?: number | null;
background?: string | null;
disableBackground?: boolean | null;
disableAutoCenter?: boolean | null;
disableAutoRotate?: boolean | null;
disableFace?: boolean | null;
disableDefaultWearables?: boolean | null;
disableDefaultEmotes?: boolean | null;
disableFadeEffect?: boolean | null;
showSceneBoundaries?: boolean;
showThumbnailBoundaries?: boolean;
peerUrl?: string | null;
nftServerUrl?: string | null;
panning?: boolean;
lockAlpha?: boolean;
lockBeta?: boolean;
lockRadius?: boolean;
};
// Warning: (ae-missing-release-tag) "PreviewProjection" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "PreviewProjection" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum PreviewProjection {
// (undocumented)
ORTHOGRAPHIC = "orthographic",
// (undocumented)
PERSPECTIVE = "perspective"
}
// @public (undocumented)
export namespace PreviewProjection {
const // (undocumented)
schema: JSONSchema<PreviewProjection>;
const // (undocumented)
validate: ValidateFunction<PreviewProjection>;
}
// @alpha (undocumented)
export enum PreviewType {
// (undocumented)
AVATAR = "avatar",
// (undocumented)
TEXTURE = "texture",
// (undocumented)
WEARABLE = "wearable"
}
// @alpha (undocumented)
export namespace PreviewType {
const // (undocumented)
schema: JSONSchema<PreviewType>;
const // (undocumented)
validate: ValidateFunction<PreviewType>;
}
// @alpha
export type Profile = {
avatars: Avatar[];
};
// @alpha
export namespace Profile {
const // (undocumented)
schema: JSONSchema<Profile>;
const // (undocumented)
validate: ValidateFunction<Profile>;
}
// @public (undocumented)
enum ProjectType {
// (undocumented)
LIBRARY = "library",
// (undocumented)
PORTABLE_EXPERIENCE = "portable-experience",
// (undocumented)
SCENE = "scene",
// (undocumented)
SMART_ITEM = "smart-item"
}
// @public (undocumented)
namespace ProjectType {
const // (undocumented)
schema: JSONSchema<ProjectType>;
const // (undocumented)
validate: ValidateFunction<ProjectType>;
}
// @alpha
export enum ProviderType {
// (undocumented)
AUTH_SERVER = "auth_server",
// (undocumented)
FORTMATIC = "formatic",
// (undocumented)
INJECTED = "injected",
// (undocumented)
MAGIC = "magic",
// (undocumented)
METAMASK_MOBILE = "metamask_mobile",
// (undocumented)
NETWORK = "network",
// (undocumented)
WALLET_CONNECT = "wallet_connect",
// (undocumented)
WALLET_CONNECT_V2 = "wallet_connect_v2",
// (undocumented)
WALLET_LINK = "wallet_link"
}
// @alpha (undocumented)
export namespace ProviderType {
const // (undocumented)
schema: JSONSchema<ProviderType>;
const // (undocumented)
validate: ValidateFunction<ProviderType>;
}
// @alpha
export type RangeMapping = {
type: MappingType.RANGE;
from: string;
to: string;
};
// @alpha
export namespace RangeMapping {
const // (undocumented)
_fromLessThanOrEqualTo: KeywordDefinition;
const // (undocumented)
schema: JSONSchema<RangeMapping>;
const // (undocumented)
validate: ValidateFunction<Mapping>;
}
// Warning: (ae-missing-release-tag) "Rarity" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Rarity" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum Rarity {
// (undocumented)
COMMON = "common",
// (undocumented)
EPIC = "epic",
// (undocumented)
EXOTIC = "exotic",
// (undocumented)
LEGENDARY = "legendary",
// (undocumented)
MYTHIC = "mythic",
// (undocumented)
RARE = "rare",
// (undocumented)
UNCOMMON = "uncommon",
// (undocumented)
UNIQUE = "unique"
}
// @public (undocumented)
export namespace Rarity {
const // (undocumented)
schema: JSONSchema<Rarity>;
const // (undocumented)
validate: ValidateFunction<Rarity>;
// (undocumented)
export function getColor(rarity: Rarity): string;
// (undocumented)
export function getGradient(rarity: Rarity): [string, string];
// (undocumented)
export function getMaxSupply(rarity: Rarity): number;
// (undocumented)
export function getRarities(): Rarity[];
}
// Warning: (ae-missing-release-tag) "RentalEndedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "RentalEndedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RentalEndedEvent = BaseEvent & {
type: Events.Type.BLOCKCHAIN;
subType: Events.SubType.Blockchain.RENTAL_ENDED;
metadata: RentalMetadata;
};
// @public (undocumented)
export namespace RentalEndedEvent {
const // (undocumented)
schema: JSONSchema<RentalEndedEvent>;
const // (undocumented)
validate: ValidateFunction<RentalEndedEvent>;
}
// Warning: (ae-missing-release-tag) "RentalListing" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type RentalListing = {
id: string;
nftId: string;
category: NFTCategory;
searchText: string;
network: Network.ETHEREUM;
chainId: ChainId;
expiration: number;
signature: string;
nonces: string[];
tokenId: string;
contractAddress: string;
rentalContractAddress: string;
lessor: string | null;
tenant: string | null;
status: RentalStatus;
createdAt: number;
updatedAt: number;
startedAt: number | null;
periods: RentalListingPeriod[];
target: string;
rentedDays: number | null;
};
// Warning: (ae-missing-release-tag) "RentalListingCreation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "RentalListingCreation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type RentalListingCreation = {
network: Network.ETHEREUM;
chainId: ChainId;
expiration: number;
signature: string;
tokenId: string;
contractAddress: string;
rentalContractAddress: string;
nonces: string[];
periods: PeriodCreation[];
target: string;
};
// @public (undocumented)
export namespace RentalListingCreation {
const // (undocumented)
schema: JSONSchema<RentalListingCreation>;
const // (undocumented)
validate: ValidateFunction<RentalListingCreation>;
}
// Warning: (ae-missing-release-tag) "RentalListingPeriod" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type RentalListingPeriod = {
minDays: number;
maxDays: number;
pricePerDay: string;
};
// Warning: (ae-missing-release-tag) "RentalsListingsFilterBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type RentalsListingsFilterBy = {
category?: RentalsListingsFilterByCategory;
text?: string;
status?: RentalStatus | RentalStatus[];
periods?: RentalsListingsFilterByPeriod;
lessor?: string;
tenant?: string;
tokenId?: string;
contractAddresses?: string[];
network?: Network;
nftIds?: string[];
updatedAfter?: number;
target?: string;
minPricePerDay?: string;
maxPricePerDay?: string;
minDistanceToPlaza?: number;
maxDistanceToPlaza?: number;
minEstateSize?: number;
maxEstateSize?: number;
adjacentToRoad?: boolean;
rentalDays?: number[];
};
// Warning: (ae-missing-release-tag) "RentalsListingsFilterByCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export enum RentalsListingsFilterByCategory {
// (undocumented)
ESTATE = "estate",
// (undocumented)
PARCEL = "parcel"
}
// Warning: (ae-missing-release-tag) "RentalsListingsFilterByPeriod" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type RentalsListingsFilterByPeriod = {
minDays: number;
maxDays: number;
pricePerDay?: number;
};
// Warning: (ae-missing-release-tag) "RentalsListingSortDirection" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export enum RentalsListingSortDirection {
// (undocumented)
ASC = "asc",
// (undocumented)
DESC = "desc"
}
// Warning: (ae-missing-release-tag) "RentalsListingsSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export enum RentalsListingsSortBy {
LAND_CREATION_DATE = "land_creation_date",
MAX_RENTAL_PRICE = "max_rental_price",
MIN_RENTAL_PRICE = "min_rental_price",
NAME = "name",
RENTAL_DATE = "rented_date",
RENTAL_LISTING_DATE = "rental_listing_date"
}
// Warning: (ae-missing-release-tag) "RentalStartedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "RentalStartedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RentalStartedEvent = BaseEvent & {
type: Events.Type.BLOCKCHAIN;
subType: Events.SubType.Blockchain.RENTAL_STARTED;
metadata: RentalMetadata;
};
// @public (undocumented)
export namespace RentalStartedEvent {
const // (undocumented)
schema: JSONSchema<RentalStartedEvent>;
const // (undocumented)
validate: ValidateFunction<RentalStartedEvent>;
}
// Warning: (ae-missing-release-tag) "RentalStatus" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export enum RentalStatus {
// (undocumented)
CANCELLED = "cancelled",
// (undocumented)
CLAIMED = "claimed",
// (undocumented)
EXECUTED = "executed",
// (undocumented)
OPEN = "open"
}
// @alpha (undocumented)
export enum RequiredPermission {
// (undocumented)
ALLOW_MEDIA_HOSTNAMES = "ALLOW_MEDIA_HOSTNAMES",
// (undocumented)
ALLOW_TO_MOVE_PLAYER_INSIDE_SCENE = "ALLOW_TO_MOVE_PLAYER_INSIDE_SCENE",
// (undocumented)
ALLOW_TO_TRIGGER_AVATAR_EMOTE = "ALLOW_TO_TRIGGER_AVATAR_EMOTE",
// (undocumented)
OPEN_EXTERNAL_LINK = "OPEN_EXTERNAL_LINK",
// (undocumented)
USE_FETCH = "USE_FETCH",
// (undocumented)
USE_WEB3_API = "USE_WEB3_API",
// (undocumented)
USE_WEBSOCKET = "USE_WEBSOCKET"
}
// Warning: (ae-missing-release-tag) "RewardAssignedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "RewardAssignedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RewardAssignedEvent = BaseEvent & {
type: Events.Type.REWARDS;
subType: Events.SubType.Rewards.REWARD_ASSIGNED;
metadata: RewardEventMetadata;
};
// @public (undocumented)
export namespace RewardAssignedEvent {
const // (undocumented)
schema: JSONSchema<RewardAssignedEvent>;
const // (undocumented)
validate: ValidateFunction<RewardAssignedEvent>;
}
// Warning: (ae-missing-release-tag) "RewardDelayedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "RewardDelayedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RewardDelayedEvent = BaseEvent & {
type: Events.Type.REWARDS;
subType: Events.SubType.Rewards.REWARD_DELAYED;
metadata: RewardEventMetadata;
};
// @public (undocumented)
export namespace RewardDelayedEvent {
const // (undocumented)
schema: JSONSchema<RewardDelayedEvent>;
const // (undocumented)
validate: ValidateFunction<RewardDelayedEvent>;
}
// Warning: (ae-missing-release-tag) "RewardEventMetadata" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RewardEventMetadata = BaseEventMetadata & {
beneficiary: EthAddress;
tokenName: string;
tokenImage: string;
tokenRarity?: string;
tokenCategory?: string;
};
// Warning: (ae-missing-release-tag) "RewardInProgressEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "RewardInProgressEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RewardInProgressEvent = BaseEvent & {
type: Events.Type.REWARDS;
subType: Events.SubType.Rewards.REWARD_IN_PROGRESS;
metadata: RewardEventMetadata;
};
// @public (undocumented)
export namespace RewardInProgressEvent {
const // (undocumented)
schema: JSONSchema<RewardInProgressEvent>;
const // (undocumented)
validate: ValidateFunction<RewardInProgressEvent>;
}
// Warning: (ae-missing-release-tag) "RoyaltiesEarnedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "RoyaltiesEarnedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RoyaltiesEarnedEvent = BaseEvent & {
type: Events.Type.BLOCKCHAIN;
subType: Events.SubType.Blockchain.ROYALTIES_EARNED;
metadata: {
address: string;
image: string;
category: string;
rarity?: string;
link: string;
nftName?: string;
royaltiesCut: string;
royaltiesCollector: string;
network: string;
title: string;
description?: string;
};
};
// @public (undocumented)
export namespace RoyaltiesEarnedEvent {
const // (undocumented)
schema: JSONSchema<RoyaltiesEarnedEvent>;
const // (undocumented)
validate: ValidateFunction<RoyaltiesEarnedEvent>;
}
// Warning: (ae-missing-release-tag) "Sale" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Sale" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Sale = {
id: string;
type: SaleType;
buyer: string;
seller: string;
itemId: string | null;
tokenId: string;
contractAddress: string;
price: string;
timestamp: number;
txHash: string;
network: Network.ETHEREUM | Network.MATIC;
chainId: ChainId;
};
// @public (undocumented)
export namespace Sale {
const // (undocumented)
schema: JSONSchema<Sale>;
const // (undocumented)
validate: ValidateFunction<Sale>;
}
// Warning: (ae-missing-release-tag) "SaleFilters" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type SaleFilters = {
first?: number;
skip?: number;
sortBy?: SaleSortBy;
type?: SaleType;
categories?: NFTCategory[];
buyer?: string;
seller?: string;
contractAddress?: string;
itemId?: string;
tokenId?: string;
from?: number;
to?: number;
minPrice?: string;
maxPrice?: string;
network?: Network;
};
// Warning: (ae-missing-release-tag) "SaleSortBy" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum SaleSortBy {
// (undocumented)
MOST_EXPENSIVE = "most_expensive",
// (undocumented)
RECENTLY_SOLD = "recently_sold"
}
// Warning: (ae-missing-release-tag) "SaleType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "SaleType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum SaleType {
// (undocumented)
BID = "bid",
// (undocumented)
MINT = "mint",
// (undocumented)
ORDER = "order"
}
// @public (undocumented)
export namespace SaleType {
const // (undocumented)
schema: JSONSchema<SaleType>;
const // (undocumented)
validate: ValidateFunction<SaleType>;
}
// @alpha (undocumented)
export type Scene = DisplayableDeployment & {
isPortableExperience?: boolean;
main: string;
scene: SceneParcels;
display?: {
title?: string;
favicon?: string;
description?: string;
navmapThumbnail?: string;
};
owner?: string;
contact?: {
name?: string;
email?: string;
im?: string;
url?: string;
};
tags?: string[];
source?: Source;
spawnPoints?: SpawnPoint[];
requiredPermissions?: RequiredPermission[];
featureToggles?: FeatureToggles;
worldConfiguration?: WorldConfiguration;
allowedMediaHostnames?: string[];
};
// @alpha (undocumented)
export namespace Scene {
const // (undocumented)
schema: JSONSchema<Scene>;
const // (undocumented)
validate: ValidateFunction<Scene>;
}
// @public (undocumented)
const SCENE_UPDATE = "SCENE_UPDATE";
// @alpha (undocumented)
export type SceneParcels = {
base: string;
parcels: string[];
};
// @alpha (undocumented)
export namespace SceneParcels {
const // (undocumented)
schema: JSONSchema<SceneParcels>;
const // (undocumented)
schemaValidator: ValidateFunction<SceneParcels>;
const // (undocumented)
validate: ValidateFunction<SceneParcels>;
}
// @public (undocumented)
type SceneUpdate = {
type: typeof SCENE_UPDATE;
payload: {
sceneId: string;
sceneType: string;
};
};
// @public (undocumented)
namespace SceneUpdate {
const // (undocumented)
schema: JSONSchema<SceneUpdate>;
const // (undocumented)
validate: ValidateFunction<SceneUpdate>;
}
declare namespace sdk {
export {
Actions,
Messages,
SCENE_UPDATE,
SceneUpdate,
UPDATE,
Update,
ProjectType,
WearableJson
}
}
export { sdk }
// Warning: (ae-missing-release-tag) "sendMessage" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const sendMessage: <T extends PreviewMessageType>(window: {
postMessage(event: any, targetOrigin: string): any;
}, type: T, payload: PreviewMessagePayload<T>, targetOrigin?: string) => void;
// @alpha
export type SingleMapping = {
type: MappingType.SINGLE;
id: string;
};
// @alpha
export namespace SingleMapping {
const // (undocumented)
schema: JSONSchema<SingleMapping>;
const // (undocumented)
validate: ValidateFunction<Mapping>;
}
// @alpha
export type Snapshots = {
face256: IPFSv2;
body: IPFSv2;
};
// @alpha
export namespace Snapshots {
const // (undocumented)
schema: JSONSchema<Snapshots>;
const // (undocumented)
validate: ValidateFunction<Snapshots>;
}
// @public
export type SnapshotSyncDeployment = {
entityId: IPFSv1 | IPFSv2;
entityType: string;
pointers: string[];
authChain: AuthChain;
entityTimestamp: number;
};
// @public (undocumented)
export namespace SnapshotSyncDeployment {
const // (undocumented)
schema: JSONSchema<SnapshotSyncDeployment>;
const // (undocumented)
validate: ValidateFunction<SnapshotSyncDeployment>;
}
// @alpha (undocumented)
export type Source = {
version?: number;
origin: string;
projectId: string;
point?: {
x: number;
y: number;
};
rotation?: 'north' | 'east' | 'south' | 'west';
layout?: {
rows: number;
cols: number;
};
isEmpty?: boolean;
};
// @alpha (undocumented)
export namespace Source {
const // (undocumented)
schema: JSONSchema<Source>;
const // (undocumented)
validate: ValidateFunction<Source>;
}
// @alpha (undocumented)
export type SpawnPoint = {
name?: string;
position: SinglePosition | MultiPosition;
default?: boolean;
cameraTarget?: SinglePosition;
};
// @alpha (undocumented)
export namespace SpawnPoint {
const // (undocumented)
schema: JSONSchema<SpawnPoint>;
const // (undocumented)
validate: ValidateFunction<SpawnPoint>;
}
// Warning: (ae-missing-release-tag) "StandardProps" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type StandardProps = {
collectionAddress: string;
rarity: Rarity;
};
// Warning: (ae-missing-release-tag) "Store" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "Store" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Store = {
id: string;
owner: string;
description: string;
links: {
name: string;
url: string;
}[];
images: {
name: string;
file: string;
}[];
version: number;
};
// @public (undocumented)
export namespace Store {
const // (undocumented)
schema: JSONSchema<Store>;
const // (undocumented)
validate: ValidateFunction<Store>;
}
// @alpha
export type Subscription = {
address: EthAddress;
email: string | undefined;
details: SubscriptionDetails;
};
// @alpha
export namespace Subscription {
const // (undocumented)
schema: JSONSchema<Subscription>;
const // (undocumented)
validate: ValidateFunction<Subscription>;
}
// @alpha
export type SubscriptionDetails = {
ignore_all_email: boolean;
ignore_all_in_app: boolean;
message_type: {
[notificationType in NotificationType]: NotificationChannelType;
};
};
// @alpha
export namespace SubscriptionDetails {
const // (undocumented)
schema: JSONSchema<SubscriptionDetails>;
const // (undocumented)
validate: ValidateFunction<SubscriptionDetails>;
}
// Warning: (ae-missing-release-tag) "SyncDeployment" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type SyncDeployment = SnapshotSyncDeployment | PointerChangesSyncDeployment;
// Warning: (ae-missing-release-tag) "ThirdPartyProps" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ThirdPartyProps = {
merkleProof: MerkleProof;
content: Record<string, string>;
mappings?: Mappings;
};
// Warning: (ae-missing-release-tag) "Trade" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Trade = {
id: string;
signature: string;
signer: string;
network: Network;
chainId: ChainId;
type: TradeType;
checks: TradeChecks;
createdAt: number;
sent: TradeAsset[];
received: TradeAssetWithBeneficiary[];
};
// Warning: (ae-missing-release-tag) "TradeAsset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type TradeAsset = CollectionItemTradeAsset | ERC20TradeAsset | ERC721TradeAsset | USDPeggedManaTradeAsset;
// Warning: (ae-missing-release-tag) "TradeAssetDirection" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum TradeAssetDirection {
// (undocumented)
RECEIVED = "received",
// (undocumented)
SENT = "sent"
}
// Warning: (ae-missing-release-tag) "TradeAssetType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum TradeAssetType {
// (undocumented)
COLLECTION_ITEM = 4,
// (undocumented)
ERC20 = 1,
// (undocumented)
ERC721 = 3,
// (undocumented)
USD_PEGGED_MANA = 2
}
// Warning: (ae-missing-release-tag) "TradeAssetWithBeneficiary" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type TradeAssetWithBeneficiary = TradeAsset & {
beneficiary: string;
};
// Warning: (ae-missing-release-tag) "TradeChecks" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type TradeChecks = {
uses: number;
expiration: number;
effective: number;
salt: string;
contractSignatureIndex: number;
signerSignatureIndex: number;
allowedRoot: string;
allowedProof?: string[];
externalChecks: TradeExternalCheck[];
};
// Warning: (ae-missing-release-tag) "TradeCreation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type TradeCreation = {
signer: string;
signature: string;
network: Network;
chainId: ChainId;
type: TradeType;
checks: TradeChecks;
sent: TradeAsset[];
received: TradeAssetWithBeneficiary[];
};
// Warning: (ae-missing-release-tag) "TradeExternalCheck" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type TradeExternalCheck = {
contractAddress: string;
selector: string;
value: string;
required: boolean;
};
// Warning: (ae-missing-release-tag) "TradeType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum TradeType {
// (undocumented)
BID = "bid",
// (undocumented)
PUBLIC_ITEM_ORDER = "public_item_order",
// (undocumented)
PUBLIC_NFT_ORDER = "public_nft_order"
}
// Warning: (tsdoc-missing-deprecation-message) The @deprecated block must include a deprecation message, e.g. describing the recommended alternative
//
// @public @deprecated (undocumented)
const UPDATE = "update";
// Warning: (tsdoc-missing-deprecation-message) The @deprecated block must include a deprecation message, e.g. describing the recommended alternative
//
// @public @deprecated (undocumented)
type Update = {
type: typeof UPDATE;
};
// Warning: (tsdoc-missing-deprecation-message) The @deprecated block must include a deprecation message, e.g. describing the recommended alternative
//
// @public @deprecated (undocumented)
namespace Update {
const // (undocumented)
schema: JSONSchema<Update>;
const // (undocumented)
validate: ValidateFunction<Update>;
}
// Warning: (ae-missing-release-tag) "USDPeggedManaTradeAsset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type USDPeggedManaTradeAsset = BaseTradeAsset & {
assetType: TradeAssetType.USD_PEGGED_MANA;
amount: string;
};
// Warning: (ae-missing-release-tag) "UsedEmoteEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type UsedEmoteEvent = BaseEvent & {
type: Events.Type.CLIENT;
subType: Events.SubType.Client.USED_EMOTE;
metadata: ClientBaseMetadata & {
emote: {
emoteIndex: number;
isBase: boolean;
itemId: string;
source: string;
};
};
};
// @public
export interface ValidateFunction<T = unknown> {
// (undocumented)
(this: any, data: any, dataCxt?: any): data is T;
// (undocumented)
errors?: null | ErrorObject[];
}
// @public
export function validateType<T>(theType: Pick<AbstractTypedSchema<T>, 'validate'>, value: T): boolean;
// @alpha
export type ValidWorldRange = {
xMin: number;
yMin: number;
xMax: number;
yMax: number;
};
// Warning: (ae-missing-release-tag) "VerticalHeightReachedEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type VerticalHeightReachedEvent = BaseEvent & {
type: Events.Type.CLIENT;
subType: Events.SubType.Client.VERTICAL_HEIGHT_REACHED;
metadata: ClientBaseMetadata & {
height: number;
};
};
// Warning: (ae-missing-release-tag) "WalkedDistanceEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type WalkedDistanceEvent = BaseEvent & {
type: Events.Type.CLIENT;
subType: Events.SubType.Client.WALKED_DISTANCE;
metadata: ClientBaseMetadata & {
distance: number;
stepCount: number;
};
};
// @alpha (undocumented)
export type Wearable = BaseItem & {
data: {
replaces: HideableWearableCategory[];
hides: HideableWearableCategory[];
tags: string[];
representations: WearableRepresentation[];
category: WearableCategory;
removesDefaultHiding?: HideableWearableCategory[];
blockVrmExport?: boolean;
};
} & (StandardProps | ThirdPartyProps);
// @alpha (undocumented)
export namespace Wearable {
const // (undocumented)
schema: JSONSchema<Wearable>;
const validate: ValidateFunction<Wearable>;
}
// Warning: (ae-missing-release-tag) "WearableCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "WearableCategory" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum WearableCategory {
// (undocumented)
BODY_SHAPE = "body_shape",
// (undocumented)
EARRING = "earring",
// (undocumented)
EYEBROWS = "eyebrows",
// (undocumented)
EYES = "eyes",
// (undocumented)
EYEWEAR = "eyewear",
// (undocumented)
FACIAL_HAIR = "facial_hair",
// (undocumented)
FEET = "feet",
// (undocumented)
HAIR = "hair",
// (undocumented)
HANDS_WEAR = "hands_wear",
// (undocumented)
HAT = "hat",
// (undocumented)
HELMET = "helmet",
// (undocumented)
LOWER_BODY = "lower_body",
// (undocumented)
MASK = "mask",
// (undocumented)
MOUTH = "mouth",
// (undocumented)
SKIN = "skin",
// (undocumented)
TIARA = "tiara",
// (undocumented)
TOP_HEAD = "top_head",
// (undocumented)
UPPER_BODY = "upper_body"
}
// @public (undocumented)
export namespace WearableCategory {
const // (undocumented)
schema: JSONSchema<WearableCategory>;
const // (undocumented)
validate: ValidateFunction<WearableCategory>;
}
// @alpha (undocumented)
export type WearableDefinition = Omit<Wearable, 'data'> & {
data: Omit<Wearable['data'], 'representations'> & {
representations: WearableRepresentationDefinition[];
};
};
// Warning: (ae-missing-release-tag) "WearableGender" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "WearableGender" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum WearableGender {
// (undocumented)
FEMALE = "female",
// (undocumented)
MALE = "male"
}
// @public (undocumented)
export namespace WearableGender {
const // (undocumented)
schema: JSONSchema<WearableGender>;
const // (undocumented)
validate: ValidateFunction<WearableGender>;
}
// @alpha (undocumented)
export type WearableId = string;
// @alpha (undocumented)
type WearableJson = Pick<Wearable, 'data' | 'name' | 'description'> & {
rarity: Rarity;
};
// @alpha (undocumented)
namespace WearableJson {
const // (undocumented)
schema: JSONSchema<WearableJson>;
const // (undocumented)
validate: ValidateFunction<WearableJson>;
}
// @alpha (undocumented)
export type WearableRepresentation = {
bodyShapes: BodyShape[];
mainFile: string;
contents: string[];
overrideHides: HideableWearableCategory[];
overrideReplaces: HideableWearableCategory[];
};
// @alpha (undocumented)
export namespace WearableRepresentation {
const // (undocumented)
schema: JSONSchema<WearableRepresentation>;
const // (undocumented)
validate: ValidateFunction<WearableRepresentation>;
}
// @alpha (undocumented)
export type WearableRepresentationDefinition = Omit<WearableRepresentation, 'contents'> & {
contents: {
key: string;
url: string;
}[];
};
// @alpha (undocumented)
export type WearableRepresentationWithBlobs = Omit<WearableRepresentationDefinition, 'contents'> & {
contents: {
key: string;
blob: any;
}[];
};
// @alpha (undocumented)
export type WearableWithBlobs = Omit<WearableDefinition, 'data'> & {
data: Omit<WearableDefinition['data'], 'representations'> & {
representations: WearableRepresentationWithBlobs[];
};
};
// @alpha
export type World = {
validWorldRanges: Array<ValidWorldRange>;
};
// @alpha (undocumented)
export namespace World {
const // (undocumented)
schema: JSONSchema<World>;
const // (undocumented)
validate: ValidateFunction<World>;
}
// @alpha (undocumented)
export type WorldConfiguration = {
name?: string;
skybox?: number;
minimapVisible?: boolean;
miniMapConfig?: {
visible?: boolean;
dataImage?: string;
estateImage?: string;
};
skyboxConfig?: {
fixedTime?: number;
textures?: string[];
};
fixedAdapter?: string;
placesConfig?: {
optOut?: boolean;
};
};
// @alpha (undocumented)
export namespace WorldConfiguration {
const // (undocumented)
schema: JSONSchema<WorldConfiguration>;
const // (undocumented)
validate: ValidateFunction<WorldConfiguration>;
}
// Warnings were encountered during analysis:
//
// src/dapps/account.ts:30:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/analyticsDayData.ts:14:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/bid.ts:24:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/bid.ts:25:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/bid.ts:66:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/bid.ts:76:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/collection.ts:15:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/collection.ts:16:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/collection.ts:39:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/contract.ts:10:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/contract.ts:11:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/contract.ts:16:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/item.ts:30:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/item.ts:31:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/item.ts:73:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/mint.ts:16:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/mint.ts:17:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/mint.ts:37:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/nft.ts:44:7 - (ae-incompatible-release-tags) The symbol "bodyShapes" is marked as @public, but its signature references "BodyShape" which is marked as @alpha
// src/dapps/nft.ts:54:7 - (ae-incompatible-release-tags) The symbol "bodyShapes" is marked as @public, but its signature references "BodyShape" which is marked as @alpha
// src/dapps/nft.ts:60:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/nft.ts:61:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/nft.ts:93:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/order.ts:18:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/order.ts:19:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/order.ts:34:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/preview/emote-definition.ts:6:5 - (ae-incompatible-release-tags) The symbol "representations" is marked as @public, but its signature references "EmoteRepresentationDefinition" which is marked as @alpha
// src/dapps/preview/preview-config.ts:10:3 - (ae-incompatible-release-tags) The symbol "item" is marked as @public, but its signature references "WearableDefinition" which is marked as @alpha
// src/dapps/preview/preview-config.ts:11:3 - (ae-incompatible-release-tags) The symbol "wearables" is marked as @public, but its signature references "WearableDefinition" which is marked as @alpha
// src/dapps/preview/preview-config.ts:12:3 - (ae-incompatible-release-tags) The symbol "bodyShape" is marked as @public, but its signature references "BodyShape" which is marked as @alpha
// src/dapps/preview/preview-config.ts:17:3 - (ae-incompatible-release-tags) The symbol "type" is marked as @public, but its signature references "PreviewType" which is marked as @alpha
// src/dapps/preview/preview-message.ts:33:7 - (ae-incompatible-release-tags) The symbol "options" is marked as @public, but its signature references "PreviewOptions" which is marked as @alpha
// src/dapps/preview/preview-message.ts:70:7 - (ae-forgotten-export) The symbol "EmoteEventPayload" needs to be exported by the entry point index.d.ts
// src/dapps/rentals-listings.ts:85:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/rentals-listings.ts:126:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/rentals-listings.ts:128:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/rentals-listings.ts:178:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/rentals-listings.ts:180:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/sale.ts:18:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/sale.ts:19:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/sale.ts:42:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/trade.ts:79:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/trade.ts:80:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/dapps/trade.ts:91:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
// src/dapps/trade.ts:92:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
// src/platform/events/blockchain.ts:169:3 - (ae-forgotten-export) The symbol "RentalMetadata" needs to be exported by the entry point index.d.ts
// src/platform/events/client.ts:16:3 - (ae-forgotten-export) The symbol "ClientBaseMetadata" needs to be exported by the entry point index.d.ts
// src/platform/item/emote/adr74/emote-data-adr74.ts:7:3 - (ae-incompatible-release-tags) The symbol "representations" is marked as @public, but its signature references "EmoteRepresentationADR74" which is marked as @alpha
// src/platform/item/linked-wearable-mappings.ts:251:3 - (ae-incompatible-release-tags) The symbol "getMappings" is marked as @public, but its signature references "Mappings" which is marked as @alpha
// src/platform/item/linked-wearable-mappings.ts:252:3 - (ae-incompatible-release-tags) The symbol "addMapping" is marked as @public, but its signature references "ContractNetwork" which is marked as @alpha
// src/platform/item/linked-wearable-mappings.ts:252:3 - (ae-incompatible-release-tags) The symbol "addMapping" is marked as @public, but its signature references "ContractAddress" which is marked as @alpha
// src/platform/item/linked-wearable-mappings.ts:252:3 - (ae-incompatible-release-tags) The symbol "addMapping" is marked as @public, but its signature references "Mapping" which is marked as @alpha
// src/platform/item/linked-wearable-mappings.ts:253:3 - (ae-incompatible-release-tags) The symbol "includesNft" is marked as @public, but its signature references "ContractNetwork" which is marked as @alpha
// src/platform/item/linked-wearable-mappings.ts:253:3 - (ae-incompatible-release-tags) The symbol "includesNft" is marked as @public, but its signature references "ContractAddress" which is marked as @alpha
// src/platform/item/third-party-props.ts:7:3 - (ae-incompatible-release-tags) The symbol "merkleProof" is marked as @public, but its signature references "MerkleProof" which is marked as @alpha
// src/platform/item/third-party-props.ts:9:3 - (ae-incompatible-release-tags) The symbol "mappings" is marked as @public, but its signature references "Mappings" which is marked as @alpha
// src/platform/scene/feature-toggles.ts:11:3 - (ae-forgotten-export) The symbol "EnabledDisabled" needs to be exported by the entry point index.d.ts
// src/platform/scene/feature-toggles.ts:12:3 - (ae-forgotten-export) The symbol "PortableExperiencesToggles" needs to be exported by the entry point index.d.ts
// src/platform/scene/spawn-point.ts:6:3 - (ae-forgotten-export) The symbol "SinglePosition" needs to be exported by the entry point index.d.ts
// src/platform/scene/spawn-point.ts:6:3 - (ae-forgotten-export) The symbol "MultiPosition" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)