refactor: rename "key" to "name"

Jack-Works · Feb 11, 2024 · 0d0900b · 0d0900b
1 parent 0e661c6
commit 0d0900b
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 10 deletions.
diff --git a/.changeset/lemon-bikes-bake.md b/.changeset/lemon-bikes-bake.md
@@ -0,0 +1,5 @@
+---
+"async-call-rpc": minor
+---
+
+rename "key" to "name"
diff --git a/__tests__/__file_snapshots__/async-call-key-name.md b/__tests__/__file_snapshots__/async-call-key-name.md
@@ -0,0 +1 @@
+# Timeline
diff --git a/__tests__/options.ts b/__tests__/options.ts
@@ -108,3 +108,14 @@ it(
         expect(a).toHaveProperty('then', undefined)
     }),
 )
+
+it(
+    'should error if both name and key are provided',
+    withSnapshotDefault('async-call-key-name', async ({ init }) => {
+        expect(() =>
+            init({
+                options: { key: 'a', name: 'b' },
+            }),
+        ).toThrowErrorMatchingInlineSnapshot(`[TypeError: Please remove key.]`)
+    }),
+)
diff --git a/api/base.api.md b/api/base.api.md
@@ -22,10 +22,12 @@ export interface AsyncCallOptions<EncodedRequest = unknown, EncodedResponse = un
     channel: CallbackBasedChannel<EncodedRequest | EncodedResponse> | EventBasedChannel<EncodedRequest | EncodedResponse> | Promise<CallbackBasedChannel<EncodedRequest | EncodedResponse> | EventBasedChannel<EncodedRequest | EncodedResponse>>;
     encoder?: IsomorphicEncoder<EncodedRequest, EncodedResponse> | IsomorphicEncoderFull<EncodedRequest, EncodedResponse>;
     idGenerator?(): string | number;
+    // @deprecated
     key?: string;
     log?: AsyncCallLogLevel | boolean | 'all';
     logger?: ConsoleInterface;
     mapError?: ErrorMapFunction<unknown>;
+    name?: string;
     parameterStructures?: 'by-position' | 'by-name';
     preferLocalImplementation?: boolean;
     // @deprecated

diff --git a/api/full.api.md b/api/full.api.md
@@ -22,10 +22,12 @@ export interface AsyncCallOptions<EncodedRequest = unknown, EncodedResponse = un
     channel: CallbackBasedChannel<EncodedRequest | EncodedResponse> | EventBasedChannel<EncodedRequest | EncodedResponse> | Promise<CallbackBasedChannel<EncodedRequest | EncodedResponse> | EventBasedChannel<EncodedRequest | EncodedResponse>>;
     encoder?: IsomorphicEncoder<EncodedRequest, EncodedResponse> | IsomorphicEncoderFull<EncodedRequest, EncodedResponse>;
     idGenerator?(): string | number;
+    // @deprecated
     key?: string;
     log?: AsyncCallLogLevel | boolean | 'all';
     logger?: ConsoleInterface;
     mapError?: ErrorMapFunction<unknown>;
+    name?: string;
     parameterStructures?: 'by-position' | 'by-name';
     preferLocalImplementation?: boolean;
     // @deprecated

diff --git a/docs/async-call-rpc.asynccalloptions.key.md b/docs/async-call-rpc.asynccalloptions.key.md
@@ -4,6 +4,11 @@
 
 ## AsyncCallOptions.key property
 
+> Warning: This API is now obsolete.
+> 
+> Renamed to "name".
+> 
+
 Name used when pretty log is enabled.
 
 **Signature:**

diff --git a/docs/async-call-rpc.asynccalloptions.md b/docs/async-call-rpc.asynccalloptions.md
@@ -22,6 +22,7 @@ export interface AsyncCallOptions<EncodedRequest = unknown, EncodedResponse = un
 |  [log?](./async-call-rpc.asynccalloptions.log.md) |  | [AsyncCallLogLevel](./async-call-rpc.asynccallloglevel.md) \| boolean \| 'all' | _(Optional)_ Choose log level. |
 |  [logger?](./async-call-rpc.asynccalloptions.logger.md) |  | [ConsoleInterface](./async-call-rpc.consoleinterface.md) | _(Optional)_ Provide the logger |
 |  [mapError?](./async-call-rpc.asynccalloptions.maperror.md) |  | [ErrorMapFunction](./async-call-rpc.errormapfunction.md)<!-- -->&lt;unknown&gt; | _(Optional)_ Change the [ErrorResponseDetail](./async-call-rpc.errorresponsedetail.md)<!-- -->. |
+|  [name?](./async-call-rpc.asynccalloptions.name.md) |  | string | _(Optional)_ Name used when pretty log is enabled. |
 |  [parameterStructures?](./async-call-rpc.asynccalloptions.parameterstructures.md) |  | 'by-position' \| 'by-name' | _(Optional)_ Choose flavor of parameter structures defined in the spec |
 |  [preferLocalImplementation?](./async-call-rpc.asynccalloptions.preferlocalimplementation.md) |  | boolean | _(Optional)_ Prefer local implementation than remote. |
 |  [serializer?](./async-call-rpc.asynccalloptions.serializer.md) |  | [Serialization](./async-call-rpc.serialization.md) | _(Optional)_ Serializer of the requests and responses. |

diff --git a/docs/async-call-rpc.asynccalloptions.name.md b/docs/async-call-rpc.asynccalloptions.name.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [async-call-rpc](./async-call-rpc.md) &gt; [AsyncCallOptions](./async-call-rpc.asynccalloptions.md) &gt; [name](./async-call-rpc.asynccalloptions.name.md)
+
+## AsyncCallOptions.name property
+
+Name used when pretty log is enabled.
+
+**Signature:**
+
+```typescript
+name?: string;
+```
diff --git a/src/Async-Call.ts b/src/Async-Call.ts
@@ -112,7 +112,8 @@ export function AsyncCall<OtherSideImplementedFunctions = {}>(
     const {
         serializer,
         encoder,
-        key: logKey = 'rpc',
+        key: deprecatedName,
+        name,
         strict = true,
         log = true,
         parameterStructures = 'by-position',
@@ -124,6 +125,11 @@ export function AsyncCall<OtherSideImplementedFunctions = {}>(
         thenable,
     } = options
 
+    // Note: we're not shorten this error message because it will be removed in the next major version.
+    if (serializer && encoder) throw new TypeError('Please remove serializer.')
+    if (name && deprecatedName) throw new TypeError('Please remove key.')
+    const logKey = name || deprecatedName || 'rpc'
+
     const {
         encode: encodeFromOption,
         encodeRequest: encodeRequestFromOption,
@@ -136,8 +142,8 @@ export function AsyncCall<OtherSideImplementedFunctions = {}>(
     const encodeRequest: (data: Requests | Responses) => any = encoder
         ? (data) => apply(encodeRequestFromOption || encodeFromOption, encoder, [data])
         : serializer
-        ? (data) => serializer.serialization(data)
-        : Object
+          ? (data) => serializer.serialization(data)
+          : Object
 
     const encodeResponse: (data: Requests | Responses) => any = encoder
         ? (data) => apply(encodeResponseFromOption || encodeFromOption, encoder, [data])
@@ -150,14 +156,11 @@ export function AsyncCall<OtherSideImplementedFunctions = {}>(
               hint == 'request'
                   ? apply(decodeRequest || decode, encoder, [data])
                   : hint == 'response'
-                  ? apply(decodeResponse || decode, encoder, [data])
-                  : apply(decode, encoder, [data])
+                    ? apply(decodeResponse || decode, encoder, [data])
+                    : apply(decode, encoder, [data])
         : serializer
-        ? (data) => serializer.deserialization(data)
-        : Object
-
-    // Note: we're not shorten this error message because it will be removed in the next major version.
-    if (serializer && encoder) throw new TypeError('Please remove serializer.')
+          ? (data) => serializer.deserialization(data)
+          : Object
 
     if (thisSideImplementation instanceof Promise) awaitThisSideImplementation()
     else {

diff --git a/src/types.ts b/src/types.ts
@@ -126,10 +126,16 @@ export interface AsyncCallOptions<EncodedRequest = unknown, EncodedResponse = un
     /**
      * Name used when pretty log is enabled.
      * @defaultValue `rpc`
+     * @deprecated Renamed to "name".
      * @privateRemarks
      * TODO: rename this option to name.
      */
     key?: string
+    /**
+     * Name used when pretty log is enabled.
+     * @defaultValue `rpc`
+     */
+    name?: string
     /**
      * Serializer of the requests and responses.
      * @deprecated Use "encoding" option instead. This option will be removed in the next major version.