@xyo-network/image-thumbnail-plugin 2.99.5 → 3.0.0

package/dist/node/index.d.ts

@@ -1,4 +1,92 @@
-export { ImageThumbnailPlugin as default, ImageThumbnailPlugin } from './Plugin.ts';
-export * from './Witness/index.ts';
+import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
+import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Schema } from '@xyo-network/payload-model';
+import * as _store__xyo_network_account_model_virtual_3afa553815_package from '.store/@xyo-network-account-model-virtual-3afa553815/package';
+import * as _store__xylabs_object_npm_4_0_0_ffd6151301_package from '.store/@xylabs-object-npm-4.0.0-ffd6151301/package';
+import { ImageThumbnailDiviner } from '@xyo-network/diviner-image-thumbnail';
 export * from '@xyo-network/diviner-image-thumbnail';
-//# sourceMappingURL=index.d.ts.map
+import { AbstractWitness } from '@xyo-network/abstract-witness';
+import { ImageThumbnail } from '@xyo-network/image-thumbnail-payload-plugin';
+import { UrlPayload } from '@xyo-network/url-payload-plugin';
+
+declare const ImageThumbnailWitnessConfigSchema: "network.xyo.image.thumbnail.witness.config";
+type ImageThumbnailWitnessConfigSchema = typeof ImageThumbnailWitnessConfigSchema;
+type ImageThumbnailEncoding = 'PNG' | 'JPG' | 'GIF';
+type ImageThumbnailWitnessConfig = WitnessConfig<{
+    dataUrlPassthrough?: boolean;
+    encoding?: ImageThumbnailEncoding;
+    height?: number;
+    ipfsGateway?: string;
+    maxAsyncProcesses?: number;
+    maxCacheBytes?: number;
+    maxCacheEntries?: number;
+    quality?: number;
+    runExclusive?: boolean;
+    schema: ImageThumbnailWitnessConfigSchema;
+    width?: number;
+}>;
+
+type ImageThumbnailWitnessParams = WitnessParams<AnyConfigSchema<ImageThumbnailWitnessConfig>, {
+    loaders?: string[];
+}>;
+
+interface ImageThumbnailWitnessError extends Error {
+    name: 'ImageThumbnailWitnessError';
+    url: string;
+}
+interface DnsError extends Error {
+    code: string;
+}
+declare class ImageThumbnailWitness<TParams extends ImageThumbnailWitnessParams = ImageThumbnailWitnessParams> extends AbstractWitness<TParams> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    private _semaphore;
+    get encoding(): ImageThumbnailEncoding;
+    get height(): number;
+    get ipfsGateway(): string;
+    get maxAsyncProcesses(): number;
+    get quality(): number;
+    get width(): number;
+    private static binaryToSha256;
+    private static bufferFromDataUrl;
+    protected observeHandler(payloads?: UrlPayload[]): Promise<ImageThumbnail[]>;
+    private createThumbnailDataUrl;
+    private createThumbnailFromVideo;
+    private fromHttp;
+    private processMedia;
+}
+
+declare const ImageThumbnailPlugin: () => _xyo_network_payloadset_plugin.PayloadSetDualPlugin<ImageThumbnailWitness<_store__xylabs_object_npm_4_0_0_ffd6151301_package.BaseParamsFields & {
+    account?: _store__xyo_network_account_model_virtual_3afa553815_package.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _store__xyo_network_account_model_virtual_3afa553815_package.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+        schema: "network.xyo.image.thumbnail.witness.config";
+    } & {
+        dataUrlPassthrough?: boolean;
+        encoding?: ImageThumbnailEncoding;
+        height?: number;
+        ipfsGateway?: string;
+        maxAsyncProcesses?: number;
+        maxCacheBytes?: number;
+        maxCacheEntries?: number;
+        quality?: number;
+        runExclusive?: boolean;
+        schema: ImageThumbnailWitnessConfigSchema;
+        width?: number;
+    }, "schema"> & {
+        schema: "network.xyo.image.thumbnail.witness.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+} & {
+    loaders?: string[];
+}>, ImageThumbnailDiviner>;
+
+export { type DnsError, type ImageThumbnailEncoding, ImageThumbnailPlugin, ImageThumbnailWitness, type ImageThumbnailWitnessConfig, ImageThumbnailWitnessConfigSchema, type ImageThumbnailWitnessError, type ImageThumbnailWitnessParams, ImageThumbnailPlugin as default };

package/dist/node/index.mjs

@@ -1,11 +1,3 @@
-var __defProp = Object.defineProperty;
-var __getProtoOf = Object.getPrototypeOf;
-var __reflectGet = Reflect.get;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-var __superGet = (cls, obj, key) => __reflectGet(__getProtoOf(cls), key, obj);
-
 // src/Plugin.ts
 import { ImageThumbnailDiviner } from "@xyo-network/diviner-image-thumbnail";
 import { ImageThumbnailSchema as ImageThumbnailSchema3 } from "@xyo-network/image-thumbnail-payload-plugin";
@@ -19,13 +11,13 @@ var ImageThumbnailWitnessConfigSchema = `${ImageThumbnailSchema}.witness.config`
 // src/Witness/Witness.ts
 import { Buffer as Buffer2 } from "node:buffer";
 import { promises as dnsPromises } from "node:dns";
-import { axios as axios2 } from "@xylabs/axios";
-import { compact } from "@xylabs/lodash";
+import { exists } from "@xylabs/exists";
 import { AbstractWitness } from "@xyo-network/abstract-witness";
 import { PayloadHasher } from "@xyo-network/hash";
 import { ImageThumbnailSchema as ImageThumbnailSchema2 } from "@xyo-network/image-thumbnail-payload-plugin";
 import { UrlSchema } from "@xyo-network/url-payload-plugin";
 import { Semaphore } from "async-mutex";
+import axios2 from "axios";
 import FileType from "file-type";
 import graphicsMagick from "gm";
 import hasbin from "hasbin";
@@ -39,8 +31,7 @@ import { tmpdir } from "node:os";
 import { Writable } from "node:stream";
 import ffmpeg from "fluent-ffmpeg";
 import { v4 as uuid } from "uuid";
-var _a;
-var FfmpegOutputStream = (_a = class extends Writable {
+var FfmpegOutputStream = class extends Writable {
   chunks = [];
   constructor(options) {
     super(options);
@@ -50,18 +41,16 @@ var FfmpegOutputStream = (_a = class extends Writable {
     callback();
   }
   /**
-  * Collects the output from ffmpeg into a buffer.
-  * @returns A buffer containing the concatenated
-  * output from ffmpeg.
-  */
-  toBuffer = /* @__PURE__ */ __name(() => Buffer.concat(this.chunks), "toBuffer");
-}, __name(_a, "FfmpegOutputStream"), _a);
-var getVideoFrameAsImageFluent = /* @__PURE__ */ __name(async (videoBuffer) => {
+   * Collects the output from ffmpeg into a buffer.
+   * @returns A buffer containing the concatenated
+   * output from ffmpeg.
+   */
+  toBuffer = () => Buffer.concat(this.chunks);
+};
+var getVideoFrameAsImageFluent = async (videoBuffer) => {
   const tmpFile = `/${tmpdir()}/${uuid()}`;
   try {
-    await writeFile(tmpFile, new Uint8Array(videoBuffer), {
-      encoding: "binary"
-    });
+    await writeFile(tmpFile, new Uint8Array(videoBuffer), { encoding: "binary" });
     const imageBuffer = await new Promise((resolve, reject) => {
       const ffmpegOutput = new FfmpegOutputStream();
       ffmpeg().on("error", (err) => reject(err.message)).on("end", () => resolve(ffmpegOutput.toBuffer())).input(tmpFile).takeFrames(1).withNoAudio().outputOptions("-f image2pipe").videoCodec("png").pipe(ffmpegOutput);
@@ -73,12 +62,12 @@ var getVideoFrameAsImageFluent = /* @__PURE__ */ __name(async (videoBuffer) => {
     } catch {
     }
   }
-}, "getVideoFrameAsImageFluent");
+};
 
 // src/Witness/lib/checkIpfsUrl.ts
 import { assertEx } from "@xylabs/assert";
 var allowIpfsIoRepair = true;
-var checkIpfsUrl = /* @__PURE__ */ __name((urlToCheck, ipfsGateway) => {
+var checkIpfsUrl = (urlToCheck, ipfsGateway) => {
   try {
     const url = new URL(urlToCheck);
     let protocol = url.protocol;
@@ -90,7 +79,7 @@ var checkIpfsUrl = /* @__PURE__ */ __name((urlToCheck, ipfsGateway) => {
       host = assertEx(ipfsGateway, () => "No ipfsGateway provided");
       path = url.host === "ipfs" ? `ipfs${path}` : `ipfs/${url.host}${path}`;
       const root = `${protocol}//${host}/${path}`;
-      return (query == null ? void 0 : query.length) > 0 ? `${root}?${query}` : root;
+      return query?.length > 0 ? `${root}?${query}` : root;
     } else if (allowIpfsIoRepair && protocol === "https" && host === "ipfs.io") {
       protocol = "https:";
       host = assertEx(ipfsGateway, () => "No ipfsGateway provided");
@@ -100,26 +89,26 @@ var checkIpfsUrl = /* @__PURE__ */ __name((urlToCheck, ipfsGateway) => {
       }
       path = pathParts.join("/");
       const root = `${protocol}//${host}/${path}`;
-      return (query == null ? void 0 : query.length) > 0 ? `${root}?${query}` : root;
+      return query?.length > 0 ? `${root}?${query}` : root;
     } else {
       return urlToCheck;
     }
   } catch {
     return urlToCheck;
   }
-}, "checkIpfsUrl");
+};
 
 // src/Witness/lib/createDataUrl.ts
 import { fromByteArray } from "base64-js";
-var createDataUrl = /* @__PURE__ */ __name((data, contextType, encoding = "base64") => {
+var createDataUrl = (data, contextType, encoding = "base64") => {
   return `data:${contextType};${encoding},${fromByteArray(new Uint8Array(data))}`;
-}, "createDataUrl");
+};
 
 // src/Witness/lib/resolveDynamicSvg.ts
-import { axios } from "@xylabs/axios";
+import axios from "axios";
 import { toByteArray } from "base64-js";
 import { Builder, parseStringPromise } from "xml2js";
-var resolveDynamicSvg = /* @__PURE__ */ __name(async (base64Bytes) => {
+var resolveDynamicSvg = async (base64Bytes) => {
   const decoder = new TextDecoder();
   const bytes = toByteArray(base64Bytes);
   const svg = decoder.decode(bytes);
@@ -135,38 +124,23 @@ var resolveDynamicSvg = /* @__PURE__ */ __name(async (base64Bytes) => {
     ])
   );
   const image = imageResults.map(([href, response]) => {
-    var _a2;
     if (response.data) {
       const sourceBuffer = Buffer.from(response.data, "binary");
-      return {
-        $: {
-          href: `data:${(_a2 = response.headers["content-type"]) == null ? void 0 : _a2.toString()};base64,${sourceBuffer.toString("base64")}`
-        }
-      };
+      return { $: { href: `data:${response.headers["content-type"]?.toString()};base64,${sourceBuffer.toString("base64")}` } };
     } else {
-      return {
-        $: {
-          href
-        }
-      };
+      return { $: { href } };
     }
   });
-  const updatedSVG = {
-    ...svgObj,
-    svg: {
-      ...svgNode,
-      image
-    }
-  };
+  const updatedSVG = { ...svgObj, svg: { ...svgNode, image } };
   const builder = new Builder();
   return builder.buildObject(updatedSVG);
-}, "resolveDynamicSvg");
+};
 
 // src/Witness/Witness.ts
-var gm = graphicsMagick.subClass({
-  imageMagick: "7+"
-});
-var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitness {
+var gm = graphicsMagick.subClass({ imageMagick: "7+" });
+var ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitness {
+  static configSchemas = [...super.configSchemas, ImageThumbnailWitnessConfigSchema];
+  static defaultConfigSchema = ImageThumbnailWitnessConfigSchema;
   _semaphore = new Semaphore(this.maxAsyncProcesses);
   get encoding() {
     return this.config.encoding ?? "PNG";
@@ -218,42 +192,48 @@ var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitnes
       throw new Error("ImageMagick is required for this witness");
     }
     const urlPayloads = payloads.filter((payload) => payload.schema === UrlSchema);
-    const process = /* @__PURE__ */ __name(async () => {
-      return compact(await Promise.all(urlPayloads.map(async ({ url }) => {
-        let result;
-        const dataBuffer = _ImageThumbnailWitness.bufferFromDataUrl(url);
-        if (dataBuffer) {
-          if (this.config.dataUrlPassthrough) {
-            result = {
-              schema: ImageThumbnailSchema2,
-              sourceHash: await _ImageThumbnailWitness.binaryToSha256(dataBuffer),
-              sourceUrl: url,
-              url
-            };
-          } else {
-            let cookedDataBuffer = dataBuffer;
-            const urlParts = url.split(";");
-            const [, contentType] = urlParts[0].split(":");
-            if (contentType.startsWith("image/svg")) {
-              const [encoding, byteString] = urlParts[1].split(",");
-              if (encoding === "base64") {
-                const newSvg = await resolveDynamicSvg(byteString);
-                const newSvgDataUrl = createDataUrl(Buffer2.from(newSvg), contentType);
-                cookedDataBuffer = _ImageThumbnailWitness.bufferFromDataUrl(newSvgDataUrl) ?? dataBuffer;
+    const process = async () => {
+      return (await Promise.all(
+        urlPayloads.map(async ({ url }) => {
+          let result;
+          const dataBuffer = _ImageThumbnailWitness.bufferFromDataUrl(url);
+          if (dataBuffer) {
+            if (this.config.dataUrlPassthrough) {
+              result = {
+                schema: ImageThumbnailSchema2,
+                sourceHash: await _ImageThumbnailWitness.binaryToSha256(dataBuffer),
+                sourceUrl: url,
+                url
+              };
+            } else {
+              let cookedDataBuffer = dataBuffer;
+              const urlParts = url.split(";");
+              const [, contentType] = urlParts[0].split(":");
+              if (contentType.startsWith("image/svg")) {
+                const [encoding, byteString] = urlParts[1].split(",");
+                if (encoding === "base64") {
+                  const newSvg = await resolveDynamicSvg(byteString);
+                  const newSvgDataUrl = createDataUrl(Buffer2.from(newSvg), contentType);
+                  cookedDataBuffer = _ImageThumbnailWitness.bufferFromDataUrl(newSvgDataUrl) ?? dataBuffer;
+                }
               }
+              result = await this.processMedia(
+                cookedDataBuffer,
+                {
+                  schema: ImageThumbnailSchema2,
+                  sourceUrl: url
+                },
+                contentType
+              );
             }
-            result = await this.processMedia(cookedDataBuffer, {
-              schema: ImageThumbnailSchema2,
-              sourceUrl: url
-            }, contentType);
+          } else {
+            const mutatedUrl = checkIpfsUrl(url, this.ipfsGateway);
+            result = await this.fromHttp(mutatedUrl, url);
           }
-        } else {
-          const mutatedUrl = checkIpfsUrl(url, this.ipfsGateway);
-          result = await this.fromHttp(mutatedUrl, url);
-        }
-        return result;
-      })));
-    }, "process");
+          return result;
+        })
+      )).filter(exists);
+    };
     return this.config.runExclusive ? await this._semaphore.runExclusive(() => process()) : process();
   }
   async createThumbnailDataUrl(sourceBuffer, encoding) {
@@ -269,17 +249,16 @@ var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitnes
     return createDataUrl(thumb, "image/png");
   }
   /**
-  * Creates an image thumbnail from a video.
-  * @param videoBuffer The input video buffer.
-  * @returns An buffer containing an image thumbnail for the video.
-  */
+   * Creates an image thumbnail from a video.
+   * @param videoBuffer The input video buffer.
+   * @returns An buffer containing an image thumbnail for the video.
+   */
   async createThumbnailFromVideo(videoBuffer) {
     const imageBuffer = await getVideoFrameAsImageFluent(videoBuffer);
     return this.createThumbnailDataUrl(imageBuffer);
   }
   // eslint-disable-next-line complexity
   async fromHttp(url, sourceUrl) {
-    var _a2, _b, _c;
     let response;
     let dnsResult;
     try {
@@ -310,13 +289,13 @@ var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitnes
           schema: ImageThumbnailSchema2,
           sourceUrl: sourceUrl ?? url
         };
-        if (((_a2 = axiosError == null ? void 0 : axiosError.response) == null ? void 0 : _a2.status) !== void 0) {
+        if (axiosError?.response?.status !== void 0) {
           result2.http = result2.http ?? {};
-          result2.http.status = (_b = axiosError == null ? void 0 : axiosError.response) == null ? void 0 : _b.status;
+          result2.http.status = axiosError?.response?.status;
         }
-        if ((axiosError == null ? void 0 : axiosError.code) !== void 0) {
+        if (axiosError?.code !== void 0) {
           result2.http = result2.http ?? {};
-          result2.http.code = axiosError == null ? void 0 : axiosError.code;
+          result2.http.code = axiosError?.code;
         }
         return result2;
       } else {
@@ -331,31 +310,27 @@ var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitnes
       sourceUrl: sourceUrl ?? url
     };
     if (response.status >= 200 && response.status < 300) {
-      const contentType = (_c = response.headers["content-type"]) == null ? void 0 : _c.toString();
+      const contentType = response.headers["content-type"]?.toString();
       const sourceBuffer = Buffer2.from(response.data, "binary");
       return this.processMedia(sourceBuffer, result, contentType);
     }
     return result;
   }
   async processMedia(sourceBuffer, imageThumbnail, contentType) {
-    var _a2, _b, _c, _d, _e;
-    const [mediaType, fileType] = (contentType == null ? void 0 : contentType.split("/")) ?? [
-      "",
-      ""
-    ];
+    const [mediaType, fileType] = contentType?.split("/") ?? ["", ""];
     imageThumbnail.mime = imageThumbnail.mime ?? {};
     imageThumbnail.mime.returned = mediaType;
     try {
       imageThumbnail.mime.detected = await FileType.fromBuffer(sourceBuffer);
     } catch (ex) {
       const error = ex;
-      (_a2 = this.logger) == null ? void 0 : _a2.error(`FileType error: ${error.message}`);
+      this.logger?.error(`FileType error: ${error.message}`);
     }
-    const processImage = /* @__PURE__ */ __name(async (encoding2) => {
+    const processImage = async (encoding2) => {
       imageThumbnail.sourceHash = await _ImageThumbnailWitness.binaryToSha256(sourceBuffer);
       imageThumbnail.url = await this.createThumbnailDataUrl(sourceBuffer, encoding2);
-    }, "processImage");
-    const processVideo = /* @__PURE__ */ __name(async () => {
+    };
+    const processVideo = async () => {
       if (hasbin.sync("ffmpeg")) {
         imageThumbnail.sourceHash = await _ImageThumbnailWitness.binaryToSha256(sourceBuffer);
         imageThumbnail.url = await this.createThumbnailFromVideo(sourceBuffer);
@@ -363,7 +338,7 @@ var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitnes
         imageThumbnail.mime = imageThumbnail.mime ?? {};
         imageThumbnail.mime.invalid = true;
       }
-    }, "processVideo");
+    };
     let encoding = "PNG";
     switch (fileType.toUpperCase()) {
       case "GIF": {
@@ -388,19 +363,16 @@ var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitnes
         break;
       }
       default: {
-        const [detectedMediaType] = ((_c = (_b = imageThumbnail.mime.detected) == null ? void 0 : _b.mime) == null ? void 0 : _c.split("/")) ?? [
-          "",
-          ""
-        ];
+        const [detectedMediaType] = imageThumbnail.mime.detected?.mime?.split("/") ?? ["", ""];
         switch (detectedMediaType) {
           case "image": {
             await processImage();
-            imageThumbnail.mime.type = (_d = imageThumbnail.mime.detected) == null ? void 0 : _d.mime;
+            imageThumbnail.mime.type = imageThumbnail.mime.detected?.mime;
             break;
           }
           case "video": {
             await processVideo();
-            imageThumbnail.mime.type = (_e = imageThumbnail.mime.detected) == null ? void 0 : _e.mime;
+            imageThumbnail.mime.type = imageThumbnail.mime.detected?.mime;
             break;
           }
           default: {
@@ -414,30 +386,21 @@ var _ImageThumbnailWitness = class _ImageThumbnailWitness extends AbstractWitnes
     return imageThumbnail;
   }
 };
-__name(_ImageThumbnailWitness, "ImageThumbnailWitness");
-__publicField(_ImageThumbnailWitness, "configSchemas", [
-  ...__superGet(_ImageThumbnailWitness, _ImageThumbnailWitness, "configSchemas"),
-  ImageThumbnailWitnessConfigSchema
-]);
-__publicField(_ImageThumbnailWitness, "defaultConfigSchema", ImageThumbnailWitnessConfigSchema);
-var ImageThumbnailWitness = _ImageThumbnailWitness;
 
 // src/Plugin.ts
-var ImageThumbnailPlugin = /* @__PURE__ */ __name(() => createPayloadSetDualPlugin({
-  required: {
-    [ImageThumbnailSchema3]: 1
-  },
-  schema: PayloadSetSchema
-}, {
-  diviner: /* @__PURE__ */ __name(async (params) => {
-    const result = await ImageThumbnailDiviner.create(params);
-    return result;
-  }, "diviner"),
-  witness: /* @__PURE__ */ __name(async (params) => {
-    const result = await ImageThumbnailWitness.create(params);
-    return result;
-  }, "witness")
-}), "ImageThumbnailPlugin");
+var ImageThumbnailPlugin = () => createPayloadSetDualPlugin(
+  { required: { [ImageThumbnailSchema3]: 1 }, schema: PayloadSetSchema },
+  {
+    diviner: async (params) => {
+      const result = await ImageThumbnailDiviner.create(params);
+      return result;
+    },
+    witness: async (params) => {
+      const result = await ImageThumbnailWitness.create(params);
+      return result;
+    }
+  }
+);
 
 // src/index.ts
 export * from "@xyo-network/diviner-image-thumbnail";