Rename wait to waitFor and export via utils only

- Renamed wait() to waitFor() as requested
- Moved export to utils object instead of direct export
- Reverted type assertion changes in index.test.ts
- Updated README to show usage via utils.waitFor()
- Updated JSDoc example to reflect new API

Co-authored-by: fregante <1402241+fregante@users.noreply.github.com>

Author: Copilot

index.test.ts

@@ -22,20 +22,12 @@ for (const [detectName, detect] of Object.entries(pageDetect)) {
 		continue;
 	}
 
-	// Skip wait and other utility functions
-	if (detectName === 'wait') {
-		continue;
-	}
-
 	const validURLs = getTests(detectName);
 
 	if (validURLs[0] === 'combinedTestOnly' || String(detect).startsWith('() =>')) {
 		continue;
 	}
 
-	// Type assertion for TypeScript to understand this is a detection function
-	const detectionFn = detect as (url?: URL | HTMLAnchorElement | Location) => boolean;
-
 	test(detectName + ' has tests', () => {
 		assert.ok(
 			Array.isArray(validURLs),
@@ -50,7 +42,7 @@ for (const [detectName, detect] of Object.entries(pageDetect)) {
 	for (const url of validURLs) {
 		test(`${detectName} ${url.replace('https://github.com', '')}`, () => {
 			assert.ok(
-				detectionFn(new URL(url)),
+				detect(new URL(url)),
 				stripIndent(`
 					Is this URL \`${detectName}\`?
 						${url.replace('https://github.com', '')}
@@ -71,7 +63,7 @@ for (const [detectName, detect] of Object.entries(pageDetect)) {
 		if (!validURLs.includes(url)) {
 			test(`${detectName} NO ${url}`, () => {
 				assert.equal(
-					detectionFn(new URL(url)),
+					detect(new URL(url)),
 					false,
 					stripIndent(`
 						Is this URL \`${detectName}\`?
@@ -297,25 +289,25 @@ test('parseRepoExplorerTitle', () => {
 	);
 });
 
-test('wait - immediately true', async () => {
+test('waitFor - immediately true', async () => {
 	const detection = () => true;
-	const result = await pageDetect.wait(detection);
+	const result = await pageDetect.utils.waitFor(detection);
 	assert.equal(result, true);
 });
 
-test('wait - becomes true', async () => {
+test('waitFor - becomes true', async () => {
 	let callCount = 0;
 	const detection = () => {
 		callCount++;
 		return callCount >= 3;
 	};
 
-	const result = await pageDetect.wait(detection);
+	const result = await pageDetect.utils.waitFor(detection);
 	assert.equal(result, true);
 	assert.ok(callCount >= 3);
 });
 
-test('wait - false when document complete', async () => {
+test('waitFor - false when document complete', async () => {
 	// Save original state
 	const originalReadyState = Object.getOwnPropertyDescriptor(document, 'readyState');
 
@@ -327,7 +319,7 @@ test('wait - false when document complete', async () => {
 	});
 
 	const detection = () => false;
-	const result = await pageDetect.wait(detection);
+	const result = await pageDetect.utils.waitFor(detection);
 	assert.equal(result, false);
 
 	// Restore original state

index.ts

@@ -11,17 +11,17 @@ const exists = (selector: string) => Boolean($(selector));
  * @returns A promise that resolves to the final result of the detection
  * @example
  * ```
- * import {wait, isOrganizationProfile} from 'github-url-detection';
+ * import {utils} from 'github-url-detection';
  *
  * async function init() {
- *   if (!await wait(isOrganizationProfile)) {
+ *   if (!await utils.waitFor(isOrganizationProfile)) {
  *     return;
  *   }
  *   // Do something when on organization profile
  * }
  * ```
  */
-export async function wait(detection: () => boolean): Promise<boolean> {
+async function waitFor(detection: () => boolean): Promise<boolean> {
 	// eslint-disable-next-line no-await-in-loop -- We need to wait on each frame
 	while (!detection() && document.readyState !== 'complete') {
 		// eslint-disable-next-line no-await-in-loop
@@ -991,4 +991,5 @@ export const utils = {
 	getCleanGistPathname,
 	getRepositoryInfo: getRepo,
 	parseRepoExplorerTitle,
+	waitFor,
 };

readme.md

@@ -67,16 +67,16 @@ if (pageDetect.isOrganizationProfile()) {
 }
 ```
 
-### Async detections with `wait`
+### Async detections with `waitFor`
 
-The `wait` helper function allows you to wait for a detection to become true by repeatedly checking it on each animation frame. This is useful for DOM-based detections that need to wait for elements to appear before the document is fully loaded.
+The `waitFor` helper function allows you to wait for a detection to become true by repeatedly checking it on each animation frame. This is useful for DOM-based detections that need to wait for elements to appear before the document is fully loaded.
 
 ```js
-import {wait, isOrganizationProfile} from 'github-url-detection';
+import {utils, isOrganizationProfile} from 'github-url-detection';
 
 async function init() {
 	// Wait for the detection to return true or for the document to be complete
-	if (!await wait(isOrganizationProfile)) {
+	if (!await utils.waitFor(isOrganizationProfile)) {
 		return; // Not an organization profile
 	}
 
@@ -85,7 +85,7 @@ async function init() {
 }
 ```
 
-The `wait` function:
+The `waitFor` function:
 - Repeatedly calls the detection function on each animation frame
 - Stops when the detection returns `true` or when `document.readyState` is `'complete'`
 - Returns the final result of the detection