zakeke-configurator-react 0.1.233 → 0.1.234

package/dist/declarations/composer/Module/src/environment.d.ts

@@ -2,7 +2,7 @@ import { EventMessage, ExtensionFields, NftForm, NftSettings, OnBeforeSendDataTo
 import { FocusAttributesEventListener } from '../../../3D/src';
 import { PlatformAttributeSelection } from './integrations/Integration';
 import { BootParameters, Camera, Composition, FontFamily, Group, ImageMacroCategory, Item, Product, ProductQuantityRule, SellerSettings, Template, TemplateMacroCategory, Translations, TryOnGenericFineTuningSettings, TryOnProduct, TryOnSeller } from './models';
-import type { Image, PrintingMethodsRestrictions } from './models';
+import type { Image, PrintingMethodsRestrictions, TextSanitationResult } from './models';
 declare global {
     interface Window {
         token: string;
@@ -238,6 +238,9 @@ export declare class ZakekeEnvironment {
     setItemColor: (guid: string, color: string) => void;
     setItemFontFamily: (guid: string, fontFamily: string) => Promise<void>;
     setItemTextOnPath: (guid: string, areaId: number, value: boolean) => void;
+    fullyLoadFont(font: string | FontFamily): Promise<FontFamily>;
+    sanitizeString: (family: FontFamily, text: string) => string;
+    getSanitationText: (family: FontFamily, text: string) => TextSanitationResult;
     createImage: (file: File, progress?: ((percentage: number) => void) | undefined) => Promise<Image>;
     createImageFromUrl: (url: string) => Promise<Image>;
     addItemImage: (id: number, areaId: number) => Promise<void>;

package/dist/declarations/composer/Module/src/fontsManager.d.ts

@@ -1,6 +1,9 @@
-import { FontFamily } from ".";
+import { FontFamily, FontFamilyFace, TextSanitationResult } from '.';
 /**
  * Download a list of font families so that are available for the browser
+ *
+ * @param fontFamilies List of font families to download
+ * @returns A promise that resolves when all fonts are downloaded
  */
 export declare function loadFonts(fontFamilies: FontFamily[]): Promise<void>;
 /**
@@ -10,3 +13,63 @@ export declare function loadFonts(fontFamilies: FontFamily[]): Promise<void>;
  * @param downloadedFonts A list of downloaded fonts
  */
 export declare function downloadFontsOfDesign(design: MPlaza.Design, downloadedFonts: FontFamily[]): Promise<void>;
+/**
+ * Remove invalid characters from the text.
+ * Invalid characters include backspace (\x08) and null (\u0000) characters.
+ *
+ * @param text The text to remove invalid characters from
+ * @returns The text without invalid characters
+ */
+export declare function removeInvalidCharactersFromText(text: string): string;
+/**
+ * Remove unsupported characters from the text.
+ * Unsupported characters include characters that cannot be displayed or processed correctly.
+ * @param face The font to check character support
+ * @param text The text to remove unsupported characters from
+ * @returns The text without unsupported characters
+ */
+export declare function sanitizeString(face: FontFamilyFace, string: string): string;
+/**
+ * Remove unsupported characters from the text and return a list of removed characters.
+ * Unsupported characters include characters that cannot be displayed or processed correctly.
+ * @param face The font to check character support
+ * @param text The text to remove unsupported characters from
+ * @returns The text without unsupported characters and a list of removed characters
+ */
+export declare function sanitizeText(face: FontFamilyFace, text: string): TextSanitationResult;
+/**
+ * Remove invalid characters from the text based on the font file.
+ * Invalid characters include whitespace or characters that are not supported by the font.
+ *
+ * @param text The text to remove invalid characters from
+ * @param fontFile The font file used to check character support
+ * @returns The text without invalid characters
+ */
+export declare function removeInvalidCharacters(text: string, fontFile: any): string;
+/**
+ * Get the parsed file from a font
+ *
+ * @param face The font to get the parsed file from
+ * @returns The parsed file
+ */
+export declare function getParsedFileFromFont(face: FontFamilyFace): import("./models").FontFamilyFaceFiles | undefined;
+/**
+ * Remove unsupported characters from the text.
+ * Unsupported characters include characters that cannot be displayed or processed correctly.
+ * @param text The text to remove unsupported characters from
+ * @returns The text without unsupported characters
+ */
+export declare function removeUnsupportedCharacters(text: string, currentFont: FontFamilyFace): string;
+/**
+ * Remove textual emojis from the text.
+ * Textual emojis include emojis that are made up of multiple characters.
+ * @param text The text to remove textual emojis from
+ * @returns The text without textual emojis
+ */
+export declare function removeTextualEmojisFromText(text: string): string;
+/**
+ * Remove emojis from the text.
+ * @param text The text to remove emojis from
+ * @returns The text without emojis
+ */
+export declare function removeEmojisFromText(text: string): string;

package/dist/declarations/composer/Module/src/models.d.ts

@@ -257,6 +257,10 @@ export declare class PlatformSettings {
     constructor(ecommerceId: number, currencyId: number | undefined, apiKey: string, apiSecret: string, accessKey: string, accessSecret: string, remoteUrl: string, username: string, password: string, adminPath: string);
     static fromData(settings: PlatformSettingsDto): PlatformSettings;
 }
+export interface TextSanitationResult {
+    sanitizedText: string;
+    dirtyChars: string[];
+}
 export interface MerchantImageResultDto {
     fileNameSmall: string;
     fileNameBig: string;
@@ -284,12 +288,32 @@ export interface SubscriptionInfo {
 export interface FontFamily {
     fontFamilyID: number;
     fontFamilyGuid: number;
+    faces: FontFamilyFace[];
     name: string;
     imageUrl: string;
     cssUrl: string;
     isSystemFont: boolean;
     stretches: string;
     variations: string;
+    fullLoaded?: boolean;
+}
+export interface FontFamilyFace {
+    filesUrls: string[];
+    parsedFiles: FontFamilyFaceFiles[];
+    fontFaceGuid: string;
+    fontFaceID: number;
+    name: string;
+    openTypeStretch: string;
+    openTypeWeight: string;
+    stretch: string;
+    style: string;
+    variation: string;
+    version: string;
+    weight: string;
+}
+export interface FontFamilyFaceFiles {
+    url: string;
+    file: any;
 }
 /**
  * Represents an image.

package/dist/declarations/composer/Module/src/state/createProviderValue.d.ts

@@ -1,3 +1,3 @@
-import { Zakeke } from "./providerValue";
-import { AppState } from "./state";
+import { Zakeke } from './providerValue';
+import { AppState } from './state';
 export declare const createProviderValue: (state: AppState, dispatch: React.Dispatch<any>) => Zakeke;

package/dist/declarations/composer/Module/src/state/providerValue.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module Zakeke
  */
-import { EventMessage, FontFamily, Group, Item, NftForm, NftSettings, OnBeforeSendDataToParent, PrintingMethodsRestrictions, Product, Template, TemplateMacroCategory, Translations, VisibleEventMessage } from '..';
+import { EventMessage, FontFamily, Group, Item, NftForm, NftSettings, OnBeforeSendDataToParent, PrintingMethodsRestrictions, Product, Template, TemplateMacroCategory, TextSanitationResult, Translations, VisibleEventMessage } from '..';
 import { FocusAttributesEventListener } from '../../../../3D/src';
 import { Camera, Image, ImageMacroCategory, ProductQuantityRule, SellerSettings, TemplateUploadRestrictictions } from '../models';
 interface RestrictionColor {
@@ -111,6 +111,9 @@ export interface Zakeke {
     setCameraZoomEnabled: (enabled: boolean) => void;
     resetCameraPivot: () => void;
     setCameraPivot: (meshId: string) => void;
+    fullyLoadFont: (fontFamily: string | FontFamily) => Promise<FontFamily>;
+    sanitizeString: (family: FontFamily, text: string) => string;
+    getSanitationText: (family: FontFamily, text: string) => TextSanitationResult;
     getImages: (categoryId: number) => Promise<Image[]>;
     getMacroCategories: () => Promise<ImageMacroCategory[]>;
     previewOnly__setItemImageFromBase64: (guid: string, base64: string) => void;