node-datalith 0.1.0 → 0.1.2

package/lib/file.d.ts

@@ -11,6 +11,7 @@ export declare class File {
     readonly date: Date;
     readonly contentType: string;
     readonly contentLength: number;
+    readonly contentDisposition: string;
     readonly data: ReadableStream;
     readonly imageSize?: (ImageSize | null) | undefined;
     /**
@@ -21,10 +22,11 @@ export declare class File {
      * @param {Date} date The date and time when the file was created.
      * @param {string} contentType The MIME type of the file.
      * @param {number} contentLength The size of the file in bytes.
+     * @param {string} contentDisposition The file name and the expected usage.
      * @param {ReadableStream} data The file content as a readable stream.
      * @param {imageSize} [imageSize] (Optional) The size of the image in pixels, or `null` if not applicable, or `undefined` if this file is not an image.
      */
-    constructor(resource: TimeoutResponse, etag: string, date: Date, contentType: string, contentLength: number, data: ReadableStream, imageSize?: (ImageSize | null) | undefined);
+    constructor(resource: TimeoutResponse, etag: string, date: Date, contentType: string, contentLength: number, contentDisposition: string, data: ReadableStream, imageSize?: (ImageSize | null) | undefined);
     /**
      * If you want to cancel the data, use this function instead of `data.cancel()` or `data.getReader().cancel()`.
      */

package/lib/file.js

@@ -9,6 +9,7 @@ export class File {
     date;
     contentType;
     contentLength;
+    contentDisposition;
     data;
     imageSize;
     /**
@@ -19,15 +20,17 @@ export class File {
      * @param {Date} date The date and time when the file was created.
      * @param {string} contentType The MIME type of the file.
      * @param {number} contentLength The size of the file in bytes.
+     * @param {string} contentDisposition The file name and the expected usage.
      * @param {ReadableStream} data The file content as a readable stream.
      * @param {imageSize} [imageSize] (Optional) The size of the image in pixels, or `null` if not applicable, or `undefined` if this file is not an image.
      */
-    constructor(resource, etag, date, contentType, contentLength, data, imageSize) {
+    constructor(resource, etag, date, contentType, contentLength, contentDisposition, data, imageSize) {
         this.resource = resource;
         this.etag = etag;
         this.date = date;
         this.contentType = contentType;
         this.contentLength = contentLength;
+        this.contentDisposition = contentDisposition;
         this.data = data;
         this.imageSize = imageSize;
         // do nothing

package/lib/lib.d.ts

@@ -133,8 +133,19 @@ export interface ImagePutOptions extends WithBodyTimeoutOptions {
      */
     idleTimeout?: number | null;
 }
-export type ResourceGetOptions = WithBodyTimeoutOptions;
-export interface ImageGetOptions extends WithBodyTimeoutOptions {
+export interface FileGetOptions extends WithBodyTimeoutOptions {
+    /**
+     * Whether to download as a file. It will affect the `contentDisposition` field of the returned `File` instance.
+     *
+     * If not provided (`undefined`), Datalith will default to `false`.
+     *
+     * @default undefined (Datalith defaults to `false`)
+     */
+    download?: boolean;
+}
+export type ResourceGetOptions = FileGetOptions;
+export type Resolution = `${1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10}x` | "original";
+export interface ImageGetOptions extends FileGetOptions {
     /**
      * The desired resolution of the image.
      *
@@ -144,7 +155,7 @@ export interface ImageGetOptions extends WithBodyTimeoutOptions {
      *
      * @default undefined (Datalith defaults to `"1x"`)
      */
-    resolution?: `${1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10}x` | "original";
+    resolution?: Resolution;
     /**
      * Whether to use a fallback image (in PNG/JPEG format instead of WebP).
      *
@@ -237,8 +248,9 @@ export declare class Datalith {
 }
 /**
  * Validates if the input string is a valid center crop string (in the format of `"<float>:<float>"`).
- *
- * @param {string}
- * @returns {boolean}
  */
 export declare const validateCenterCrop: (centerCrop?: string) => boolean;
+/**
+ * Validates if the given resolution is either `undefined`, `"original"`, or follows the format of `"<positive integer>x"`.
+ */
+export declare const validateResolution: (resolution?: string) => resolution is Resolution;

package/lib/lib.js

@@ -159,6 +159,10 @@ export class Datalith {
      */
     async getResource(id, options = {}) {
         const url = new URL(id, this._apiFetch);
+        const searchParams = url.searchParams;
+        if (options.download) {
+            searchParams.append("download", "1");
+        }
         const response = await timeoutFetch(url, {
             method: "GET",
             requestTimeout: typeof options.reqeustTimeout !== "undefined" ? options.reqeustTimeout : DEFAULT_REQUEST_TIMEOUT,
@@ -176,8 +180,10 @@ export class Datalith {
                     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                     const contentLength = parseInt(response.headers.get("content-length"));
                     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    const contentDisposition = response.headers.get("content-disposition");
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                     const body = response.body;
-                    return new File(response, etag, date, contentType, contentLength, body);
+                    return new File(response, etag, date, contentType, contentLength, contentDisposition, body);
                 }
             case 400:
                 await response.cancelBody();
@@ -199,6 +205,9 @@ export class Datalith {
     async getImage(id, options = {}) {
         const url = new URL(id, this._apiFetchImage);
         const searchParams = url.searchParams;
+        if (options.download) {
+            searchParams.append("download", "1");
+        }
         if (typeof options.resolution !== "undefined") {
             searchParams.append("resolution", options.resolution);
         }
@@ -222,6 +231,8 @@ export class Datalith {
                     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                     const contentLength = parseInt(response.headers.get("content-length"));
                     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    const contentDisposition = response.headers.get("content-disposition");
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                     const body = response.body;
                     const getNullableNumber = (fieldName) => {
                         const s = response.headers.get(fieldName);
@@ -239,7 +250,7 @@ export class Datalith {
                             height: imageHeight,
                         };
                     }
-                    return new File(response, etag, date, contentType, contentLength, body, imageSize);
+                    return new File(response, etag, date, contentType, contentLength, contentDisposition, body, imageSize);
                 }
             case 400:
                 await response.cancelBody();
@@ -341,9 +352,6 @@ export class Datalith {
 }
 /**
  * Validates if the input string is a valid center crop string (in the format of `"<float>:<float>"`).
- *
- * @param {string}
- * @returns {boolean}
  */
 export const validateCenterCrop = (centerCrop) => {
     if (typeof centerCrop === "undefined") {
@@ -351,3 +359,15 @@ export const validateCenterCrop = (centerCrop) => {
     }
     return (/^-?\d+\.?\d*:-?\d+\.?\d*$/).test(centerCrop);
 };
+/**
+ * Validates if the given resolution is either `undefined`, `"original"`, or follows the format of `"<positive integer>x"`.
+ */
+export const validateResolution = (resolution) => {
+    if (typeof resolution === "undefined") {
+        return true;
+    }
+    if (resolution === "original") {
+        return true;
+    }
+    return (/^[1-9][0-9]*x$/).test(resolution);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-datalith",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "description": "Datalith is a file management system powered by SQLite for metadata storage and the file system for file storage. This library can help you conmunicate with Datalith in Node.js.",
     "type": "module",
     "exports": "./lib/lib.js",