Interface AsukaStateApi

State import/export helpers exposed through AsukaDesigner.util.

interface AsukaStateApi {
    clearStorage: ((options?: {
        key?: string;
    }) => void);
    exportFull: (() => AsukaExportedState);
    exportPart: ((part: AsukaStatePart) => AsukaExportedState);
    exportPortablePackage: ((options: Omit<AsukaPortableProductCreateOptions, "state"> & Omit<AsukaPortableProductPackageCreateOptions, "document">) => Promise<Uint8Array>);
    exportPortableProduct: ((options: Omit<AsukaPortableProductCreateOptions, "state">) => AsukaPortableProductDocument);
    extractRuntimeLayoutAsConfig: ((layoutState?: any) => LayoutConfig);
    importFull: ((state: AsukaExportedState, options?: AsukaImportOptions) => void);
    importPart: ((part: AsukaStatePart, state: AsukaExportedState, options?: AsukaImportOptions) => void);
    importPortablePackage: ((input: Blob | ArrayBuffer | Uint8Array, options?: {
        publishAsset?: AsukaPortableAssetPublisher;
        state?: AsukaImportOptions;
    }) => Promise<void>);
    importPortableProduct: ((document: unknown, options?: AsukaImportOptions) => void);
    loadFromStorage: ((options?: {
        key?: string;
    }) => null | AsukaExportedState);
    normalizeLayoutConfigToRuntimeState: ((config: LayoutConfig, fallbackState?: any) => any);
    rebuildActiveViewFromDocument: ((targetViewId?: null | string) => void);
    replaceProduct: ((state: AsukaExportedState, options?: {
        recreate?: boolean;
    }) => AsukaDesigner);
    saveToStorage: ((state: AsukaExportedState, options?: {
        key?: string;
    }) => void);
}

Properties

clearStorage exportFull exportPart exportPortablePackage exportPortableProduct extractRuntimeLayoutAsConfig importFull importPart importPortablePackage importPortableProduct loadFromStorage normalizeLayoutConfigToRuntimeState rebuildActiveViewFromDocument replaceProduct saveToStorage

Properties

clearStorage

clearStorage: ((options?: {
    key?: string;
}) => void)

Clear a previously persisted state payload from local storage.

exportFull

exportFull: (() => AsukaExportedState)

Export the complete serializable app state.

exportPart

exportPart: ((part: AsukaStatePart) => AsukaExportedState)

Export one named part such as template, theme, document, or pricing.

exportPortablePackage

exportPortablePackage: ((options: Omit<AsukaPortableProductCreateOptions, "state"> & Omit<AsukaPortableProductPackageCreateOptions, "document">) => Promise<Uint8Array>)

Create a complete checksummed .asuka.zip package, including resolvable media.

exportPortableProduct

exportPortableProduct: ((options: Omit<AsukaPortableProductCreateOptions, "state">) => AsukaPortableProductDocument)

Export a platform-neutral product document that can move between integrations.

extractRuntimeLayoutAsConfig

extractRuntimeLayoutAsConfig: ((layoutState?: any) => LayoutConfig)

Convert runtime layout state back into init-time layout config.

importFull

importFull: ((state: AsukaExportedState, options?: AsukaImportOptions) => void)

Import a complete serializable app state.

importPart

importPart: ((part: AsukaStatePart, state: AsukaExportedState, options?: AsukaImportOptions) => void)

Import only one named part from a part export or a complete state payload.

importPortablePackage

importPortablePackage: ((input: Blob | ArrayBuffer | Uint8Array, options?: {
    publishAsset?: AsukaPortableAssetPublisher;
    state?: AsukaImportOptions;
}) => Promise<void>)

Read a complete package, publish its media, then restore its product state.

importPortableProduct

importPortableProduct: ((document: unknown, options?: AsukaImportOptions) => void)

Import the canonical product state from a platform-neutral product document.

loadFromStorage

loadFromStorage: ((options?: {
    key?: string;
}) => null | AsukaExportedState)

Load a canonical state payload from local storage.

normalizeLayoutConfigToRuntimeState

normalizeLayoutConfigToRuntimeState: ((config: LayoutConfig, fallbackState?: any) => any)

Convert init-time layout config into runtime layout state.

rebuildActiveViewFromDocument

rebuildActiveViewFromDocument: ((targetViewId?: null | string) => void)

Rebuild the active Fabric view from the current document store.

replaceProduct

replaceProduct: ((state: AsukaExportedState, options?: {
    recreate?: boolean;
}) => AsukaDesigner)

Replace the current product/session with a complete state payload.

saveToStorage

saveToStorage: ((state: AsukaExportedState, options?: {
    key?: string;
}) => void)

Save a canonical state payload to local storage.

Settings

Member Visibility

On This Page

Properties