wip: cast object to map

Author: jamacku

itest/test/attachments.test.ts

@@ -68,6 +68,8 @@ beforeAll(async () => {
 });
 
 test('Get single attachment', async () => {
+  await expect(api.getAttachment(1)).resolves.toMatchInlineSnapshot();
+
   await expect(api.getAttachment(1)).resolves.toEqual({
     bug_id: expect.anything(),
     content_type: 'image/png',

src/link.ts

@@ -1,5 +1,5 @@
 import { URLSearchParams, URL } from 'url';
-import { z } from 'zod';
+import { z, ZodSchema } from 'zod';
 
 import axios, { AxiosRequestConfig } from 'axios';
 import { loginResponseSchema } from './types';
@@ -28,10 +28,10 @@ function isError(payload: unknown): payload is ApiError {
   return payload && typeof payload == 'object' && payload.error;
 }
 
-async function performRequest<TValues>(
-  config: AxiosRequestConfig,
-  schema: z.Schema<TValues>,
-): Promise<TValues> {
+async function performRequest<
+  TSchema extends ZodSchema,
+  KValues extends z.infer<TSchema>,
+>(config: AxiosRequestConfig, schema: TSchema): Promise<KValues> {
   try {
     let response = await axios.request({
       ...config,
@@ -67,10 +67,10 @@ export abstract class BugzillaLink {
     this.instance = new URL('rest/', instance);
   }
 
-  protected abstract request<TValues>(
-    config: AxiosRequestConfig,
-    schema: z.Schema<TValues>,
-  ): Promise<TValues>;
+  protected abstract request<
+    TSchema extends ZodSchema,
+    KValues extends z.infer<TSchema>,
+  >(config: AxiosRequestConfig, schema: TSchema): Promise<KValues>;
 
   protected buildURL(path: string, query?: SearchParams): URL {
     let url = new URL(path, this.instance);
@@ -80,11 +80,11 @@ export abstract class BugzillaLink {
     return url;
   }
 
-  public async get<TValues>(
+  public async get<TSchema extends ZodSchema, KValues extends z.infer<TSchema>>(
     path: string,
-    schema: z.Schema<TValues>,
+    schema: TSchema,
     searchParams?: SearchParams,
-  ): Promise<TValues> {
+  ): Promise<KValues> {
     return this.request(
       {
         url: this.buildURL(path, searchParams).toString(),
@@ -93,12 +93,16 @@ export abstract class BugzillaLink {
     );
   }
 
-  public async post<R, TValues>(
+  public async post<
+    R,
+    TSchema extends ZodSchema,
+    KValues extends z.infer<TSchema>,
+  >(
     path: string,
-    schema: z.Schema<TValues>,
+    schema: TSchema,
     content: R,
     searchParams?: SearchParams,
-  ): Promise<TValues> {
+  ): Promise<KValues> {
     return this.request(
       {
         url: this.buildURL(path, searchParams).toString(),
@@ -112,12 +116,16 @@ export abstract class BugzillaLink {
     );
   }
 
-  public async put<R, TValues>(
+  public async put<
+    R,
+    TSchema extends ZodSchema,
+    KValues extends z.infer<TSchema>,
+  >(
     path: string,
-    schema: z.Schema<TValues>,
+    schema: TSchema,
     content: R,
     searchParams?: SearchParams,
-  ): Promise<TValues> {
+  ): Promise<KValues> {
     return this.request(
       {
         url: this.buildURL(path, searchParams).toString(),
@@ -133,10 +141,10 @@ export abstract class BugzillaLink {
 }
 
 export class PublicLink extends BugzillaLink {
-  protected async request<TValues>(
-    config: AxiosRequestConfig,
-    schema: z.Schema<TValues>,
-  ): Promise<TValues> {
+  protected async request<
+    TSchema extends ZodSchema,
+    KValues extends z.infer<TSchema>,
+  >(config: AxiosRequestConfig, schema: TSchema): Promise<KValues> {
     return performRequest(config, schema);
   }
 }
@@ -152,10 +160,10 @@ export class ApiKeyLink extends BugzillaLink {
     super(instance);
   }
 
-  protected async request<TValues>(
-    config: AxiosRequestConfig,
-    schema: z.Schema<TValues>,
-  ): Promise<TValues> {
+  protected async request<
+    TSchema extends ZodSchema,
+    KValues extends z.infer<TSchema>,
+  >(config: AxiosRequestConfig, schema: TSchema): Promise<KValues> {
     return performRequest(
       {
         ...config,
@@ -201,10 +209,10 @@ export class PasswordLink extends BugzillaLink {
     return loginInfo.token;
   }
 
-  protected async request<TValues>(
-    config: AxiosRequestConfig,
-    schema: z.Schema<TValues>,
-  ): Promise<TValues> {
+  protected async request<
+    TSchema extends ZodSchema,
+    KValues extends z.infer<TSchema>,
+  >(config: AxiosRequestConfig, schema: TSchema): Promise<KValues> {
     if (!this.token) {
       this.token = await this.login();
     }

src/types.ts

@@ -144,9 +144,29 @@ export const commentsTemplateSchema = z.object({
 
 export type CommentsTemplate = z.infer<typeof commentsTemplateSchema>;
 
+function castObjectToMap<K extends z.ZodTypeAny, V extends z.ZodTypeAny>(
+  keyValidator: K,
+  valueValidator: V,
+) {
+  return z.record(keyValidator, valueValidator).transform(record => {
+    let result = new Map<z.infer<K>, z.infer<V>>();
+
+    for (let [k, v] of Object.entries(record)) {
+      // if (typeof k === 'number') {
+      //   result.set(k, v);
+      // }
+      if (k?.toString()) {
+        result.set(k.toString(), v);
+      }
+    }
+
+    return result;
+  });
+}
+
 export const commentsSchema = z.object({
-  bugs: z.map(z.number(), commentsTemplateSchema),
-  comments: z.map(z.number(), commentSchema),
+  bugs: castObjectToMap(z.number(), commentsTemplateSchema),
+  comments: castObjectToMap(z.number(), commentSchema),
 });
 
 export type Comments = z.infer<typeof commentsSchema>;
@@ -222,7 +242,7 @@ export const updateBugContentSchema = z.object({
   cc: updateListSchema(z.string()).optional(),
   is_cc_accessible: z.boolean().optional(),
   comment: createCommentContentSchema.optional(),
-  comment_is_private: z.map(z.number(), z.boolean()).optional(),
+  comment_is_private: castObjectToMap(z.number(), z.boolean()).optional(),
   comment_tags: z.array(z.string()).optional(),
   component: z.string().optional(),
   deadline: z.string().datetime().optional(),
@@ -262,7 +282,7 @@ export const updatedBugSchema = z.object({
   id: z.number(),
   alias: z.array(z.string()),
   last_change_time: z.string().datetime(),
-  changes: z.map(z.string(), changesSchema),
+  changes: castObjectToMap(z.string(), changesSchema),
 });
 
 export type UpdatedBug = z.infer<typeof updatedBugSchema>;
@@ -294,8 +314,8 @@ export const attachmentSchema = z.object({
 export type Attachment = z.infer<typeof attachmentSchema>;
 
 export const attachmentsSchema = z.object({
-  bugs: z.map(z.number(), z.array(attachmentSchema)),
-  attachments: z.map(z.number(), attachmentSchema),
+  bugs: castObjectToMap(z.number(), z.array(attachmentSchema)),
+  attachments: castObjectToMap(z.number(), attachmentSchema),
 });
 
 export type Attachments = z.infer<typeof attachmentsSchema>;
@@ -343,7 +363,7 @@ export type UpdateAttachmentContent = z.infer<
 export const updatedAttachmentSchema = z.object({
   id: z.number(),
   last_change_time: z.string().datetime(),
-  changes: z.map(z.string(), changesSchema),
+  changes: castObjectToMap(z.string(), changesSchema),
 });
 
 export type UpdatedAttachment = z.infer<typeof updatedAttachmentSchema>;