@xsai/generate-image 0.2.0-beta.5 → 0.2.0

package/dist/index.d.ts

@@ -9,6 +9,14 @@ interface GenerateImageOptions extends CommonRequestOptions {
     n?: number;
     /** A text description of the desired image(s). */
     prompt: string;
+    /**
+     * The format in which generated images with `dall-e-2` and `dall-e-3` are returned from the API.
+     * `gpt-image-1` only supports `b64_json`, and `url` will be ignored.
+     *
+     * Images will always be Base64-encoded in the result. If `url` is used, the images will be
+     * fetched upon receiving the response.
+     */
+    responseFormat?: 'b64_json' | 'url';
     /**
      * The size of the generated images.
      * @default `1024x1024`
@@ -18,8 +26,20 @@ interface GenerateImageOptions extends CommonRequestOptions {
 interface GenerateImageResponse {
     created: number;
     data: {
-        b64_json: string;
+        /**
+         * The Bse64-encoded JSON of the generated image. Default value for `gpt-image-1`, and only
+         * present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`.
+         */
+        b64_json?: string;
+        /**
+         * For `dall-e-3` only, the revised prompt that was used to generate the image.
+         */
         revised_prompt?: string;
+        /**
+         * When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is
+         * set to `url` (default value). Unsupported for `gpt-image-1`.
+         */
+        url?: string;
     }[];
 }
 interface GenerateImageResult {

package/dist/index.js

@@ -1,4 +1,4 @@
-import { requestURL, requestHeaders, requestBody, responseJSON } from '@xsai/shared';
+import { requestURL, requestHeaders, requestBody, responseJSON, responseCatch } from '@xsai/shared';
 
 const mimeTypes = {
   "/9j/": "image/jpg",
@@ -16,20 +16,48 @@ const convertImage = (b64_json) => {
     mimeType
   };
 };
+const responseBlobAsDataURL = async (res) => responseCatch(res).then(async (res2) => {
+  const blob = await res2.blob();
+  try {
+    return await new Promise((resolve, reject) => {
+      const reader = new FileReader();
+      reader.onloadend = () => resolve(reader.result);
+      reader.onerror = reject;
+      reader.readAsDataURL(blob);
+    });
+  } catch {
+    throw new Error(`Failed to parse response blob, response URL: ${res2.url}`);
+  }
+});
 const generateImage = async (options) => (options.fetch ?? globalThis.fetch)(requestURL("images/generations", options.baseURL), {
-  body: requestBody({
-    ...options,
-    responseFormat: "b64_json"
-  }),
+  body: requestBody(options),
   headers: requestHeaders({
     "Content-Type": "application/json",
     ...options.headers
   }, options.apiKey),
   method: "POST",
   signal: options.abortSignal
-}).then(responseJSON).then(({ data }) => {
-  const images = data.map(({ b64_json }) => convertImage(b64_json));
-  return { image: images[0], images };
-});
+}).then(responseJSON).then(
+  async ({ data }) => Promise.all(
+    data.map(async (img, i) => {
+      if (typeof img.b64_json === "string") {
+        return convertImage(img.b64_json);
+      }
+      if (typeof img.url === "string") {
+        return (options.fetch ?? globalThis.fetch)(new URL(img.url), {
+          signal: options.abortSignal
+        }).then(responseBlobAsDataURL).then((dataURL) => {
+          const sepIndex = dataURL.indexOf(";");
+          const mimeType = dataURL.substring(5, sepIndex);
+          return {
+            base64: dataURL,
+            mimeType
+          };
+        });
+      }
+      throw new Error(`Unrecognized image at index ${i}: ${JSON.stringify(img)}`);
+    })
+  )
+).then((images) => ({ image: images[0], images }));
 
 export { generateImage };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xsai/generate-image",
   "type": "module",
-  "version": "0.2.0-beta.5",
+  "version": "0.2.0",
   "description": "extra-small AI SDK.",
   "author": "Moeru AI",
   "license": "MIT",