Update tests, add labels for better editor hints

Author: aklinker1

docs/content/index.md

@@ -60,7 +60,7 @@ All Packages
   #title
   `@webext-core/messaging`
   #description
-  A simpler, type-safe API for sending and recieving messages.
+  A simpler, type-safe API for sending and receiving messages.
   <br />
   <br />
   [Go to docs →](/messaging/installation)

docs/content/messaging/api.md

@@ -19,7 +19,7 @@ interface BaseMessagingConfig {
 
 Shared configuration between all the different messengers.
 
-### Properties 
+### Properties
 
 - ***`logger?: Logger`*** (default: `console`)<br/>The logger to use when logging messages. Set to `null` to disable logging.
 
@@ -35,7 +35,7 @@ interface CustomEventMessage {
 
 Additional fields available on the `Message` from a `CustomEventMessenger`.
 
-### Properties 
+### Properties
 
 - ***`event: CustomEvent`***<br/>The event that was fired, resulting in the message being passed.
 
@@ -153,7 +153,7 @@ interface ExtensionMessage {
 
 Additional fields available on the `Message` from an `ExtensionMessenger`.
 
-### Properties 
+### Properties
 
 - ***`sender: Runtime.MessageSender`***<br/>Information about where the message came from. See
 [`Runtime.MessageSender`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/MessageSender).
@@ -256,7 +256,7 @@ interface Logger {
 }
 ```
 
-Interface used to log text to the console when sending and recieving messages.
+Interface used to log text to the console when sending and receiving messages.
 
 ## `MaybePromise`
 
@@ -281,9 +281,9 @@ interface Message<
 }
 ```
 
-Contains information about the message recieved.
+Contains information about the message received.
 
-### Properties 
+### Properties
 
 - ***`id: number`***<br/>A semi-unique, auto-incrementing number used to trace messages being sent.
 
@@ -306,7 +306,7 @@ interface MessageSender {
 
 An object containing information about the script context that sent a message or request.
 
-### Properties 
+### Properties
 
 - ***`tab?: Tabs.Tab`***<br/>The $(ref:tabs.Tab) which opened the connection, if any. This property will <strong>only</strong>
 be present when the connection was opened from a tab (including content scripts), and <strong>only</strong>
@@ -332,7 +332,7 @@ interface NamespaceMessagingConfig extends BaseMessagingConfig {
 }
 ```
 
-### Properties 
+### Properties
 
 - ***`namespace: string`***<br/>A string used to ensure the messenger only sends messages to and listens for messages from
 other messengers of the same type, with the same namespace.
@@ -354,7 +354,7 @@ Used to add a return type to a message in the protocol map.
 
 > Internally, this is just an object with random keys for the data and return types.
 
-### Properties 
+### Properties
 
 - ***`BtVgCTPYZu: TData`***<br/>Stores the data type. Randomly named so that it isn't accidentally implemented.
 
@@ -392,7 +392,7 @@ interface SendMessageOptions {
 
 Options for sending a message to a specific tab/frame
 
-### Properties 
+### Properties
 
 - ***`tabId: number`***<br/>The tab to send a message to
 
@@ -429,4 +429,4 @@ details.
 
 ---
 
-_API reference generated by [`docs/generate-api-references.ts`](https://github.com/aklinker1/webext-core/blob/main/docs/generate-api-references.ts)_
+_API reference generated by [`docs/generate-api-references.ts`](https://github.com/aklinker1/webext-core/blob/main/docs/generate-api-references.ts)_

packages/messaging/src/extension.test-d.ts

@@ -58,6 +58,11 @@ describe('Messenger Typing', () => {
       getStringLength: (data: string) => number;
     }>();
 
+    // @ts-expect-error: Requires one parameter
+    sendMessage('getStringLength');
+    sendMessage('getStringLength', 'test');
+    sendMessage('getStringLength', 'test', 123);
+
     expectTypeOf(sendMessage).parameter(0).toMatchTypeOf<'getStringLength'>();
     expectTypeOf(sendMessage).parameter(1).toBeString();
     expectTypeOf(sendMessage).returns.resolves.toBeNumber();
@@ -66,21 +71,33 @@ describe('Messenger Typing', () => {
     expectTypeOf(onMessage).parameter(1).returns.resolves.toBeNumber();
   });
 
-  it('should require passing undefined to sendMessage when there is no data', () => {
+  it('should accept passing undefined to sendMessage when there is no data', () => {
     const { sendMessage } = defineExtensionMessaging<{
       ping: ProtocolWithReturn<undefined, 'pong'>;
     }>();
 
+    sendMessage('ping');
+    sendMessage('ping', undefined);
+    // @ts-expect-error: It will still throw an error if you try to pass a target without sending `undefined` for the data.
+    sendMessage('ping', 123);
+    sendMessage('ping', undefined, 123);
+
     expectTypeOf(sendMessage).parameter(0).toMatchTypeOf<'ping'>();
     expectTypeOf(sendMessage).parameter(1).toBeUndefined();
     expectTypeOf(sendMessage).parameter(2).toEqualTypeOf<number | undefined | SendMessageOptions>();
   });
 
-  it('should require passing undefined to sendMessage when there is no arguments in a function definition', () => {
+  it('should accept passing undefined to sendMessage when there is no arguments in a function definition', () => {
     const { sendMessage } = defineExtensionMessaging<{
       ping(): 'pong';
     }>();
 
+    sendMessage('ping');
+    sendMessage('ping', undefined);
+    // @ts-expect-error: It will still throw an error if you try to pass a target without sending `undefined` for the data.
+    sendMessage('ping', 123);
+    sendMessage('ping', undefined, 123);
+
     expectTypeOf(sendMessage).parameter(0).toMatchTypeOf<'ping'>();
     expectTypeOf(sendMessage).parameter(1).toBeUndefined();
     expectTypeOf(sendMessage).parameter(2).toEqualTypeOf<number | undefined | SendMessageOptions>();

packages/messaging/src/extension.test.ts

@@ -23,7 +23,7 @@ describe('Messaging Wrapper', () => {
     vi.restoreAllMocks();
   });
 
-  it('should send and recieve messages', async () => {
+  it('should send and receive messages', async () => {
     const { onMessage, sendMessage } = defineExtensionMessaging<ProtocolMap>();
     const input = 'test';
     const expected = 4;

packages/messaging/src/generic.ts

@@ -55,7 +55,7 @@ export interface GenericMessenger<
   sendMessage<TType extends keyof TProtocolMap>(
     type: TType,
     ...args: GetDataType<TProtocolMap[TType]> extends undefined
-      ? [undefined?, ...TSendMessageArgs]
+      ? [data?: undefined, ...args: TSendMessageArgs]
       : never
   ): Promise<GetReturnType<TProtocolMap[TType]>>;
   sendMessage<TType extends keyof TProtocolMap>(
@@ -65,13 +65,13 @@ export interface GenericMessenger<
   ): Promise<GetReturnType<TProtocolMap[TType]>>;
 
   /**
-   * Trigger a callback when a message of the requested type is recieved. You cannot setup multiple
+   * Trigger a callback when a message of the requested type is received. You cannot setup multiple
    * listeners for the same message type in the same JS context.
    *
    * To remove the listener, call the returned message.
    *
-   * @param type The message type to listen for. Call `sendMessage` with the same type to triggern this listener.
-   * @param onReceived The callback executed when a message is recieved.
+   * @param type The message type to listen for. Call `sendMessage` with the same type to trigger this listener.
+   * @param onReceived The callback executed when a message is received.
    */
   onMessage<TType extends keyof TProtocolMap>(
     type: TType,
@@ -113,13 +113,13 @@ export function defineGenericMessanging<
   return {
     async sendMessage<TType extends keyof TProtocolMap>(
       type: TType,
-      data: TProtocolMap[TType],
+      data?: TProtocolMap[TType],
       ...args: TSendMessageArgs
     ): Promise<any> {
       const _message: Message<TProtocolMap, TType> = {
         id: getNextId(),
         type: type,
-        data,
+        data: data as any,
         timestamp: Date.now(),
       };
       const message = (await config.verifyMessageData?.(_message)) ?? _message;

packages/messaging/src/types.ts

@@ -1,5 +1,5 @@
 /**
- * Interface used to log text to the console when sending and recieving messages.
+ * Interface used to log text to the console when sending and receiving messages.
  */
 export interface Logger {
   debug(...args: any[]): void;
@@ -95,7 +95,7 @@ export interface NamespaceMessagingConfig extends BaseMessagingConfig {
 }
 
 /**
- * Contains information about the message recieved.
+ * Contains information about the message received.
  */
 export interface Message<
   TProtocolMap extends Record<string, any>,