@abtnode/util 1.16.0-beta-b16cb035 → 1.16.0-beta-1d6c582e

package/lib/logo-middleware.js

@@ -4,6 +4,13 @@ const get = require('lodash/get');
 
 const logger = require('@abtnode/logger')('@abtnode/util:logo-middleware');
 
+/**
+ *
+ * @param {import('express').Request} req
+ * @param {import('express').Response & {sendFallbackLogo: Function} } res
+ * @param {import('express').NextFunction} next
+ * @returns
+ */
 const ensureBlockletExist = async (req, res, next) => {
   const { blocklet } = req;
 
@@ -15,9 +22,17 @@ const ensureBlockletExist = async (req, res, next) => {
   next();
 };
 
+/**
+ *
+ * @param {import('express').Request} req
+ * @param {import('express').Response & {sendFallbackLogo: Function} } res
+ * @param {import('express').NextFunction} next
+ * @returns
+ */
 const ensureCustomSquareLogo = async (req, res, next) => {
   const { blocklet, sendOptions } = req;
 
+  /** @type {string} */
   const customLogoSquare = get(blocklet, 'environmentObj.BLOCKLET_APP_LOGO_SQUARE');
 
   if (customLogoSquare) {
@@ -36,7 +51,20 @@ const ensureCustomSquareLogo = async (req, res, next) => {
   next();
 };
 
+/**
+ *
+ * @param {import('express').Request} req
+ * @param {import('express').Response & {sendFallbackLogo: Function} } res
+ * @param {import('express').NextFunction} next
+ * @returns
+ */
 const ensureBundleLogo = async (req, res, next) => {
+  /**
+   * @type {{
+   *  blocklet: import('@abtnode/client').BlockletState, // 目前肯定是不准确的，但是有些属性是通用的，无伤大雅
+   *  sendOptions: any
+   * }}
+   * */
   const { blocklet, sendOptions } = req;
 
   if (blocklet.meta.logo) {
@@ -51,7 +79,13 @@ const ensureBundleLogo = async (req, res, next) => {
   next();
 };
 
-const fallbackLogo = async (req, res) => {
+/**
+ *
+ * @param {import('express').Request} _req
+ * @param {import('express').Response & {sendFallbackLogo: Function} } res
+ * @returns
+ */
+const fallbackLogo = async (_req, res) => {
   res.sendFallbackLogo();
 };
 
@@ -61,7 +95,20 @@ const cacheError = async (err, req, res, next) => {
   res.sendFallbackLogo();
 };
 
+/**
+ *
+ * @param {import('express').Request} req
+ * @param {import('express').Response & {sendFallbackLogo: Function} } res
+ * @param {import('express').NextFunction} next
+ * @returns
+ */
 const ensureDefaultLogo = async (req, res, next) => {
+  /**
+   * @type {{
+   *  blocklet: import('@abtnode/client').BlockletState, // 目前肯定是不准确的，但是有些属性是通用的，无伤大雅
+   *  sendOptions: any
+   * }}
+   * */
   const { blocklet, sendOptions } = req;
 
   if (blocklet && get(blocklet, 'env.dataDir')) {
@@ -83,7 +130,20 @@ const ensureDefaultLogo = async (req, res, next) => {
   next();
 };
 
+/**
+ *
+ * @param {import('express').Request} req
+ * @param {import('express').Response & {sendFallbackLogo: Function} } res
+ * @param {import('express').NextFunction} next
+ * @returns
+ */
 const ensureCustomFavicon = async (req, res, next) => {
+  /**
+   * @type {{
+   *  blocklet: import('@abtnode/client').BlockletState, // 目前肯定是不准确的，但是有些属性是通用的，无伤大雅
+   *  sendOptions: any
+   * }}
+   * */
   const { blocklet, sendOptions } = req;
 
   const customLogoFavicon = get(blocklet, 'environmentObj.BLOCKLET_APP_LOGO_FAVICON');

package/lib/logo.js

@@ -0,0 +1,46 @@
+const { existsSync } = require('fs-extra');
+const isUrl = require('is-url');
+const { join } = require('path');
+const axios = require('./axios');
+
+/**
+ *
+ *
+ * @param {{
+ *  customLogoSquareUrl?: string;
+ *  appDir: string;
+ *  logo?: string;
+ *  defaultLogoPath?: string;
+ * }}{ blocklet }
+ * @return {Promise<string | undefined>}
+ */
+async function getLogoUrl({ customLogoSquareUrl, appDir, logo, defaultLogoPath }) {
+  if (customLogoSquareUrl) {
+    if (isUrl(customLogoSquareUrl)) {
+      const res = await axios.get(customLogoSquareUrl, { responseType: 'stream' }).catch(() => {
+        return { data: null };
+      });
+      if (res.data) {
+        return customLogoSquareUrl;
+      }
+    } else if (appDir) {
+      const localCustomLogoSquareUrl = join(appDir, customLogoSquareUrl);
+      if (existsSync(localCustomLogoSquareUrl)) {
+        return localCustomLogoSquareUrl;
+      }
+    }
+  }
+
+  if (appDir && logo) {
+    const metaLogoPath = join(appDir, logo);
+    if (existsSync(metaLogoPath)) {
+      return metaLogoPath;
+    }
+  }
+
+  return defaultLogoPath;
+}
+
+module.exports = {
+  getLogoUrl,
+};

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.0-beta-b16cb035",
+  "version": "1.16.0-beta-1d6c582e",
   "description": "ArcBlock's JavaScript utility",
   "main": "lib/index.js",
   "files": [
@@ -18,13 +18,13 @@
   "author": "polunzh <polunzh@gmail.com> (http://github.com/polunzh)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/constant": "1.16.0-beta-b16cb035",
-    "@abtnode/logger": "1.16.0-beta-b16cb035",
-    "@arcblock/jwt": "^1.18.59",
-    "@blocklet/constant": "1.16.0-beta-b16cb035",
-    "@ocap/mcrypto": "1.18.59",
-    "@ocap/util": "1.18.59",
-    "@ocap/wallet": "1.18.59",
+    "@abtnode/constant": "1.16.0-beta-1d6c582e",
+    "@abtnode/logger": "1.16.0-beta-1d6c582e",
+    "@arcblock/jwt": "^1.18.62",
+    "@blocklet/constant": "1.16.0-beta-1d6c582e",
+    "@ocap/mcrypto": "1.18.62",
+    "@ocap/util": "1.18.62",
+    "@ocap/wallet": "1.18.62",
     "archiver": "^5.3.1",
     "axios": "^0.27.2",
     "axios-mock-adapter": "^1.21.2",
@@ -42,6 +42,7 @@
     "hpagent": "^1.1.0",
     "internal-ip": "^6.2.0",
     "is-docker": "^2.2.1",
+    "is-url": "^1.2.4",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.21",
     "multiformats": "9.9.0",
@@ -70,5 +71,5 @@
     "jest": "^27.5.1",
     "unzipper": "^0.10.11"
   },
-  "gitHead": "138bd91aee5a35b28c2de4e1e924c44932efaf3a"
+  "gitHead": "209fa1413ae05d8961942b2c21f2d83df66f4b68"
 }