feat(cc-api/commands): add GetZoneCommand

Author: florian-sanders-cc

src/clients/cc-api/commands/zone/get-zone-command.js

@@ -0,0 +1,30 @@
+/** @import { GetZoneCommandInput, GetZoneCommandOutput } from "./get-zone-command.types.js" */
+import { QueryParams } from '../../../../lib/request/query-params.js';
+import { get } from '../../../../lib/request/request-params-builder.js';
+import { CcApiSimpleCommand } from '../../lib/cc-api-command.js';
+import { transformZone } from './zone-transform.js';
+
+/**
+ *
+ * @extends {CcApiSimpleCommand<GetZoneCommandInput, GetZoneCommandOutput>}
+ * @endpoint [GET] /v4/products/zones/:XXX
+ * @group Zone
+ * @version 4
+ */
+export class GetZoneCommand extends CcApiSimpleCommand {
+  /** @type {CcApiSimpleCommand<GetZoneCommandInput, GetZoneCommandOutput>['toRequestParams']} */
+  toRequestParams(params) {
+    /** @type {QueryParams} */
+    let queryParms;
+    if (params.ownerId != null) {
+      queryParms = new QueryParams().append('ownerId', params.ownerId);
+    }
+
+    return get(`/v4/products/zones/${params.zoneName}`, queryParms);
+  }
+
+  /** @type {CcApiSimpleCommand<GetZoneCommandInput, GetZoneCommandOutput>['transformCommandOutput']} response */
+  transformCommandOutput(response) {
+    return transformZone(response);
+  }
+}

src/clients/cc-api/commands/zone/get-zone-command.types.d.ts

@@ -0,0 +1,8 @@
+import type { Zone } from './zone.types.js';
+
+export type GetZoneCommandInput = {
+  zoneName: string;
+  ownerId?: string;
+};
+
+export type GetZoneCommandOutput = Zone;

src/clients/cc-api/commands/zone/zone-transform.js

@@ -0,0 +1,20 @@
+/** @import { Zone } from './zone.types.d.ts' */
+
+/**
+ * @param {any} payload
+ * @returns {Zone}
+ */
+export function transformZone(payload) {
+  return {
+    id: payload.id,
+    name: payload.name,
+    country: payload.country,
+    countryCode: payload.countryCode,
+    city: payload.city,
+    displayName: payload.displayName,
+    lat: payload.lat,
+    lon: payload.lon,
+    outboundIPs: payload.outboundIPs?.sort() ?? [],
+    tags: payload?.tags.sort() ?? [],
+  };
+}

test/e2e/clients/cc-api/commands/zone-commands.spec.js

@@ -1,4 +1,5 @@
 import { expect } from 'chai';
+import { GetZoneCommand } from '../../../../../src/clients/cc-api/commands/zone/get-zone-command.js';
 import { ListZoneCommand } from '../../../../../src/clients/cc-api/commands/zone/list-zone-command.js';
 import { e2eSupport } from '../e2e-support.js';
 
@@ -38,4 +39,32 @@ describe('zone commands', function () {
     expect(response[0].outboundIPs).to.be.an('array');
     expect(response[0].tags).to.be.an('array');
   });
+
+  it('should get "par" zone by name without ownerId', async () => {
+    const response = await support.client.send(new GetZoneCommand({ zoneName: 'par' }));
+
+    expect(response.id).to.be.a('string');
+    expect(response.name).to.be.a('string');
+    expect(response.country).to.be.a('string');
+    expect(response.countryCode).to.be.a('string');
+    expect(response.lat).to.be.a('number');
+    expect(response.lon).to.be.a('number');
+    expect(response.outboundIPs).to.be.an('array');
+    expect(response.tags).to.be.an('array');
+  });
+
+  it('should get "par" zone by name with ownerId', async () => {
+    const response = await support.client.send(
+      new GetZoneCommand({ zoneName: 'par', ownerId: support.organisationId }),
+    );
+
+    expect(response.id).to.be.a('string');
+    expect(response.name).to.be.a('string');
+    expect(response.country).to.be.a('string');
+    expect(response.countryCode).to.be.a('string');
+    expect(response.lat).to.be.a('number');
+    expect(response.lon).to.be.a('number');
+    expect(response.outboundIPs).to.be.an('array');
+    expect(response.tags).to.be.an('array');
+  });
 });