Options
All
  • Public
  • Public/Protected
  • All
Menu

@byondrnd/byondxr-web-visualizer

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ICameraEventType

ICameraEventType: "zoom" | "move"

IConfigurationFilter

IConfigurationFilter: z.infer<typeof configurationFilterValidator>

IConfigurationSceneCommon

IConfigurationSceneCommon: z.infer<typeof configurationSceneCommonValidator>

IConfigurationSceneOutput

IConfigurationSceneOutput: z.infer<typeof configurationSceneOutputValidator>

IFacet

IFacet: z.infer<typeof facetValidator>

IFavorite

IFavorite: z.infer<typeof favoriteValidator>

IFavoriteProductList

IFavoriteProductList: z.infer<typeof favoriteProductListValidator>

IFavoriteProductShortList

IFavoriteProductShortList: z.infer<typeof favoriteProductShortListValidator>

IFavoriteScene

IFavoriteScene: z.infer<typeof favoriteSceneValidator>

IFavoriteSceneList

IFavoriteSceneList: z.infer<typeof favoriteSceneListValidator>

IFavoriteShort

IFavoriteShort: z.infer<typeof favoriteShortValidator>

IProduct

IProduct: z.infer<typeof productValidator>

IProductShort

IProductShort: z.infer<typeof productShortValidator>

IScene

IScene: z.infer<typeof sceneValidator>

ISceneSubSelection

ISceneSubSelection: z.infer<typeof sceneSubSelectionValidator>

TAnalyticsEvent

TAnalyticsEvent: Partial<{}>

THotspotOnRender

THotspotOnRender: { application: string; position: { x: number; y: number }; title: string }

Type declaration

  • application: string
  • position: { x: number; y: number }
    • x: number
    • y: number
  • title: string

Variables

Const configurationFilterValidator

configurationFilterValidator: ZodObject<{ customFieldName: ZodOptional<ZodString>; name: ZodString; operator: ZodOptional<ZodLiteral<"not">>; options: ZodUnion<[ZodArray<ZodString>, ZodLiteral<any>]> }, "strip", ZodTypeAny, {}, {}> = z.object({name: z.string(),customFieldName: z.string().optional(),operator: z.literal('not').optional(),options: z.union([z.array(z.string()), z.literal(null)]),})

Const configurationSceneCommonValidator

configurationSceneCommonValidator: ZodObject<{ previewImage: ZodOptional<ZodString>; subtitle: ZodOptional<ZodString>; title: ZodString }, "strip", ZodTypeAny, {}, {}> = z.object({title: z.string(),subtitle: z.string().optional(),previewImage: z.string().optional(),})

Const configurationSceneOutputValidator

configurationSceneOutputValidator: ZodObject<extend<{ name: ZodString; subSelection: ZodOptional<ZodObject<{ name: ZodString; previewImage: ZodOptional<ZodString>; title: ZodOptional<ZodString> }, "strip", ZodTypeAny, {}, {}>> }, { previewImage: ZodOptional<ZodString>; subtitle: ZodOptional<ZodString>; title: ZodString }>, "strip", ZodTypeAny, {}, {}> = z.object({name: z.string(),subSelection: sceneSubSelectionValidator.optional(),}).merge(configurationSceneCommonValidator)

Const facetValidator

facetValidator: ZodObject<{ name: ZodString; options: ZodUnion<[ZodArray<ZodString>, ZodLiteral<any>]> }, "strip", ZodTypeAny, {}, {}> = z.object({name: z.string(),options: z.union([z.array(z.string()), z.literal(null)]),})

Const favoriteProductListValidator

favoriteProductListValidator: ZodArray<ZodObject<{ product: ZodObject<{ _id: ZodString; application: ZodString; description: ZodOptional<ZodString>; facets: ZodOptional<ZodArray<ZodObject<{ name: ZodString; options: ZodUnion<[ZodArray<ZodString>, ZodLiteral<any>]> }, "strip", ZodTypeAny, {}, {}>>>; image: ZodString; name: ZodOptional<ZodString>; price: ZodOptional<ZodString>; sku: ZodString; title: ZodString }, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}>> = z.array(favoriteValidator)

Const favoriteProductShortListValidator

favoriteProductShortListValidator: ZodArray<ZodObject<{ product: ZodObject<{ application: ZodString; sku: ZodString }, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}>> = z.array(favoriteShortValidator)

Const favoriteSceneListValidator

favoriteSceneListValidator: ZodArray<ZodObject<{ favorites: ZodArray<ZodObject<{ product: ZodObject<{ _id: ZodString; application: ZodString; description: ZodOptional<ZodString>; facets: ZodOptional<ZodArray<ZodObject<{ name: ZodString; options: ZodUnion<[ZodArray<ZodString>, ZodLiteral<any>]> }, "strip", ZodTypeAny, {}, {}>>>; image: ZodString; name: ZodOptional<ZodString>; price: ZodOptional<ZodString>; sku: ZodString; title: ZodString }, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}>>; id: ZodString; image: ZodString; scene: ZodObject<extend<{ experienceId: ZodString; sceneId: ZodString }, extend<{ name: ZodString; subSelection: ZodOptional<ZodObject<{ name: ZodString; previewImage: ZodOptional<ZodString>; title: ZodOptional<ZodString> }, "strip", ZodTypeAny, {}, {}>> }, { previewImage: ZodOptional<ZodString>; subtitle: ZodOptional<ZodString>; title: ZodString }>>, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}>> = z.array(favoriteSceneValidator)

Const favoriteSceneValidator

favoriteSceneValidator: ZodObject<{ favorites: ZodArray<ZodObject<{ product: ZodObject<{ _id: ZodString; application: ZodString; description: ZodOptional<ZodString>; facets: ZodOptional<ZodArray<ZodObject<{ name: ZodString; options: ZodUnion<[ZodArray<ZodString>, ZodLiteral<any>]> }, "strip", ZodTypeAny, {}, {}>>>; image: ZodString; name: ZodOptional<ZodString>; price: ZodOptional<ZodString>; sku: ZodString; title: ZodString }, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}>>; id: ZodString; image: ZodString; scene: ZodObject<extend<{ experienceId: ZodString; sceneId: ZodString }, extend<{ name: ZodString; subSelection: ZodOptional<ZodObject<{ name: ZodString; previewImage: ZodOptional<ZodString>; title: ZodOptional<ZodString> }, "strip", ZodTypeAny, {}, {}>> }, { previewImage: ZodOptional<ZodString>; subtitle: ZodOptional<ZodString>; title: ZodString }>>, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}> = z.object({id: z.string(),image: z.string(),favorites: z.array(favoriteValidator),scene: sceneValidator,})

Const favoriteShortValidator

favoriteShortValidator: ZodObject<{ product: ZodObject<{ application: ZodString; sku: ZodString }, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}> = z.object({product: productShortValidator,})

Const favoriteValidator

favoriteValidator: ZodObject<{ product: ZodObject<{ _id: ZodString; application: ZodString; description: ZodOptional<ZodString>; facets: ZodOptional<ZodArray<ZodObject<{ name: ZodString; options: ZodUnion<[ZodArray<ZodString>, ZodLiteral<any>]> }, "strip", ZodTypeAny, {}, {}>>>; image: ZodString; name: ZodOptional<ZodString>; price: ZodOptional<ZodString>; sku: ZodString; title: ZodString }, "strip", ZodTypeAny, {}, {}> }, "strip", ZodTypeAny, {}, {}> = z.object({product: productValidator,})

Const productShortValidator

productShortValidator: ZodObject<{ application: ZodString; sku: ZodString }, "strip", ZodTypeAny, {}, {}> = z.object({sku: z.string(),application: z.string(),})

Const productValidator

productValidator: ZodObject<{ _id: ZodString; application: ZodString; description: ZodOptional<ZodString>; facets: ZodOptional<ZodArray<ZodObject<{ name: ZodString; options: ZodUnion<[ZodArray<ZodString>, ZodLiteral<any>]> }, "strip", ZodTypeAny, {}, {}>>>; image: ZodString; name: ZodOptional<ZodString>; price: ZodOptional<ZodString>; sku: ZodString; title: ZodString }, "strip", ZodTypeAny, {}, {}> = z.object({sku: z.string(),name: z.string().optional(),title: z.string(),description: z.string().optional(),application: z.string(),image: z.string(),price: z.string().optional(),facets: z.array(facetValidator).optional(),_id: z.string(),})

Const sceneSubSelectionValidator

sceneSubSelectionValidator: ZodObject<{ name: ZodString; previewImage: ZodOptional<ZodString>; title: ZodOptional<ZodString> }, "strip", ZodTypeAny, {}, {}> = z.object({name: z.string(),title: z.string().optional(),previewImage: z.string().optional(),})

Const sceneValidator

sceneValidator: ZodObject<extend<{ experienceId: ZodString; sceneId: ZodString }, extend<{ name: ZodString; subSelection: ZodOptional<ZodObject<{ name: ZodString; previewImage: ZodOptional<ZodString>; title: ZodOptional<ZodString> }, "strip", ZodTypeAny, {}, {}>> }, { previewImage: ZodOptional<ZodString>; subtitle: ZodOptional<ZodString>; title: ZodString }>>, "strip", ZodTypeAny, {}, {}> = z.object({experienceId: z.string(),sceneId: z.string(),}).merge(configurationSceneOutputValidator)

Object literals

Const analyticsEvents

analyticsEvents: object

property names are assigned to action

evenParamsPaths are serialized into label (and delimited with ':')

applicationHotspotClicked

applicationHotspotClicked: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: string[] = ['application.application']

applicationPointClicked

applicationPointClicked: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: undefined[] = []

applicationsNavigateButtonClicked

applicationsNavigateButtonClicked: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: undefined[] = []

applicationsStripButtonClicked

applicationsStripButtonClicked: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: undefined[] = []

applicationsStripOpened

applicationsStripOpened: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: undefined[] = []

closeFullscreenClicked

closeFullscreenClicked: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoriteSceneClicked

favoriteSceneClicked: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoritesPanelClosed

favoritesPanelClosed: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoritesPanelOpened

favoritesPanelOpened: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoritesSceneDisplayed

favoritesSceneDisplayed: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

fullscreenClicked

fullscreenClicked: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: undefined[] = []

orderSample

orderSample: object

category

category: string = "conversion"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productAddedToCart

productAddedToCart: object

category

category: string = "conversion"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productAddedToFavorites

productAddedToFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productChanged

productChanged: object

category

category: string = "products"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productRemovedFromFavorites

productRemovedFromFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

sceneAddedToFavorites

sceneAddedToFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

sceneLoaded

sceneLoaded: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: string[] = ['scene.sceneId', 'scene.title', 'scene.subtitle']

sceneLoading

sceneLoading: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: string[] = ['scene.sceneId', 'scene.title', 'scene.subtitle']

sceneRemovedFromFavorites

sceneRemovedFromFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

sceneTouched

sceneTouched: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: string[] = ['scene.sceneId', 'scene.title', 'scene.subtitle']

scenesPanelClosed

scenesPanelClosed: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: undefined[] = []

scenesPanelOpened

scenesPanelOpened: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: undefined[] = []

summaryClicked

summaryClicked: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

userChangedProduct

userChangedProduct: object

category

category: string = "products"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

visualizerLoaded

visualizerLoaded: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: string[] = ['visualizer.experienceId']

Generated using TypeDoc