@magicfeedback/native 2.1.7-alpha.8 → 2.2.0-alpha.0

package/dist/types/src/models/types.d.ts

@@ -38,10 +38,95 @@ export declare enum FEEDBACKAPPANSWERTYPE {
 export declare class QuestionType {
     conf: any;
 }
-export type NativeQuestion = {
+export type QuestionAssetsBase = {
+    [key: string]: any;
+    placeholder?: string;
+    subtitle?: string | Record<string, string>;
+    subtitleStyle?: string | string[];
+    maxCharacters?: number;
+    randomPosition?: boolean;
+    direction?: "row" | "column" | string;
+    order?: "ltr" | "rtl" | string;
+    min?: number;
+    max?: number;
+    minPlaceholder?: string;
+    maxPlaceholder?: string;
+    extraOption?: boolean;
+    extraOptionText?: string;
+    extraOptionPlaceholder?: string;
+};
+export type QuestionAssetsByType = {
+    [FEEDBACKAPPANSWERTYPE.TEXT]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.LONGTEXT]: QuestionAssetsBase & {
+        maxCharacters?: number;
+    };
+    [FEEDBACKAPPANSWERTYPE.NUMBER]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.RADIO]: QuestionAssetsBase & {
+        exclusiveAnswers?: string[];
+        maxOptions?: number;
+        extraOption?: boolean;
+        extraOptionText?: string;
+        extraOptionPlaceholder?: string;
+    };
+    [FEEDBACKAPPANSWERTYPE.MULTIPLECHOICE]: QuestionAssetsByType[FEEDBACKAPPANSWERTYPE.RADIO];
+    [FEEDBACKAPPANSWERTYPE.SELECT]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.DATE]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.EMAIL]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.PASSWORD]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.BOOLEAN]: QuestionAssetsBase & {
+        addIcon?: boolean;
+    };
+    [FEEDBACKAPPANSWERTYPE.CONSENT]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.RATING_EMOJI]: QuestionAssetsBase & {
+        min?: number;
+        max?: number;
+        minPlaceholder?: string;
+        maxPlaceholder?: string;
+        extraOption?: boolean;
+        extraOptionText?: string;
+    };
+    [FEEDBACKAPPANSWERTYPE.RATING_NUMBER]: QuestionAssetsBase & {
+        min?: number;
+        max?: number;
+        minPlaceholder?: string;
+        maxPlaceholder?: string;
+        numberPlaceholders?: Record<number, string>;
+        extraOption?: boolean;
+        extraOptionText?: string;
+        ariaLabel?: string;
+    };
+    [FEEDBACKAPPANSWERTYPE.RATING_STAR]: QuestionAssetsBase & {
+        minPlaceholder?: string;
+        maxPlaceholder?: string;
+    };
+    [FEEDBACKAPPANSWERTYPE.MULTIPLECHOISE_IMAGE]: QuestionAssetsBase & {
+        addTitle?: boolean;
+        multiOption?: boolean;
+        extraOption?: boolean;
+        extraOptionValue?: any[];
+    };
+    [FEEDBACKAPPANSWERTYPE.MULTI_QUESTION_MATRIX]: QuestionAssetsBase & {
+        options?: string[];
+        exclusiveAnswers?: string[];
+    };
+    [FEEDBACKAPPANSWERTYPE.PRIORITY_LIST]: QuestionAssetsBase & {
+        limitPriority?: boolean;
+        maxPriority?: number;
+    };
+    [FEEDBACKAPPANSWERTYPE.POINT_SYSTEM]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.INFO_PAGE]: QuestionAssetsBase;
+    [FEEDBACKAPPANSWERTYPE.UPLOAD_FILE]: QuestionAssetsBase & {
+        multiple?: boolean;
+        maxFiles?: number;
+    };
+    [FEEDBACKAPPANSWERTYPE.UPLOAD_IMAGE]: QuestionAssetsByType[FEEDBACKAPPANSWERTYPE.UPLOAD_FILE];
+    [FEEDBACKAPPANSWERTYPE.CONTACT]: QuestionAssetsBase;
+};
+export type QuestionAssetsFor<T extends FEEDBACKAPPANSWERTYPE | string> = T extends FEEDBACKAPPANSWERTYPE ? QuestionAssetsByType[T] & QuestionAssetsBase : QuestionAssetsBase;
+export type NativeQuestion<T extends FEEDBACKAPPANSWERTYPE | string = FEEDBACKAPPANSWERTYPE | string> = {
     id: string;
     title: string;
-    type: FEEDBACKAPPANSWERTYPE | string;
+    type: T;
     questionType: QuestionType;
     ref: string;
     require: boolean;
@@ -51,7 +136,7 @@ export type NativeQuestion = {
     appId?: string;
     followup: boolean;
     position: number;
-    assets: any;
+    assets: QuestionAssetsFor<T>;
     refMetric: string;
     integrationId: string;
     integrationPageId: string;

package/dist/types/src/render/helpers.d.ts

@@ -0,0 +1,3 @@
+export declare function parseTitle(title: string, lang: string): string;
+export declare function getBooleanOptions(lang: string): string[];
+export declare function getUrlParam(key: string): string | null;

package/dist/types/src/render/ratingHelpers.d.ts

@@ -0,0 +1,3 @@
+export declare function createRatingPlaceholder(min: number, max: number, minPlaceholder: string, maxPlaceholder: string, extraOption: boolean, mobile?: boolean, order?: string, direction?: string): HTMLDivElement;
+export declare function createStarRating(ref: string, minPlaceholder: string, maxPlaceholder: string, send?: () => void, urlParamValue?: string | null): HTMLDivElement;
+export declare function createRatingNumberElement(ref: string, assets: any, order: string, direction: string, isPhone: boolean, elementTypeClass: string, send?: () => void, urlParamValue?: string | null): HTMLElement;

package/dist/types/src/render/registry.d.ts

@@ -0,0 +1,3 @@
+import { FEEDBACKAPPANSWERTYPE } from "../models/types";
+import { QuestionRenderer } from "./types";
+export declare function getQuestionRenderer(type: FEEDBACKAPPANSWERTYPE | string): QuestionRenderer | undefined;

package/dist/types/src/render/renderBoolean.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderBoolean: QuestionRenderer;

package/dist/types/src/render/renderChoice.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderChoice: QuestionRenderer;

package/dist/types/src/render/renderConsent.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderConsent: QuestionRenderer;

package/dist/types/src/render/renderDate.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderDate: QuestionRenderer;

package/dist/types/src/render/renderEmail.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderEmail: QuestionRenderer;

package/dist/types/src/render/renderInfoPage.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderInfoPage: QuestionRenderer;

package/dist/types/src/render/renderLongText.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderLongText: QuestionRenderer;

package/dist/types/src/render/renderMatrix.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderMatrix: QuestionRenderer;

package/dist/types/src/render/renderMultipleChoiceImage.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderMultipleChoiceImage: QuestionRenderer;

package/dist/types/src/render/renderNumber.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderNumber: QuestionRenderer;

package/dist/types/src/render/renderPassword.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderPassword: QuestionRenderer;

package/dist/types/src/render/renderPointSystem.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderPointSystem: QuestionRenderer;

package/dist/types/src/render/renderPriorityList.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderPriorityList: QuestionRenderer;

package/dist/types/src/render/renderRatingEmoji.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderRatingEmoji: QuestionRenderer;

package/dist/types/src/render/renderRatingNumber.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderRatingNumber: QuestionRenderer;

package/dist/types/src/render/renderRatingStar.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderRatingStar: QuestionRenderer;

package/dist/types/src/render/renderSelect.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderSelect: QuestionRenderer;

package/dist/types/src/render/renderText.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderText: QuestionRenderer;

package/dist/types/src/render/renderUploadFile.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderUploadFile: QuestionRenderer;

package/dist/types/src/render/renderUploadImage.d.ts

@@ -0,0 +1,2 @@
+import { QuestionRenderer } from "./types";
+export declare const renderUploadImage: QuestionRenderer;

package/dist/types/src/render/types.d.ts

@@ -0,0 +1,20 @@
+import { NativeQuestion } from "../models/types";
+export type RenderContext = {
+    question: NativeQuestion;
+    format: string;
+    language: string;
+    url: string;
+    send?: () => void;
+    isPhone: boolean;
+    urlParamValue: string | null;
+    placeholderText?: string;
+    maxCharacters: number;
+    randomPosition: boolean;
+    direction: string;
+    order: string;
+};
+export type RenderResult = {
+    element: HTMLElement;
+    elementTypeClass: string;
+};
+export type QuestionRenderer = (ctx: RenderContext) => RenderResult;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicfeedback/native",
-  "version": "2.1.7-alpha.8",
+  "version": "2.2.0-alpha.0",
   "main": "./dist/magicfeedback-sdk.node.js",
   "browser": "./dist/magicfeedback-sdk.browser.js",
   "types": "./dist/types/src/index.d.ts",