feat(ipfs): add export and import key (#847)

Author: scaleway-bot

packages/clients/src/api/ipfs/v1alpha1/api.gen.ts

@@ -14,9 +14,11 @@ import {
   marshalCreatePinByCIDRequest,
   marshalCreatePinByURLRequest,
   marshalCreateVolumeRequest,
+  marshalImportKeyNameRequest,
   marshalReplacePinRequest,
   marshalUpdateNameRequest,
   marshalUpdateVolumeRequest,
+  unmarshalExportKeyNameResponse,
   unmarshalListNamesResponse,
   unmarshalListPinsResponse,
   unmarshalListVolumesResponse,
@@ -33,9 +35,12 @@ import type {
   DeleteNameRequest,
   DeletePinRequest,
   DeleteVolumeRequest,
+  ExportKeyNameRequest,
+  ExportKeyNameResponse,
   GetNameRequest,
   GetPinRequest,
   GetVolumeRequest,
+  ImportKeyNameRequest,
   ListNamesRequest,
   ListNamesResponse,
   ListPinsRequest,
@@ -435,4 +440,32 @@ export class API extends ParentAPI {
       },
       unmarshalName,
     )
+
+  exportKeyName = (request: Readonly<ExportKeyNameRequest>) =>
+    this.client.fetch<ExportKeyNameResponse>(
+      {
+        method: 'GET',
+        path: `/ipfs/v1alpha1/regions/${validatePathParam(
+          'region',
+          request.region ?? this.client.settings.defaultRegion,
+        )}/names/export-key/${validatePathParam('nameId', request.nameId)}`,
+      },
+      unmarshalExportKeyNameResponse,
+    )
+
+  importKeyName = (request: Readonly<ImportKeyNameRequest>) =>
+    this.client.fetch<Name>(
+      {
+        body: JSON.stringify(
+          marshalImportKeyNameRequest(request, this.client.settings),
+        ),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/ipfs/v1alpha1/regions/${validatePathParam(
+          'region',
+          request.region ?? this.client.settings.defaultRegion,
+        )}/names/import-key`,
+      },
+      unmarshalName,
+    )
 }

packages/clients/src/api/ipfs/v1alpha1/index.gen.ts

@@ -10,9 +10,12 @@ export type {
   DeleteNameRequest,
   DeletePinRequest,
   DeleteVolumeRequest,
+  ExportKeyNameRequest,
+  ExportKeyNameResponse,
   GetNameRequest,
   GetPinRequest,
   GetVolumeRequest,
+  ImportKeyNameRequest,
   ListNamesRequest,
   ListNamesRequestOrderBy,
   ListNamesResponse,

packages/clients/src/api/ipfs/v1alpha1/marshalling.gen.ts

@@ -11,6 +11,8 @@ import type {
   CreatePinByCIDRequest,
   CreatePinByURLRequest,
   CreateVolumeRequest,
+  ExportKeyNameResponse,
+  ImportKeyNameRequest,
   ListNamesResponse,
   ListPinsResponse,
   ListVolumesResponse,
@@ -125,6 +127,23 @@ export const unmarshalVolume = (data: unknown) => {
   } as Volume
 }
 
+export const unmarshalExportKeyNameResponse = (data: unknown) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ExportKeyNameResponse' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    nameId: data.name_id,
+    privateKey: data.private_key,
+    projectId: data.project_id,
+    publicKey: data.public_key,
+    updatedAt: unmarshalDate(data.updated_at),
+  } as ExportKeyNameResponse
+}
+
 export const unmarshalListNamesResponse = (data: unknown) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -226,6 +245,15 @@ export const marshalCreateVolumeRequest = (
   project_id: request.projectId ?? defaults.defaultProjectId,
 })
 
+export const marshalImportKeyNameRequest = (
+  request: ImportKeyNameRequest,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  name: request.name,
+  private_key: request.privateKey,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+})
+
 export const marshalReplacePinRequest = (
   request: ReplacePinRequest,
   defaults: DefaultValues,

packages/clients/src/api/ipfs/v1alpha1/types.gen.ts

@@ -45,6 +45,15 @@ export type PinStatus =
   | 'failed'
   | 'pinned'
 
+export interface ExportKeyNameResponse {
+  nameId: string
+  projectId: string
+  createdAt?: Date
+  updatedAt?: Date
+  publicKey: string
+  privateKey: string
+}
+
 export interface ListNamesResponse {
   names: Name[]
   totalCount: number
@@ -299,3 +308,23 @@ export type UpdateNameRequest = {
   tags?: string[]
   cid?: string
 }
+
+export type ExportKeyNameRequest = {
+  /**
+   * Region to target. If none is passed will use default region from the
+   * config.
+   */
+  region?: Region
+  nameId: string
+}
+
+export type ImportKeyNameRequest = {
+  /**
+   * Region to target. If none is passed will use default region from the
+   * config.
+   */
+  region?: Region
+  projectId?: string
+  name: string
+  privateKey: string
+}