github-url-detection 11.1.3 → 11.2.0

package/distribution/index.d.ts

@@ -1,4 +1,22 @@
 /* Examples added by add-examples-to-dts.ts */
+/**
+ * Waits for a detection to return true by repeatedly checking it on each animation frame.
+ * Useful for DOM-based detections that need to wait for elements to appear.
+ * @param detection - A detection function to check repeatedly
+ * @returns A promise that resolves to the final result of the detection
+ * @example
+ * ```
+ * import {utils} from 'github-url-detection';
+ *
+ * async function init() {
+ *   if (!await utils.waitFor(isOrganizationProfile)) {
+ *     return;
+ *   }
+ *   // Do something when on organization profile
+ * }
+ * ```
+ */
+declare function waitFor(detection: () => boolean): Promise<boolean>;
 export declare const is404: () => boolean;
 export declare const is500: () => boolean;
 export declare const isPasswordConfirmation: () => boolean;
@@ -42,15 +60,16 @@ export declare const isCompare: (url?: URL | HTMLAnchorElement | Location) => bo
  */
 export declare const isCompareWikiPage: (url?: URL | HTMLAnchorElement | Location) => boolean;
 /**
+ * @deprecated Use `isHome` and/or `isFeed` instead
+ *  
  * @example https://github.com///
  * @example https://github.com//
  * @example https://github.com/
  * @example https://github.com
- * @example https://github.com/orgs/test/dashboard
+ * @example https://github.com/orgs/refined-github/dashboard
  * @example https://github.com/dashboard/index/2
  * @example https://github.com//dashboard
  * @example https://github.com/dashboard
- * @example https://github.com/orgs/edit/dashboard
  * @example https://github.big-corp.com/
  * @example https://not-github.com/
  * @example https://my-little-hub.com/
@@ -63,6 +82,29 @@ export declare const isCompareWikiPage: (url?: URL | HTMLAnchorElement | Locatio
  * @example https://github.com/dashboard-feed
  */
 export declare const isDashboard: (url?: URL | HTMLAnchorElement | Location) => boolean;
+/**
+ * @example https://github.com
+ * @example https://github.com//dashboard
+ * @example https://github.com///
+ * @example https://github.com//
+ * @example https://github.com/
+ * @example https://github.com/dashboard
+ * @example https://github.big-corp.com/
+ * @example https://not-github.com/
+ * @example https://my-little-hub.com/
+ * @example https://github.com/?tab=repositories
+ * @example https://github.com/?tab=stars
+ * @example https://github.com/?tab=followers
+ * @example https://github.com/?tab=following
+ * @example https://github.com/?tab=overview
+ * @example https://github.com?search=1
+ */
+export declare const isHome: (url?: URL | HTMLAnchorElement | Location) => boolean;
+/**
+ * @example https://github.com/feed
+ * @example https://github.com/orgs/refined-github/dashboard
+ */
+export declare const isFeed: (url?: URL | HTMLAnchorElement | Location) => boolean;
 /**
  * @example https://github.big-corp.com/
  * @example https://not-github.com/
@@ -602,7 +644,11 @@ export declare const isNewAction: (url?: URL | HTMLAnchorElement | Location) =>
  */
 export declare const isRepositoryActions: (url?: URL | HTMLAnchorElement | Location) => boolean;
 export declare const isUserTheOrganizationOwner: () => boolean;
+/**
+ * @deprecated Use canUserAccessRepoSettings or API instead.
+ */
 export declare const canUserAdminRepo: () => boolean;
+export declare const canUserAccessRepoSettings: () => boolean;
 /**
  * @example https://github.com/new
  * @example https://github.com/organizations/npmhub/repositories/new
@@ -639,4 +685,6 @@ export declare const utils: {
     getCleanGistPathname: (url?: URL | HTMLAnchorElement | Location) => string | undefined;
     getRepositoryInfo: (url?: URL | HTMLAnchorElement | Location | string) => RepositoryInfo | undefined;
     parseRepoExplorerTitle: (pathname: string, title: string) => RepoExplorerInfo | undefined;
+    waitFor: typeof waitFor;
 };
+export {};

package/distribution/index.js

@@ -2,6 +2,14 @@
 import reservedNames from "github-reserved-names/reserved-names.json" with { type: "json" };
 var $ = (selector) => document.querySelector(selector);
 var exists = (selector) => Boolean($(selector));
+async function waitFor(detection) {
+  while (!detection() && document.readyState !== "complete") {
+    await new Promise((resolve) => {
+      requestAnimationFrame(resolve);
+    });
+  }
+  return detection();
+}
 var is404 = () => /^(Page|File) not found · GitHub/.test(document.title);
 var is500 = () => document.title === "Server Error \xB7 GitHub" || document.title === "Unicorn! \xB7 GitHub" || document.title === "504 Gateway Time-out";
 var isPasswordConfirmation = () => document.title === "Confirm password" || document.title === "Confirm access";
@@ -13,6 +21,8 @@ var isRepoCommitList = (url = location) => Boolean(getRepo(url)?.path.startsWith
 var isCompare = (url = location) => Boolean(getRepo(url)?.path.startsWith("compare"));
 var isCompareWikiPage = (url = location) => isRepoWiki(url) && getCleanPathname(url).split("/").slice(3, 5).includes("_compare");
 var isDashboard = (url = location) => !isGist(url) && /^$|^(orgs\/[^/]+\/)?dashboard(-feed)?(\/|$)/.test(getCleanPathname(url));
+var isHome = (url = location) => !isGist(url) && /^$|^dashboard\/?$/.test(getCleanPathname(url));
+var isFeed = (url = location) => !isGist(url) && /^(feed|orgs\/[^/]+\/dashboard)\/?$/.test(getCleanPathname(url));
 var isEnterprise = (url = location) => url.hostname !== "github.com" && url.hostname !== "gist.github.com";
 var isGist = (url = location) => typeof getCleanGistPathname(url) === "string";
 var isGlobalIssueOrPRList = (url = location) => ["issues", "pulls"].includes(url.pathname.split("/", 2)[1]);
@@ -198,6 +208,7 @@ var canUserAdminRepo = () => {
     ".js-repo-nav"
   ].join(",")}) a[href="/${repo.nameWithOwner}/settings"]`));
 };
+var canUserAccessRepoSettings = canUserAdminRepo;
 var isNewRepo = (url = location) => !isGist(url) && (url.pathname === "/new" || /^organizations\/[^/]+\/repositories\/new$/.test(getCleanPathname(url)));
 var isNewRepoTemplate = (url = location) => Boolean(url.pathname.split("/")[3] === "generate");
 var getLoggedInUser = () => $('meta[name="user-login"]')?.getAttribute("content") ?? void 0;
@@ -248,9 +259,11 @@ var utils = {
   getCleanPathname,
   getCleanGistPathname,
   getRepositoryInfo: getRepo,
-  parseRepoExplorerTitle
+  parseRepoExplorerTitle,
+  waitFor
 };
 export {
+  canUserAccessRepoSettings,
   canUserAdminRepo,
   hasCode,
   hasComments,
@@ -286,6 +299,7 @@ export {
   isEmptyRepo,
   isEmptyRepoRoot,
   isEnterprise,
+  isFeed,
   isFileFinder,
   isForkedRepo,
   isForkingRepo,
@@ -295,6 +309,7 @@ export {
   isGistRevision,
   isGlobalIssueOrPRList,
   isGlobalSearchResults,
+  isHome,
   isIssue,
   isIssueOrPRList,
   isLabelList,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "github-url-detection",
-	"version": "11.1.3",
+	"version": "11.2.0",
 	"description": "Which GitHub page are you on? Is it an issue? Is it a list? Perfect for your WebExtension or userscript.",
 	"keywords": [
 		"github",
@@ -42,7 +42,7 @@
 		"xo": "xo"
 	},
 	"dependencies": {
-		"github-reserved-names": "^2.1.1"
+		"github-reserved-names": "^2.1.3"
 	},
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "^8.1.0",

package/readme.md

@@ -67,6 +67,30 @@ if (pageDetect.isOrganizationProfile()) {
 }
 ```
 
+### Async detections with `waitFor`
+
+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 {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 utils.waitFor(isOrganizationProfile)) {
+		return; // Not an organization profile
+	}
+
+	// The page is now confirmed to be an organization profile
+	console.log('On organization profile!');
+}
+```
+
+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
+- Works with any detection function that returns a boolean
+
 ## Related
 
 - [github-reserved-names](https://github.com/Mottie/github-reserved-names) - Get a list, or check if a user or organization name is reserved by GitHub.