Api-User-Agent header (RESTBase)

Author: ChlodAlejandro

package-lock.json

@@ -84,7 +84,7 @@
         ">0.05% and supports fetch and not dead"
     ],
     "dependencies": {
-        "@chlodalejandro/parsoid": "2.0.0-f08be30",
+        "@chlodalejandro/parsoid": "^2.0.1-37ea110",
         "broadcastchannel-polyfill": "^1.0.1",
         "idb": "^7.1.0",
         "tsx-dom": "^1.4.0"

package.json

@@ -21,3 +21,6 @@ export {
 	version as deputyVersion,
 	version as default
 } from '../package.json';
+
+import { dependencies } from '../package-lock.json';
+export const parsoidVersion = dependencies[ '@chlodalejandro/parsoid' ].version;

src/DeputyVersion.ts

@@ -8,6 +8,10 @@ export default class MwApi {
 	private static _action: mw.Api;
 	private static _rest: mw.Rest;
 
+	public static readonly USER_AGENT = `Deputy/${
+		deputyVersion
+	} (https://w.wiki/5k$q; User:Chlod; wiki@chlod.net)`;
+
 	/**
 	 * @return A mw.Api for the current wiki.
 	 */

src/MwApi.ts

@@ -11,6 +11,8 @@ import TemplateFactory from './TemplateFactory';
 import moveToStart from '../../../util/moveToStart';
 import RowedAttributionNotice from './RowedAttributionNotice';
 import organize from '../../../util/organize';
+import MwApi from '../../../MwApi';
+import { parsoidVersion } from '../../../DeputyVersion';
 
 /**
  * An object containing an {@link HTMLIFrameElement} along with helper functions
@@ -71,6 +73,21 @@ export default class CTEParsoidDocument extends ParsoidDocument {
 		} );
 	}
 
+	/**
+	 * @inheritDoc
+	 * @protected
+	 */
+	protected getRequestOptions(): Omit<RequestInit, 'body' | 'cache' | 'method'> {
+		const ro = super.getRequestOptions();
+		return {
+			headers: {
+				'Api-User-Agent': `${MwApi.USER_AGENT} ${
+					( ro.headers as any )?.[ 'Api-User-Agent' ] ?? ''
+				}`
+			}
+		};
+	}
+
 	/**
 	 * @inheritDoc
 	 */
@@ -113,12 +130,17 @@ export default class CTEParsoidDocument extends ParsoidDocument {
 		return notices;
 	}
 
+	/**
+	 * Find all notices which have rows using their 'href' fields.
+	 *
+	 * @return All found {@link RowedAttributionNotice}s
+	 */
 	findRowedNoticesByHref(): Record<string, RowedAttributionNotice<any>[]> {
 		return organize(
 			this.findNotices().filter(
 				v => v instanceof RowedAttributionNotice
 			) as RowedAttributionNotice<any>[],
-			(v) => v.node.getTarget().href
+			( v ) => v.node.getTarget().href
 		);
 	}