@etsoo/shared 1.1.83 → 1.1.85

package/README.md

@@ -32,6 +32,15 @@ $ yarn add @etsoo/shared
 ## storage
 Storage interface and browser storage implementation
 
+## ContentDisposition
+Content disposition of HTTP
+
+|Name|Description|
+|---:|---|
+|static parse|Parse header value|
+|Methods||
+|format|Format to standard output|
+
 ## EColor
 Etsoo implmented Color
 
@@ -121,6 +130,8 @@ Data type definitions and type safe functions. ListItemType and ListItemType1 ar
 |MConstructor|Mixins constructor|
 |ObjType|Generic object type|
 |Optional|Make properties optional|
+|PlacementEnum|Placement enum|
+|Placement|Placement type|
 |RequireAtLeastOne|Require at least one property of the keys|
 |Simple|Basic or basic array type|
 |SimpleEnum|Simple type enum|

package/__tests__/ContentDisposition.ts

@@ -0,0 +1,24 @@
+import { ContentDisposition } from '../src/types/ContentDisposition';
+
+test('Tests for parse', () => {
+    const cd1 = ContentDisposition.parse(
+        "attachment; filename=__PDF.pdf; filename*=UTF-8''%E6%B5%8B%E8%AF%95PDF.pdf"
+    );
+
+    const cd2 = ContentDisposition.parse(
+        `attachment; filename="__PDF.pdf"; filename*="UTF-8''%E6%B5%8B%E8%AF%95PDF.pdf"`
+    );
+
+    expect(cd1?.type).toBe(cd2?.type);
+    expect(cd1?.filename).toBe(cd2?.filename);
+    expect(cd1?.filename).toBe('测试PDF.pdf');
+});
+
+test('Tests for format', () => {
+    const cd1 = new ContentDisposition('form-data', 'a-b.jpg', 'file');
+    expect(cd1.format()).toBe(`form-data; name="file"; filename="a-b.jpg"`);
+    const cd2 = new ContentDisposition('attachment', '测试PDF.pdf');
+    expect(cd2.format()).toBe(
+        `attachment; filename="__PDF.pdf"; filename*="UTF-8''%E6%B5%8B%E8%AF%95PDF.pdf"`
+    );
+});

package/lib/cjs/DataTypes.d.ts

@@ -114,6 +114,25 @@ export declare namespace DataTypes {
      * Vertical align
      */
     type VAlign = Lowercase<keyof typeof VAlignEnum>;
+    /**
+     * Placement enum
+     */
+    enum PlacementEnum {
+        TopLeft = 0,
+        TopCenter = 1,
+        TopRight = 2,
+        MiddleLeft = 3,
+        Center = 4,
+        MiddleRight = 5,
+        BottomLeft = 6,
+        BottomCenter = 7,
+        BottomRight = 8,
+        Unknown = 9
+    }
+    /**
+     * Placement type
+     */
+    type Placement = keyof typeof PlacementEnum;
     /**
      * Number and string combination id type
      */

package/lib/cjs/DataTypes.js

@@ -76,6 +76,22 @@ var DataTypes;
         VAlignEnum[VAlignEnum["Center"] = 2] = "Center";
         VAlignEnum[VAlignEnum["Bottom"] = 3] = "Bottom";
     })(VAlignEnum = DataTypes.VAlignEnum || (DataTypes.VAlignEnum = {}));
+    /**
+     * Placement enum
+     */
+    let PlacementEnum;
+    (function (PlacementEnum) {
+        PlacementEnum[PlacementEnum["TopLeft"] = 0] = "TopLeft";
+        PlacementEnum[PlacementEnum["TopCenter"] = 1] = "TopCenter";
+        PlacementEnum[PlacementEnum["TopRight"] = 2] = "TopRight";
+        PlacementEnum[PlacementEnum["MiddleLeft"] = 3] = "MiddleLeft";
+        PlacementEnum[PlacementEnum["Center"] = 4] = "Center";
+        PlacementEnum[PlacementEnum["MiddleRight"] = 5] = "MiddleRight";
+        PlacementEnum[PlacementEnum["BottomLeft"] = 6] = "BottomLeft";
+        PlacementEnum[PlacementEnum["BottomCenter"] = 7] = "BottomCenter";
+        PlacementEnum[PlacementEnum["BottomRight"] = 8] = "BottomRight";
+        PlacementEnum[PlacementEnum["Unknown"] = 9] = "Unknown"; // Reserved for modal, only one instance held at the same time
+    })(PlacementEnum = DataTypes.PlacementEnum || (DataTypes.PlacementEnum = {}));
     /**
      * Convert value to target type
      * @param input Input value

package/lib/cjs/DomUtils.d.ts

@@ -79,16 +79,12 @@ export declare namespace DomUtils {
     const getCulture: <T extends DataTypes.StringRecord>(items: Readonly<{
         name: string;
         label: string;
-        resources: T; /**
-         * Current detected culture
-         */
+        resources: T;
         compatibleNames?: string[] | undefined;
     }>[], culture: string) => [Readonly<{
         name: string;
         label: string;
-        resources: T; /**
-         * Current detected culture
-         */
+        resources: T;
         compatibleNames?: string[] | undefined;
     }> | undefined, CultureMatch];
     /**

package/lib/cjs/index.d.ts

@@ -1,3 +1,4 @@
+export * from './types/ContentDisposition';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/lib/cjs/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/ContentDisposition"), exports);
 __exportStar(require("./types/DelayedExecutorType"), exports);
 __exportStar(require("./types/EColor"), exports);
 __exportStar(require("./types/EHistory"), exports);

package/lib/cjs/types/ContentDisposition.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Content disposition of HTTP
+ * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+ */
+export declare class ContentDisposition {
+    readonly type: string;
+    readonly filename: string;
+    readonly name?: string | undefined;
+    constructor(type: 'inline' | 'attachment', filename: string);
+    constructor(type: 'form-data', filename: string, name: string);
+    /**
+     * Format to standard output
+     * @returns Result
+     */
+    format(): string;
+    /**
+     * Parse header value
+     * @param header Content-Disposition header value
+     * @returns Object
+     */
+    static parse(header: string | undefined | null): ContentDisposition | undefined;
+}

package/lib/cjs/types/ContentDisposition.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentDisposition = void 0;
+const Utils_1 = require("../Utils");
+/**
+ * Content disposition of HTTP
+ * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+ */
+class ContentDisposition {
+    constructor(type, filename, name) {
+        this.type = type;
+        this.filename = filename;
+        this.name = name;
+    }
+    /**
+     * Format to standard output
+     * @returns Result
+     */
+    format() {
+        const items = [this.type];
+        if (this.name)
+            items.push(`name="${this.name}"`);
+        const filename1 = this.filename.replace(/[^a-zA-Z0-9\.-]/g, '_');
+        items.push(`filename="${filename1}"`);
+        if (filename1 != this.filename)
+            items.push(`filename*="UTF-8''${encodeURIComponent(this.filename)}"`);
+        return items.join('; ');
+    }
+    /**
+     * Parse header value
+     * @param header Content-Disposition header value
+     * @returns Object
+     */
+    static parse(header) {
+        if (!header)
+            return undefined;
+        const parts = header.trim().split(/\s*;\s*/g);
+        const len = parts.length;
+        if (len < 2)
+            return undefined;
+        const type = parts[0];
+        let name;
+        let filename = '';
+        for (let i = 1; i < len; i++) {
+            const part = parts[i];
+            let [field, value] = part.split(/\s*=\s*/g);
+            // case-insensitive
+            field = field.toLowerCase();
+            // Remove quotes
+            value = Utils_1.Utils.trim(value, '"');
+            if (field === 'name') {
+                name = value;
+            }
+            else if (field === 'filename') {
+                if (filename === '')
+                    filename = value;
+            }
+            else if (field === 'filename*') {
+                const pos = value.indexOf("''");
+                filename =
+                    pos == -1
+                        ? value
+                        : decodeURIComponent(value.substring(pos + 2));
+            }
+        }
+        if (type === 'form-data') {
+            return new ContentDisposition(type, filename, name !== null && name !== void 0 ? name : 'file');
+        }
+        if (type === 'inline' || type === 'attachment') {
+            return new ContentDisposition(type, filename);
+        }
+        return undefined;
+    }
+}
+exports.ContentDisposition = ContentDisposition;

package/lib/mjs/DataTypes.d.ts

@@ -114,6 +114,25 @@ export declare namespace DataTypes {
      * Vertical align
      */
     type VAlign = Lowercase<keyof typeof VAlignEnum>;
+    /**
+     * Placement enum
+     */
+    enum PlacementEnum {
+        TopLeft = 0,
+        TopCenter = 1,
+        TopRight = 2,
+        MiddleLeft = 3,
+        Center = 4,
+        MiddleRight = 5,
+        BottomLeft = 6,
+        BottomCenter = 7,
+        BottomRight = 8,
+        Unknown = 9
+    }
+    /**
+     * Placement type
+     */
+    type Placement = keyof typeof PlacementEnum;
     /**
      * Number and string combination id type
      */

package/lib/mjs/DataTypes.js

@@ -73,6 +73,22 @@ export var DataTypes;
         VAlignEnum[VAlignEnum["Center"] = 2] = "Center";
         VAlignEnum[VAlignEnum["Bottom"] = 3] = "Bottom";
     })(VAlignEnum = DataTypes.VAlignEnum || (DataTypes.VAlignEnum = {}));
+    /**
+     * Placement enum
+     */
+    let PlacementEnum;
+    (function (PlacementEnum) {
+        PlacementEnum[PlacementEnum["TopLeft"] = 0] = "TopLeft";
+        PlacementEnum[PlacementEnum["TopCenter"] = 1] = "TopCenter";
+        PlacementEnum[PlacementEnum["TopRight"] = 2] = "TopRight";
+        PlacementEnum[PlacementEnum["MiddleLeft"] = 3] = "MiddleLeft";
+        PlacementEnum[PlacementEnum["Center"] = 4] = "Center";
+        PlacementEnum[PlacementEnum["MiddleRight"] = 5] = "MiddleRight";
+        PlacementEnum[PlacementEnum["BottomLeft"] = 6] = "BottomLeft";
+        PlacementEnum[PlacementEnum["BottomCenter"] = 7] = "BottomCenter";
+        PlacementEnum[PlacementEnum["BottomRight"] = 8] = "BottomRight";
+        PlacementEnum[PlacementEnum["Unknown"] = 9] = "Unknown"; // Reserved for modal, only one instance held at the same time
+    })(PlacementEnum = DataTypes.PlacementEnum || (DataTypes.PlacementEnum = {}));
     /**
      * Convert value to target type
      * @param input Input value

package/lib/mjs/DomUtils.d.ts

@@ -79,16 +79,12 @@ export declare namespace DomUtils {
     const getCulture: <T extends DataTypes.StringRecord>(items: Readonly<{
         name: string;
         label: string;
-        resources: T; /**
-         * Current detected culture
-         */
+        resources: T;
         compatibleNames?: string[] | undefined;
     }>[], culture: string) => [Readonly<{
         name: string;
         label: string;
-        resources: T; /**
-         * Current detected culture
-         */
+        resources: T;
         compatibleNames?: string[] | undefined;
     }> | undefined, CultureMatch];
     /**

package/lib/mjs/index.d.ts

@@ -1,3 +1,4 @@
+export * from './types/ContentDisposition';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/lib/mjs/index.js

@@ -1,3 +1,4 @@
+export * from './types/ContentDisposition';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/lib/mjs/types/ContentDisposition.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Content disposition of HTTP
+ * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+ */
+export declare class ContentDisposition {
+    readonly type: string;
+    readonly filename: string;
+    readonly name?: string | undefined;
+    constructor(type: 'inline' | 'attachment', filename: string);
+    constructor(type: 'form-data', filename: string, name: string);
+    /**
+     * Format to standard output
+     * @returns Result
+     */
+    format(): string;
+    /**
+     * Parse header value
+     * @param header Content-Disposition header value
+     * @returns Object
+     */
+    static parse(header: string | undefined | null): ContentDisposition | undefined;
+}

package/lib/mjs/types/ContentDisposition.js

@@ -0,0 +1,71 @@
+import { Utils } from '../Utils';
+/**
+ * Content disposition of HTTP
+ * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+ */
+export class ContentDisposition {
+    constructor(type, filename, name) {
+        this.type = type;
+        this.filename = filename;
+        this.name = name;
+    }
+    /**
+     * Format to standard output
+     * @returns Result
+     */
+    format() {
+        const items = [this.type];
+        if (this.name)
+            items.push(`name="${this.name}"`);
+        const filename1 = this.filename.replace(/[^a-zA-Z0-9\.-]/g, '_');
+        items.push(`filename="${filename1}"`);
+        if (filename1 != this.filename)
+            items.push(`filename*="UTF-8''${encodeURIComponent(this.filename)}"`);
+        return items.join('; ');
+    }
+    /**
+     * Parse header value
+     * @param header Content-Disposition header value
+     * @returns Object
+     */
+    static parse(header) {
+        if (!header)
+            return undefined;
+        const parts = header.trim().split(/\s*;\s*/g);
+        const len = parts.length;
+        if (len < 2)
+            return undefined;
+        const type = parts[0];
+        let name;
+        let filename = '';
+        for (let i = 1; i < len; i++) {
+            const part = parts[i];
+            let [field, value] = part.split(/\s*=\s*/g);
+            // case-insensitive
+            field = field.toLowerCase();
+            // Remove quotes
+            value = Utils.trim(value, '"');
+            if (field === 'name') {
+                name = value;
+            }
+            else if (field === 'filename') {
+                if (filename === '')
+                    filename = value;
+            }
+            else if (field === 'filename*') {
+                const pos = value.indexOf("''");
+                filename =
+                    pos == -1
+                        ? value
+                        : decodeURIComponent(value.substring(pos + 2));
+            }
+        }
+        if (type === 'form-data') {
+            return new ContentDisposition(type, filename, name !== null && name !== void 0 ? name : 'file');
+        }
+        if (type === 'inline' || type === 'attachment') {
+            return new ContentDisposition(type, filename);
+        }
+        return undefined;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.83",
+    "version": "1.1.85",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,13 +54,8 @@
     },
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "devDependencies": {
-        "@types/jest": "^29.2.4",
+        "@types/jest": "^29.2.5",
         "@types/lodash.isequal": "^4.5.6",
-        "@typescript-eslint/eslint-plugin": "^5.46.1",
-        "@typescript-eslint/parser": "^5.46.1",
-        "eslint": "^8.30.0",
-        "eslint-config-airbnb-base": "^15.0.0",
-        "eslint-plugin-import": "^2.26.0",
         "jest": "^29.3.1",
         "jest-environment-jsdom": "^29.3.1",
         "ts-jest": "^29.0.3",

package/src/DataTypes.ts

@@ -148,6 +148,30 @@ export namespace DataTypes {
      */
     export type VAlign = Lowercase<keyof typeof VAlignEnum>;
 
+    /**
+     * Placement enum
+     */
+    export enum PlacementEnum {
+        TopLeft,
+        TopCenter,
+        TopRight,
+
+        MiddleLeft,
+        Center,
+        MiddleRight,
+
+        BottomLeft,
+        BottomCenter,
+        BottomRight,
+
+        Unknown // Reserved for modal, only one instance held at the same time
+    }
+
+    /**
+     * Placement type
+     */
+    export type Placement = keyof typeof PlacementEnum;
+
     /**
      * Number and string combination id type
      */

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from './types/ContentDisposition';
 export * from './types/DelayedExecutorType';
 export * from './types/EColor';
 export * from './types/EHistory';

package/src/types/ContentDisposition.ts

@@ -0,0 +1,81 @@
+import { Utils } from '../Utils';
+
+/**
+ * Content disposition of HTTP
+ * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+ */
+export class ContentDisposition {
+    constructor(type: 'inline' | 'attachment', filename: string);
+    constructor(type: 'form-data', filename: string, name: string);
+    constructor(
+        public readonly type: string,
+        public readonly filename: string,
+        public readonly name?: string
+    ) {}
+
+    /**
+     * Format to standard output
+     * @returns Result
+     */
+    format() {
+        const items = [this.type];
+        if (this.name) items.push(`name="${this.name}"`);
+        const filename1 = this.filename.replace(/[^a-zA-Z0-9\.-]/g, '_');
+        items.push(`filename="${filename1}"`);
+        if (filename1 != this.filename)
+            items.push(
+                `filename*="UTF-8''${encodeURIComponent(this.filename)}"`
+            );
+        return items.join('; ');
+    }
+
+    /**
+     * Parse header value
+     * @param header Content-Disposition header value
+     * @returns Object
+     */
+    static parse(header: string | undefined | null) {
+        if (!header) return undefined;
+
+        const parts = header.trim().split(/\s*;\s*/g);
+        const len = parts.length;
+        if (len < 2) return undefined;
+
+        const type = parts[0];
+        let name: string | undefined;
+        let filename: string = '';
+
+        for (let i = 1; i < len; i++) {
+            const part = parts[i];
+            let [field, value] = part.split(/\s*=\s*/g);
+
+            // case-insensitive
+            field = field.toLowerCase();
+
+            // Remove quotes
+            value = Utils.trim(value, '"');
+
+            if (field === 'name') {
+                name = value;
+            } else if (field === 'filename') {
+                if (filename === '') filename = value;
+            } else if (field === 'filename*') {
+                const pos = value.indexOf("''");
+                filename =
+                    pos == -1
+                        ? value
+                        : decodeURIComponent(value.substring(pos + 2));
+            }
+        }
+
+        if (type === 'form-data') {
+            return new ContentDisposition(type, filename, name ?? 'file');
+        }
+
+        if (type === 'inline' || type === 'attachment') {
+            return new ContentDisposition(type, filename);
+        }
+
+        return undefined;
+    }
+}