An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
'use client';
/**
* @input Build-time docs and probe origins, a top-level page, and an anonymous
* iframe's exact-origin reachability message
* @output A fail-closed, once-per-page-load reachability result
* @position Client-only detection shared across root-layout remounts
*
* Both origins are deployment configuration, read from
* NEXT_PUBLIC_INTERNAL_DOCS_ORIGIN and NEXT_PUBLIC_DOCS_ACCESS_CHECK_ORIGIN at
* build time. A build without both (every fork and local build by default)
* never probes and never shows the prompt.
*/
import {useSyncExternalStore} from 'react';
export const ALLOWED_PARENT_ORIGINS: readonly string[] = [
'https://astryx.atmeta.com',
'https://astryx-git-feat-docs-internal-network-prompt-fbopensource.vercel.app',
'https://astryx-canary.vercel.app',
];
/**
* The exact origin of a configured absolute https URL, or undefined when the
* value is missing, malformed, or not https: a bad value disables the prompt
* rather than probing or linking somewhere unintended.
*/
export function configuredOrigin(
value: string | undefined,
): string | undefined {
if (!value?.trim()) {
return undefined;
}
try {
const url = new URL(value.trim());
return url.protocol === 'https:' ? url.origin : undefined;
} catch {
return undefined;
}
}
// Each variable is read by its literal name so the build inlines it.
export const INTERNAL_DOCS_ORIGIN = configuredOrigin(
process.env.NEXT_PUBLIC_INTERNAL_DOCS_ORIGIN,
);
export const ACCESS_CHECK_ORIGIN = configuredOrigin(
process.env.NEXT_PUBLIC_DOCS_ACCESS_CHECK_ORIGIN,
);
export const ACCESS_CHECK_MESSAGE_TYPE = 'codebunny:access-check:v1';
const listeners = new Set<() => void>();
let attempted = false;
let reachable = false;
let cancelCheck: (() => void) | undefined;
function publishReachability(next: boolean) {
reachable = next;
for (const listener of listeners) {
listener();
}
}
function startCheck() {
attempted = true;
// Without both configured origins there is nothing to probe or link to.
const accessCheckOrigin = ACCESS_CHECK_ORIGIN;
if (!accessCheckOrigin || !INTERNAL_DOCS_ORIGIN) {
return;
}
// Embedded documents, including playground previews, must not probe again.
if (window.top !== window) {
return;
}
// The probe and docs destination are independent origins. Match only the
// probe's exact parent allowlist, never arbitrary preview/hash domains.
const parentOrigin = window.location.origin;
if (!ALLOWED_PARENT_ORIGINS.includes(parentOrigin)) {
return;
}
const frame = document.createElement('iframe');
frame.hidden = true;
frame.tabIndex = -1;
frame.setAttribute('aria-hidden', 'true');
frame.setAttribute('sandbox', 'allow-scripts allow-same-origin');
frame.title = 'Astryx documentation reachability check';
frame.referrerPolicy = 'no-referrer';
frame.src = `${accessCheckOrigin}/embed/access-check?parent_origin=${encodeURIComponent(parentOrigin)}`;
let loaded = false;
let received = false;
const finish = (reachable: boolean) => {
window.clearTimeout(timeout);
window.removeEventListener('message', onMessage);
frame.removeEventListener('load', onLoad);
frame.remove();
cancelCheck = undefined;
publishReachability(reachable);
};
const onLoad = () => {
loaded = true;
if (received) {
finish(true);
}
};
const onMessage = (event: MessageEvent) => {
if (
event.origin !== accessCheckOrigin ||
event.source !== frame.contentWindow ||
event.data?.type !== ACCESS_CHECK_MESSAGE_TYPE ||
event.data?.reachable !== true
) {
return;
}
received = true;
if (loaded) {
finish(true);
}
};
const timeout = window.setTimeout(() => finish(false), 4000);
cancelCheck = () => finish(false);
window.addEventListener('message', onMessage);
frame.addEventListener('load', onLoad);
document.body.append(frame);
}
function subscribe(listener: () => void) {
listeners.add(listener);
// StrictMode's setup/cleanup/setup finishes before this microtask. It must
// neither start two probes nor cancel the only probe during effect replay.
queueMicrotask(() => {
if (!attempted && listeners.size > 0) {
startCheck();
}
});
return () => {
listeners.delete(listener);
if (listeners.size === 0) {
cancelCheck?.();
}
};
}
const getSnapshot = () => reachable;
const getServerSnapshot = () => false;
export function useInternalDocsPrompt() {
return useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot);
}