Interface: Zakeke

Contains all the data and methods to control a Zakeke configuration

Properties

IS_ANDROID

• IS_ANDROID: boolean

---

IS_IOS

• IS_IOS: boolean

---

T_dynamic

• T_dynamic: (str: string) => string

Type declaration

▸ (str): string

Parameters

Name	Type
str	string

Returns

string

---

T_static

• T_static: (str: string) => string

Type declaration

▸ (str): string

Parameters

Name	Type
str	string

Returns

string

---

addFocusAttributesListener

• addFocusAttributesListener: (listenerFunction: FocusAttributesEventListener) => void

Type declaration

▸ (listenerFunction): void

Parameters

Name	Type
listenerFunction	FocusAttributesEventListener

Returns

void

---

addItemImage

• addItemImage: (id: number, areaId: number) => Promise<undefined | null | string>

Type declaration

▸ (id, areaId): Promise<undefined | null | string>

Parameters

Name	Type
id	number
areaId	number

Returns

Promise<undefined | null | string>

---

addItemText

• addItemText: (settings: { fontFamily: string ; text: string }, areaId: number) => Promise<void>

Type declaration

▸ (settings, areaId): Promise<void>

Parameters

Name	Type
settings	Object
settings.fontFamily	string
settings.text	string
areaId	number

Returns

Promise<void>

---

addToCart

• addToCart: (additionalProperties: Record<string, any>, OnBeforeSendDataToParent?: (data: OnBeforeSendDataToParent) => Promise<Record<string, any>>, legacyScreenshot?: boolean, nftForm?: NftForm, saveDesignFromTemplateEditor?: boolean) => Promise<void>

Type declaration

▸ (additionalProperties, OnBeforeSendDataToParent?, legacyScreenshot?, nftForm?, saveDesignFromTemplateEditor?): Promise<void>

Parameters

Name	Type
additionalProperties	Record<string, any>
OnBeforeSendDataToParent?	(data: OnBeforeSendDataToParent) => Promise<Record<string, any>>
legacyScreenshot?	boolean
nftForm?	NftForm
saveDesignFromTemplateEditor?	boolean

Returns

Promise<void>

---

additionalCustomProperties

• additionalCustomProperties: null | { formatString: string ; label: string ; name: string ; value: number }[]

---

animationsConfig

• animationsConfig: null | SceneAnimationsConfig

---

applyTemplate

• applyTemplate: (templateGroupCompositionId: number) => Promise<void>

Type declaration

▸ (templateGroupCompositionId): Promise<void>

Parameters

Name	Type
templateGroupCompositionId	number

Returns

Promise<void>

---

areTranslationsLoaded

• areTranslationsLoaded: boolean

---

backgroundColor

• backgroundColor: string

---

cameras

• cameras: Camera[]

---

canUsePD

• canUsePD: boolean

---

canUseTryOn

• canUseTryOn: boolean

---

checkFontSupports

• checkFontSupports: (fontName: string, needsBold: boolean, needsItalic: boolean) => { canKeepStyles: boolean ; supportsBold: boolean ; supportsItalic: boolean }

Type declaration

▸ (fontName, needsBold, needsItalic): Object

Parameters

Name	Type
fontName	string
needsBold	boolean
needsItalic	boolean

Returns

Object

Name	Type
canKeepStyles	boolean
supportsBold	boolean
supportsItalic	boolean

---

clearListeners

• clearListeners: () => void

Type declaration

▸ (): void

Returns

void

---

configureByAI

• configureByAI: (text: string) => Promise<void>

Type declaration

▸ (text): Promise<void>

Parameters

Name	Type
text	string

Returns

Promise<void>

---

createImage

• createImage: (file: File, progress?: (percentage: number) => void) => Promise<ZakekeImage>

Upload an image and get the uploaded image

Param

The file to upload

Param

A callback to get the upload progress

Type declaration

▸ (file, progress?): Promise<ZakekeImage>

Upload an image and get the uploaded image

Parameters

Name	Type	Description
file	File	The file to upload
progress?	(percentage: number) => void	A callback to get the upload progress

Returns

Promise<ZakekeImage>

The uploaded image

---

createImageFromUrl

• createImageFromUrl: (url: string) => Promise<ZakekeImage>

Type declaration

▸ (url): Promise<ZakekeImage>

Parameters

Name	Type
url	string

Returns

Promise<ZakekeImage>

---

createQuote

• createQuote: (formData: any) => Promise<any>

Type declaration

▸ (formData): Promise<any>

Parameters

Name	Type
formData	any

Returns

Promise<any>

---

culture

• culture: string

---

currency

• currency: string

---

currentAttributesSelection

• currentAttributesSelection: null | object

---

currentCompositionInfo

• currentCompositionInfo: null | { compositionId: null | string ; compositionName: null | string ; compositionTags: null | string[] }

---

currentTemplate

• currentTemplate: null | Template

---

deepARsceneGLBUrl

• deepARsceneGLBUrl: null | string

---

defaultColor

• defaultColor: string

---

defaultFontID

• defaultFontID: null | number

---

deleteSavedComposition

• deleteSavedComposition: (docId: string) => Promise<void>

Type declaration

▸ (docId): Promise<void>

Parameters

Name	Type
docId	string

Returns

Promise<void>

---

designUpdate

• designUpdate: () => void

Type declaration

▸ (): void

Returns

void

---

disableTextColors

• disableTextColors: boolean

---

draftCompositions

• draftCompositions: null | ThemeCompositions[]

---

eventMessages

• eventMessages: null | EventMessage[]

---

exportSceneToGlb

• exportSceneToGlb: () => Promise<null | string | Blob>

Type declaration

▸ (): Promise<null | string | Blob>

Returns

Promise<null | string | Blob>

---

exportTryOnMeshToGlb

• exportTryOnMeshToGlb: () => Promise<null | string | Blob>

Type declaration

▸ (): Promise<null | string | Blob>

Returns

Promise<null | string | Blob>

---

focusAttribute

• focusAttribute: (attributeId: number) => void

Type declaration

▸ (attributeId): void

Parameters

Name	Type
attributeId	number

Returns

void

---

fonts

• fonts: FontFamily[]

---

fullyLoadFont

• fullyLoadFont: (fontFamily: string | FontFamily) => Promise<FontFamily>

Type declaration

▸ (fontFamily): Promise<FontFamily>

Parameters

Name	Type
fontFamily	string | FontFamily

Returns

Promise<FontFamily>

---

getCopyrightMessageAccepted

• getCopyrightMessageAccepted: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

---

getDeepARDesktopIframeUrl

• getDeepARDesktopIframeUrl: () => Promise<string>

Type declaration

▸ (): Promise<string>

Returns

Promise<string>

---

getFontWeights

• getFontWeights: (font: FontFamily) => { bold: boolean ; boldWeight: number ; italic: boolean ; italicBold: boolean ; italicBoldWeight: number ; italicWeight: number ; normal: boolean ; normalWeight: number }

Type declaration

▸ (font): Object

Parameters

Name	Type
font	FontFamily

Returns

Object

Name	Type
bold	boolean
boldWeight	number
italic	boolean
italicBold	boolean
italicBoldWeight	number
italicWeight	number
normal	boolean
normalWeight	number

---

getImages

• getImages: (categoryId: number) => Promise<ZakekeImage[]>

Type declaration

▸ (categoryId): Promise<ZakekeImage[]>

Parameters

Name	Type
categoryId	number

Returns

Promise<ZakekeImage[]>

---

getMacroCategories

• getMacroCategories: () => Promise<ImageMacroCategory[]>

Type declaration

▸ (): Promise<ImageMacroCategory[]>

Returns

Promise<ImageMacroCategory[]>

---

getMeshIDbyName

• getMeshIDbyName: (name: string) => undefined | null | string

Type declaration

▸ (name): undefined | null | string

Parameters

Name	Type
name	string

Returns

undefined | null | string

---

getMobileArUrl

• getMobileArUrl: () => Promise<null | string | Blob>

Type declaration

▸ (): Promise<null | string | Blob>

Returns

Promise<null | string | Blob>

---

getOnlineScreenshot

• getOnlineScreenshot: (width: number, height: number, legacyScreenshot?: boolean, backgroundColor?: string, padding?: number) => Promise<{ originalUrl: string ; rewrittenUrl: string }>

Type declaration

▸ (width, height, legacyScreenshot?, backgroundColor?, padding?): Promise<{ originalUrl: string ; rewrittenUrl: string }>

Parameters

Name	Type
width	number
height	number
legacyScreenshot?	boolean
backgroundColor?	string
padding?	number

Returns

Promise<{ originalUrl: string ; rewrittenUrl: string }>

---

getPDF

• getPDF: () => Promise<string>

Create a PDF of the current configuration

Type declaration

▸ (): Promise<string>

Create a PDF of the current configuration

Returns

Promise<string>

The URL of the PDF

---

getPrintingMethods

• getPrintingMethods: () => { name: string ; printMethodId: number }[]

Type declaration

▸ (): { name: string ; printMethodId: number }[]

Returns

{ name: string ; printMethodId: number }[]

---

getPrintingMethodsRestrictions

• getPrintingMethodsRestrictions: () => PrintingMethodsRestrictions

Type declaration

▸ (): PrintingMethodsRestrictions

Returns

PrintingMethodsRestrictions

---

getQrCodeArUrl

• getQrCodeArUrl: (device: "iOS" | "Android") => Promise<string>

Type declaration

▸ (device): Promise<string>

Parameters

Name	Type
device	"iOS" | "Android"

Returns

Promise<string>

---

getSanitationText

• getSanitationText: (family: FontFamily, text: string) => TextSanitationResult

Type declaration

▸ (family, text): TextSanitationResult

Parameters

Name	Type
family	FontFamily
text	string

Returns

TextSanitationResult

---

getShareCompositionUrl

• getShareCompositionUrl: () => Promise<string>

Type declaration

▸ (): Promise<string>

Returns

Promise<string>

---

getTemplateUploadRestrictions

• getTemplateUploadRestrictions: (areaId: number) => TemplateUploadRestrictions

Type declaration

▸ (areaId): TemplateUploadRestrictions

Parameters

Name	Type
areaId	number

Returns

TemplateUploadRestrictions

---

getTryOnSettings

• getTryOnSettings: () => undefined | TryOnSettings

Type declaration

▸ (): undefined | TryOnSettings

Returns

undefined | TryOnSettings

---

getTryOnUrl

• getTryOnUrl: (tryOnUrl?: string) => Promise<string>

Type declaration

▸ (tryOnUrl?): Promise<string>

Parameters

Name	Type
tryOnUrl?	string

Returns

Promise<string>

---

groups

• groups: Group[]

---

hasAnimations

• hasAnimations: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

---

hasExplodedMode

• hasExplodedMode: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

---

hasVTryOnEnabled

• hasVTryOnEnabled: boolean

---

hideMeshAndSaveState

• hideMeshAndSaveState: (meshId: string) => void

Type declaration

▸ (meshId): void

Parameters

Name	Type
meshId	string

Returns

void

---

highlightAttribute

• highlightAttribute: (attributeId: number) => void

Type declaration

▸ (attributeId): void

Parameters

Name	Type
attributeId	number

Returns

void

---

highlightGroup

• highlightGroup: (groupId: number) => void

Type declaration

▸ (groupId): void

Parameters

Name	Type
groupId	number

Returns

void

---

imagesMacroCategories

• imagesMacroCategories: ImageMacroCategory[]

---

isAIEnabled

• isAIEnabled: boolean

---

isAddToCartLoading

• isAddToCartLoading: boolean

---

isArDeviceCompliant

• isArDeviceCompliant: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

---

isAreaVisible

• isAreaVisible: (areaId: number) => boolean

Type declaration

▸ (areaId): boolean

Parameters

Name	Type
areaId	number

Returns

boolean

---

isAssetsLoading

• isAssetsLoading: boolean

---

isExplodedMode

• isExplodedMode: boolean

---

isFullscreenMode

• isFullscreenMode: boolean

---

isInfoPointContentVisible

• isInfoPointContentVisible: boolean

---

isMandatoryPD

• isMandatoryPD: boolean

---

isOutOfStock

• isOutOfStock: boolean

---

isSceneArEnabled

• isSceneArEnabled: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

---

isSceneLoading

• isSceneLoading: boolean

---

isSceneTryOnEnabled

• isSceneTryOnEnabled: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

---

isTryOnMeshVisible

• isTryOnMeshVisible: boolean

---

isViewerReady

• isViewerReady: boolean

---

isVisibleMeshShownForTryOn

• isVisibleMeshShownForTryOn: boolean

---

items

• items: Item[]

---

loadComposition

• loadComposition: (id: string) => Promise<void>

Type declaration

▸ (id): Promise<void>

Parameters

Name	Type
id	string

Returns

Promise<void>

---

loadSavedComposition

• loadSavedComposition: (docID: string) => Promise<void>

Type declaration

▸ (docID): Promise<void>

Parameters

Name	Type
docID	string

Returns

Promise<void>

---

loadedComposition

• loadedComposition: null | { attributesOptions: Map<number, number> ; selectedCategoryID: null | number ; templateName: string }

---

moveItemDown

• moveItemDown: (itemGuid: string) => void

Type declaration

▸ (itemGuid): void

Parameters

Name	Type
itemGuid	string

Returns

void

---

moveItemUp

• moveItemUp: (itemGuid: string) => void

Type declaration

▸ (itemGuid): void

Parameters

Name	Type
itemGuid	string

Returns

void

---

nftSettings

• nftSettings: null | NftSettings

---

openArMobile

• openArMobile: (url: string) => void

Type declaration

▸ (url): void

Parameters

Name	Type
url	string

Returns

void

---

openSecondScreen

• openSecondScreen: () => void

Type declaration

▸ (): void

Returns

void

---

pdDistance

• pdDistance: () => number

Type declaration

▸ (): number

Returns

number

---

personalizedMessages

• personalizedMessages: null | EventMessage[]

---

playAnimations

• playAnimations: () => void

Type declaration

▸ (): void

Returns

void

---

previewOnly__setItemImageFromBase64

• previewOnly__setItemImageFromBase64: (guid: string, base64: string) => void

Type declaration

▸ (guid, base64): void

Parameters

Name	Type
guid	string
base64	string

Returns

void

---

price

• price: number

The current price of the configuration plus the product price

---

product

• product: null | Product

---

productCode

• productCode: string

---

productName

• productName: string

---

quantity

• quantity: number

---

quantityRule

• quantityRule: null | ProductQuantityRule

---

redo

• redo: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

---

removeBackground

• removeBackground: boolean

---

removeItem

• removeItem: (guid: string) => Promise<void>

Remove an item from the customization

Param

The guid of the item to remove

Type declaration

▸ (guid): Promise<void>

Remove an item from the customization

Parameters

Name	Type	Description
guid	string	The guid of the item to remove

Returns

Promise<void>

---

reset

• reset: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

---

resetCameraPivot

• resetCameraPivot: () => void

Type declaration

▸ (): void

Returns

void

---

restoreMeshVisibility

• restoreMeshVisibility: (meshId: string) => void

Type declaration

▸ (meshId): void

Parameters

Name	Type
meshId	string

Returns

void

---

sanitizeString

• sanitizeString: (family: FontFamily, text: string) => string

Type declaration

▸ (family, text): string

Parameters

Name	Type
family	FontFamily
text	string

Returns

string

---

saveComposition

• saveComposition: (customPreviewSize?: CustomPreviewSize, saveDesignFromTemplateEditor?: boolean) => Promise<void>

Type declaration

▸ (customPreviewSize?, saveDesignFromTemplateEditor?): Promise<void>

Parameters

Name	Type
customPreviewSize?	CustomPreviewSize
saveDesignFromTemplateEditor?	boolean

Returns

Promise<void>

---

saveDraftsComposition

• saveDraftsComposition: (name: string, tags: string[], isCopy?: boolean) => Promise<void>

Type declaration

▸ (name, tags, isCopy?): Promise<void>

Parameters

Name	Type
name	string
tags	string[]
isCopy?	boolean

Returns

Promise<void>

---

saveTemplate

• saveTemplate: (templateName: string, selectedCategoryID: null | number, attributesOptions: Map<number, number>, save2Ddesign?: boolean) => Promise<void>

Type declaration

▸ (templateName, selectedCategoryID, attributesOptions, save2Ddesign?): Promise<void>

Parameters

Name	Type
templateName	string
selectedCategoryID	null | number
attributesOptions	Map<number, number>
save2Ddesign?	boolean

Returns

Promise<void>

---

selectOption

• selectOption: (optionId: number) => void

Type declaration

▸ (optionId): void

Parameters

Name	Type
optionId	number

Returns

void

---

sellerSettings

• sellerSettings: null | SellerSettings

---

setBackgroundColor

• setBackgroundColor: (color: string, alpha: number) => void

Type declaration

▸ (color, alpha): void

Parameters

Name	Type
color	string
alpha	number

Returns

void

---

setCamera

• setCamera: (id: string, onlyAngleOfView?: boolean, animate?: boolean) => void

Type declaration

▸ (id, onlyAngleOfView?, animate?): void

Parameters

Name	Type
id	string
onlyAngleOfView?	boolean
animate?	boolean

Returns

void

---

setCameraByName

• setCameraByName: (name: string, onlyAngleOfView?: boolean, animate?: boolean) => void

Type declaration

▸ (name, onlyAngleOfView?, animate?): void

Parameters

Name	Type
name	string
onlyAngleOfView?	boolean
animate?	boolean

Returns

void

---

setCameraLocked

• setCameraLocked: (isBlocked: boolean) => void

Type declaration

▸ (isBlocked): void

Parameters

Name	Type
isBlocked	boolean

Returns

void

---

setCameraPinchingZoom

• setCameraPinchingZoom: (toggle: boolean) => void

Type declaration

▸ (toggle): void

Parameters

Name	Type
toggle	boolean

Returns

void

---

setCameraPivot

• setCameraPivot: (meshId: string) => void

Type declaration

▸ (meshId): void

Parameters

Name	Type
meshId	string

Returns

void

---

setCameraZoomEnabled

• setCameraZoomEnabled: (enabled: boolean) => void

Type declaration

▸ (enabled): void

Parameters

Name	Type
enabled	boolean

Returns

void

---

setCopyrightMessageAccepted

• setCopyrightMessageAccepted: (copyrightMandatoryCheckbox: boolean) => void

Type declaration

▸ (copyrightMandatoryCheckbox): void

Parameters

Name	Type
copyrightMandatoryCheckbox	boolean

Returns

void

---

setExplodedMode

• setExplodedMode: (exploded: boolean) => void

Type declaration

▸ (exploded): void

Parameters

Name	Type
exploded	boolean

Returns

void

---

setHighlightSettings

• setHighlightSettings: (settings: { color: string ; size: number }) => void

Type declaration

▸ (settings): void

Parameters

Name	Type
settings	Object
settings.color	string
settings.size	number

Returns

void

---

setItemBold

• setItemBold: (guid: string, bold: boolean, fontFamily: FontFamily) => void

Type declaration

▸ (guid, bold, fontFamily): void

Parameters

Name	Type
guid	string
bold	boolean
fontFamily	FontFamily

Returns

void

---

setItemColor

• setItemColor: (guid: string, color: string) => void

Type declaration

▸ (guid, color): void

Parameters

Name	Type
guid	string
color	string

Returns

void

---

setItemConstraints

• setItemConstraints: (guid: string, constraints: { canDelete?: boolean ; canMove?: boolean ; canResize?: boolean ; canRotate?: boolean }) => void

Type declaration

▸ (guid, constraints): void

Parameters

Name	Type
guid	string
constraints	Object
constraints.canDelete?	boolean
constraints.canMove?	boolean
constraints.canResize?	boolean
constraints.canRotate?	boolean

Returns

void

---

setItemFontFamily

• setItemFontFamily: (guid: string, fontFamily: string) => void

Type declaration

▸ (guid, fontFamily): void

Parameters

Name	Type
guid	string
fontFamily	string

Returns

void

---

setItemImage

• setItemImage: (guid: string, imageId: number) => Promise<void>

Type declaration

▸ (guid, imageId): Promise<void>

Parameters

Name	Type
guid	string
imageId	number

Returns

Promise<void>

---

setItemImageFromFile

• setItemImageFromFile: (guid: string, file: File) => Promise<void>

Type declaration

▸ (guid, file): Promise<void>

Parameters

Name	Type
guid	string
file	File

Returns

Promise<void>

---

setItemItalic

• setItemItalic: (guid: string, italic: boolean, fontFamily: FontFamily) => void

Type declaration

▸ (guid, italic, fontFamily): void

Parameters

Name	Type
guid	string
italic	boolean
fontFamily	FontFamily

Returns

void

---

setItemSize

• setItemSize: (guid: string, width: number, height: number) => Promise<void>

Type declaration

▸ (guid, width, height): Promise<void>

Parameters

Name	Type
guid	string
width	number
height	number

Returns

Promise<void>

---

setItemText

• setItemText: (guid: string, text: string) => string

Type declaration

▸ (guid, text): string

Parameters

Name	Type
guid	string
text	string

Returns

string

---

setItemTextOnPath

• setItemTextOnPath: (guid: string, areaId: number, value: boolean) => void

Type declaration

▸ (guid, areaId, value): void

Parameters

Name	Type
guid	string
areaId	number
value	boolean

Returns

void

---

setMeshDesignVisibility

• setMeshDesignVisibility: (meshId: string, visible: boolean) => void

Type declaration

▸ (meshId, visible): void

Parameters

Name	Type
meshId	string
visible	boolean

Returns

void

---

setMouseWheelZoomEnabled

• setMouseWheelZoomEnabled: (enabled: boolean) => void

Type declaration

▸ (enabled): void

Parameters

Name	Type
enabled	boolean

Returns

void

---

setPDDistance

• setPDDistance: (distance: number) => void

Type declaration

▸ (distance): void

Parameters

Name	Type
distance	number

Returns

void

---

setPrintingMethod

• setPrintingMethod: (printingMethodId: number, areaId: number) => void

Type declaration

▸ (printingMethodId, areaId): void

Parameters

Name	Type
printingMethodId	number
areaId	number

Returns

void

---

setQuantity

• setQuantity: (quantity: number) => void

Type declaration

▸ (quantity): void

Parameters

Name	Type
quantity	number

Returns

void

---

setTemplate

• setTemplate: (templateId: number) => Promise<void>

Type declaration

▸ (templateId): Promise<void>

Parameters

Name	Type
templateId	number

Returns

Promise<void>

---

shouldLoadDesign

• shouldLoadDesign: null | boolean

---

stopAllAnimations

• stopAllAnimations: () => void

Type declaration

▸ (): void

Returns

void

---

switchFullscreen

• switchFullscreen: () => void

Type declaration

▸ (): void

Returns

void

---

templateMacroCategories

• templateMacroCategories: null | TemplateMacroCategory[]

---

templates

• templates: Template[]

---

textColors

• textColors: RestrictionColor[]

---

uiConfig

• uiConfig: null | UIConfig

---

undo

• undo: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

---

updateView

• updateView: (adjustCamera?: boolean) => void

Type declaration

▸ (adjustCamera?): void

Parameters

Name	Type
adjustCamera?	boolean

Returns

void

---

useLegacyScreenshot

• useLegacyScreenshot: boolean

---

userSettings

• userSettings: null | Settings

---

validationNFTEmail

• validationNFTEmail: (email: string) => boolean

Type declaration

▸ (email): boolean

Parameters

Name	Type
email	string

Returns

boolean

---

validationNFTWalletAddress

• validationNFTWalletAddress: (walletAddress: string) => boolean

Type declaration

▸ (walletAddress): boolean

Parameters

Name	Type
walletAddress	string

Returns

boolean

---

visibleEventMessages

• visibleEventMessages: VisibleEventMessage[]

---

zoomIn

• zoomIn: () => void

Type declaration

▸ (): void

Returns

void

---

zoomOut

• zoomOut: () => void

Type declaration

▸ (): void

Returns

void