@blocklet/images 1.16.33-beta-20241107-065332-b20666d2

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018-2020 ArcBlock
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/lib/get-image-size.d.ts

@@ -0,0 +1,6 @@
+export declare const getImageSize: (path: string) => Promise<{
+    width: number | undefined;
+    height: number | undefined;
+    orientation?: number;
+    type?: string;
+}>;

package/lib/get-image-size.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImageSize = void 0;
+const image_size_1 = __importDefault(require("image-size"));
+const getImageSize = async (path) => {
+    return new Promise((reslove, reject) => {
+        try {
+            (0, image_size_1.default)(path, (e, res) => {
+                if (e) {
+                    reject(e);
+                }
+                else {
+                    reslove(res);
+                }
+            });
+        }
+        catch (error) {
+            reject(error);
+        }
+    });
+};
+exports.getImageSize = getImageSize;

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { validateLogo } from './logo-validate';
+import { validateScreenshots } from './screenshot-validate';
+import { ordinalSuffix } from './ordinal-suffix';
+export { validateLogo, validateScreenshots, ordinalSuffix };

package/lib/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ordinalSuffix = exports.validateScreenshots = exports.validateLogo = void 0;
+const logo_validate_1 = require("./logo-validate");
+Object.defineProperty(exports, "validateLogo", { enumerable: true, get: function () { return logo_validate_1.validateLogo; } });
+const screenshot_validate_1 = require("./screenshot-validate");
+Object.defineProperty(exports, "validateScreenshots", { enumerable: true, get: function () { return screenshot_validate_1.validateScreenshots; } });
+const ordinal_suffix_1 = require("./ordinal-suffix");
+Object.defineProperty(exports, "ordinalSuffix", { enumerable: true, get: function () { return ordinal_suffix_1.ordinalSuffix; } });

package/lib/logo-validate.d.ts

@@ -0,0 +1,9 @@
+type ISizeKB = number;
+interface ILogoValidateOptions {
+    maxSize?: ISizeKB;
+    width?: number;
+    logoType?: string;
+    extractedFilepath: string;
+}
+export declare const validateLogo: (logoName: string, options: ILogoValidateOptions) => Promise<any[]>;
+export {};

package/lib/logo-validate.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateLogo = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const get_image_size_1 = require("./get-image-size");
+const validateLogo = async (logoName, options) => {
+    const { extractedFilepath, maxSize = 1024, width = 256, logoType = '.png,.jpg,.jpeg,.webp' } = options;
+    const logoPath = path_1.default.join(extractedFilepath, logoName);
+    const preLogoMessage = `The logo(${logoName})`;
+    const errorMessages = [];
+    if (!logoName) {
+        errorMessages.push(`The logo field is required in blocklet.yml.`);
+        return errorMessages;
+    }
+    if (!fs_1.default.existsSync(logoPath)) {
+        errorMessages.push(`${preLogoMessage} file not found.`);
+        return errorMessages;
+    }
+    const logoStats = fs_1.default.statSync(logoPath);
+    if (maxSize && logoStats.size > maxSize * 1024) {
+        errorMessages.push(`${preLogoMessage} size exceeds ${maxSize} KB, but got ${(logoStats.size / 1024).toFixed(2)} KB.`);
+    }
+    await (0, get_image_size_1.getImageSize)(logoPath).then((imageMeta) => {
+        if (!logoType.split(',').includes(path_1.default.extname(logoPath).toLowerCase())) {
+            errorMessages.push(`${preLogoMessage} format is not supported, expected: [${logoType}].`);
+        }
+        if (imageMeta.width !== imageMeta.height || imageMeta.width !== width) {
+            errorMessages.push(`${preLogoMessage} just supports ${width}x${width}, but got ${imageMeta.width}x${imageMeta.height}.`);
+        }
+    });
+    return errorMessages;
+};
+exports.validateLogo = validateLogo;

package/lib/ordinal-suffix.d.ts

@@ -0,0 +1 @@
+export declare function ordinalSuffix(index: number): string;

package/lib/ordinal-suffix.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ordinalSuffix = ordinalSuffix;
+function ordinalSuffix(index) {
+    const j = index % 10;
+    const k = index % 100;
+    if (j === 1 && k !== 11)
+        return `${index}st`;
+    if (j === 2 && k !== 12)
+        return `${index}nd`;
+    if (j === 3 && k !== 13)
+        return `${index}rd`;
+    return `${index}th`;
+}

package/lib/screenshot-validate.d.ts

@@ -0,0 +1,11 @@
+type ISizeMB = number;
+interface IScreenshotValidateOptions {
+    extractedFilepath: string;
+    minCount?: number;
+    maxCount?: number;
+    maxSize?: ISizeMB;
+    minWidth?: number;
+    minHeight?: number;
+}
+export declare const validateScreenshots: (screenshots: string[], options: IScreenshotValidateOptions) => Promise<any[]>;
+export {};

package/lib/screenshot-validate.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateScreenshots = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const get_image_size_1 = require("./get-image-size");
+const ordinal_suffix_1 = require("./ordinal-suffix");
+const ASPECT_RATIO_16_10 = 16 / 10;
+const ASPECT_RATIO_THRESHOLD = 0.01;
+const validateScreenshots = async (screenshots, options) => {
+    const { extractedFilepath, minCount, maxCount, maxSize, minWidth, minHeight } = options;
+    const errorMessages = [];
+    const screenshotList = [];
+    screenshots.forEach((screenshot, index) => {
+        if (screenshotList.includes(screenshot)) {
+            errorMessages.push(`The ${(0, ordinal_suffix_1.ordinalSuffix)(index + 1)} screenshot(${screenshot}) is duplicated with the ${(0, ordinal_suffix_1.ordinalSuffix)(screenshotList.indexOf(screenshot) + 1)} screenshot.`);
+        }
+        else {
+            screenshotList.push(screenshot);
+        }
+    });
+    if (minCount && screenshotList.length < minCount) {
+        errorMessages.push(`At least ${minCount} screenshots are required, but just got ${screenshotList.length}.`);
+    }
+    if (maxCount && screenshotList.length > maxCount) {
+        errorMessages.push(`At most ${maxCount} screenshots are supported, but just got ${screenshotList.length}.`);
+    }
+    const asyncErrors = {};
+    await Promise.all(screenshotList.map((screenshot, index) => {
+        const screenshotsPath = path_1.default.join(extractedFilepath, 'screenshots', screenshot);
+        const preMessage = `The ${(0, ordinal_suffix_1.ordinalSuffix)(index + 1)}[${screenshot}] screenshot`;
+        asyncErrors[screenshot] = [];
+        if (!fs_1.default.existsSync(screenshotsPath)) {
+            asyncErrors[screenshot].push(`${preMessage} file not found.`);
+            return Promise.resolve('');
+        }
+        const screenshotsStats = fs_1.default.statSync(screenshotsPath);
+        if (maxSize && screenshotsStats.size > maxSize * 1024 * 1024) {
+            asyncErrors[screenshot].push(`${preMessage} size exceeds ${maxSize} MB, but got ${(screenshotsStats.size / 1024 / 1024).toFixed(2)} MB.`);
+        }
+        const screenshotsImageType = ['.png', '.jpg', '.jpeg', '.gif', '.bmp', '.webp', '.svg'];
+        if (!screenshotsImageType.includes(path_1.default.extname(screenshotsPath).toLowerCase())) {
+            asyncErrors[screenshot].push(`${preMessage} format is not supported, expected: [${screenshotsImageType.join(', ')}].`);
+        }
+        return (0, get_image_size_1.getImageSize)(screenshotsPath).then((imageMeta) => {
+            const aspectRatio = imageMeta.width / imageMeta.height;
+            const width = minWidth || (minHeight && minHeight * ASPECT_RATIO_16_10);
+            const height = minHeight || (width && width / ASPECT_RATIO_16_10);
+            if (imageMeta.width < width || imageMeta.height < height) {
+                asyncErrors[screenshot].push(`${preMessage} minimum size must be ${width}x${height}, but got ${imageMeta.width}x${imageMeta.height}.`);
+            }
+            if (Math.abs(aspectRatio - ASPECT_RATIO_16_10) > ASPECT_RATIO_THRESHOLD) {
+                asyncErrors[screenshot].push(`${preMessage} aspect ratio must be approximately 16:10, but got 16:${parseFloat((imageMeta.height / (imageMeta.width / 16)).toFixed(2))} (${imageMeta.width}x${imageMeta.height}).`);
+            }
+        });
+    }));
+    screenshotList.forEach((screenshot) => {
+        if (asyncErrors[screenshot].length) {
+            errorMessages.push(...asyncErrors[screenshot]);
+        }
+    });
+    return errorMessages;
+};
+exports.validateScreenshots = validateScreenshots;

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@blocklet/images",
+  "version": "1.16.33-beta-20241107-065332-b20666d2",
+  "main": "lib/index.js",
+  "types": "./lib/index.d.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "lib"
+  ],
+  "bugs": {
+    "url": "https://github.com/ArcBlock/blocklet-server/issues"
+  },
+  "description": "support functions for blocklet image validation",
+  "keywords": [
+    "blocklet",
+    "image",
+    "validation"
+  ],
+  "author": "blocklet<blocklet@arcblock.io>",
+  "homepage": "https://github.com/ArcBlock/blocklet-server#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ArcBlock/blocklet-server.git"
+  },
+  "scripts": {
+    "build:blocklet-images": "tsc",
+    "build": "tsc",
+    "test": "jest",
+    "watch": "nodemon -w src -e ts -x 'npm run build'"
+  },
+  "dependencies": {
+    "image-size": "^1.0.2"
+  },
+  "devDependencies": {
+    "@arcblock/eslint-config-ts": "^0.3.3",
+    "@types/jest": "^29.5.14",
+    "eslint": "^8.27.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.6.3"
+  },
+  "gitHead": "cfc4d5837f83a0bfd507567915695894dda2c0ec"
+}