fix(key/gen): use correct key type casing (#145)

ipfs · Feb 13, 2023 · 8b24a94 · 8b24a94
1 parent 1f382e7
commit 8b24a94
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 22 deletions.
diff --git a/src/key/export.js b/src/key/export.js
@@ -3,7 +3,7 @@ import errCode from 'err-code'
 
 export const createExport = configure(api => {
   /**
-   * @type {import('../types').KeyAPI["export"]}
+   * @type {import('./types.js').KeyAPI['export']}
    */
   const exportKey = async (name, password, options = {}) => {
     throw errCode(new Error('Not implemented'), 'ERR_NOT_IMPLEMENTED')

diff --git a/src/key/gen.js b/src/key/gen.js
@@ -2,14 +2,14 @@ import { objectToCamel } from '../lib/object-to-camel.js'
 import { configure } from '../lib/configure.js'
 import { toUrlSearchParams } from '../lib/to-url-search-params.js'
 
-/** @type {import('ipfs-core-types/src/key').GenOptions} */
+/** @type {import('./types.js').GenOptions} */
 const defaultOptions = {
-  type: 'Ed25519'
+  type: 'ed25519'
 }
 
 export const createGen = configure(api => {
   /**
-   * @type {import('../types').KeyAPI["gen"]}
+   * @type {import('./types.js').KeyAPI['gen']}
    */
   async function gen (name, options = defaultOptions) {
     const res = await api.post('key/gen', {

diff --git a/src/key/import.js b/src/key/import.js
@@ -4,7 +4,7 @@ import { toUrlSearchParams } from '../lib/to-url-search-params.js'
 
 export const createImport = configure(api => {
   /**
-   * @type {import('../types').KeyAPI["import"]}
+   * @type {import('./types.js').KeyAPI['import']}
    */
   async function importKey (name, pem, password, options = {}) {
     const res = await api.post('key/import', {

diff --git a/src/key/index.js b/src/key/index.js
@@ -1,20 +1,19 @@
 import { createExport } from './export.js'
 import { createGen } from './gen.js'
 import { createImport } from './import.js'
-import { createInfo } from './info.js'
 import { createList } from './list.js'
 import { createRename } from './rename.js'
 import { createRm } from './rm.js'
 
 /**
- * @param {import('../types').Options} config
+ * @param {import('../types.js').Options} config
+ * @returns {import('./types.js').KeyAPI}
  */
 export function createKey (config) {
   return {
     export: createExport(config),
     gen: createGen(config),
     import: createImport(config),
-    info: createInfo(config),
     list: createList(config),
     rename: createRename(config),
     rm: createRm(config)

diff --git a/src/key/info.js b/src/key/info.js
diff --git a/src/key/rename.js b/src/key/rename.js
@@ -4,7 +4,7 @@ import { toUrlSearchParams } from '../lib/to-url-search-params.js'
 
 export const createRename = configure(api => {
   /**
-   * @type {import('../types').KeyAPI["rename"]}
+   * @type {import('./types.js').KeyAPI['rename']}
    */
   async function rename (oldName, newName, options = {}) {
     const res = await api.post('key/rename', {

diff --git a/src/key/types.ts b/src/key/types.ts
@@ -0,0 +1,29 @@
+import type { AbortOptions } from '../types'
+
+export type KeyType = 'ed25519' | 'rsa'
+
+export interface Key {
+  id: string
+  name: string
+}
+
+export interface GenOptions extends AbortOptions {
+  type: KeyType
+  size?: number
+}
+
+export interface RenameKeyResult {
+  id: string
+  was: string
+  now: string
+  overwrite: boolean
+}
+
+export interface KeyAPI<OptionExtension = {}> {
+  export: (name: string, password: string, options?: AbortOptions & OptionExtension) => Promise<string>
+  gen: (name: string, options?: GenOptions & OptionExtension) => Promise<Key>
+  import: (name: string, pem: string, password: string, options?: AbortOptions & OptionExtension) => Promise<Key>
+  list: (options?: AbortOptions & OptionExtension) => Promise<Key[]>
+  rename: (oldName: string, newName: string, options?: AbortOptions & OptionExtension) => Promise<RenameKeyResult>
+  rm: (name: string, options?: AbortOptions & OptionExtension) => Promise<Key>
+}