@lookiero/checkout 8.18.0 → 8.20.0

package/src/projection/returnQuestion/listReturnQuestionsByCheckoutItemId.test.ts

@@ -1,30 +1,22 @@
 import { mock } from "jest-mock-extended";
 import { QueryBus } from "@lookiero/messaging";
+import { returnQuestions } from "../../infrastructure/projection/returnQuestion/returnQuestions.mock";
 import {
   listReturnQuestionsByCheckoutItemId,
   listReturnQuestionsByCheckoutItemIdHandler as sut,
 } from "./listReturnQuestionsByCheckoutItemId";
-import { ReturnQuestionProjection, ReturnQuestionType } from "./returnQuestion";
 
 const checkoutItemId = "29790d24-b139-4ab8-b618-d796d101e974";
-const returnQuestionsProjection: ReturnQuestionProjection[] = [
-  {
-    id: "efe07b97-f6fb-4b6a-ba92-b68519320b2c",
-    name: "main_title",
-    placeholder: "",
-    type: ReturnQuestionType.HOST_DEFAULT,
-  },
-];
 const queryBus = mock<QueryBus>();
 const signal = mock<AbortSignal>();
 
 describe("listReturnQuestionsByCheckoutItemId", () => {
   it("returns return questions by checkout item id", async () => {
     const query = listReturnQuestionsByCheckoutItemId({ checkoutItemId });
-    const view = jest.fn(() => Promise.resolve(returnQuestionsProjection));
+    const view = jest.fn(() => Promise.resolve(returnQuestions));
 
-    const returnQuestionsProjectionResult = await sut({ view, queryBus, signal })(query);
+    const returnQuestionsResult = await sut({ view, queryBus, signal })(query);
 
-    expect(returnQuestionsProjectionResult).toBe(returnQuestionsProjection);
+    expect(returnQuestionsResult).toBe(returnQuestions);
   });
 });

package/src/projection/returnQuestion/returnQuestion.constants.ts

@@ -0,0 +1,10 @@
+enum ReturnQuestionType {
+  HOST_DEFAULT = "HOST_DEFAULT",
+  HOST_TEXTAREA = "HOST_TEXTAREA",
+  HOST_SELECT = "HOST_SELECT",
+  HOST_STACK = "HOST_STACK",
+  TEXTAREA = "TEXTAREA",
+  OPTION = "OPTION",
+}
+
+export { ReturnQuestionType };

package/src/projection/returnQuestion/returnQuestion.metadata.ts

@@ -0,0 +1,17 @@
+import { EmptyObject } from "@lookiero/sty-psp-typescript";
+import { ReturnQuestionType } from "./returnQuestion.constants";
+
+interface ComponentPlaceholder {
+  readonly placeholder: string;
+}
+
+type MetadataDictionary = Record<ReturnQuestionType, EmptyObject>;
+
+type ComponentMetadata = MetadataDictionary & {
+  [ReturnQuestionType.HOST_SELECT]: ComponentPlaceholder;
+  [ReturnQuestionType.TEXTAREA]: ComponentPlaceholder;
+};
+
+type Metadata<RQT extends ReturnQuestionType> = ComponentMetadata[RQT];
+
+export type { Metadata };

package/src/projection/returnQuestion/returnQuestion.ts

@@ -1,20 +1,42 @@
-enum ReturnQuestionType {
-  HOST_DEFAULT = "HOST_DEFAULT",
-  HOST_TEXTAREA = "HOST_TEXTAREA",
-  HOST_SELECT = "HOST_SELECT",
-  HOST_STACK = "HOST_STACK",
-  TEXTAREA = "TEXTAREA",
-  OPTION = "OPTION",
-  // ICON = "ICON",
-}
-
-interface ReturnQuestionProjection {
-  readonly id: string;
-  readonly name: string;
-  readonly placeholder: string; // required for ReturnQuestionType.SELECT | ReturnQuestionType.TEXTAREA
-  readonly type: ReturnQuestionType;
-  readonly children?: ReturnQuestionProjection[];
-}
-
-export { ReturnQuestionType };
-export type { ReturnQuestionProjection };
+import { EmptyObject, ExcludePropertyIfOptional, NonEmptyArray } from "@lookiero/sty-psp-typescript";
+import { ReturnQuestionType } from "./returnQuestion.constants";
+import { Metadata } from "./returnQuestion.metadata";
+
+type ReturnQuestionTypesWithChildren =
+  | ReturnQuestionType.HOST_DEFAULT
+  | ReturnQuestionType.HOST_SELECT
+  | ReturnQuestionType.HOST_STACK
+  | ReturnQuestionType.HOST_TEXTAREA;
+
+type ReturnQuestionTypesWithOptionalChildren = ReturnQuestionType.OPTION;
+
+type ReturnQuestionTypesWithOptionalTranslationKeys = ReturnQuestionType.HOST_STACK;
+
+type ReturnQuestionMetadata<RQT extends ReturnQuestionType> = ExcludePropertyIfOptional<
+  "metadata",
+  { readonly metadata: Metadata<RQT> }
+>;
+
+type ReturnQuestionChildren<RQT extends ReturnQuestionType> = RQT extends ReturnQuestionTypesWithChildren
+  ? { readonly children: NonEmptyArray<ReturnQuestion> }
+  : RQT extends ReturnQuestionTypesWithOptionalChildren
+    ? { readonly children?: NonEmptyArray<ReturnQuestion> }
+    : EmptyObject;
+
+type ReturnQuestionTranslationKey<RQT extends ReturnQuestionType> =
+  RQT extends ReturnQuestionTypesWithOptionalTranslationKeys
+    ? { readonly translationKey?: string }
+    : { readonly translationKey: string };
+
+type ReturnQuestion<RQT extends ReturnQuestionType = ReturnQuestionType> = RQT extends infer K extends
+  ReturnQuestionType
+  ? { readonly id: string; readonly type: K } & ReturnQuestionTranslationKey<K> &
+      ReturnQuestionChildren<K> &
+      ReturnQuestionMetadata<K>
+  : never;
+
+export type {
+  ReturnQuestion as ReturnQuestionProjection,
+  ReturnQuestionTypesWithOptionalTranslationKeys,
+  ReturnQuestionTypesWithChildren,
+};

package/src/projection/returnQuestion/returnQuestion.typeguard.ts

@@ -0,0 +1,24 @@
+import {
+  ReturnQuestionProjection,
+  ReturnQuestionTypesWithChildren,
+  ReturnQuestionTypesWithOptionalTranslationKeys,
+} from "./returnQuestion";
+import { ReturnQuestionType } from "./returnQuestion.constants";
+
+const returnQuestionWithTranslationKey = (
+  question: ReturnQuestionProjection,
+): question is ReturnQuestionProjection<Exclude<ReturnQuestionType, ReturnQuestionTypesWithOptionalTranslationKeys>> =>
+  Boolean(question.translationKey);
+
+const returnQuestionHasChildren = (
+  question: ReturnQuestionProjection,
+): question is ReturnQuestionProjection<ReturnQuestionTypesWithChildren> =>
+  [
+    ReturnQuestionType.HOST_DEFAULT,
+    ReturnQuestionType.HOST_SELECT,
+    ReturnQuestionType.HOST_STACK,
+    ReturnQuestionType.HOST_TEXTAREA,
+    ReturnQuestionType.OPTION,
+  ].includes(question.type);
+
+export { returnQuestionWithTranslationKey, returnQuestionHasChildren };