@siteping/widget 0.11.1 → 0.12.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { SitepingIdentity, SitepingConfig, SitepingInstance } from './siteping-core.cjs';
-export { AnchorData, AnnotationPayload, AnnotationResponse, CommentResponse, FeedbackPayload, FeedbackPermissions, FeedbackResponse, FeedbackStatus, FeedbackType, RectData, SitepingConfig, SitepingHeadersOption, SitepingHttpConfig, SitepingInstance, SitepingLocale, SitepingPanelAction, SitepingPanelActionContext, SitepingPanelActionFeedback, SitepingPanelButtonAction, SitepingPanelLinkAction, SitepingPublicEvents, SitepingStore, SitepingStoreConfig } from './siteping-core.cjs';
+import { SitepingConfig, SitepingInstance } from './siteping-core.cjs';
+export { AnchorData, AnnotationPayload, AnnotationResponse, BuiltinLocale, CommentPermissions, CommentResponse, DiagnosticsCaptureOptions, DiagnosticsSnapshot, FeedbackPayload, FeedbackPermissions, FeedbackResponse, FeedbackStatus, FeedbackType, PageScope, RectData, ScreenshotRegion, SitepingClientError, SitepingConfig, SitepingDeepLinkOptions, SitepingErrorCode, SitepingHeadersOption, SitepingHttpConfig, SitepingIdentity, SitepingInstance, SitepingLocale, SitepingPanelAction, SitepingPanelActionContext, SitepingPanelActionFeedback, SitepingPanelButtonAction, SitepingPanelLinkAction, SitepingPosition, SitepingPublicEventListener, SitepingPublicEvents, SitepingSkipReason, SitepingStore, SitepingStoreConfig, SitepingTheme, SitepingUnsubscribe, isSitepingError } from './siteping-core.cjs';
 
 /** All translatable string keys used by the widget. */
 interface Translations {
@@ -18,6 +18,8 @@ interface Translations {
     "panel.retry": string;
     "panel.empty": string;
     "panel.showMore": string;
+    /** A feedback of this page whose pin can't be placed (its element is gone or hidden). */
+    "panel.notOnPage": string;
     "panel.showLess": string;
     "panel.resolve": string;
     "panel.reopen": string;
@@ -30,6 +32,7 @@ interface Translations {
     "panel.statusResolved": string;
     "panel.statusInProgress": string;
     "panel.statusWontFix": string;
+    "panel.statusClosed": string;
     "type.label": string;
     "type.question": string;
     "type.change": string;
@@ -70,9 +73,14 @@ interface Translations {
     "fab.badge": string;
     "feedback.sent.confirmation": string;
     "feedback.error.message": string;
+    /** A failed send saved on the device for the next page load. */
+    "feedback.queued": string;
     "feedback.deleted.confirmation": string;
     "badge.count": string;
+    "bulk.aria": string;
     "bulk.selectAll": string;
+    /** A card's selection checkbox; `{label}` is the card's accessible name. */
+    "bulk.selectFeedback": string;
     "bulk.selected": string;
     "bulk.resolve": string;
     "bulk.delete": string;
@@ -84,11 +92,13 @@ interface Translations {
     "sort.label": string;
     "group.byPage": string;
     "group.feedbacks": string;
+    "stats.aria": string;
     "stats.open": string;
-    "stats.resolved": string;
+    "stats.closed": string;
     "stats.bugs": string;
     "stats.progress": string;
     "detail.back": string;
+    "detail.aria": string;
     "detail.title": string;
     "detail.status": string;
     "detail.message": string;
@@ -140,29 +150,25 @@ interface Translations {
 }
 /** 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.
+ * Register translations at runtime, for a new locale or over a built-in one —
+ * call it before `initSiteping`. Partial dictionaries are welcome: under a
+ * built-in code (`registerLocale("fr", { "fab.annotate": "Commenter" })`) the
+ * keys given override the built-in dictionary and every other key keeps its
+ * built-in value; elsewhere missing keys fall back to English per key. So
+ * overriding a single string never requires copying the whole catalog.
+ * Calls for the same code accumulate.
  */
 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.
+ * Dynamically import a built-in locale (once) and register it. Returns the
+ * locale as the widget resolves it — the built-in dictionary with any
+ * {@link registerLocale} overrides on top — or `null` for a code that is
+ * neither built in nor registered. A custom code never hits a 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.
  *
@@ -178,4 +184,5 @@ type Identity = SitepingIdentity;
  */
 declare function initSiteping(config: SitepingConfig): SitepingInstance;
 
-export { type Identity, type TFunction, type TranslationKey, type Translations, initSiteping, loadLocale, registerLocale };
+export { initSiteping, loadLocale, registerLocale };
+export type { TranslationKey, Translations };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { SitepingIdentity, SitepingConfig, SitepingInstance } from './siteping-core.js';
-export { AnchorData, AnnotationPayload, AnnotationResponse, CommentResponse, FeedbackPayload, FeedbackPermissions, FeedbackResponse, FeedbackStatus, FeedbackType, RectData, SitepingConfig, SitepingHeadersOption, SitepingHttpConfig, SitepingInstance, SitepingLocale, SitepingPanelAction, SitepingPanelActionContext, SitepingPanelActionFeedback, SitepingPanelButtonAction, SitepingPanelLinkAction, SitepingPublicEvents, SitepingStore, SitepingStoreConfig } from './siteping-core.js';
+import { SitepingConfig, SitepingInstance } from './siteping-core.js';
+export { AnchorData, AnnotationPayload, AnnotationResponse, BuiltinLocale, CommentPermissions, CommentResponse, DiagnosticsCaptureOptions, DiagnosticsSnapshot, FeedbackPayload, FeedbackPermissions, FeedbackResponse, FeedbackStatus, FeedbackType, PageScope, RectData, ScreenshotRegion, SitepingClientError, SitepingConfig, SitepingDeepLinkOptions, SitepingErrorCode, SitepingHeadersOption, SitepingHttpConfig, SitepingIdentity, SitepingInstance, SitepingLocale, SitepingPanelAction, SitepingPanelActionContext, SitepingPanelActionFeedback, SitepingPanelButtonAction, SitepingPanelLinkAction, SitepingPosition, SitepingPublicEventListener, SitepingPublicEvents, SitepingSkipReason, SitepingStore, SitepingStoreConfig, SitepingTheme, SitepingUnsubscribe, isSitepingError } from './siteping-core.js';
 
 /** All translatable string keys used by the widget. */
 interface Translations {
@@ -18,6 +18,8 @@ interface Translations {
     "panel.retry": string;
     "panel.empty": string;
     "panel.showMore": string;
+    /** A feedback of this page whose pin can't be placed (its element is gone or hidden). */
+    "panel.notOnPage": string;
     "panel.showLess": string;
     "panel.resolve": string;
     "panel.reopen": string;
@@ -30,6 +32,7 @@ interface Translations {
     "panel.statusResolved": string;
     "panel.statusInProgress": string;
     "panel.statusWontFix": string;
+    "panel.statusClosed": string;
     "type.label": string;
     "type.question": string;
     "type.change": string;
@@ -70,9 +73,14 @@ interface Translations {
     "fab.badge": string;
     "feedback.sent.confirmation": string;
     "feedback.error.message": string;
+    /** A failed send saved on the device for the next page load. */
+    "feedback.queued": string;
     "feedback.deleted.confirmation": string;
     "badge.count": string;
+    "bulk.aria": string;
     "bulk.selectAll": string;
+    /** A card's selection checkbox; `{label}` is the card's accessible name. */
+    "bulk.selectFeedback": string;
     "bulk.selected": string;
     "bulk.resolve": string;
     "bulk.delete": string;
@@ -84,11 +92,13 @@ interface Translations {
     "sort.label": string;
     "group.byPage": string;
     "group.feedbacks": string;
+    "stats.aria": string;
     "stats.open": string;
-    "stats.resolved": string;
+    "stats.closed": string;
     "stats.bugs": string;
     "stats.progress": string;
     "detail.back": string;
+    "detail.aria": string;
     "detail.title": string;
     "detail.status": string;
     "detail.message": string;
@@ -140,29 +150,25 @@ interface Translations {
 }
 /** 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.
+ * Register translations at runtime, for a new locale or over a built-in one —
+ * call it before `initSiteping`. Partial dictionaries are welcome: under a
+ * built-in code (`registerLocale("fr", { "fab.annotate": "Commenter" })`) the
+ * keys given override the built-in dictionary and every other key keeps its
+ * built-in value; elsewhere missing keys fall back to English per key. So
+ * overriding a single string never requires copying the whole catalog.
+ * Calls for the same code accumulate.
  */
 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.
+ * Dynamically import a built-in locale (once) and register it. Returns the
+ * locale as the widget resolves it — the built-in dictionary with any
+ * {@link registerLocale} overrides on top — or `null` for a code that is
+ * neither built in nor registered. A custom code never hits a 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.
  *
@@ -178,4 +184,5 @@ type Identity = SitepingIdentity;
  */
 declare function initSiteping(config: SitepingConfig): SitepingInstance;
 
-export { type Identity, type TFunction, type TranslationKey, type Translations, initSiteping, loadLocale, registerLocale };
+export { initSiteping, loadLocale, registerLocale };
+export type { TranslationKey, Translations };