fix: typings for test labels

wix-incubator · Dec 28, 2023 · e238639 · e238639
1 parent 90673e3
commit e238639
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 20 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -110,21 +110,6 @@ declare module 'jest-allure2-reporter' {
     plugins: Promise<Plugin[]>;
   };
 
-  export type _LabelName =
-    | 'package'
-    | 'testClass'
-    | 'testMethod'
-    | 'parentSuite'
-    | 'suite'
-    | 'subSuite'
-    | 'epic'
-    | 'feature'
-    | 'story'
-    | 'thread'
-    | 'severity'
-    | 'tag'
-    | 'owner';
-
   export type AttachmentsOptions = {
     /**
      * Defines a subdirectory within the {@link ReporterOptions#resultsDir} where attachments will be stored.
@@ -210,8 +195,8 @@ declare module 'jest-allure2-reporter' {
     labels:
       | TestCaseExtractor<Label[]>
       | Record<
-          _LabelName | string,
-          TestCaseExtractor<string[], string | string[]>
+          LabelName | string,
+          string | string[] | TestCaseExtractor<string[], string | string[]>
         >;
     /**
      * Resolve issue links for the test case.
@@ -305,8 +290,8 @@ declare module 'jest-allure2-reporter' {
     labels:
       | TestFileExtractor<Label[]>
       | Record<
-          _LabelName | string,
-          TestFileExtractor<string[], string | string[]>
+          LabelName | string,
+          string | string[] | TestFileExtractor<string[], string | string[]>
         >;
     /**
      * Resolve issue links for the test file.

diff --git a/package-e2e/package.json b/package-e2e/package.json
@@ -4,7 +4,7 @@
   "version": "1.0.0",
   "description": "",
   "scripts": {
-    "test": "node test.cjs && node test.mjs && tsc",
+    "test": "node test.cjs && node test.mjs && tsc && tsc -p tsconfig.isolated.json",
     "test:cjs": "node test.cjs",
     "test:mjs": "node test.mjs",
     "test:ts": "tsc && tsc -p tsconfig.isolated.json"

diff --git a/package-e2e/test.ts b/package-e2e/test.ts
@@ -19,6 +19,26 @@ assertType<ReporterOptions>({
     subDir: 'attachments',
     fileHandler: 'copy',
   },
+  testFile: {
+    labels: {
+      tag: ['unit', 'javascript'],
+      package: 'Some Package',
+      severity: (context) => context.value ?? 'critical',
+    },
+    links: {
+      github: ({ filePath }) => ({
+        name: 'GitHub',
+        url: `https://github.com/owner/repo/tree/master/${filePath.join('/')}`,
+      }),
+    },
+  },
+  testCase: {
+    labels: {
+      tag: ['unit', 'javascript'],
+      severity: 'normal',
+      story: () => 'Some Story',
+    },
+  },
 });
 
 assertType<Function>($Owner);