@siteping/widget 0.10.6 → 0.10.8

package/dist/index.d.cts

@@ -1,10 +1,156 @@
-import { SitepingConfig, SitepingInstance } from './siteping-core.cjs';
-export { AnchorData, AnnotationPayload, AnnotationResponse, FeedbackPayload, FeedbackResponse, FeedbackStatus, FeedbackType, RectData, SitepingConfig, SitepingHeadersOption, SitepingInstance, SitepingPublicEvents, SitepingStore } from './siteping-core.cjs';
+import { SitepingIdentity, SitepingConfig, SitepingInstance } from './siteping-core.cjs';
+export { AnchorData, AnnotationPayload, AnnotationResponse, FeedbackPayload, FeedbackResponse, FeedbackStatus, FeedbackType, RectData, SitepingConfig, SitepingHeadersOption, SitepingHttpConfig, SitepingInstance, SitepingLocale, SitepingPublicEvents, SitepingStore, SitepingStoreConfig } from './siteping-core.cjs';
 
-interface Identity {
-    name: string;
-    email: string;
+/** All translatable string keys used by the widget. */
+interface Translations {
+    "panel.title": string;
+    "panel.ariaLabel": string;
+    "panel.feedbackList": string;
+    "panel.loading": string;
+    "panel.close": string;
+    "panel.deleteAll": string;
+    "panel.deleteAllConfirmTitle": string;
+    "panel.deleteAllConfirmMessage": string;
+    "panel.search": string;
+    "panel.searchAria": string;
+    "panel.filterAll": string;
+    "panel.loadError": string;
+    "panel.retry": string;
+    "panel.empty": string;
+    "panel.showMore": string;
+    "panel.showLess": string;
+    "panel.resolve": string;
+    "panel.reopen": string;
+    "panel.delete": string;
+    "panel.cancel": string;
+    "panel.confirmDelete": string;
+    "panel.loadMore": string;
+    "panel.statusAll": string;
+    "panel.statusOpen": string;
+    "panel.statusResolved": string;
+    "panel.statusInProgress": string;
+    "panel.statusWontFix": string;
+    "type.label": string;
+    "type.question": string;
+    "type.change": string;
+    "type.bug": string;
+    "type.other": string;
+    "status.label": string;
+    "scope.label": string;
+    "scope.thisPage": string;
+    "scope.thisType": string;
+    "scope.all": string;
+    "fab.aria": string;
+    "fab.messages": string;
+    "fab.annotate": string;
+    "fab.annotations": string;
+    "annotator.instruction": string;
+    "annotator.instantInstruction": string;
+    "annotator.cancel": string;
+    "popup.placeholder": string;
+    "popup.textareaAria": string;
+    "popup.submitHintMac": string;
+    "popup.submitHintOther": string;
+    "popup.ariaLabel": string;
+    "popup.cancel": string;
+    "popup.submit": string;
+    "identity.title": string;
+    "identity.nameLabel": string;
+    "identity.namePlaceholder": string;
+    "identity.emailLabel": string;
+    "identity.emailPlaceholder": string;
+    "identity.cancel": string;
+    "identity.submit": string;
+    "marker.approximate": string;
+    "marker.aria": string;
+    "marker.count": string;
+    "fab.badge": string;
+    "feedback.sent.confirmation": string;
+    "feedback.error.message": string;
+    "feedback.deleted.confirmation": string;
+    "badge.count": string;
+    "bulk.selectAll": string;
+    "bulk.selected": string;
+    "bulk.resolve": string;
+    "bulk.delete": string;
+    "bulk.deselect": string;
+    "sort.newest": string;
+    "sort.oldest": string;
+    "sort.byType": string;
+    "sort.openFirst": string;
+    "sort.label": string;
+    "group.byPage": string;
+    "group.feedbacks": string;
+    "stats.open": string;
+    "stats.resolved": string;
+    "stats.bugs": string;
+    "stats.progress": string;
+    "detail.back": string;
+    "detail.title": string;
+    "detail.status": string;
+    "detail.message": string;
+    "detail.screenshot": string;
+    "detail.screenshotAlt": string;
+    "detail.metadata": string;
+    "detail.annotation": string;
+    "detail.page": string;
+    "detail.author": string;
+    "detail.date": string;
+    "detail.viewport": string;
+    "detail.browser": string;
+    "detail.resolvedAt": string;
+    /** Closure-date label for won't-fix feedbacks. */
+    "detail.closedAt": string;
+    "detail.goToAnnotation": string;
+    "detail.element": string;
+    "detail.selector": string;
+    "detail.position": string;
+    "detail.resolve": string;
+    "detail.reopen": string;
+    "detail.delete": string;
+    "detail.diagnostics": string;
+    "detail.diagnostics.console": string;
+    "detail.diagnostics.network": string;
+    "detail.diagnostics.expand": string;
+    "detail.diagnostics.collapse": string;
+    "detail.diagnostics.noEntries": string;
+    "shortcuts.title": string;
+    "shortcuts.navigate": string;
+    "shortcuts.resolve": string;
+    "shortcuts.delete": string;
+    "shortcuts.search": string;
+    "shortcuts.select": string;
+    "shortcuts.help": string;
+    "shortcuts.close": string;
+    "shortcuts.hint": string;
+    "export.label": string;
+    "export.csv": string;
+    "export.json": string;
 }
+/** Every valid key of `Translations` as a string-literal union. */
+type TranslationKey = keyof Translations;
+/** A translate function that returns the string for a given key. */
+type TFunction = (key: TranslationKey) => string;
+
+/**
+ * Register a custom locale at runtime. Partial dictionaries are welcome —
+ * missing keys fall back to English per key, so overriding a single string
+ * never requires copying the whole catalog.
+ */
+declare const registerLocale: (code: string, translations: Partial<Translations>) => void;
+/**
+ * Dynamically import a built-in locale and register it. Returns the loaded
+ * translations or `null` if the locale isn't a known built-in. Custom
+ * locales registered via {@link registerLocale} bypass this loader.
+ */
+declare const loadLocale: (locale: string) => Promise<Partial<Translations> | null>;
+
+/**
+ * Author identity persisted by the widget — alias of core's
+ * `SitepingIdentity` (one concept, one shape; the alias keeps the widget's
+ * historical export name working).
+ */
+type Identity = SitepingIdentity;
 
 /**
  * Initialize the Siteping feedback widget.
@@ -21,4 +167,4 @@ interface Identity {
  */
 declare function initSiteping(config: SitepingConfig): SitepingInstance;
 
-export { type Identity, initSiteping };
+export { type Identity, type TFunction, type TranslationKey, type Translations, initSiteping, loadLocale, registerLocale };

package/dist/index.d.ts

@@ -1,10 +1,156 @@
-import { SitepingConfig, SitepingInstance } from './siteping-core.js';
-export { AnchorData, AnnotationPayload, AnnotationResponse, FeedbackPayload, FeedbackResponse, FeedbackStatus, FeedbackType, RectData, SitepingConfig, SitepingHeadersOption, SitepingInstance, SitepingPublicEvents, SitepingStore } from './siteping-core.js';
+import { SitepingIdentity, SitepingConfig, SitepingInstance } from './siteping-core.js';
+export { AnchorData, AnnotationPayload, AnnotationResponse, FeedbackPayload, FeedbackResponse, FeedbackStatus, FeedbackType, RectData, SitepingConfig, SitepingHeadersOption, SitepingHttpConfig, SitepingInstance, SitepingLocale, SitepingPublicEvents, SitepingStore, SitepingStoreConfig } from './siteping-core.js';
 
-interface Identity {
-    name: string;
-    email: string;
+/** All translatable string keys used by the widget. */
+interface Translations {
+    "panel.title": string;
+    "panel.ariaLabel": string;
+    "panel.feedbackList": string;
+    "panel.loading": string;
+    "panel.close": string;
+    "panel.deleteAll": string;
+    "panel.deleteAllConfirmTitle": string;
+    "panel.deleteAllConfirmMessage": string;
+    "panel.search": string;
+    "panel.searchAria": string;
+    "panel.filterAll": string;
+    "panel.loadError": string;
+    "panel.retry": string;
+    "panel.empty": string;
+    "panel.showMore": string;
+    "panel.showLess": string;
+    "panel.resolve": string;
+    "panel.reopen": string;
+    "panel.delete": string;
+    "panel.cancel": string;
+    "panel.confirmDelete": string;
+    "panel.loadMore": string;
+    "panel.statusAll": string;
+    "panel.statusOpen": string;
+    "panel.statusResolved": string;
+    "panel.statusInProgress": string;
+    "panel.statusWontFix": string;
+    "type.label": string;
+    "type.question": string;
+    "type.change": string;
+    "type.bug": string;
+    "type.other": string;
+    "status.label": string;
+    "scope.label": string;
+    "scope.thisPage": string;
+    "scope.thisType": string;
+    "scope.all": string;
+    "fab.aria": string;
+    "fab.messages": string;
+    "fab.annotate": string;
+    "fab.annotations": string;
+    "annotator.instruction": string;
+    "annotator.instantInstruction": string;
+    "annotator.cancel": string;
+    "popup.placeholder": string;
+    "popup.textareaAria": string;
+    "popup.submitHintMac": string;
+    "popup.submitHintOther": string;
+    "popup.ariaLabel": string;
+    "popup.cancel": string;
+    "popup.submit": string;
+    "identity.title": string;
+    "identity.nameLabel": string;
+    "identity.namePlaceholder": string;
+    "identity.emailLabel": string;
+    "identity.emailPlaceholder": string;
+    "identity.cancel": string;
+    "identity.submit": string;
+    "marker.approximate": string;
+    "marker.aria": string;
+    "marker.count": string;
+    "fab.badge": string;
+    "feedback.sent.confirmation": string;
+    "feedback.error.message": string;
+    "feedback.deleted.confirmation": string;
+    "badge.count": string;
+    "bulk.selectAll": string;
+    "bulk.selected": string;
+    "bulk.resolve": string;
+    "bulk.delete": string;
+    "bulk.deselect": string;
+    "sort.newest": string;
+    "sort.oldest": string;
+    "sort.byType": string;
+    "sort.openFirst": string;
+    "sort.label": string;
+    "group.byPage": string;
+    "group.feedbacks": string;
+    "stats.open": string;
+    "stats.resolved": string;
+    "stats.bugs": string;
+    "stats.progress": string;
+    "detail.back": string;
+    "detail.title": string;
+    "detail.status": string;
+    "detail.message": string;
+    "detail.screenshot": string;
+    "detail.screenshotAlt": string;
+    "detail.metadata": string;
+    "detail.annotation": string;
+    "detail.page": string;
+    "detail.author": string;
+    "detail.date": string;
+    "detail.viewport": string;
+    "detail.browser": string;
+    "detail.resolvedAt": string;
+    /** Closure-date label for won't-fix feedbacks. */
+    "detail.closedAt": string;
+    "detail.goToAnnotation": string;
+    "detail.element": string;
+    "detail.selector": string;
+    "detail.position": string;
+    "detail.resolve": string;
+    "detail.reopen": string;
+    "detail.delete": string;
+    "detail.diagnostics": string;
+    "detail.diagnostics.console": string;
+    "detail.diagnostics.network": string;
+    "detail.diagnostics.expand": string;
+    "detail.diagnostics.collapse": string;
+    "detail.diagnostics.noEntries": string;
+    "shortcuts.title": string;
+    "shortcuts.navigate": string;
+    "shortcuts.resolve": string;
+    "shortcuts.delete": string;
+    "shortcuts.search": string;
+    "shortcuts.select": string;
+    "shortcuts.help": string;
+    "shortcuts.close": string;
+    "shortcuts.hint": string;
+    "export.label": string;
+    "export.csv": string;
+    "export.json": string;
 }
+/** Every valid key of `Translations` as a string-literal union. */
+type TranslationKey = keyof Translations;
+/** A translate function that returns the string for a given key. */
+type TFunction = (key: TranslationKey) => string;
+
+/**
+ * Register a custom locale at runtime. Partial dictionaries are welcome —
+ * missing keys fall back to English per key, so overriding a single string
+ * never requires copying the whole catalog.
+ */
+declare const registerLocale: (code: string, translations: Partial<Translations>) => void;
+/**
+ * Dynamically import a built-in locale and register it. Returns the loaded
+ * translations or `null` if the locale isn't a known built-in. Custom
+ * locales registered via {@link registerLocale} bypass this loader.
+ */
+declare const loadLocale: (locale: string) => Promise<Partial<Translations> | null>;
+
+/**
+ * Author identity persisted by the widget — alias of core's
+ * `SitepingIdentity` (one concept, one shape; the alias keeps the widget's
+ * historical export name working).
+ */
+type Identity = SitepingIdentity;
 
 /**
  * Initialize the Siteping feedback widget.
@@ -21,4 +167,4 @@ interface Identity {
  */
 declare function initSiteping(config: SitepingConfig): SitepingInstance;
 
-export { type Identity, initSiteping };
+export { type Identity, type TFunction, type TranslationKey, type Translations, initSiteping, loadLocale, registerLocale };