pptx-react-viewer 1.20.0 → 1.22.0

package/dist/index.d.ts

@@ -127,6 +127,25 @@ declare const vermilionLightTheme: ViewerTheme;
 /** Dark vermilion theme, ready for the viewer's `theme` prop. */
 declare const vermilionDarkTheme: ViewerTheme;
 
+/** One selectable entry in the viewer chrome's built-in theme picker (File > Options > Appearance). */
+interface ThemeCatalogEntry {
+    /** Stable identifier persisted to storage and passed to `onThemeChange`. */
+    key: string;
+    /** `pptx.*` translation key for the entry's display label. */
+    labelKey: string;
+    /** The theme to apply, or `undefined` to reset to the built-in default. */
+    theme: ViewerTheme | undefined;
+}
+/**
+ * Built-in theme choices offered by File > Options > Appearance when a host
+ * doesn't supply its own `availableThemes`. Keep this list short: it's meant
+ * as a sensible out-of-the-box picker, not a full theme gallery. Hosts that
+ * want more (or fewer) choices pass their own `availableThemes` prop.
+ */
+declare const THEME_CATALOG: readonly ThemeCatalogEntry[];
+/** Look up a catalog entry by key, falling back to `undefined` (the built-in default) if not found. */
+declare function resolveThemeCatalogEntry(key: string | undefined, catalog?: readonly ThemeCatalogEntry[]): ViewerTheme | undefined;
+
 /**
  * Action types: hyperlinks, slide jumps, macros, and action buttons.
  *
@@ -5282,6 +5301,119 @@ interface ViewerFontSource {
     style?: 'normal' | 'italic';
 }
 
+/** Local-only display profile shown in File > Account. Never sent anywhere; purely cosmetic. */
+interface ViewerProfile {
+    displayName: string;
+    /** CSS color for the avatar bubble background, e.g. `'#c2431f'`. */
+    avatarColor: string;
+    /** Single character shown in the avatar bubble. Derived from `displayName` when omitted. */
+    initial?: string;
+}
+declare const DEFAULT_VIEWER_PROFILE: ViewerProfile;
+/** Suggested avatar color swatches for the Account profile editor. */
+declare const AVATAR_COLOR_SWATCHES: readonly string[];
+/** Derive the avatar-bubble initial from a profile, falling back to `'?'` for an empty name. */
+declare function resolveProfileInitial(profile: ViewerProfile): string;
+/**
+ * Optional hook point for hosts that want to wire a real sign-in flow into
+ * File > Account. Disabled by default: the Account page renders nothing
+ * extra unless a host explicitly opts in by passing `enabled: true`.
+ * See docs/guide for wiring instructions.
+ */
+interface AccountAuthConfig {
+    enabled: boolean;
+    onSignIn: () => void;
+    signedInUser?: {
+        name: string;
+        email?: string;
+        avatarUrl?: string;
+    };
+}
+interface LocalStorageUsageSummary {
+    /** Number of presentations with a local autosave/recovery snapshot. */
+    presentationCount: number;
+    /** Total bytes across every stored snapshot. */
+    totalBytes: number;
+}
+/** Summarize local (IndexedDB) storage usage for the Account > Storage & Privacy panel. */
+declare function getLocalStorageUsageSummary(): Promise<LocalStorageUsageSummary>;
+/**
+ * Delete every locally stored presentation/recovery snapshot and persisted
+ * viewer preference (theme/locale/profile). Irreversible; callers should
+ * confirm with the user before invoking this.
+ */
+declare function clearAllLocalViewerData(): Promise<void>;
+/** Persist an updated profile via the shared viewer-prefs store. */
+declare function saveViewerProfile(profile: ViewerProfile): void;
+
+/**
+ * `localStorage`-backed viewer chrome preferences (theme/locale/profile),
+ * shared by every binding.
+ *
+ * This is the persistence layer behind File > Options' Appearance/Language
+ * tabs and File > Account's profile editor when a host doesn't supply its
+ * own `onThemeChange`/`onLocaleChange`/`onProfileChange` callbacks - i.e. the
+ * "standalone" fallback path. Hosts that do wire those callbacks own
+ * persistence themselves and this module is never touched.
+ */
+declare const VIEWER_PREFS_STORAGE_KEY = "pptx-viewer-prefs";
+interface StoredViewerPrefs {
+    /** Key into the shared `THEME_CATALOG` (or a host-supplied `availableThemes` catalog). */
+    themeKey?: string;
+    /** Locale code, e.g. `'fr'`. */
+    localeCode?: string;
+    /** Local-only display profile shown in File > Account. */
+    profile?: ViewerProfile;
+}
+/** Read all persisted viewer preferences. Returns `{}` when unavailable, unset, or corrupt. */
+declare function readStoredViewerPrefs(): StoredViewerPrefs;
+/** Merge `patch` into the persisted viewer preferences. Silently no-ops when storage is unavailable. */
+declare function writeStoredViewerPrefs(patch: Partial<StoredViewerPrefs>): void;
+/** Remove all persisted viewer preferences. Silently no-ops when storage is unavailable. */
+declare function clearStoredViewerPrefs(): void;
+
+/**
+ * Toolbar action / ribbon-tab visibility: a single, framework-agnostic
+ * catalogue of every top-level toolbar button and ribbon tab a host app can
+ * independently hide. Each binding exposes a `hiddenActions?: ToolbarActionId[]`
+ * prop, threads it down to the relevant render sites, and gates them with
+ * `isActionHidden`. Default (`undefined` / `[]`) hides nothing, matching
+ * today's always-visible behaviour.
+ *
+ * `TOOLBAR_TABS` is also the canonical ribbon-tab list/order, replacing the
+ * copy hand-duplicated in each binding (React's `TOOLBAR_SECTIONS`, Vue's
+ * `ribbon-constants.ts`, Angular's `RIBBON_TABS`, etc.) so the tab set can't
+ * drift between bindings. Per-tab icons stay in each binding (icon libraries
+ * differ per framework); only id + i18n key + order are shared here.
+ */
+/**
+ * A single toolbar button/control that can be hidden independently of the
+ * ribbon tab it may also appear inside. `zoom` and `navigation` each cover a
+ * whole control cluster (zoom in/out/fit, prev/next) rather than each button
+ * in it, matching how hosts actually want to hide/keep them as a unit.
+ */
+type ToolbarButtonId = 'share' | 'broadcast' | 'export' | 'undo' | 'redo' | 'record' | 'notes' | 'fullscreen' | 'zoom' | 'navigation';
+/** A top-level ribbon tab. `record` intentionally shares its id with the quick-access Record button above: both surface the same recording feature, so hiding one hides the other. */
+type ToolbarTabId = 'file' | 'home' | 'insert' | 'draw' | 'design' | 'transitions' | 'animations' | 'slideShow' | 'record' | 'review' | 'view' | 'help';
+type ToolbarActionId = ToolbarButtonId | ToolbarTabId;
+
+/** One selectable entry in the viewer chrome's built-in language picker (File > Options > Language). */
+interface LocaleCatalogEntry {
+  /** BCP-47-ish locale code, e.g. `'en'`, `'fr'`. Matches `pptx-viewer-locales`' exports. */
+  code: string;
+  /** English display name, used before a translation dictionary for the target locale is loaded. */
+  label: string;
+  /** The locale's own name for itself, e.g. `'Français'` for `fr`. */
+  nativeLabel: string;
+}
+/**
+ * Built-in language choices offered by File > Options > Language when a host
+ * doesn't supply its own `availableLocales`. Mirrors the locales shipped by
+ * the optional `pptx-viewer-locales` package (English needs no dictionary,
+ * it's the viewer's own baseline).
+ */
+declare const LOCALE_CATALOG: readonly LocaleCatalogEntry[];
+
 //#endregion
 //#region src/theme/context.d.ts
 interface ViewerThemeProviderProps {
@@ -5376,6 +5508,50 @@ interface PowerPointViewerProps {
    * @see {@link ViewerTheme} for the full type definition.
    */
   theme?: ViewerTheme;
+  /**
+   * Initial key into `availableThemes` (or the built-in `THEME_CATALOG`) for
+   * File > Options > Appearance. Ignored once the user picks a different
+   * entry in that session, and always overridden by the `theme` prop when
+   * both are supplied. Falls back to a persisted `localStorage` choice, then
+   * `'default'`.
+   */
+  defaultThemeKey?: string;
+  /**
+   * Theme choices offered by File > Options > Appearance. Defaults to the
+   * shared `THEME_CATALOG` (default/light/vermilionLight/vermilionDark).
+   */
+  availableThemes?: ThemeCatalogEntry[];
+  /**
+   * Called when the user picks a theme from File > Options > Appearance.
+   * When provided, the host owns persisting the choice (the viewer will not
+   * also write it to `localStorage`); otherwise the viewer persists it via
+   * the shared `writeStoredViewerPrefs` helper.
+   */
+  onThemeChange?: (key: string) => void;
+  /**
+   * Initial locale code for File > Options > Language. Falls back to a
+   * persisted `localStorage` choice, then `'en'`.
+   */
+  defaultLocale?: string;
+  /**
+   * Locale choices offered by File > Options > Language. Defaults to the
+   * codes actually registered on the host's `react-i18next` instance
+   * (mapped through the shared `LOCALE_CATALOG` for display labels).
+   */
+  availableLocales?: LocaleCatalogEntry[];
+  /**
+   * Called when the user picks a language from File > Options > Language.
+   * When provided, the host owns applying and persisting the choice (the
+   * viewer will not call `i18n.changeLanguage` or touch `localStorage`
+   * itself); otherwise the viewer applies and persists it directly.
+   */
+  onLocaleChange?: (code: string) => void;
+  /**
+   * Optional hook point for File > Account's sign-in section. Disabled by
+   * default (renders nothing extra); pass `{ enabled: true, onSignIn }` to
+   * surface a real sign-in flow.
+   */
+  accountAuth?: AccountAuthConfig;
   /**
    * Optional real-time collaboration configuration.
    *
@@ -5437,6 +5613,24 @@ interface PowerPointViewerProps {
    * back to the SVG `SmartArtRenderer`. Default `false`.
    */
   smartArt3D?: boolean;
+  /**
+   * Hide individual toolbar buttons and/or ribbon tabs instead of the whole
+   * toolbar. Accepts any mix of button ids (`share`, `broadcast`, `export`,
+   * `undo`, `redo`, `record`, `notes`, `fullscreen`, `zoom`, `navigation`)
+   * and ribbon-tab ids (`file`, `home`, `insert`, `draw`, `design`,
+   * `transitions`, `animations`, `slideShow`, `record`, `review`, `view`,
+   * `help`). `zoom` and `navigation` each hide their whole control cluster
+   * (zoom in/out/fit; previous/next slide), not each sub-button. `record`
+   * is shared between the quick-access Record button and the Record ribbon
+   * tab: hiding it hides both. Omitted or empty hides nothing (default,
+   * fully backward compatible).
+   *
+   * @example
+   * ```tsx
+   * <PowerPointViewer content={bytes} hiddenActions={['share', 'broadcast', 'record']} />
+   * ```
+   */
+  hiddenActions?: ToolbarActionId[];
 }
 interface PowerPointViewerHandle extends FileViewerHandle, PowerPointViewerAPI {
   getContent: () => Promise<Uint8Array>;
@@ -5476,5 +5670,5 @@ declare const PowerPointViewer: react.ForwardRefExoticComponent<PowerPointViewer
  */
 declare function renderToCanvas(element: HTMLElement, options?: Partial<Options>): Promise<HTMLCanvasElement>;
 
-export { PowerPointViewer, ViewerThemeProvider, defaultCssVars, defaultRadius, defaultThemeColors, getAnimationInitialStyle, renderToCanvas, themeToCssVars, useViewerTheme, vermilionDarkColors, vermilionDarkTheme, vermilionLightColors, vermilionLightTheme, vermilionRadius };
-export type { PowerPointViewerAPI, PowerPointViewerHandle, PowerPointViewerProps, ViewerMode, ViewerTheme, ViewerThemeColors };
+export { AVATAR_COLOR_SWATCHES, DEFAULT_VIEWER_PROFILE, LOCALE_CATALOG, PowerPointViewer, THEME_CATALOG, VIEWER_PREFS_STORAGE_KEY, ViewerThemeProvider, clearAllLocalViewerData, clearStoredViewerPrefs, defaultCssVars, defaultRadius, defaultThemeColors, getAnimationInitialStyle, getLocalStorageUsageSummary, readStoredViewerPrefs, renderToCanvas, resolveProfileInitial, resolveThemeCatalogEntry, saveViewerProfile, themeToCssVars, useViewerTheme, vermilionDarkColors, vermilionDarkTheme, vermilionLightColors, vermilionLightTheme, vermilionRadius, writeStoredViewerPrefs };
+export type { AccountAuthConfig, LocalStorageUsageSummary, LocaleCatalogEntry, PowerPointViewerAPI, PowerPointViewerHandle, PowerPointViewerProps, StoredViewerPrefs, ThemeCatalogEntry, ToolbarActionId, ToolbarButtonId, ToolbarTabId, ViewerMode, ViewerProfile, ViewerTheme, ViewerThemeColors };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib/canvas-export.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;iBAmCsB,eACrB,SAAS,aACT,UAAS,QAAQ,WACf,QAAQ"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib/canvas-export.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;iBAmCsB,eACrB,SAAS,aACT,UAAS,QAAQ,WACf,QAAQ"}

package/dist/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var chunkKRK367H5_js = require('./chunk-KRK367H5.js');
-var chunkLXUMBK2O_js = require('./chunk-LXUMBK2O.js');
-var chunkBXACB3BG_js = require('./chunk-BXACB3BG.js');
-require('./chunk-4SRCC7NB.js');
+var chunkA6IFTYB5_js = require('./chunk-A6IFTYB5.js');
+var chunkQVQTDWB7_js = require('./chunk-QVQTDWB7.js');
+var chunkVSNXVKJI_js = require('./chunk-VSNXVKJI.js');
+var chunkZISXRMDJ_js = require('./chunk-ZISXRMDJ.js');
 require('./chunk-AD3EAEY6.js');
 require('./chunk-QGM4M3NI.js');
 
@@ -11,57 +11,109 @@ require('./chunk-QGM4M3NI.js');
 
 Object.defineProperty(exports, "PowerPointViewer", {
   enumerable: true,
-  get: function () { return chunkKRK367H5_js.PowerPointViewer; }
+  get: function () { return chunkA6IFTYB5_js.PowerPointViewer; }
 });
 Object.defineProperty(exports, "ViewerThemeProvider", {
   enumerable: true,
-  get: function () { return chunkKRK367H5_js.ViewerThemeProvider; }
+  get: function () { return chunkA6IFTYB5_js.ViewerThemeProvider; }
 });
 Object.defineProperty(exports, "useViewerTheme", {
   enumerable: true,
-  get: function () { return chunkKRK367H5_js.useViewerTheme; }
+  get: function () { return chunkA6IFTYB5_js.useViewerTheme; }
 });
 Object.defineProperty(exports, "getAnimationInitialStyle", {
   enumerable: true,
-  get: function () { return chunkLXUMBK2O_js.getAnimationInitialStyle; }
+  get: function () { return chunkQVQTDWB7_js.getAnimationInitialStyle; }
 });
 Object.defineProperty(exports, "renderToCanvas", {
   enumerable: true,
-  get: function () { return chunkLXUMBK2O_js.renderToCanvas; }
+  get: function () { return chunkQVQTDWB7_js.renderToCanvas; }
+});
+Object.defineProperty(exports, "AVATAR_COLOR_SWATCHES", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.AVATAR_COLOR_SWATCHES; }
+});
+Object.defineProperty(exports, "DEFAULT_VIEWER_PROFILE", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.DEFAULT_VIEWER_PROFILE; }
+});
+Object.defineProperty(exports, "THEME_CATALOG", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.THEME_CATALOG; }
+});
+Object.defineProperty(exports, "VIEWER_PREFS_STORAGE_KEY", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.VIEWER_PREFS_STORAGE_KEY; }
+});
+Object.defineProperty(exports, "clearAllLocalViewerData", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.clearAllLocalViewerData; }
+});
+Object.defineProperty(exports, "clearStoredViewerPrefs", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.clearStoredViewerPrefs; }
 });
 Object.defineProperty(exports, "defaultCssVars", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.defaultCssVars; }
+  get: function () { return chunkVSNXVKJI_js.defaultCssVars; }
 });
 Object.defineProperty(exports, "defaultRadius", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.defaultRadius; }
+  get: function () { return chunkVSNXVKJI_js.defaultRadius; }
 });
 Object.defineProperty(exports, "defaultThemeColors", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.defaultThemeColors; }
+  get: function () { return chunkVSNXVKJI_js.defaultThemeColors; }
+});
+Object.defineProperty(exports, "getLocalStorageUsageSummary", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.getLocalStorageUsageSummary; }
+});
+Object.defineProperty(exports, "readStoredViewerPrefs", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.readStoredViewerPrefs; }
+});
+Object.defineProperty(exports, "resolveProfileInitial", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.resolveProfileInitial; }
+});
+Object.defineProperty(exports, "resolveThemeCatalogEntry", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.resolveThemeCatalogEntry; }
+});
+Object.defineProperty(exports, "saveViewerProfile", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.saveViewerProfile; }
 });
 Object.defineProperty(exports, "themeToCssVars", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.themeToCssVars; }
+  get: function () { return chunkVSNXVKJI_js.themeToCssVars; }
 });
 Object.defineProperty(exports, "vermilionDarkColors", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.vermilionDarkColors; }
+  get: function () { return chunkVSNXVKJI_js.vermilionDarkColors; }
 });
 Object.defineProperty(exports, "vermilionDarkTheme", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.vermilionDarkTheme; }
+  get: function () { return chunkVSNXVKJI_js.vermilionDarkTheme; }
 });
 Object.defineProperty(exports, "vermilionLightColors", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.vermilionLightColors; }
+  get: function () { return chunkVSNXVKJI_js.vermilionLightColors; }
 });
 Object.defineProperty(exports, "vermilionLightTheme", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.vermilionLightTheme; }
+  get: function () { return chunkVSNXVKJI_js.vermilionLightTheme; }
 });
 Object.defineProperty(exports, "vermilionRadius", {
   enumerable: true,
-  get: function () { return chunkBXACB3BG_js.vermilionRadius; }
+  get: function () { return chunkVSNXVKJI_js.vermilionRadius; }
+});
+Object.defineProperty(exports, "writeStoredViewerPrefs", {
+  enumerable: true,
+  get: function () { return chunkVSNXVKJI_js.writeStoredViewerPrefs; }
+});
+Object.defineProperty(exports, "LOCALE_CATALOG", {
+  enumerable: true,
+  get: function () { return chunkZISXRMDJ_js.LOCALE_CATALOG; }
 });

package/dist/index.mjs

@@ -1,6 +1,6 @@
-export { PowerPointViewer, ViewerThemeProvider, useViewerTheme } from './chunk-TUVSZMLW.mjs';
-export { getAnimationInitialStyle, renderToCanvas } from './chunk-UDJHJM5B.mjs';
-export { defaultCssVars, defaultRadius, defaultThemeColors, themeToCssVars, vermilionDarkColors, vermilionDarkTheme, vermilionLightColors, vermilionLightTheme, vermilionRadius } from './chunk-GG2KBJSN.mjs';
-import './chunk-4LPWBQTH.mjs';
+export { PowerPointViewer, ViewerThemeProvider, useViewerTheme } from './chunk-7P7QQGTI.mjs';
+export { getAnimationInitialStyle, renderToCanvas } from './chunk-DZUI64SO.mjs';
+export { AVATAR_COLOR_SWATCHES, DEFAULT_VIEWER_PROFILE, THEME_CATALOG, VIEWER_PREFS_STORAGE_KEY, clearAllLocalViewerData, clearStoredViewerPrefs, defaultCssVars, defaultRadius, defaultThemeColors, getLocalStorageUsageSummary, readStoredViewerPrefs, resolveProfileInitial, resolveThemeCatalogEntry, saveViewerProfile, themeToCssVars, vermilionDarkColors, vermilionDarkTheme, vermilionLightColors, vermilionLightTheme, vermilionRadius, writeStoredViewerPrefs } from './chunk-5SBQZEKD.mjs';
+export { LOCALE_CATALOG } from './chunk-E3KJKCSV.mjs';
 import './chunk-3ZGCM6RC.mjs';
 import './chunk-6DZX6EAA.mjs';