@x8r/sapphire 0.1.0

package/src/types.ts

@@ -0,0 +1,132 @@
+export interface ChromeManifestIcons {
+  [size: string]: string;
+}
+
+export interface ChromeManifestAction {
+  default_icon?: string | ChromeManifestIcons;
+  default_title?: string;
+  default_popup?: string;
+}
+
+export interface ChromeManifestBackground {
+  service_worker?: string;
+  type?: "module" | "classic";
+  page?: string;
+  scripts?: string[];
+}
+
+export interface ChromeManifestContentScript {
+  matches?: string[];
+  exclude_matches?: string[];
+  js?: string[];
+  css?: string[];
+  run_at?: "document_start" | "document_end" | "document_idle";
+  all_frames?: boolean;
+}
+
+export interface ChromeManifestRuleResource {
+  id?: string;
+  enabled?: boolean;
+  path: string;
+}
+
+export interface ChromeManifestCommand {
+  description?: string;
+  suggested_key?: {
+    default?: string;
+    windows?: string;
+    mac?: string;
+    linux?: string;
+  };
+}
+
+export interface ChromeManifest {
+  name: string;
+  short_name?: string;
+  description?: string;
+  version?: string;
+  manifest_version?: number;
+  default_locale?: string;
+  background?: ChromeManifestBackground;
+  content_scripts?: ChromeManifestContentScript[];
+  declarative_net_request?: {
+    rule_resources?: ChromeManifestRuleResource[];
+  };
+  icons?: ChromeManifestIcons;
+  action?: ChromeManifestAction;
+  browser_action?: ChromeManifestAction;
+  page_action?: ChromeManifestAction;
+  options_page?: string;
+  options_ui?: { page?: string };
+  chrome_url_overrides?: { newtab?: string; bookmarks?: string; history?: string };
+  commands?: Record<string, ChromeManifestCommand>;
+  permissions?: string[];
+  host_permissions?: string[];
+  [key: string]: unknown;
+}
+
+export interface ExtensionMeta {
+  id: string;
+  manifest: ChromeManifest;
+  enabled: boolean;
+  installedAt: number;
+  filename: string;
+  fileList: string[];
+}
+
+export interface DNRRuleCondition {
+  urlFilter?: string;
+  regexFilter?: string;
+  resourceTypes?: string[];
+  initiatorDomains?: string[];
+  excludedInitiatorDomains?: string[];
+}
+
+export interface DNRRuleAction {
+  type: "block" | "redirect" | "upgradeScheme" | "modifyHeaders" | "allow";
+  redirect?: { url?: string; regexSubstitution?: string };
+  requestHeaders?: unknown[];
+  responseHeaders?: unknown[];
+}
+
+export interface DNRRule {
+  id: number;
+  priority?: number;
+  condition: DNRRuleCondition;
+  action: DNRRuleAction;
+}
+
+export type DNRDecision =
+  | { action: "block" }
+  | { action: "redirect"; url: string }
+  | { action: "modifyHeaders"; headers: unknown[]; responseHeaders: unknown[] };
+
+export interface ContentScriptRegistration {
+  extId: string;
+  id?: string;
+  matches: string[];
+  excludeMatches: string[];
+  js: string[];
+  css: string[];
+  runAt: "document_start" | "document_end" | "document_idle";
+  allFrames: boolean;
+}
+
+export interface TabInfo {
+  id: number;
+  windowId: number;
+  url: string;
+  title: string;
+  active: boolean;
+}
+
+export interface SapphireHostBindings {
+  getTabId: (win: Window) => number | null;
+  getTab: (tabId: number) => TabInfo | null;
+  getAllTabs: () => TabInfo[];
+  getActiveTabId?: () => number | null;
+  getTabWindow?: (tabId: number) => Window | null;
+  navigateTab?: (tabId: number | null, url: string) => void;
+  openExtensionTab?: (extId: string, page: string, tabId: number | null) => void;
+  showNotification?: (title: string, message: string) => void;
+}

package/src/urlScheme.ts

@@ -0,0 +1,56 @@
+export const SAPPHIRE_PREFIX = "/~/sx/";
+
+export function sapphireBootstrapUrl(extId: string): string {
+  return `${sapphireExtensionBase(extId)}__bootstrap__`;
+}
+
+export function sapphireExtensionBase(extId: string): string {
+  return `${globalThis.location.origin}${SAPPHIRE_PREFIX}${extId}/`;
+}
+
+export function buildExtensionUrl(extId: string, path: string): string {
+  return `${sapphireExtensionBase(extId)}${path.replace(/^\//, "")}`;
+}
+
+export function chromeExtensionUrl(extId: string, path: string): string {
+  return `chrome-extension://${extId}/${path.replace(/^\//, "")}`;
+}
+
+export function resolveExtensionResourcePath(pageDir: string, ref: string): string {
+  if (ref.startsWith("/")) return ref.replace(/^\//, "");
+  const fakeBase = `sapphire://x/${pageDir ? `${pageDir}/` : ""}`;
+  const resolved = new URL(ref, fakeBase);
+  return decodeURIComponent(resolved.pathname.replace(/^\//, ""));
+}
+
+export function extensionPathDir(path: string): string {
+  const slash = path.lastIndexOf("/");
+  return slash === -1 ? "" : path.slice(0, slash);
+}
+
+export function decodeSapphirePath(pathname: string): { extId: string; path: string } | null {
+  if (!pathname.startsWith(SAPPHIRE_PREFIX)) return null;
+  const rest = pathname.slice(SAPPHIRE_PREFIX.length);
+  const slash = rest.indexOf("/");
+  if (slash === -1) return null;
+  const extId = rest.slice(0, slash);
+  const path = decodeURIComponent(rest.slice(slash + 1));
+  if (!extId || !path) return null;
+  return { extId, path };
+}
+
+export function decodeSapphireUrl(input: string): { extId: string; path: string } | null {
+  try {
+    const url = new URL(input, globalThis.location.href);
+    if (url.protocol === "chrome-extension:") {
+      const extId = url.hostname;
+      const path = decodeURIComponent(url.pathname.replace(/^\//, ""));
+      if (!extId || !path) return null;
+      return { extId, path };
+    }
+    if (url.origin !== globalThis.location.origin) return null;
+    return decodeSapphirePath(url.pathname);
+  } catch {
+    return null;
+  }
+}