@opensite/hooks 2.0.0 → 2.0.2

package/dist/core/websiteExtractorTypes.d.ts

@@ -0,0 +1,65 @@
+export interface WebsiteExtractCacheMeta {
+    hit: boolean;
+    ageSeconds: number;
+    ttlSeconds: number;
+    staleWhileRevalidateSeconds: number;
+}
+export interface WebsiteExtractMeta {
+    requestedUrl: string;
+    finalUrl: string;
+    url: string;
+    normalizedUrl: string;
+    status: number;
+    contentType: string;
+    fetchedAt: string;
+    bodyBytes: number;
+    bodyTruncated: boolean;
+    maxBodyBytes: number;
+    cache: WebsiteExtractCacheMeta;
+}
+export interface WebsiteExtractorError {
+    message: string;
+    status?: number;
+    raw?: unknown;
+}
+export interface WebsiteExtractorOptions {
+    url?: string;
+    apiKey?: string;
+    baseUrl?: string;
+    debounceMs?: number;
+    refreshDebounceMs?: number;
+    enabled?: boolean;
+    cache?: boolean;
+}
+export interface WebsiteExtractorState<TData, TRaw = TData> {
+    loading: boolean;
+    data?: TData;
+    raw?: TRaw;
+    meta?: WebsiteExtractMeta;
+    error?: WebsiteExtractorError;
+}
+export interface WebsiteExtractorResult<TData, TRaw = TData> extends WebsiteExtractorState<TData, TRaw> {
+    refresh: () => void;
+}
+export type WebsiteExtractorResponse<TPayload> = WebsiteExtractMeta & TPayload;
+export interface WebsiteExtractorRequest {
+    endpoint: string;
+    url: string;
+    apiKey?: string;
+    baseUrl?: string;
+    signal?: AbortSignal;
+}
+export type WebsiteExtractorClientResult<T> = {
+    ok: true;
+    response: T;
+} | {
+    ok: false;
+    error: WebsiteExtractorError;
+};
+export declare const DEFAULT_WEBSITE_EXTRACTOR_BASE_URL = "https://octane.buzz";
+export declare const DEFAULT_EXTRACTOR_DEBOUNCE_MS = 250;
+export declare const DEFAULT_EXTRACTOR_REFRESH_DEBOUNCE_MS = 150;
+export declare const DEFAULT_EXTRACTOR_ENABLED = true;
+export declare const DEFAULT_EXTRACTOR_CACHE = true;
+export declare function extractWebsiteMeta(response: WebsiteExtractMeta): WebsiteExtractMeta;
+export declare function stripWebsiteMeta<TResponse extends WebsiteExtractMeta>(response: TResponse): Omit<TResponse, keyof WebsiteExtractMeta>;

package/dist/core/websiteExtractorTypes.js

@@ -0,0 +1,25 @@
+export const DEFAULT_WEBSITE_EXTRACTOR_BASE_URL = "https://octane.buzz";
+export const DEFAULT_EXTRACTOR_DEBOUNCE_MS = 250;
+export const DEFAULT_EXTRACTOR_REFRESH_DEBOUNCE_MS = 150;
+export const DEFAULT_EXTRACTOR_ENABLED = true;
+export const DEFAULT_EXTRACTOR_CACHE = true;
+export function extractWebsiteMeta(response) {
+    const { requestedUrl, finalUrl, url, normalizedUrl, status, contentType, fetchedAt, bodyBytes, bodyTruncated, maxBodyBytes, cache, } = response;
+    return {
+        requestedUrl,
+        finalUrl,
+        url,
+        normalizedUrl,
+        status,
+        contentType,
+        fetchedAt,
+        bodyBytes,
+        bodyTruncated,
+        maxBodyBytes,
+        cache,
+    };
+}
+export function stripWebsiteMeta(response) {
+    const { requestedUrl: _requestedUrl, finalUrl: _finalUrl, url: _url, normalizedUrl: _normalizedUrl, status: _status, contentType: _contentType, fetchedAt: _fetchedAt, bodyBytes: _bodyBytes, bodyTruncated: _bodyTruncated, maxBodyBytes: _maxBodyBytes, cache: _cache, ...payload } = response;
+    return payload;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensite/hooks",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Performance-first React hooks for UI state, storage, events, and responsive behavior with tree-shakable exports.",
   "keywords": [
     "react",
@@ -93,6 +93,11 @@
       "require": "./dist/core/useMediaQuery.cjs",
       "types": "./dist/core/useMediaQuery.d.ts"
     },
+    "./useOpenGraphExtractor": {
+      "import": "./dist/core/useOpenGraphExtractor.js",
+      "require": "./dist/core/useOpenGraphExtractor.cjs",
+      "types": "./dist/core/useOpenGraphExtractor.d.ts"
+    },
     "./useOnClickOutside": {
       "import": "./dist/core/useOnClickOutside.js",
       "require": "./dist/core/useOnClickOutside.cjs",
@@ -117,6 +122,36 @@
       "import": "./dist/core/useThrottle.js",
       "require": "./dist/core/useThrottle.cjs",
       "types": "./dist/core/useThrottle.d.ts"
+    },
+    "./useWebsiteSchemaExtractor": {
+      "import": "./dist/core/useWebsiteSchemaExtractor.js",
+      "require": "./dist/core/useWebsiteSchemaExtractor.cjs",
+      "types": "./dist/core/useWebsiteSchemaExtractor.d.ts"
+    },
+    "./useWebsiteLinksExtractor": {
+      "import": "./dist/core/useWebsiteLinksExtractor.js",
+      "require": "./dist/core/useWebsiteLinksExtractor.cjs",
+      "types": "./dist/core/useWebsiteLinksExtractor.d.ts"
+    },
+    "./useWebsiteMetaExtractor": {
+      "import": "./dist/core/useWebsiteMetaExtractor.js",
+      "require": "./dist/core/useWebsiteMetaExtractor.cjs",
+      "types": "./dist/core/useWebsiteMetaExtractor.d.ts"
+    },
+    "./useWebsiteRssExtractor": {
+      "import": "./dist/core/useWebsiteRssExtractor.js",
+      "require": "./dist/core/useWebsiteRssExtractor.cjs",
+      "types": "./dist/core/useWebsiteRssExtractor.d.ts"
+    },
+    "./websiteExtractorService": {
+      "import": "./dist/core/websiteExtractorService.js",
+      "require": "./dist/core/websiteExtractorService.cjs",
+      "types": "./dist/core/websiteExtractorService.d.ts"
+    },
+    "./websiteExtractorTypes": {
+      "import": "./dist/core/websiteExtractorTypes.js",
+      "require": "./dist/core/websiteExtractorTypes.cjs",
+      "types": "./dist/core/websiteExtractorTypes.d.ts"
     }
   },
   "scripts": {

package/dist/hooks/index.cjs

@@ -1,16 +0,0 @@
-export { useBoolean } from "../core/useBoolean.js";
-export { useDebounceCallback } from "../core/useDebounceCallback.js";
-export { useDebounceValue } from "../core/useDebounceValue.js";
-export { useLocalStorage } from "../core/useLocalStorage.js";
-export { useSessionStorage } from "../core/useSessionStorage.js";
-export { useOnClickOutside } from "../core/useOnClickOutside.js";
-export { useMediaQuery } from "../core/useMediaQuery.js";
-export { useEventListener } from "../core/useEventListener.js";
-export { useIsClient } from "../core/useIsClient.js";
-export { useCopyToClipboard } from "../core/useCopyToClipboard.js";
-export { usePrevious } from "../core/usePrevious.js";
-export { useThrottle } from "../core/useThrottle.js";
-export { useResizeObserver } from "../core/useResizeObserver.js";
-export { useHover } from "../core/useHover.js";
-export { useIsomorphicLayoutEffect } from "../core/useIsomorphicLayoutEffect.js";
-export { useMap } from "../core/useMap.js";

package/dist/hooks/index.d.ts

@@ -1,24 +0,0 @@
-export { useBoolean } from "../core/useBoolean.js";
-export type { UseBooleanResult } from "../core/useBoolean.js";
-export { useDebounceCallback } from "../core/useDebounceCallback.js";
-export type { DebounceOptions, DebouncedCallback } from "../core/useDebounceCallback.js";
-export { useDebounceValue } from "../core/useDebounceValue.js";
-export { useLocalStorage } from "../core/useLocalStorage.js";
-export type { StorageOptions } from "../core/useLocalStorage.js";
-export { useSessionStorage } from "../core/useSessionStorage.js";
-export type { SessionStorageOptions } from "../core/useSessionStorage.js";
-export { useOnClickOutside } from "../core/useOnClickOutside.js";
-export { useMediaQuery } from "../core/useMediaQuery.js";
-export type { UseMediaQueryOptions } from "../core/useMediaQuery.js";
-export { useEventListener } from "../core/useEventListener.js";
-export { useIsClient } from "../core/useIsClient.js";
-export { useCopyToClipboard } from "../core/useCopyToClipboard.js";
-export type { UseCopyToClipboardOptions, CopyToClipboardResult, } from "../core/useCopyToClipboard.js";
-export { usePrevious } from "../core/usePrevious.js";
-export { useThrottle } from "../core/useThrottle.js";
-export type { ThrottleOptions } from "../core/useThrottle.js";
-export { useResizeObserver } from "../core/useResizeObserver.js";
-export { useHover } from "../core/useHover.js";
-export { useIsomorphicLayoutEffect } from "../core/useIsomorphicLayoutEffect.js";
-export { useMap } from "../core/useMap.js";
-export type { MapActions } from "../core/useMap.js";

package/dist/hooks/index.js

@@ -1,16 +0,0 @@
-export { useBoolean } from "../core/useBoolean.js";
-export { useDebounceCallback } from "../core/useDebounceCallback.js";
-export { useDebounceValue } from "../core/useDebounceValue.js";
-export { useLocalStorage } from "../core/useLocalStorage.js";
-export { useSessionStorage } from "../core/useSessionStorage.js";
-export { useOnClickOutside } from "../core/useOnClickOutside.js";
-export { useMediaQuery } from "../core/useMediaQuery.js";
-export { useEventListener } from "../core/useEventListener.js";
-export { useIsClient } from "../core/useIsClient.js";
-export { useCopyToClipboard } from "../core/useCopyToClipboard.js";
-export { usePrevious } from "../core/usePrevious.js";
-export { useThrottle } from "../core/useThrottle.js";
-export { useResizeObserver } from "../core/useResizeObserver.js";
-export { useHover } from "../core/useHover.js";
-export { useIsomorphicLayoutEffect } from "../core/useIsomorphicLayoutEffect.js";
-export { useMap } from "../core/useMap.js";

package/dist/hooks/useBoolean.cjs

@@ -1 +0,0 @@
-export { useBoolean } from "../core/useBoolean.js";

package/dist/hooks/useBoolean.d.ts

@@ -1,2 +0,0 @@
-export { useBoolean } from "../core/useBoolean.js";
-export type { UseBooleanResult } from "../core/useBoolean.js";

package/dist/hooks/useBoolean.js

@@ -1 +0,0 @@
-export { useBoolean } from "../core/useBoolean.js";

package/dist/hooks/useCopyToClipboard.cjs

@@ -1 +0,0 @@
-export { useCopyToClipboard } from "../core/useCopyToClipboard.js";

package/dist/hooks/useCopyToClipboard.d.ts

@@ -1,2 +0,0 @@
-export { useCopyToClipboard } from "../core/useCopyToClipboard.js";
-export type { UseCopyToClipboardOptions, CopyToClipboardResult, } from "../core/useCopyToClipboard.js";

package/dist/hooks/useCopyToClipboard.js

@@ -1 +0,0 @@
-export { useCopyToClipboard } from "../core/useCopyToClipboard.js";

package/dist/hooks/useDebounceCallback.cjs

@@ -1 +0,0 @@
-export { useDebounceCallback } from "../core/useDebounceCallback.js";

package/dist/hooks/useDebounceCallback.d.ts

@@ -1,2 +0,0 @@
-export { useDebounceCallback } from "../core/useDebounceCallback.js";
-export type { DebounceOptions, DebouncedCallback } from "../core/useDebounceCallback.js";

package/dist/hooks/useDebounceCallback.js

@@ -1 +0,0 @@
-export { useDebounceCallback } from "../core/useDebounceCallback.js";

package/dist/hooks/useDebounceValue.cjs

@@ -1 +0,0 @@
-export { useDebounceValue } from "../core/useDebounceValue.js";

package/dist/hooks/useDebounceValue.d.ts

@@ -1,2 +0,0 @@
-export { useDebounceValue } from "../core/useDebounceValue.js";
-export type { DebounceOptions } from "../core/useDebounceCallback.js";

package/dist/hooks/useDebounceValue.js

@@ -1 +0,0 @@
-export { useDebounceValue } from "../core/useDebounceValue.js";

package/dist/hooks/useEventListener.cjs

@@ -1 +0,0 @@
-export { useEventListener } from "../core/useEventListener.js";

package/dist/hooks/useEventListener.d.ts

@@ -1 +0,0 @@
-export { useEventListener } from "../core/useEventListener.js";

package/dist/hooks/useEventListener.js

@@ -1 +0,0 @@
-export { useEventListener } from "../core/useEventListener.js";

package/dist/hooks/useHover.cjs

@@ -1 +0,0 @@
-export { useHover } from "../core/useHover.js";

package/dist/hooks/useHover.d.ts

@@ -1 +0,0 @@
-export { useHover } from "../core/useHover.js";

package/dist/hooks/useHover.js

@@ -1 +0,0 @@
-export { useHover } from "../core/useHover.js";

package/dist/hooks/useIsClient.cjs

@@ -1 +0,0 @@
-export { useIsClient } from "../core/useIsClient.js";

package/dist/hooks/useIsClient.d.ts

@@ -1 +0,0 @@
-export { useIsClient } from "../core/useIsClient.js";

package/dist/hooks/useIsClient.js

@@ -1 +0,0 @@
-export { useIsClient } from "../core/useIsClient.js";

package/dist/hooks/useIsomorphicLayoutEffect.cjs

@@ -1 +0,0 @@
-export { useIsomorphicLayoutEffect } from "../core/useIsomorphicLayoutEffect.js";

package/dist/hooks/useIsomorphicLayoutEffect.d.ts

@@ -1 +0,0 @@
-export { useIsomorphicLayoutEffect } from "../core/useIsomorphicLayoutEffect.js";

package/dist/hooks/useIsomorphicLayoutEffect.js

@@ -1 +0,0 @@
-export { useIsomorphicLayoutEffect } from "../core/useIsomorphicLayoutEffect.js";

package/dist/hooks/useLocalStorage.cjs

@@ -1 +0,0 @@
-export { useLocalStorage } from "../core/useLocalStorage.js";

package/dist/hooks/useLocalStorage.d.ts

@@ -1,2 +0,0 @@
-export { useLocalStorage } from "../core/useLocalStorage.js";
-export type { StorageOptions } from "../core/useLocalStorage.js";

package/dist/hooks/useLocalStorage.js

@@ -1 +0,0 @@
-export { useLocalStorage } from "../core/useLocalStorage.js";

package/dist/hooks/useMap.cjs

@@ -1 +0,0 @@
-export { useMap } from "../core/useMap.js";

package/dist/hooks/useMap.d.ts

@@ -1,2 +0,0 @@
-export { useMap } from "../core/useMap.js";
-export type { MapActions } from "../core/useMap.js";

package/dist/hooks/useMap.js

@@ -1 +0,0 @@
-export { useMap } from "../core/useMap.js";

package/dist/hooks/useMediaQuery.cjs

@@ -1 +0,0 @@
-export { useMediaQuery } from "../core/useMediaQuery.js";

package/dist/hooks/useMediaQuery.d.ts

@@ -1,2 +0,0 @@
-export { useMediaQuery } from "../core/useMediaQuery.js";
-export type { UseMediaQueryOptions } from "../core/useMediaQuery.js";

package/dist/hooks/useMediaQuery.js

@@ -1 +0,0 @@
-export { useMediaQuery } from "../core/useMediaQuery.js";

package/dist/hooks/useOnClickOutside.cjs

@@ -1 +0,0 @@
-export { useOnClickOutside } from "../core/useOnClickOutside.js";

package/dist/hooks/useOnClickOutside.d.ts

@@ -1 +0,0 @@
-export { useOnClickOutside } from "../core/useOnClickOutside.js";

package/dist/hooks/useOnClickOutside.js

@@ -1 +0,0 @@
-export { useOnClickOutside } from "../core/useOnClickOutside.js";

package/dist/hooks/usePrevious.cjs

@@ -1 +0,0 @@
-export { usePrevious } from "../core/usePrevious.js";

package/dist/hooks/usePrevious.d.ts

@@ -1 +0,0 @@
-export { usePrevious } from "../core/usePrevious.js";

package/dist/hooks/usePrevious.js

@@ -1 +0,0 @@
-export { usePrevious } from "../core/usePrevious.js";

package/dist/hooks/useResizeObserver.cjs

@@ -1 +0,0 @@
-export { useResizeObserver } from "../core/useResizeObserver.js";

package/dist/hooks/useResizeObserver.d.ts

@@ -1 +0,0 @@
-export { useResizeObserver } from "../core/useResizeObserver.js";

package/dist/hooks/useResizeObserver.js

@@ -1 +0,0 @@
-export { useResizeObserver } from "../core/useResizeObserver.js";

package/dist/hooks/useSessionStorage.cjs

@@ -1 +0,0 @@
-export { useSessionStorage } from "../core/useSessionStorage.js";

package/dist/hooks/useSessionStorage.d.ts

@@ -1,2 +0,0 @@
-export { useSessionStorage } from "../core/useSessionStorage.js";
-export type { SessionStorageOptions } from "../core/useSessionStorage.js";

package/dist/hooks/useSessionStorage.js

@@ -1 +0,0 @@
-export { useSessionStorage } from "../core/useSessionStorage.js";

package/dist/hooks/useThrottle.cjs

@@ -1 +0,0 @@
-export { useThrottle } from "../core/useThrottle.js";

package/dist/hooks/useThrottle.d.ts

@@ -1,2 +0,0 @@
-export { useThrottle } from "../core/useThrottle.js";
-export type { ThrottleOptions } from "../core/useThrottle.js";

package/dist/hooks/useThrottle.js

@@ -1 +0,0 @@
-export { useThrottle } from "../core/useThrottle.js";

package/dist/test/setup.cjs

@@ -1,98 +0,0 @@
-/**
- * Vitest test setup file
- * Runs before each test file
- */
-import { cleanup } from "@testing-library/react";
-import { afterEach, vi } from "vitest";
-// Cleanup after each test case (unmounts React trees that were mounted with render)
-afterEach(() => {
-    cleanup();
-});
-// Mock window.matchMedia for useMediaQuery tests
-Object.defineProperty(window, "matchMedia", {
-    writable: true,
-    value: vi.fn().mockImplementation((query) => ({
-        matches: false,
-        media: query,
-        onchange: null,
-        addListener: vi.fn(), // deprecated
-        removeListener: vi.fn(), // deprecated
-        addEventListener: vi.fn(),
-        removeEventListener: vi.fn(),
-        dispatchEvent: vi.fn(),
-    })),
-});
-// Mock ResizeObserver for useResizeObserver tests
-class MockResizeObserver {
-    callback;
-    constructor(callback) {
-        this.callback = callback;
-    }
-    observe = vi.fn();
-    unobserve = vi.fn();
-    disconnect = vi.fn();
-}
-Object.defineProperty(window, "ResizeObserver", {
-    writable: true,
-    value: MockResizeObserver,
-});
-// Mock clipboard API for useCopyToClipboard tests
-Object.defineProperty(navigator, "clipboard", {
-    writable: true,
-    value: {
-        writeText: vi.fn().mockResolvedValue(undefined),
-        readText: vi.fn().mockResolvedValue(""),
-    },
-});
-// Mock localStorage
-const localStorageMock = (() => {
-    let store = {};
-    return {
-        getItem: vi.fn((key) => store[key] ?? null),
-        setItem: vi.fn((key, value) => {
-            store[key] = value;
-        }),
-        removeItem: vi.fn((key) => {
-            delete store[key];
-        }),
-        clear: vi.fn(() => {
-            store = {};
-        }),
-        get length() {
-            return Object.keys(store).length;
-        },
-        key: vi.fn((index) => Object.keys(store)[index] ?? null),
-    };
-})();
-Object.defineProperty(window, "localStorage", {
-    value: localStorageMock,
-});
-// Mock sessionStorage (same as localStorage)
-const sessionStorageMock = (() => {
-    let store = {};
-    return {
-        getItem: vi.fn((key) => store[key] ?? null),
-        setItem: vi.fn((key, value) => {
-            store[key] = value;
-        }),
-        removeItem: vi.fn((key) => {
-            delete store[key];
-        }),
-        clear: vi.fn(() => {
-            store = {};
-        }),
-        get length() {
-            return Object.keys(store).length;
-        },
-        key: vi.fn((index) => Object.keys(store)[index] ?? null),
-    };
-})();
-Object.defineProperty(window, "sessionStorage", {
-    value: sessionStorageMock,
-});
-// Clear mocks between tests
-afterEach(() => {
-    vi.clearAllMocks();
-    localStorageMock.clear();
-    sessionStorageMock.clear();
-});

package/dist/test/setup.d.ts

@@ -1,5 +0,0 @@
-/**
- * Vitest test setup file
- * Runs before each test file
- */
-export {};

package/dist/test/setup.js

@@ -1,98 +0,0 @@
-/**
- * Vitest test setup file
- * Runs before each test file
- */
-import { cleanup } from "@testing-library/react";
-import { afterEach, vi } from "vitest";
-// Cleanup after each test case (unmounts React trees that were mounted with render)
-afterEach(() => {
-    cleanup();
-});
-// Mock window.matchMedia for useMediaQuery tests
-Object.defineProperty(window, "matchMedia", {
-    writable: true,
-    value: vi.fn().mockImplementation((query) => ({
-        matches: false,
-        media: query,
-        onchange: null,
-        addListener: vi.fn(), // deprecated
-        removeListener: vi.fn(), // deprecated
-        addEventListener: vi.fn(),
-        removeEventListener: vi.fn(),
-        dispatchEvent: vi.fn(),
-    })),
-});
-// Mock ResizeObserver for useResizeObserver tests
-class MockResizeObserver {
-    callback;
-    constructor(callback) {
-        this.callback = callback;
-    }
-    observe = vi.fn();
-    unobserve = vi.fn();
-    disconnect = vi.fn();
-}
-Object.defineProperty(window, "ResizeObserver", {
-    writable: true,
-    value: MockResizeObserver,
-});
-// Mock clipboard API for useCopyToClipboard tests
-Object.defineProperty(navigator, "clipboard", {
-    writable: true,
-    value: {
-        writeText: vi.fn().mockResolvedValue(undefined),
-        readText: vi.fn().mockResolvedValue(""),
-    },
-});
-// Mock localStorage
-const localStorageMock = (() => {
-    let store = {};
-    return {
-        getItem: vi.fn((key) => store[key] ?? null),
-        setItem: vi.fn((key, value) => {
-            store[key] = value;
-        }),
-        removeItem: vi.fn((key) => {
-            delete store[key];
-        }),
-        clear: vi.fn(() => {
-            store = {};
-        }),
-        get length() {
-            return Object.keys(store).length;
-        },
-        key: vi.fn((index) => Object.keys(store)[index] ?? null),
-    };
-})();
-Object.defineProperty(window, "localStorage", {
-    value: localStorageMock,
-});
-// Mock sessionStorage (same as localStorage)
-const sessionStorageMock = (() => {
-    let store = {};
-    return {
-        getItem: vi.fn((key) => store[key] ?? null),
-        setItem: vi.fn((key, value) => {
-            store[key] = value;
-        }),
-        removeItem: vi.fn((key) => {
-            delete store[key];
-        }),
-        clear: vi.fn(() => {
-            store = {};
-        }),
-        get length() {
-            return Object.keys(store).length;
-        },
-        key: vi.fn((index) => Object.keys(store)[index] ?? null),
-    };
-})();
-Object.defineProperty(window, "sessionStorage", {
-    value: sessionStorageMock,
-});
-// Clear mocks between tests
-afterEach(() => {
-    vi.clearAllMocks();
-    localStorageMock.clear();
-    sessionStorageMock.clear();
-});