export configuration types

Author: BitPatty

README.md

@@ -68,8 +68,8 @@ app.prepare().then(() => {
           logging: {
             // (Optional) The logger to use (defaults to console)
             logger: console,
-            // The log level, must be one of
-            // 'debug', 'warn' or 'error'
+            // (Optional) The log level, must be one of
+            // 'debug', 'warn' or 'error' (defaults to 'error')
             level: 'debug'
           }
         },
@@ -103,11 +103,7 @@ const handler = (req: NextApiRequest, res: NextApiResponse): void => {
   }
 
   handle(new URL('http://localhost:4000/'), req.query, res, {
-    signature: {
-      key: '91bdcda48ce22cd7d8d3a0eda930b3db1762bc1cba5dc13542e723b68fe55d6f9d18199cbe35191a45faf22593405cad0fe76ffec67d24f8aee861ac8fe44d96',
-      salt: '72456c286761260f320391fe500fcec53755958dabd288867a6db072e1bc1dbd84b15079838a83a715edc1ecad50c3ce91dd8fdef6f981816fa274f91d8ecf06',
-    },
-    bucketWhitelist: ['test-bucket'],
+    // Handler Options
   });
 };
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitpatty/next-image-s3-imgproxy-loader",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "imgproxy S3 extension for next/image",
   "author": "Matteias Collet <[email protected]>",
   "main": "dist/index.js",

package.json

@@ -13,20 +13,69 @@ import pb from '@bitpatty/imgproxy-url-builder';
 
 import Logger, { LoggerOptions } from './logger';
 
+/**
+ * The options for the request handler
+ */
 type HandlerOptions = {
+  /**
+   * The secrets for signing the URLs
+   */
   signature?: {
+    /**
+     * The hex-encoded imgproxy key (IMGPROXY_KEY)
+     */
     key: string;
+
+    /**
+     * The hex-encoded imgproxy salt (IMGPROXY_SALT)
+     */
     salt: string;
   };
+
+  /**
+   * The auth token (IMGPROXY_SECRET), will be included in the Authorization request
+   * header as bearer token
+   */
   authToken?: string;
+
+  /**
+   * Restrict access to the specified buckets
+   */
   bucketWhitelist?: string[];
+
+  /**
+   * The imgproxy headers that should be forwarded to the client. Overrides the default
+   * set of response headers.
+   *
+   * If specified, all headers not included in this configuration will be stripped
+   * from the response.
+   */
   forwardedHeaders?: string[];
+
+  /**
+   * Additional request headers that should be sent to imgproxy
+   */
   requestHeaders?: OutgoingHttpHeaders;
+
+  /**
+   * The logger configuration
+   */
   logging?: LoggerOptions;
 };
 
+/**
+ * The default NextJS endpoint that should be used for proxying the images
+ */
 const IMGPROXY_ENDPOINT = '/_next/imgproxy';
+
+/**
+ * The regex for validating whether a source string is valid (<bucket name>/<file name>)
+ */
 const SRC_REGEX = /^[^/.]+\/.+[^/]$/;
+
+/**
+ * The default imgproxy response headers that should be forwarded to the client.
+ */
 const FORWARDED_HEADERS = [
   'date',
   'expires',
@@ -175,9 +224,23 @@ const handle = (
   req.end();
 };
 
+/**
+ * The props for the <ProxyImage /> component
+ */
 type ProxyImageProps = {
+  /**
+   * The file path in the format `<bucket name>/<file-name>`
+   */
   file: string;
+
+  /**
+   * The imgproxy params
+   */
   proxyParams?: string;
+
+  /**
+   * The NextJS endpoint handling the proxy request
+   */
   endpoint?: string;
 };
 
@@ -226,3 +289,4 @@ const ProxyImage = ({
 
 export default ProxyImage;
 export { IMGPROXY_ENDPOINT, buildProxyImagePath, handle };
+export type { HandlerOptions, ProxyImageProps, LoggerOptions };