msw/utils: Add JSDoc comments for better type support (#12542)

Author: Turbo87

packages/crates-io-msw/utils/counters.js

@@ -1,5 +1,8 @@
 const COUNTERS = new Map();
 
+/**
+ * @param {string} counterName
+ */
 export function increment(counterName) {
   let value = (COUNTERS.get(counterName) || 0) + 1;
   COUNTERS.set(counterName, value);

packages/crates-io-msw/utils/dates.js

@@ -1,3 +1,7 @@
+/**
+ * @param {string} a
+ * @param {string} b
+ */
 export function compareDates(a, b) {
   let aDate = new Date(a);
   let bDate = new Date(b);

packages/crates-io-msw/utils/handlers.js

@@ -4,6 +4,9 @@ export function notFound() {
   return HttpResponse.json({ errors: [{ detail: 'Not Found' }] }, { status: 404 });
 }
 
+/**
+ * @param {import("msw").StrictRequest<import("msw").DefaultBodyType>} request
+ */
 export function pageParams(request) {
   let url = new URL(request.url);
 

packages/crates-io-msw/utils/random.js

@@ -1,7 +1,13 @@
+/**
+ * @param {number} seed
+ */
 export function seededRandom(seed) {
   return mulberry32(seed)();
 }
 
+/**
+ * @param {number} a
+ */
 function mulberry32(a) {
   return function () {
     let t = (a += 0x6d_2b_79_f5);

packages/crates-io-msw/utils/release-tracks.js

@@ -1,9 +1,14 @@
 import semverParse from 'semver/functions/parse.js';
 import semverSort from 'semver/functions/rsort.js';
 
+/**
+ * @param {{ yanked: boolean, num: string }[]} versions
+ */
 export function calculateReleaseTracks(versions) {
   let versionNums = versions.filter(it => !it.yanked).map(it => it.num);
   semverSort(versionNums, { loose: true });
+
+  /** @type {Record<string, { highest: string }>} */
   let tracks = {};
   for (let num of versionNums) {
     let semver = semverParse(num, { loose: true });

packages/crates-io-msw/utils/serializers.js

@@ -1,6 +1,10 @@
 import { underscore } from './strings.js';
 
+/**
+ * @param {{ [s: string]: any; }} model
+ */
 export function serializeModel(model) {
+  /** @type {{ [s: string]: any; }} */
   let json = {};
   for (let [key, value] of Object.entries(model)) {
     json[underscore(key)] = value;

packages/crates-io-msw/utils/strings.js

@@ -1,10 +1,16 @@
+/**
+ * @param {string} str
+ */
 export function dasherize(str) {
   return str
     .replace(/([a-z\d])([A-Z])/g, '$1_$2')
     .toLowerCase()
     .replace(/[ _]/g, '-');
 }
 
+/**
+ * @param {string} str
+ */
 export function underscore(str) {
   return str
     .replace(/([a-z\d])([A-Z]+)/g, '$1_$2')