Change: Use TypeScript for Ticket commands

Ensure the behavior of both commands and define the expected parameters.

Author: bjoernricks

src/gmp/__tests__/gmp.test.ts

@@ -263,6 +263,8 @@ describe('Gmp tests', () => {
     'targets',
     'task',
     'tasks',
+    'ticket',
+    'tickets',
     'timezones',
     'trashcan',
     'user',
@@ -276,8 +278,6 @@ describe('Gmp tests', () => {
     'license',
     'scanconfig',
     'scanconfigs',
-    'ticket',
-    'tickets',
     'tlscertificate',
     'tlscertificates',
   ])('should expose command %s', name => {

src/gmp/commands/__tests__/ticket.test.js src/gmp/commands/__tests__/ticket.test.tssrc/gmp/commands/__tests__/ticket.test.js renamed to src/gmp/commands/__tests__/ticket.test.ts

@@ -9,7 +9,7 @@ import {
   createEntityResponse,
   createHttp,
 } from 'gmp/commands/testing';
-import {TicketCommand} from 'gmp/commands/tickets';
+import TicketCommand from 'gmp/commands/ticket';
 
 describe('TicketCommand tests', () => {
   test('should trim note when creating ticket', async () => {
@@ -19,7 +19,6 @@ describe('TicketCommand tests', () => {
     const resp = await cmd.create({
       resultId: 'r1',
       userId: 'u1',
-      foo: 'bar',
       note: ' ',
     });
     expect(fakeHttp.request).toHaveBeenCalledWith('post', {
@@ -42,7 +41,6 @@ describe('TicketCommand tests', () => {
       resultId: 'r1',
       userId: 'u1',
       note: 'foo',
-      foo: 'bar',
     });
     expect(fakeHttp.request).toHaveBeenCalledWith('post', {
       data: {

…c/gmp/commands/__tests__/tickets.test.js …c/gmp/commands/__tests__/tickets.test.tssrc/gmp/commands/__tests__/tickets.test.js renamed to src/gmp/commands/__tests__/tickets.test.ts src/gmp/commands/__tests__/tickets.test.js renamed to src/gmp/commands/__tests__/tickets.test.ts

@@ -5,11 +5,12 @@
 
 import {describe, test, expect} from '@gsa/testing';
 import {createHttp, createEntitiesResponse} from 'gmp/commands/testing';
-import {TicketsCommand} from 'gmp/commands/tickets';
+import TicketsCommand from 'gmp/commands/tickets';
 import {ALL_FILTER} from 'gmp/models/filter';
+import Ticket from 'gmp/models/ticket';
 
 describe('TicketsCommand tests', () => {
-  test('should return all tickets', async () => {
+  test('should fetch all tickets', async () => {
     const response = createEntitiesResponse('ticket', [
       {
         _id: '1',
@@ -32,7 +33,7 @@ describe('TicketsCommand tests', () => {
     expect(data.length).toEqual(2);
   });
 
-  test('should return tickets', async () => {
+  test('should fetch tickets with default params', async () => {
     const response = createEntitiesResponse('ticket', [
       {
         _id: '1',
@@ -53,4 +54,29 @@ describe('TicketsCommand tests', () => {
     const {data} = resp;
     expect(data.length).toEqual(2);
   });
+
+  test('should fetch tickets with custom params', async () => {
+    const response = createEntitiesResponse('ticket', [
+      {
+        _id: '1',
+        status: 'open',
+      },
+    ]);
+
+    const fakeHttp = createHttp(response);
+    const cmd = new TicketsCommand(fakeHttp);
+    const resp = await cmd.get({filter: "status='open'"});
+    expect(fakeHttp.request).toHaveBeenCalledWith('get', {
+      args: {
+        cmd: 'get_tickets',
+        filter: "status='open'",
+      },
+    });
+    expect(resp.data).toEqual([
+      new Ticket({
+        id: '1',
+        status: 'open',
+      }),
+    ]);
+  });
 });

src/gmp/commands/ticket.ts

@@ -0,0 +1,76 @@
+/* SPDX-FileCopyrightText: 2024 Greenbone AG
+ *
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import EntityCommand from 'gmp/commands/entity';
+import type Http from 'gmp/http/http';
+import {type Element} from 'gmp/models/model';
+import Ticket, {type TicketStatus, type TicketElement} from 'gmp/models/ticket';
+import {isDefined} from 'gmp/utils/identity';
+
+interface CreateTicketArguments {
+  resultId: string;
+  userId: string;
+  note?: string;
+}
+
+interface SaveTicketArguments {
+  id: string;
+  openNote?: string;
+  fixedNote?: string;
+  closedNote?: string;
+  status: TicketStatus;
+  userId: string;
+}
+
+const convertNote = (note?: string) => {
+  if (!isDefined(note)) {
+    return note;
+  }
+
+  note = note.trim();
+
+  return note;
+};
+
+class TicketCommand extends EntityCommand<Ticket, TicketElement> {
+  constructor(http: Http) {
+    super(http, 'ticket', Ticket);
+  }
+
+  create({resultId, userId, note}: CreateTicketArguments) {
+    return this.action({
+      cmd: 'create_ticket',
+      result_id: resultId,
+      user_id: userId,
+      note: convertNote(note),
+    });
+  }
+
+  save({
+    id,
+    openNote,
+    fixedNote,
+    closedNote,
+    status,
+    userId,
+  }: SaveTicketArguments) {
+    return this.action({
+      cmd: 'save_ticket',
+      id,
+      open_note: convertNote(openNote),
+      fixed_note: convertNote(fixedNote),
+      closed_note: convertNote(closedNote),
+      ticket_status: status,
+      user_id: userId,
+    });
+  }
+
+  getElementFromRoot(root: Element): TicketElement {
+    // @ts-expect-error
+    return root.get_ticket.get_tickets_response.ticket;
+  }
+}
+
+export default TicketCommand;

src/gmp/commands/tickets.js

@@ -0,0 +1,22 @@
+/* SPDX-FileCopyrightText: 2024 Greenbone AG
+ *
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import EntitiesCommand from 'gmp/commands/entities';
+import type Http from 'gmp/http/http';
+import {type Element} from 'gmp/models/model';
+import Ticket from 'gmp/models/ticket';
+
+class TicketsCommand extends EntitiesCommand<Ticket> {
+  constructor(http: Http) {
+    super(http, 'ticket', Ticket);
+  }
+
+  getEntitiesResponse(root: Element): Element {
+    // @ts-expect-error
+    return root.get_tickets.get_tickets_response;
+  }
+}
+
+export default TicketsCommand;

src/gmp/commands/tickets.ts

@@ -6,7 +6,6 @@
 import 'gmp/commands/audit-reports';
 import 'gmp/commands/license';
 import 'gmp/commands/scan-configs';
-import 'gmp/commands/tickets';
 import 'gmp/commands/tls-certificates';
 
 import {getCommands} from 'gmp/command';
@@ -90,6 +89,8 @@ import TargetCommand from 'gmp/commands/target';
 import TargetsCommand from 'gmp/commands/targets';
 import TaskCommand from 'gmp/commands/task';
 import TasksCommand from 'gmp/commands/tasks';
+import TicketCommand from 'gmp/commands/ticket';
+import TicketsCommand from 'gmp/commands/tickets';
 import TimezonesCommand from 'gmp/commands/timezones';
 import TrashCanCommand from 'gmp/commands/trashcan';
 import UserCommand from 'gmp/commands/user';
@@ -201,6 +202,8 @@ class Gmp {
   public readonly targets: TargetsCommand;
   public readonly task: TaskCommand;
   public readonly tasks: TasksCommand;
+  public readonly ticket: TicketCommand;
+  public readonly tickets: TicketsCommand;
   public readonly timezones: TimezonesCommand;
   public readonly trashcan: TrashCanCommand;
   public readonly user: UserCommand;
@@ -316,6 +319,8 @@ class Gmp {
     this.targets = new TargetsCommand(this.http);
     this.task = new TaskCommand(this.http);
     this.tasks = new TasksCommand(this.http);
+    this.ticket = new TicketCommand(this.http);
+    this.tickets = new TicketsCommand(this.http);
     this.timezones = new TimezonesCommand(this.http);
     this.trashcan = new TrashCanCommand(this.http);
     this.user = new UserCommand(this.http);

src/gmp/gmp.ts

@@ -12,7 +12,7 @@ import {isEmpty} from 'gmp/utils/string';
 
 export type TicketStatus = keyof typeof TICKET_STATUS;
 
-interface TicketElement extends ModelElement {
+export interface TicketElement extends ModelElement {
   assigned_to?: {
     user?: {
       _id?: string;