feat: typed enums

Use forked version of wsdl-tsclient to make use of enumerable strings
MailOnline · May 13, 2024 · 650280a · 650280a
1 parent 79b53c7
commit 650280a
Show file tree

Hide file tree

Showing 7 changed files with 123 additions and 1,522 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.pnp.loader.mjs b/.pnp.loader.mjs
diff --git a/package.json b/package.json
@@ -63,7 +63,7 @@
     "ts-jest": "29.1.2",
     "ts-node": "10.9.2",
     "typescript": "5.4.5",
-    "wsdl-tsclient": "1.5.0"
+    "wsdl-tsclient": "johngeorgewright/wsdl-tsclient#enum"
   },
   "lint-staged": {
     "*.{md,json,js,jsx,ts,tsx,yml,yaml}": [

diff --git a/src/query/query.ts b/src/query/query.ts
@@ -35,7 +35,9 @@ export function query<
   Args extends unknown[],
 >(
   client: C,
-  methodName: Parameters<C[M]> extends [GetByStatement, ...Args] ? M : never,
+  methodName: Parameters<C[M]> extends [GetByStatement, ...unknown[]]
+    ? M
+    : never,
   query: PQLOptions<GetByStatementResponseResult<C[M]>>,
   ...args: Args
 ): ReturnType<C[M]> {

diff --git a/src/report/runReport.ts b/src/report/runReport.ts
@@ -5,7 +5,7 @@ import { GoogleAdManager, ReportService } from '..'
 import { prioritiseKeys } from '../lang/Object'
 
 export interface RunAndDownloadReportOpts {
-  exportFormat: 'TSV' | 'TSV_EXCEL' | 'CSV_DUMP' | 'XML' | 'XLSX'
+  exportFormat: ReportService.GetReportDownloadUrl['exportFormat']
   statusCheckInterval?: number
   query: ReportService.ReportQuery
 }
@@ -74,7 +74,7 @@ export function ensureCorrectOrderOfReportQueryParameters(
 export async function runReport(
   client: ReportService.ReportServiceClient,
   query: ReportService.ReportQuery,
-): Promise<string> {
+): Promise<number> {
   const [reportJob] = await client.runReportJobAsync({
     reportJob: {
       reportQuery: ensureCorrectOrderOfReportQueryParameters(query),
@@ -88,7 +88,7 @@ export async function runReport(
 
 export async function waitForReportToFinish(
   client: ReportService.ReportServiceClient,
-  jobId: string,
+  jobId: number,
   statusCheckInterval: number,
 ): Promise<void> {
   let status = 'IN_PROGRESS'
@@ -110,7 +110,7 @@ export async function waitForReportToFinish(
 
 export async function streamReportResult(
   client: ReportService.ReportServiceClient,
-  jobId: string,
+  jobId: number,
   exportFormat: RunAndDownloadReportOpts['exportFormat'],
 ): Promise<IncomingMessage> {
   const [urlResult] = await client.getReportDownloadURLAsync({

diff --git a/test/report.test.ts b/test/report.test.ts
@@ -13,7 +13,6 @@ test('ensureCorrectOrderOfReportQueryParameters()', () => {
         ],
 
         columns: [
-          'AD_UNIT_CODE',
           'TOTAL_LINE_ITEM_LEVEL_IMPRESSIONS',
           'TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS',
           'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS',
@@ -39,7 +38,6 @@ test('ensureCorrectOrderOfReportQueryParameters()', () => {
       ],
       "adUnitView": "HIERARCHICAL",
       "columns": [
-        "AD_UNIT_CODE",
         "TOTAL_LINE_ITEM_LEVEL_IMPRESSIONS",
         "TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
         "AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",