react-a11y-auto-caption 1.0.1 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/next.tsx","../src/useAICaption.ts"],"sourcesContent":["\"use client\";\r\n\r\nimport React from \"react\";\r\nimport Image, { ImageProps } from \"next/image\";\r\n\r\nimport { useAICaptions } from \"./useAICaption\";\r\n\r\nexport interface SmartNextImageProps extends Omit<ImageProps, \"alt\"> {\r\n alt?: string;\r\n apiEndpoint?: string;\r\n fallbackAlt?: string;\r\n onCaptionGenerated?: (caption: string) => void;\r\n onCaptionError?: (error: Error) => void;\r\n disableAI?: boolean;\r\n announceLive?: boolean;\r\n}\r\nexport const SR_ONLY_STYLE: React.CSSProperties = {\r\n position: \"absolute\",\r\n width: \"1px\",\r\n height: \"1px\",\r\n padding: 0,\r\n margin: \"-1px\",\r\n overflow: \"hidden\",\r\n clip: \"rect(0, 0, 0, 0)\",\r\n whiteSpace: \"nowrap\",\r\n borderWidth: 0,\r\n};\r\nexport const SmartNextImage = ({\r\n src,\r\n alt,\r\n apiEndpoint: propsEndpoint,\r\n fallbackAlt = \"Image loading or caption unavailable\",\r\n onCaptionGenerated,\r\n onCaptionError,\r\n disableAI: propsDisableAI,\r\n announceLive = false,\r\n ...props\r\n}: SmartNextImageProps) => {\r\n const { isGenerating, generatedAlt } = useAICaptions({\r\n src,\r\n alt,\r\n apiEndpoint: propsEndpoint,\r\n fallbackAlt,\r\n onCaptionGenerated,\r\n disableAI: propsDisableAI,\r\n announceLive,\r\n });\r\n return (\r\n <>\r\n {announceLive && (\r\n <span style={SR_ONLY_STYLE} aria-live=\"polite\" aria-atomic=\"true\">\r\n {isGenerating\r\n ? \"Generating image description. Please wait...\"\r\n : generatedAlt\r\n ? `Image description generated: ${generatedAlt}`\r\n : \"\"}\r\n </span>\r\n )}\r\n\r\n <Image src={src} alt={generatedAlt || fallbackAlt} aria-busy={isGenerating} {...props} />\r\n </>\r\n );\r\n};\r\n","import { StaticImport } from \"next/dist/shared/lib/get-img-props\";\r\nimport { StaticImageData } from \"next/image\";\r\nimport { createContext, ImgHTMLAttributes, useContext, useEffect, useRef, useState } from \"react\";\r\n\r\nexport interface UseAICaptionOptions {\r\n src?: string | StaticImport;\r\n alt?: string;\r\n apiEndpoint?: string;\r\n fallbackAlt?: string;\r\n onCaptionGenerated?: (caption: string) => void;\r\n disableAI?: boolean;\r\n announceLive?: boolean;\r\n onCaptionError?: (error: Error) => void;\r\n}\r\n\r\ninterface SmartImageContextProps {\r\n apiEndpoint?: string;\r\n disableAI?: boolean;\r\n}\r\n\r\nexport const SmartImageContext = createContext<SmartImageContextProps | undefined>(undefined);\r\n\r\nconst MAX_SIZE = 500;\r\n\r\nclass LRUCaptionCache {\r\n private cache = new Map<string, string>();\r\n\r\n get(key: string): string | undefined {\r\n return this.cache.get(key);\r\n }\r\n set(key: string, value: string) {\r\n if (this.cache.size >= MAX_SIZE) {\r\n this.cache.delete(this.cache.keys().next().value!);\r\n }\r\n this.cache.set(key, value);\r\n }\r\n has(key: string) {\r\n return this.cache.has(key);\r\n }\r\n clear() {\r\n this.cache.clear();\r\n }\r\n}\r\n\r\nconst captionCache = new LRUCaptionCache();\r\nconst pendingRequestCache = new Map<string, Promise<string>>();\r\n\r\nexport interface SmartImageProps extends ImgHTMLAttributes<HTMLImageElement> {\r\n apiEndpoint?: string;\r\n fallbackAlt?: string;\r\n onCaptionGenerated?: (caption: string) => void;\r\n disableAI?: boolean;\r\n announceLive?: boolean;\r\n}\r\n\r\nfunction isStaticImageData(src: string | StaticImport): src is StaticImageData {\r\n return typeof src === \"object\" && src !== null && \"src\" in src;\r\n}\r\n\r\nfunction resolveImageUrl(src: string | StaticImport): string {\r\n if (typeof src === \"string\") return src;\r\n if (isStaticImageData(src)) return src.src;\r\n return src.default.src;\r\n}\r\n\r\nconst log = process.env.NODE_ENV === \"development\" ? console.log : () => {};\r\n\r\nexport const useAICaptions = ({\r\n src,\r\n alt,\r\n apiEndpoint: propsEndpoint,\r\n fallbackAlt = \"Image loading or caption unavailable\",\r\n onCaptionGenerated,\r\n disableAI: propsDisableAI,\r\n onCaptionError,\r\n}: UseAICaptionOptions) => {\r\n const context = useContext(SmartImageContext);\r\n\r\n const apiEndpoint = propsEndpoint || context?.apiEndpoint;\r\n const disableAI = propsDisableAI ?? context?.disableAI ?? false;\r\n\r\n const [generatedAlt, setGeneratedAlt] = useState(\"\");\r\n const [isGenerating, setIsGenerating] = useState(false);\r\n const [error, setError] = useState<Error | null>(null);\r\n\r\n const onCaptionGeneratedRef = useRef(onCaptionGenerated);\r\n const onCaptionErrorRef = useRef(onCaptionError);\r\n\r\n useEffect(() => {\r\n onCaptionGeneratedRef.current = onCaptionGenerated;\r\n onCaptionErrorRef.current = onCaptionError;\r\n });\r\n\r\n useEffect(() => {\r\n setError(null);\r\n\r\n if (alt) {\r\n setGeneratedAlt(alt);\r\n return;\r\n }\r\n\r\n if (!src) return;\r\n\r\n if (disableAI) {\r\n setGeneratedAlt(\"[Testing mode: AI caption generation disabled]\");\r\n return;\r\n }\r\n\r\n if (!apiEndpoint) {\r\n console.warn(\r\n \"[SmartImage] Missing 'apiEndpoint' prop. Please provide a backend API URL via props or SmartImageProvider to enable AI caption generation.\",\r\n );\r\n setGeneratedAlt(fallbackAlt);\r\n return;\r\n }\r\n\r\n const imageUrl = resolveImageUrl(src);\r\n\r\n if (captionCache.has(imageUrl)) {\r\n log(\"[SmartImage] Cache hit: Reusing existing caption.\");\r\n const cachedCaption = captionCache.get(imageUrl)!;\r\n setGeneratedAlt(cachedCaption);\r\n if (onCaptionGeneratedRef.current) onCaptionGeneratedRef.current(cachedCaption);\r\n return;\r\n }\r\n\r\n let cancelled = false;\r\n\r\n const generateCaption = async () => {\r\n setIsGenerating(true);\r\n try {\r\n if (pendingRequestCache.has(imageUrl)) {\r\n log(\"[SmartImage] Pending request detected. Waiting for the existing API call to complete.\");\r\n const caption = await pendingRequestCache.get(imageUrl)!;\r\n if (cancelled) return;\r\n setGeneratedAlt(caption);\r\n if (onCaptionGeneratedRef.current) onCaptionGeneratedRef.current(caption);\r\n return;\r\n }\r\n\r\n const fetchPromise = (async () => {\r\n const imageResponse = await fetch(imageUrl);\r\n const imageBlob = await imageResponse.blob();\r\n const imageFile = new File([imageBlob], \"image.jpg\", {\r\n type: imageBlob.type || \"image/jpeg\",\r\n });\r\n const formData = new FormData();\r\n formData.append(\"file\", imageFile);\r\n\r\n const response = await fetch(apiEndpoint, {\r\n method: \"POST\",\r\n body: formData,\r\n });\r\n\r\n if (!response.ok) throw new Error(\"AI API request failed\");\r\n const data = await response.json();\r\n if (data.caption) return data.caption;\r\n throw new Error(\"No caption returned from the API.\");\r\n })();\r\n\r\n pendingRequestCache.set(imageUrl, fetchPromise);\r\n\r\n const newCaption = await fetchPromise;\r\n pendingRequestCache.delete(imageUrl);\r\n captionCache.set(imageUrl, newCaption);\r\n\r\n if (cancelled) return;\r\n setGeneratedAlt(newCaption);\r\n if (onCaptionGeneratedRef.current) onCaptionGeneratedRef.current(newCaption);\r\n } catch (err) {\r\n const normalizedError = err instanceof Error ? err : new Error(\"Unknown error\");\r\n pendingRequestCache.delete(imageUrl);\r\n if (cancelled) return;\r\n setError(normalizedError);\r\n setGeneratedAlt(fallbackAlt);\r\n if (onCaptionErrorRef.current) onCaptionErrorRef.current(normalizedError);\r\n } finally {\r\n if (!cancelled) setIsGenerating(false);\r\n }\r\n };\r\n\r\n generateCaption();\r\n\r\n return () => {\r\n cancelled = true;\r\n };\r\n }, [src, alt, apiEndpoint, fallbackAlt, disableAI]);\r\n\r\n return { generatedAlt, isGenerating, error };\r\n};\r\n"],"mappings":";;;AAGA,OAAO,WAA2B;;;ACDlC,SAAS,eAAkC,YAAY,WAAW,QAAQ,gBAAgB;AAkBnF,IAAM,oBAAoB,cAAkD,MAAS;AAE5F,IAAM,WAAW;AAEjB,IAAM,kBAAN,MAAsB;AAAA,EAAtB;AACE,SAAQ,QAAQ,oBAAI,IAAoB;AAAA;AAAA,EAExC,IAAI,KAAiC;AACnC,WAAO,KAAK,MAAM,IAAI,GAAG;AAAA,EAC3B;AAAA,EACA,IAAI,KAAa,OAAe;AAC9B,QAAI,KAAK,MAAM,QAAQ,UAAU;AAC/B,WAAK,MAAM,OAAO,KAAK,MAAM,KAAK,EAAE,KAAK,EAAE,KAAM;AAAA,IACnD;AACA,SAAK,MAAM,IAAI,KAAK,KAAK;AAAA,EAC3B;AAAA,EACA,IAAI,KAAa;AACf,WAAO,KAAK,MAAM,IAAI,GAAG;AAAA,EAC3B;AAAA,EACA,QAAQ;AACN,SAAK,MAAM,MAAM;AAAA,EACnB;AACF;AAEA,IAAM,eAAe,IAAI,gBAAgB;AACzC,IAAM,sBAAsB,oBAAI,IAA6B;AAU7D,SAAS,kBAAkB,KAAoD;AAC7E,SAAO,OAAO,QAAQ,YAAY,QAAQ,QAAQ,SAAS;AAC7D;AAEA,SAAS,gBAAgB,KAAoC;AAC3D,MAAI,OAAO,QAAQ,SAAU,QAAO;AACpC,MAAI,kBAAkB,GAAG,EAAG,QAAO,IAAI;AACvC,SAAO,IAAI,QAAQ;AACrB;AAEA,IAAM,MAAM,QAAQ,IAAI,aAAa,gBAAgB,QAAQ,MAAM,MAAM;AAAC;AAEnE,IAAM,gBAAgB,CAAC;AAAA,EAC5B;AAAA,EACA;AAAA,EACA,aAAa;AAAA,EACb,cAAc;AAAA,EACd;AAAA,EACA,WAAW;AAAA,EACX;AACF,MAA2B;AACzB,QAAM,UAAU,WAAW,iBAAiB;AAE5C,QAAM,cAAc,iBAAiB,SAAS;AAC9C,QAAM,YAAY,kBAAkB,SAAS,aAAa;AAE1D,QAAM,CAAC,cAAc,eAAe,IAAI,SAAS,EAAE;AACnD,QAAM,CAAC,cAAc,eAAe,IAAI,SAAS,KAAK;AACtD,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAuB,IAAI;AAErD,QAAM,wBAAwB,OAAO,kBAAkB;AACvD,QAAM,oBAAoB,OAAO,cAAc;AAE/C,YAAU,MAAM;AACd,0BAAsB,UAAU;AAChC,sBAAkB,UAAU;AAAA,EAC9B,CAAC;AAED,YAAU,MAAM;AACd,aAAS,IAAI;AAEb,QAAI,KAAK;AACP,sBAAgB,GAAG;AACnB;AAAA,IACF;AAEA,QAAI,CAAC,IAAK;AAEV,QAAI,WAAW;AACb,sBAAgB,gDAAgD;AAChE;AAAA,IACF;AAEA,QAAI,CAAC,aAAa;AAChB,cAAQ;AAAA,QACN;AAAA,MACF;AACA,sBAAgB,WAAW;AAC3B;AAAA,IACF;AAEA,UAAM,WAAW,gBAAgB,GAAG;AAEpC,QAAI,aAAa,IAAI,QAAQ,GAAG;AAC9B,UAAI,mDAAmD;AACvD,YAAM,gBAAgB,aAAa,IAAI,QAAQ;AAC/C,sBAAgB,aAAa;AAC7B,UAAI,sBAAsB,QAAS,uBAAsB,QAAQ,aAAa;AAC9E;AAAA,IACF;AAEA,QAAI,YAAY;AAEhB,UAAM,kBAAkB,YAAY;AAClC,sBAAgB,IAAI;AACpB,UAAI;AACF,YAAI,oBAAoB,IAAI,QAAQ,GAAG;AACrC,cAAI,uFAAuF;AAC3F,gBAAM,UAAU,MAAM,oBAAoB,IAAI,QAAQ;AACtD,cAAI,UAAW;AACf,0BAAgB,OAAO;AACvB,cAAI,sBAAsB,QAAS,uBAAsB,QAAQ,OAAO;AACxE;AAAA,QACF;AAEA,cAAM,gBAAgB,YAAY;AAChC,gBAAM,gBAAgB,MAAM,MAAM,QAAQ;AAC1C,gBAAM,YAAY,MAAM,cAAc,KAAK;AAC3C,gBAAM,YAAY,IAAI,KAAK,CAAC,SAAS,GAAG,aAAa;AAAA,YACnD,MAAM,UAAU,QAAQ;AAAA,UAC1B,CAAC;AACD,gBAAM,WAAW,IAAI,SAAS;AAC9B,mBAAS,OAAO,QAAQ,SAAS;AAEjC,gBAAM,WAAW,MAAM,MAAM,aAAa;AAAA,YACxC,QAAQ;AAAA,YACR,MAAM;AAAA,UACR,CAAC;AAED,cAAI,CAAC,SAAS,GAAI,OAAM,IAAI,MAAM,uBAAuB;AACzD,gBAAM,OAAO,MAAM,SAAS,KAAK;AACjC,cAAI,KAAK,QAAS,QAAO,KAAK;AAC9B,gBAAM,IAAI,MAAM,mCAAmC;AAAA,QACrD,GAAG;AAEH,4BAAoB,IAAI,UAAU,YAAY;AAE9C,cAAM,aAAa,MAAM;AACzB,4BAAoB,OAAO,QAAQ;AACnC,qBAAa,IAAI,UAAU,UAAU;AAErC,YAAI,UAAW;AACf,wBAAgB,UAAU;AAC1B,YAAI,sBAAsB,QAAS,uBAAsB,QAAQ,UAAU;AAAA,MAC7E,SAAS,KAAK;AACZ,cAAM,kBAAkB,eAAe,QAAQ,MAAM,IAAI,MAAM,eAAe;AAC9E,4BAAoB,OAAO,QAAQ;AACnC,YAAI,UAAW;AACf,iBAAS,eAAe;AACxB,wBAAgB,WAAW;AAC3B,YAAI,kBAAkB,QAAS,mBAAkB,QAAQ,eAAe;AAAA,MAC1E,UAAE;AACA,YAAI,CAAC,UAAW,iBAAgB,KAAK;AAAA,MACvC;AAAA,IACF;AAEA,oBAAgB;AAEhB,WAAO,MAAM;AACX,kBAAY;AAAA,IACd;AAAA,EACF,GAAG,CAAC,KAAK,KAAK,aAAa,aAAa,SAAS,CAAC;AAElD,SAAO,EAAE,cAAc,cAAc,MAAM;AAC7C;;;AD7II,mBAEI,KAFJ;AAhCG,IAAM,gBAAqC;AAAA,EAChD,UAAU;AAAA,EACV,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,UAAU;AAAA,EACV,MAAM;AAAA,EACN,YAAY;AAAA,EACZ,aAAa;AACf;AACO,IAAM,iBAAiB,CAAC;AAAA,EAC7B;AAAA,EACA;AAAA,EACA,aAAa;AAAA,EACb,cAAc;AAAA,EACd;AAAA,EACA;AAAA,EACA,WAAW;AAAA,EACX,eAAe;AAAA,EACf,GAAG;AACL,MAA2B;AACzB,QAAM,EAAE,cAAc,aAAa,IAAI,cAAc;AAAA,IACnD;AAAA,IACA;AAAA,IACA,aAAa;AAAA,IACb;AAAA,IACA;AAAA,IACA,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AACD,SACE,iCACG;AAAA,oBACC,oBAAC,UAAK,OAAO,eAAe,aAAU,UAAS,eAAY,QACxD,yBACG,iDACA,eACE,gCAAgC,YAAY,KAC5C,IACR;AAAA,IAGF,oBAAC,SAAM,KAAU,KAAK,gBAAgB,aAAa,aAAW,cAAe,GAAG,OAAO;AAAA,KACzF;AAEJ;","names":[]}
@@ -0,0 +1,30 @@
1
+ import { StaticImport } from "next/dist/shared/lib/get-img-props";
2
+ import { ImgHTMLAttributes } from "react";
3
+ export interface UseAICaptionOptions {
4
+ src?: string | StaticImport;
5
+ alt?: string;
6
+ apiEndpoint?: string;
7
+ fallbackAlt?: string;
8
+ onCaptionGenerated?: (caption: string) => void;
9
+ disableAI?: boolean;
10
+ announceLive?: boolean;
11
+ onCaptionError?: (error: Error) => void;
12
+ }
13
+ interface SmartImageContextProps {
14
+ apiEndpoint?: string;
15
+ disableAI?: boolean;
16
+ }
17
+ export declare const SmartImageContext: import("react").Context<SmartImageContextProps | undefined>;
18
+ export interface SmartImageProps extends ImgHTMLAttributes<HTMLImageElement> {
19
+ apiEndpoint?: string;
20
+ fallbackAlt?: string;
21
+ onCaptionGenerated?: (caption: string) => void;
22
+ disableAI?: boolean;
23
+ announceLive?: boolean;
24
+ }
25
+ export declare const useAICaptions: ({ src, alt, apiEndpoint: propsEndpoint, fallbackAlt, onCaptionGenerated, disableAI: propsDisableAI, onCaptionError, }: UseAICaptionOptions) => {
26
+ generatedAlt: string;
27
+ isGenerating: boolean;
28
+ error: Error | null;
29
+ };
30
+ export {};
package/package.json CHANGED
@@ -1,41 +1,70 @@
1
- {
2
- "name": "react-a11y-auto-caption",
3
- "version": "1.0.1",
4
- "description": "Smart React component that automatically generates alt text for images using AI.",
5
- "main": "./dist/index.js",
6
- "module": "./dist/index.mjs",
7
- "types": "./dist/index.d.ts",
8
- "scripts": {
9
- "build": "tsup && tsc --emitDeclarationOnly --declaration --declarationDir ./dist",
10
- "dev": "tsup --watch"
11
- },
12
- "keywords": [
13
- "react",
14
- "accessibility",
15
- "a11y",
16
- "ai",
17
- "image-captioning",
18
- "alt-text"
19
- ],
20
- "author": "Gaeun Kim",
21
- "license": "MIT",
22
- "devDependencies": {
23
- "@types/react": "^19.2.14",
24
- "@types/react-dom": "^19.2.3",
25
- "react": "^19.2.5",
26
- "react-dom": "^19.2.5",
27
- "tsup": "^8.5.1",
28
- "typescript": "^6.0.2",
29
- "next": "^15.0.0"
30
- },
31
- "peerDependencies": {
32
- "react": ">=18.0.0",
33
- "react-dom": ">=18.0.0",
34
- "next": ">=13.0.0"
35
- },
36
- "peerDependenciesMeta": {
37
- "next": {
38
- "optional": true
39
- }
40
- }
41
- }
1
+ {
2
+ "name": "react-a11y-auto-caption",
3
+ "version": "1.0.4",
4
+ "description": "Smart React component that automatically generates alt text for images using AI.",
5
+ "main": "./dist/index.js",
6
+ "module": "./dist/index.mjs",
7
+ "types": "./dist/index.d.ts",
8
+ "keywords": [
9
+ "react",
10
+ "accessibility",
11
+ "a11y",
12
+ "alt-text",
13
+ "image-caption",
14
+ "caption-generator",
15
+ "screen-reader",
16
+ "nextjs"
17
+ ],
18
+ "homepage": "https://github.com/kong33/react-a11y-auto-caption#readme",
19
+ "repository": {
20
+ "type": "git",
21
+ "url": "https://github.com/kong33/react-a11y-auto-caption"
22
+ },
23
+ "bugs": {
24
+ "url": "https://github.com/kong33/react-a11y-auto-caption/issues"
25
+ },
26
+ "exports": {
27
+ ".": {
28
+ "import": "./dist/index.js",
29
+ "types": "./dist/index.d.ts"
30
+ },
31
+ "./next": {
32
+ "import": "./dist/next.js",
33
+ "types": "./dist/next.d.ts"
34
+ }
35
+ },
36
+ "scripts": {
37
+ "build": "tsup && tsc --emitDeclarationOnly --declaration --declarationDir ./dist",
38
+ "dev": "tsup --watch"
39
+ },
40
+ "author": "Gaeun Kim",
41
+ "license": "MIT",
42
+ "devDependencies": {
43
+ "@types/node": "^25.6.0",
44
+ "@types/react": "^19.2.14",
45
+ "@types/react-dom": "^19.2.3",
46
+ "next": "^15.0.0",
47
+ "react": "^19.2.5",
48
+ "react-dom": "^19.2.5",
49
+ "tsup": "^8.5.1",
50
+ "typescript": "^6.0.2"
51
+ },
52
+ "peerDependencies": {
53
+ "next": ">=13.0.0",
54
+ "react": ">=18.0.0",
55
+ "react-dom": ">=18.0.0"
56
+ },
57
+ "peerDependenciesMeta": {
58
+ "next": {
59
+ "optional": true
60
+ }
61
+ },
62
+ "files": [
63
+ "dist",
64
+ "README.md",
65
+ "LICENSE"
66
+ ],
67
+ "publishConfig": {
68
+ "access": "public"
69
+ }
70
+ }
package/src/index.tsx DELETED
@@ -1,161 +0,0 @@
1
- import React, { createContext, useContext, useState, useEffect, ImgHTMLAttributes } from "react";
2
-
3
- interface SmartImageContextProps {
4
- apiEndpoint?: string;
5
- disableAI?: boolean;
6
- }
7
-
8
- export const SmartImageContext = createContext<SmartImageContextProps | undefined>(undefined);
9
-
10
- export const SmartImageProvider: React.FC<{
11
- value: SmartImageContextProps;
12
- children: React.ReactNode;
13
- }> = ({ value, children }) => {
14
- return <SmartImageContext.Provider value={value}>{children}</SmartImageContext.Provider>;
15
- };
16
-
17
- const captionCache = new Map<string, string>();
18
- const pendingRequestCache = new Map<string, Promise<string>>();
19
-
20
- export interface SmartImageProps extends ImgHTMLAttributes<HTMLImageElement> {
21
- apiEndpoint?: string;
22
- fallbackAlt?: string;
23
- onCaptionGenerated?: (caption: string) => void;
24
- disableAI?: boolean;
25
- announceLive?: boolean;
26
- }
27
-
28
- export const SmartImage = ({
29
- src,
30
- alt,
31
- apiEndpoint: propsEndpoint,
32
- fallbackAlt = "Image loading or caption unavailable",
33
- onCaptionGenerated,
34
- disableAI: propsDisableAI,
35
- announceLive = false,
36
- ...props
37
- }: SmartImageProps) => {
38
- const context = useContext(SmartImageContext);
39
-
40
- const apiEndpoint = propsEndpoint || context?.apiEndpoint;
41
- const disableAI = propsDisableAI ?? context?.disableAI ?? false;
42
-
43
- const [generatedAlt, setGeneratedAlt] = useState("");
44
- const [isGenerating, setIsGenerating] = useState(false);
45
-
46
- useEffect(() => {
47
- if (alt) {
48
- setGeneratedAlt(alt);
49
- return;
50
- }
51
-
52
- if (!src) return;
53
-
54
- if (disableAI) {
55
- setGeneratedAlt("[Testing mode: AI caption generation disabled]");
56
- return;
57
- }
58
-
59
- if (!apiEndpoint) {
60
- console.warn(
61
- "[SmartImage] Missing 'apiEndpoint' prop. Please provide a backend API URL via props or SmartImageProvider to enable AI caption generation.",
62
- );
63
- setGeneratedAlt(fallbackAlt);
64
- return;
65
- }
66
-
67
- const imageUrl = src as string;
68
-
69
- if (captionCache.has(imageUrl)) {
70
- console.log("[SmartImage] Cache hit: Reusing existing caption.");
71
- const cachedCaption = captionCache.get(imageUrl)!;
72
- setGeneratedAlt(cachedCaption);
73
-
74
- if (onCaptionGenerated) onCaptionGenerated(cachedCaption);
75
- return;
76
- }
77
-
78
- const generateCaption = async () => {
79
- setIsGenerating(true);
80
- try {
81
- if (pendingRequestCache.has(imageUrl)) {
82
- console.log("[SmartImage] Pending request detected. Waiting for the existing API call to complete.");
83
- const caption = await pendingRequestCache.get(imageUrl)!;
84
- setGeneratedAlt(caption);
85
- if (onCaptionGenerated) onCaptionGenerated(caption);
86
- return;
87
- }
88
-
89
- const fetchPromise = (async () => {
90
- const imageResponse = await fetch(imageUrl);
91
- const imageBlob = await imageResponse.blob();
92
-
93
- const imageFile = new File([imageBlob], "image.jpg", {
94
- type: imageBlob.type || "image/jpeg",
95
- });
96
- const formData = new FormData();
97
-
98
- formData.append("file", imageFile);
99
-
100
- const response = await fetch(apiEndpoint, {
101
- method: "POST",
102
- body: formData,
103
- });
104
-
105
- if (!response.ok) throw new Error("AI API request failed");
106
- const data = await response.json();
107
-
108
- if (data.caption) return data.caption;
109
- throw new Error("No caption returned from the API.");
110
- })();
111
-
112
- pendingRequestCache.set(imageUrl, fetchPromise);
113
-
114
- const newCaption = await fetchPromise;
115
-
116
- pendingRequestCache.delete(imageUrl);
117
- captionCache.set(imageUrl, newCaption);
118
-
119
- setGeneratedAlt(newCaption);
120
-
121
- if (onCaptionGenerated) onCaptionGenerated(newCaption);
122
- } catch (error) {
123
- console.error("[SmartImage] Caption Error:", error);
124
- pendingRequestCache.delete(imageUrl);
125
- setGeneratedAlt(fallbackAlt);
126
- } finally {
127
- setIsGenerating(false);
128
- }
129
- };
130
-
131
- generateCaption();
132
- }, [src, alt, apiEndpoint, fallbackAlt, onCaptionGenerated, disableAI]);
133
-
134
- const srOnlyStyle: React.CSSProperties = {
135
- position: "absolute",
136
- width: "1px",
137
- height: "1px",
138
- padding: 0,
139
- margin: "-1px",
140
- overflow: "hidden",
141
- clip: "rect(0, 0, 0, 0)",
142
- whiteSpace: "nowrap",
143
- borderWidth: 0,
144
- };
145
-
146
- return (
147
- <>
148
- {announceLive && (
149
- <span style={srOnlyStyle} aria-live="polite" aria-atomic="true">
150
- {isGenerating
151
- ? "Generating image description. Please wait..."
152
- : generatedAlt
153
- ? `Image description generated: ${generatedAlt}`
154
- : ""}
155
- </span>
156
- )}
157
-
158
- <img src={src} alt={generatedAlt} aria-busy={isGenerating} {...props} />
159
- </>
160
- );
161
- };
package/src/next-env.d.ts DELETED
@@ -1,2 +0,0 @@
1
- /// <reference types="next" />
2
- /// <reference types="next/image-types/global" />
package/src/next.tsx DELETED
@@ -1,154 +0,0 @@
1
- import React, { useState, useEffect, useContext } from "react";
2
- import Image, { ImageProps } from "next/image";
3
-
4
- import { SmartImageContext } from "./index";
5
-
6
- function isStaticImport(source: any): source is { src: string } {
7
- return typeof source === "object" && source !== null && "src" in source;
8
- }
9
-
10
- const captionCache = new Map<string, string>();
11
- const pendingRequestCache = new Map<string, Promise<string>>();
12
-
13
- export interface SmartNextImageProps extends Omit<ImageProps, "alt"> {
14
- alt?: string;
15
- apiEndpoint?: string;
16
- fallbackAlt?: string;
17
- onCaptionGenerated?: (caption: string) => void;
18
- disableAI?: boolean;
19
- announceLive?: boolean;
20
- }
21
-
22
- export const SmartNextImage = ({
23
- src,
24
- alt,
25
- apiEndpoint: propsEndpoint,
26
- fallbackAlt = "Image loading or caption unavailable",
27
- onCaptionGenerated,
28
- disableAI: propsDisableAI,
29
- announceLive = false,
30
- ...props
31
- }: SmartNextImageProps) => {
32
- const context = useContext(SmartImageContext);
33
- const apiEndpoint = propsEndpoint || context?.apiEndpoint;
34
- const disableAI = propsDisableAI ?? context?.disableAI ?? false;
35
-
36
- const [generatedAlt, setGeneratedAlt] = useState("");
37
- const [isGenerating, setIsGenerating] = useState(false);
38
-
39
- const imageUrl = isStaticImport(src) ? src.src : (src as string);
40
-
41
- useEffect(() => {
42
- if (alt) {
43
- setGeneratedAlt(alt);
44
- return;
45
- }
46
-
47
- if (!src) return;
48
-
49
- if (disableAI) {
50
- setGeneratedAlt("[Testing mode: AI caption generation disabled]");
51
- return;
52
- }
53
-
54
- if (!apiEndpoint) {
55
- console.warn(
56
- "[SmartNextImage] Missing 'apiEndpoint' prop. Please provide a backend API URL via props or SmartImageProvider to enable AI caption generation.",
57
- );
58
- setGeneratedAlt(fallbackAlt);
59
- return;
60
- }
61
-
62
- if (captionCache.has(imageUrl)) {
63
- console.log("[SmartNextImage] Cache hit: Reusing existing caption.");
64
- const cachedCaption = captionCache.get(imageUrl)!;
65
- setGeneratedAlt(cachedCaption);
66
-
67
- if (onCaptionGenerated) onCaptionGenerated(cachedCaption);
68
- return;
69
- }
70
-
71
- const generateCaption = async () => {
72
- setIsGenerating(true);
73
- try {
74
- if (pendingRequestCache.has(imageUrl)) {
75
- console.log("[SmartNextImage] Pending request detected. Waiting for the existing API call to complete.");
76
- const caption = await pendingRequestCache.get(imageUrl)!;
77
- setGeneratedAlt(caption);
78
- if (onCaptionGenerated) onCaptionGenerated(caption);
79
- return;
80
- }
81
-
82
- const fetchPromise = (async () => {
83
- const imageResponse = await fetch(imageUrl);
84
- const imageBlob = await imageResponse.blob();
85
-
86
- const imageFile = new File([imageBlob], "image.jpg", {
87
- type: imageBlob.type || "image/jpeg",
88
- });
89
- const formData = new FormData();
90
-
91
- formData.append("file", imageFile);
92
-
93
- const response = await fetch(apiEndpoint, {
94
- method: "POST",
95
- body: formData,
96
- });
97
-
98
- if (!response.ok) throw new Error("AI API request failed");
99
- const data = await response.json();
100
-
101
- if (data.caption) return data.caption;
102
- throw new Error("No caption returned from the API.");
103
- })();
104
-
105
- pendingRequestCache.set(imageUrl, fetchPromise);
106
-
107
- const newCaption = await fetchPromise;
108
-
109
- pendingRequestCache.delete(imageUrl);
110
- captionCache.set(imageUrl, newCaption);
111
-
112
- setGeneratedAlt(newCaption);
113
-
114
- if (onCaptionGenerated) onCaptionGenerated(newCaption);
115
- } catch (error) {
116
- console.error("[SmartNextImage] Caption Error:", error);
117
- pendingRequestCache.delete(imageUrl);
118
- setGeneratedAlt(fallbackAlt);
119
- } finally {
120
- setIsGenerating(false);
121
- }
122
- };
123
-
124
- generateCaption();
125
- }, [src, alt, apiEndpoint, fallbackAlt, onCaptionGenerated, disableAI, imageUrl]);
126
-
127
- const srOnlyStyle: React.CSSProperties = {
128
- position: "absolute",
129
- width: "1px",
130
- height: "1px",
131
- padding: 0,
132
- margin: "-1px",
133
- overflow: "hidden",
134
- clip: "rect(0, 0, 0, 0)",
135
- whiteSpace: "nowrap",
136
- borderWidth: 0,
137
- };
138
-
139
- return (
140
- <>
141
- {announceLive && (
142
- <span style={srOnlyStyle} aria-live="polite" aria-atomic="true">
143
- {isGenerating
144
- ? "Generating image description. Please wait..."
145
- : generatedAlt
146
- ? `Image description generated: ${generatedAlt}`
147
- : ""}
148
- </span>
149
- )}
150
-
151
- <Image src={src} alt={generatedAlt || ""} aria-busy={isGenerating} {...props} />
152
- </>
153
- );
154
- };
package/tsconfig.json DELETED
@@ -1,19 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "rootDir": "./src",
4
- "target": "es2020",
5
- "lib": ["dom", "dom.iterable", "esnext"],
6
- "allowJs": false,
7
- "skipLibCheck": true,
8
- "esModuleInterop": true,
9
- "allowSyntheticDefaultImports": true,
10
- "strict": true,
11
- "forceConsistentCasingInFileNames": true,
12
- "module": "esnext",
13
- "moduleResolution": "bundler",
14
- "resolveJsonModule": true,
15
- "isolatedModules": true,
16
- "jsx": "react-jsx"
17
- },
18
- "include": ["src"]
19
- }
package/tsup.config.ts DELETED
@@ -1,11 +0,0 @@
1
- import { defineConfig } from "tsup";
2
-
3
- export default defineConfig({
4
- entry: ["src/index.tsx", "src/next.tsx"],
5
- format: ["cjs", "esm"],
6
- dts: false,
7
- splitting: false,
8
- sourcemap: true,
9
- clean: true,
10
- external: ["react", "react-dom"],
11
- });