@inploi/plugin-feedback 6.1.1 → 6.3.0

package/dist/index.d.cts

@@ -0,0 +1,182 @@
+import type { AnalyticsService } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { ApiClient } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { InploiRpcClient } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { InploiSdkEnvironment } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { Logger } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+
+export declare const createFeedbackDomManager: (logger: Logger) => {
+    getRenderTargetElement: (key: string) => Element;
+};
+
+declare const createTFunction: <T extends {
+    readonly a11y_label: "How was your experience?";
+    readonly positive_label: "Good";
+    readonly negative_label: "Bad";
+    readonly positive_heading: "Thanks!";
+    readonly negative_heading: "We’re sorry to hear that";
+    readonly positive_text: "Would you like to tell us more about your experience?";
+    readonly negative_text: "Would you like to tell us more about your experience?";
+    readonly submit: "Send feedback";
+    readonly submitting: "Sending feedback...";
+    readonly skip: "No, thanks";
+    readonly submitted_heading: "Thank you!";
+    readonly submitted_text: "Your feedback has been sent and will be used to improve our products.";
+    readonly comment_minimum: "Please type more characters in the comment box";
+} = {
+    readonly a11y_label: "How was your experience?";
+    readonly positive_label: "Good";
+    readonly negative_label: "Bad";
+    readonly positive_heading: "Thanks!";
+    readonly negative_heading: "We’re sorry to hear that";
+    readonly positive_text: "Would you like to tell us more about your experience?";
+    readonly negative_text: "Would you like to tell us more about your experience?";
+    readonly submit: "Send feedback";
+    readonly submitting: "Sending feedback...";
+    readonly skip: "No, thanks";
+    readonly submitted_heading: "Thank you!";
+    readonly submitted_text: "Your feedback has been sent and will be used to improve our products.";
+    readonly comment_minimum: "Please type more characters in the comment box";
+}>(options: {
+    overrides: Partial<TranslationDict<    {
+    readonly a11y_label: "How was your experience?";
+    readonly positive_label: "Good";
+    readonly negative_label: "Bad";
+    readonly positive_heading: "Thanks!";
+    readonly negative_heading: "We’re sorry to hear that";
+    readonly positive_text: "Would you like to tell us more about your experience?";
+    readonly negative_text: "Would you like to tell us more about your experience?";
+    readonly submit: "Send feedback";
+    readonly submitting: "Sending feedback...";
+    readonly skip: "No, thanks";
+    readonly submitted_heading: "Thank you!";
+    readonly submitted_text: "Your feedback has been sent and will be used to improve our products.";
+    readonly comment_minimum: "Please type more characters in the comment box";
+    }>>;
+    locale: string | undefined;
+}) => TFn<T>;
+
+/** Given a string with double curly braces, returns the content of all curly braces. */
+declare type ExtractParams<T extends string> = T extends `${infer Head}{{${infer Param}}}${infer Tail}` ? Param | ExtractParams<Tail> : never;
+
+export declare type Feedback = ReturnType<FeedbackPlugin>;
+
+export declare type FeedbackDomManager = ReturnType<typeof createFeedbackDomManager>;
+
+export declare type FeedbackPlugin = ReturnType<typeof feedbackPlugin>;
+
+export declare const feedbackPlugin: () => ({ apiClient, logger, analytics }: {
+    apiClient: ApiClient;
+    rpcClient: InploiRpcClient;
+    logger: Logger;
+    analytics: AnalyticsService;
+    publishableKey?: string;
+    env?: InploiSdkEnvironment;
+}) => {
+    /** Returns a string with the initial rendering state of the UI.
+     *  Useful when server-side rendering to avoid CLS.
+     */
+    prerender: (params: FeedbackPluginParams) => Promise<{
+        html: string;
+    }>;
+    /** Renders the Job Alerts Plugin inside the container element. */
+    render: (params: FeedbackPluginRenderParams) => Promise<void>;
+    /** Release one target's widget (and its portals), leaving any other target's. */
+    unmount: (target: HTMLElement) => void;
+    /** Release components, portals and document listeners when an owning widget unmounts. */
+    destroy: () => void;
+    '~brand': "@inploi/plugin-feedback";
+};
+
+export declare type FeedbackPluginParams = {
+    /**
+     *  A unique identifier for this feedback widget.
+     *  It’s up to you to ensure there is a valid feedback widget element with the property data-key="[key]"
+     */
+    key: string;
+    theme: {
+        mode: 'light' | 'dark';
+        corners: 'rounded' | 'soft' | 'sharp';
+        highlights: 'stroke' | 'fill';
+        accent: PaletteParams;
+        /**
+         * Paint the solid accent fill (the submit button) in this exact CSS colour, with `text` on it, instead of the
+         * palette shade generated from `accent`. Text and focus rings keep the palette's shades; `accent` still tints the
+         * neutrals. Both values must each be a single CSS colour (as `getComputedStyle` returns for a custom property).
+         */
+        exactAccent?: {
+            color: string;
+            text: string;
+        };
+        positive: PaletteParams;
+        negative: PaletteParams;
+    };
+    terms: Partial<FeedbackTranslationTerms>;
+    locale?: string;
+    size: 'sm' | 'md' | 'lg';
+    /**
+     * The rating to show, for a host that draws the same key's ratings in more than one place: each follows the one
+     * rating (pass back what `onScore` reports). Absent, the widget keeps its own.
+     */
+    score?: 0 | 1 | -1;
+    /**
+     * Logged with every rating and comment this widget sends, beside its `key` (which stays the reporting key): where the
+     * widget is drawn, and the build that drew it, for a host that draws one key in more than one place.
+     */
+    source?: {
+        placement?: 'header' | 'end';
+        widget_version?: string;
+    };
+    onLeaveComment?: () => void;
+    /** A rating, once it has been logged. */
+    onRate?: (rate: 0 | 1 | -1) => void;
+    /** The rating as it's pressed (1 or -1), or cleared (0: pressed again, which logs nothing, or its log failed). */
+    onScore?: (score: 0 | 1 | -1) => void;
+};
+
+export declare interface FeedbackPluginRenderParams extends FeedbackPluginParams {
+    host?: HTMLElement;
+    /** Explicit render target for widgets that share the same analytics key. */
+    target?: HTMLElement;
+}
+
+/** Visual theme for the Feedback widget. */
+export declare type FeedbackTheme = FeedbackPluginParams['theme'];
+
+export declare type FeedbackTranslationTerms = Parameters<typeof createTFunction>[0]['overrides'] | undefined;
+
+declare type HintedString<KnownValues> = (string & {}) | KnownValues;
+
+declare type PaletteParams = {
+    /** Number between 0 and 360. Number above or below range will loop. */
+    hue: number;
+    /** Float between 0 and 2. Acts as a multiplier to the original generated palette. */
+    chroma: number;
+};
+
+declare type Terms = Record<string, string | TranslationWithPlurals>;
+
+declare interface TFn<TTerms extends Terms> {
+    <K extends TranslationKeyWithParams<TTerms>>(key: K, options: TTerms[K] extends string ? {
+        [_Term in ExtractParams<TTerms[K]>]: number | string;
+    } : {
+        [_Term in ExtractParams<TTerms[K][keyof TTerms[K]] & string> | 'count']: number | string;
+    }): string;
+    <T extends Exclude<keyof (keyof TranslationDict<TTerms>), TranslationKeyWithParams<TTerms>>>(key: T): string;
+    <T extends keyof TranslationDict<TTerms>>(key: T, options?: {
+        [key: string]: string | number;
+    }): string;
+}
+
+declare type TranslationDict<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? {
+        [J in keyof TTerms[K]]: HintedString<TTerms[K][J]>;
+    } : HintedString<TTerms[K]>;
+};
+
+declare type TranslationKeyWithParams<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? K : ExtractParams<TTerms[K] & string> extends never ? never : K;
+}[keyof TranslationDict<TTerms>];
+
+declare type TranslationWithPlurals = Partial<Record<Intl.LDMLPluralRule, string>>;
+
+export { }

package/dist/index.d.ts

@@ -1,2 +1,182 @@
-export * from './feedback';
-export type { FeedbackTranslationTerms } from './i18n';
+import { AnalyticsService } from '@inploi/sdk';
+import { ApiClient } from '@inploi/sdk';
+import { InploiRpcClient } from '@inploi/sdk';
+import { InploiSdkEnvironment } from '@inploi/sdk';
+import { Logger } from '@inploi/sdk';
+
+export declare const createFeedbackDomManager: (logger: Logger) => {
+    getRenderTargetElement: (key: string) => Element;
+};
+
+declare const createTFunction: <T extends {
+    readonly a11y_label: "How was your experience?";
+    readonly positive_label: "Good";
+    readonly negative_label: "Bad";
+    readonly positive_heading: "Thanks!";
+    readonly negative_heading: "We’re sorry to hear that";
+    readonly positive_text: "Would you like to tell us more about your experience?";
+    readonly negative_text: "Would you like to tell us more about your experience?";
+    readonly submit: "Send feedback";
+    readonly submitting: "Sending feedback...";
+    readonly skip: "No, thanks";
+    readonly submitted_heading: "Thank you!";
+    readonly submitted_text: "Your feedback has been sent and will be used to improve our products.";
+    readonly comment_minimum: "Please type more characters in the comment box";
+} = {
+    readonly a11y_label: "How was your experience?";
+    readonly positive_label: "Good";
+    readonly negative_label: "Bad";
+    readonly positive_heading: "Thanks!";
+    readonly negative_heading: "We’re sorry to hear that";
+    readonly positive_text: "Would you like to tell us more about your experience?";
+    readonly negative_text: "Would you like to tell us more about your experience?";
+    readonly submit: "Send feedback";
+    readonly submitting: "Sending feedback...";
+    readonly skip: "No, thanks";
+    readonly submitted_heading: "Thank you!";
+    readonly submitted_text: "Your feedback has been sent and will be used to improve our products.";
+    readonly comment_minimum: "Please type more characters in the comment box";
+}>(options: {
+    overrides: Partial<TranslationDict<    {
+    readonly a11y_label: "How was your experience?";
+    readonly positive_label: "Good";
+    readonly negative_label: "Bad";
+    readonly positive_heading: "Thanks!";
+    readonly negative_heading: "We’re sorry to hear that";
+    readonly positive_text: "Would you like to tell us more about your experience?";
+    readonly negative_text: "Would you like to tell us more about your experience?";
+    readonly submit: "Send feedback";
+    readonly submitting: "Sending feedback...";
+    readonly skip: "No, thanks";
+    readonly submitted_heading: "Thank you!";
+    readonly submitted_text: "Your feedback has been sent and will be used to improve our products.";
+    readonly comment_minimum: "Please type more characters in the comment box";
+    }>>;
+    locale: string | undefined;
+}) => TFn<T>;
+
+/** Given a string with double curly braces, returns the content of all curly braces. */
+declare type ExtractParams<T extends string> = T extends `${infer Head}{{${infer Param}}}${infer Tail}` ? Param | ExtractParams<Tail> : never;
+
+export declare type Feedback = ReturnType<FeedbackPlugin>;
+
+export declare type FeedbackDomManager = ReturnType<typeof createFeedbackDomManager>;
+
+export declare type FeedbackPlugin = ReturnType<typeof feedbackPlugin>;
+
+export declare const feedbackPlugin: () => ({ apiClient, logger, analytics }: {
+    apiClient: ApiClient;
+    rpcClient: InploiRpcClient;
+    logger: Logger;
+    analytics: AnalyticsService;
+    publishableKey?: string;
+    env?: InploiSdkEnvironment;
+}) => {
+    /** Returns a string with the initial rendering state of the UI.
+     *  Useful when server-side rendering to avoid CLS.
+     */
+    prerender: (params: FeedbackPluginParams) => Promise<{
+        html: string;
+    }>;
+    /** Renders the Job Alerts Plugin inside the container element. */
+    render: (params: FeedbackPluginRenderParams) => Promise<void>;
+    /** Release one target's widget (and its portals), leaving any other target's. */
+    unmount: (target: HTMLElement) => void;
+    /** Release components, portals and document listeners when an owning widget unmounts. */
+    destroy: () => void;
+    '~brand': "@inploi/plugin-feedback";
+};
+
+export declare type FeedbackPluginParams = {
+    /**
+     *  A unique identifier for this feedback widget.
+     *  It’s up to you to ensure there is a valid feedback widget element with the property data-key="[key]"
+     */
+    key: string;
+    theme: {
+        mode: 'light' | 'dark';
+        corners: 'rounded' | 'soft' | 'sharp';
+        highlights: 'stroke' | 'fill';
+        accent: PaletteParams;
+        /**
+         * Paint the solid accent fill (the submit button) in this exact CSS colour, with `text` on it, instead of the
+         * palette shade generated from `accent`. Text and focus rings keep the palette's shades; `accent` still tints the
+         * neutrals. Both values must each be a single CSS colour (as `getComputedStyle` returns for a custom property).
+         */
+        exactAccent?: {
+            color: string;
+            text: string;
+        };
+        positive: PaletteParams;
+        negative: PaletteParams;
+    };
+    terms: Partial<FeedbackTranslationTerms>;
+    locale?: string;
+    size: 'sm' | 'md' | 'lg';
+    /**
+     * The rating to show, for a host that draws the same key's ratings in more than one place: each follows the one
+     * rating (pass back what `onScore` reports). Absent, the widget keeps its own.
+     */
+    score?: 0 | 1 | -1;
+    /**
+     * Logged with every rating and comment this widget sends, beside its `key` (which stays the reporting key): where the
+     * widget is drawn, and the build that drew it, for a host that draws one key in more than one place.
+     */
+    source?: {
+        placement?: 'header' | 'end';
+        widget_version?: string;
+    };
+    onLeaveComment?: () => void;
+    /** A rating, once it has been logged. */
+    onRate?: (rate: 0 | 1 | -1) => void;
+    /** The rating as it's pressed (1 or -1), or cleared (0: pressed again, which logs nothing, or its log failed). */
+    onScore?: (score: 0 | 1 | -1) => void;
+};
+
+export declare interface FeedbackPluginRenderParams extends FeedbackPluginParams {
+    host?: HTMLElement;
+    /** Explicit render target for widgets that share the same analytics key. */
+    target?: HTMLElement;
+}
+
+/** Visual theme for the Feedback widget. */
+export declare type FeedbackTheme = FeedbackPluginParams['theme'];
+
+export declare type FeedbackTranslationTerms = Parameters<typeof createTFunction>[0]['overrides'] | undefined;
+
+declare type HintedString<KnownValues> = (string & {}) | KnownValues;
+
+declare type PaletteParams = {
+    /** Number between 0 and 360. Number above or below range will loop. */
+    hue: number;
+    /** Float between 0 and 2. Acts as a multiplier to the original generated palette. */
+    chroma: number;
+};
+
+declare type Terms = Record<string, string | TranslationWithPlurals>;
+
+declare interface TFn<TTerms extends Terms> {
+    <K extends TranslationKeyWithParams<TTerms>>(key: K, options: TTerms[K] extends string ? {
+        [_Term in ExtractParams<TTerms[K]>]: number | string;
+    } : {
+        [_Term in ExtractParams<TTerms[K][keyof TTerms[K]] & string> | 'count']: number | string;
+    }): string;
+    <T extends Exclude<keyof (keyof TranslationDict<TTerms>), TranslationKeyWithParams<TTerms>>>(key: T): string;
+    <T extends keyof TranslationDict<TTerms>>(key: T, options?: {
+        [key: string]: string | number;
+    }): string;
+}
+
+declare type TranslationDict<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? {
+        [J in keyof TTerms[K]]: HintedString<TTerms[K][J]>;
+    } : HintedString<TTerms[K]>;
+};
+
+declare type TranslationKeyWithParams<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? K : ExtractParams<TTerms[K] & string> extends never ? never : K;
+}[keyof TranslationDict<TTerms>];
+
+declare type TranslationWithPlurals = Partial<Record<Intl.LDMLPluralRule, string>>;
+
+export { }