@midwayjs/static-file 3.0.0-beta.16 → 3.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/config/config.default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.default.js","sourceRoot":"","sources":["../../src/config/config.default.ts"],"names":[],"mappings":";;AACA,+BAA4B;AAE5B,kBAAe,OAAO,CAAC,EAAE;IACvB,OAAO;QACL,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,OAAO,EAAE;oBACP,MAAM,EAAE,SAAS;oBACjB,GAAG,EAAE,IAAA,WAAI,EAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC;iBACpC;aACF;YACD,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,IAAI;SACf;KAGF,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import { StaticFileOptions } from '../interface';\nimport { join } from 'path';\n\nexport default appInfo => {\n  return {\n    staticFile: {\n      dirs: {\n        default: {\n          prefix: '/public',\n          dir: join(appInfo.appDir, 'public'),\n        },\n      },\n      dynamic: true,\n      preload: false,\n      buffer: false,\n      maxFiles: 1000,\n    },\n  } as {\n    staticFile: StaticFileOptions;\n  };\n};\n"]}

package/dist/config/config.prod.d.ts

@@ -1,5 +1,3 @@
-export declare const staticFile: {
-    maxAge: number;
-    buffer: boolean;
-};
+import { StaticFileOptions } from '../interface';
+export declare const staticFile: StaticFileOptions;
 //# sourceMappingURL=config.prod.d.ts.map

package/dist/config/config.prod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.prod.js","sourceRoot":"","sources":["../../src/config/config.prod.ts"],"names":[],"mappings":";;;AAEa,QAAA,UAAU,GAAG;IACxB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,IAAI;CACQ,CAAC","sourcesContent":["import { StaticFileOptions } from '../interface';\n\nexport const staticFile = {\n  maxAge: 31536000,\n  buffer: true,\n} as StaticFileOptions;\n"]}

package/dist/configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../src/configuration.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAA4D;AAC5D,sEAAkE;AAClE,yCAA0D;AAC1D,yDAAyD;AAUzD,IAAa,uBAAuB,GAApC,MAAa,uBAAuB;IAIlC,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,kBAAkB;aACpB,eAAe,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;aACvC,OAAO,CAAC,GAAG,CAAC,EAAE;YACb,GAAG,CAAC,aAAa,EAAE,CAAC,WAAW,CAAC,oCAAgB,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACP,CAAC;CACF,CAAA;AATC;IADC,IAAA,kBAAM,GAAE;8BACW,+BAAwB;mEAAC;AAFlC,uBAAuB;IARnC,IAAA,yBAAa,EAAC;QACb,SAAS,EAAE,MAAM;QACjB,aAAa,EAAE;YACb;gBACE,OAAO,EAAE,aAAa;aACvB;SACF;KACF,CAAC;GACW,uBAAuB,CAWnC;AAXY,0DAAuB","sourcesContent":["import { Configuration, Inject } from '@midwayjs/decorator';\nimport { StaticMiddleware } from './middleware/static.middleware';\nimport { MidwayApplicationManager } from '@midwayjs/core';\nimport * as DefaultConfig from './config/config.default';\n\n@Configuration({\n  namespace: 'info',\n  importConfigs: [\n    {\n      default: DefaultConfig,\n    },\n  ],\n})\nexport class StaticFileConfiguration {\n  @Inject()\n  applicationManager: MidwayApplicationManager;\n\n  async onReady() {\n    this.applicationManager\n      .getApplications(['koa', 'faas', 'egg'])\n      .forEach(app => {\n        app.getMiddleware().insertFirst(StaticMiddleware);\n      });\n  }\n}\n"]}

package/dist/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;;AAAA,yCAAgE;AAEnD,QAAA,mBAAmB,GAAG,IAAA,wBAAiB,EAAC,aAAa,EAAE;IAClE,oBAAoB,EAAE,KAAK;CACnB,CAAC,CAAC;AAEZ,MAAa,sBAAuB,SAAQ,kBAAW;IACrD,YAAY,CAAS;QACnB,KAAK,CACH,QAAQ,CAAC,8BAA8B,EACvC,2BAAmB,CAAC,oBAAoB,CACzC,CAAC;IACJ,CAAC;CACF;AAPD,wDAOC","sourcesContent":["import { registerErrorCode, MidwayError } from '@midwayjs/core';\n\nexport const StaticFileErrorEnum = registerErrorCode('static_file', {\n  DIRECTORY_NOT_EXISTS: 10000,\n} as const);\n\nexport class DirectoryNotFoundError extends MidwayError {\n  constructor(p: string) {\n    super(\n      `Path ${p} not exist, please check it.`,\n      StaticFileErrorEnum.DIRECTORY_NOT_EXISTS\n    );\n  }\n}\n"]}

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,iDAA2E;AAAlE,8GAAA,uBAAuB,OAAiB;AACjD,iEAA+C;AAC/C,8CAA4B;AAC5B,0CAAwB","sourcesContent":["export { StaticFileConfiguration as Configuration } from './configuration';\nexport * from './middleware/static.middleware';\nexport * from './interface';\nexport * from './error';\n"]}

package/dist/interface.d.ts

@@ -23,6 +23,10 @@ export interface StaticFileOption {
      * cache control max age for the files, 0 by default.
      */
     maxFiles?: number;
+    /**
+     * cache control max age for the files, 0 by default.
+     */
+    maxAge?: number;
     /**
      * optional cache control header. Overrides options.maxAge.
      */

package/dist/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../src/interface.ts"],"names":[],"mappings":"","sourcesContent":["export interface StaticFileOption {\n  /**\n   * url prefix\n   */\n  prefix?: string;\n  /**\n   *  the directory you wish to serve\n   */\n  dir?: string;\n  /**\n   * dynamic load file which not cached on initialization.\n   */\n  dynamic?: boolean;\n  /**\n   * caches the assets on initialization or not, default to true. always work together with options.dynamic.\n   */\n  preload?: boolean;\n  /**\n   * store the files in memory instead of streaming from the filesystem on each request.\n   */\n  buffer?: boolean;\n  /**\n   * cache control max age for the files, 0 by default.\n   */\n  maxFiles?: number;\n  /**\n   * cache control max age for the files, 0 by default.\n   */\n  maxAge?: number;\n  /**\n   * optional cache control header. Overrides options.maxAge.\n   */\n  cacheControl?: string;\n  /**\n   * when request's accept-encoding include gzip, files will compressed by gzip.\n   */\n  gzip?: boolean;\n  /**\n   * object map of aliases\n   */\n  alias?: {\n    [aliasName: string]: string;\n  },\n  /**\n   * filter files at init dir, for example - skip non build (source) files. If array set - allow only listed files\n   */\n  filter?: Function | string[];\n}\n\n\nexport interface StaticFileOptions extends Omit<StaticFileOption, 'prefix' | 'dir'> {\n  dirs?: {\n    [pathName: string]: StaticFileOption;\n  },\n}\n"]}

package/dist/middleware/static.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"static.middleware.js","sourceRoot":"","sources":["../../src/middleware/static.middleware.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAO6B;AAC7B,yCAAyD;AACzD,iCAAiC;AACjC,gDAAgD;AAChD,4BAA4B;AAC5B,mCAAmC;AACnC,oCAAkD;AAGlD,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAU3B,KAAK,CAAC,OAAO,CAAC,GAAG;QACf,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;SACtC;QACD,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,SAAS,eAAe,CAAC,GAAG,EAAE,IAAI;YAChC,kDAAkD;YAClD,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,IAAI,OAAO,EAAE;gBACX,OAAO,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aACzB;YACD,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,WAAW,GAAG,CAAC,eAAe,CAAC,CAAC;QAEtC,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE;YACzB,MAAM,CACJ,iBAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,iBAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAChD,8DAA8D,CAC/D,CAAC;YAEF,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;YAEpE,IAAI,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE;gBAC3C,UAAU,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;aACjD;YAED,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;aACjC;YAED,0BAA0B;YAC1B,IAAI,CAAC,CAAC,MAAM,qBAAS,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC7C,MAAM,IAAI,8BAAsB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aAClD;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,mDAAmD,EACnD,UAAU,CAAC,MAAM,EACjB,UAAU,CAAC,GAAG,CACf,CAAC;YAEF,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;SAC3C;QAED,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAA;AA9DC;IADC,IAAA,kBAAM,EAAC,YAAY,CAAC;;0DACI;AAGzB;IADC,IAAA,kBAAM,GAAE;8BACU,8BAAuB;2DAAW;AAGrD;IADC,IAAA,kBAAM,EAAC,YAAY,CAAC;;gDACd;AARI,gBAAgB;IAD5B,IAAA,sBAAU,GAAE;GACA,gBAAgB,CAgE5B;AAhEY,4CAAgB","sourcesContent":["import {\n  Config,\n  Inject,\n  Middleware,\n  Types,\n  Logger,\n  FileUtils,\n} from '@midwayjs/decorator';\nimport { MidwayMiddlewareService } from '@midwayjs/core';\nimport * as assert from 'assert';\nimport * as staticCache from 'koa-static-cache';\nimport * as LRU from 'ylru';\nimport * as range from 'koa-range';\nimport { DirectoryNotFoundError } from '../error';\n\n@Middleware()\nexport class StaticMiddleware {\n  @Config('staticFile')\n  private staticFileConfig;\n\n  @Inject()\n  middlewareService: MidwayMiddlewareService<any, any>;\n\n  @Logger('coreLogger')\n  logger;\n\n  async resolve(app) {\n    const dirs = Object.values(this.staticFileConfig.dirs);\n    if (this.staticFileConfig.dir) {\n      dirs.push(this.staticFileConfig.dir);\n    }\n    const prefixs = [];\n\n    function rangeMiddleware(ctx, next) {\n      // if match static file, and use range middleware.\n      const isMatch = prefixs.some(p => ctx.path.startsWith(p));\n      if (isMatch) {\n        return range(ctx, next);\n      }\n      return next();\n    }\n\n    const middlewares = [rangeMiddleware];\n\n    for (const dirObj of dirs) {\n      assert(\n        Types.isObject(dirObj) || Types.isString(dirObj),\n        '`config.static.dir` must be `string | Array<string|object>`.'\n      );\n\n      const newOptions = Object.assign({}, this.staticFileConfig, dirObj);\n\n      if (newOptions.dynamic && !newOptions.files) {\n        newOptions.files = new LRU(newOptions.maxFiles);\n      }\n\n      if (newOptions.prefix) {\n        prefixs.push(newOptions.prefix);\n      }\n\n      // ensure directory exists\n      if (!(await FileUtils.exists(newOptions.dir))) {\n        throw new DirectoryNotFoundError(newOptions.dir);\n      }\n\n      this.logger.info(\n        '[@midwayjs/static] starting static serve %s -> %s',\n        newOptions.prefix,\n        newOptions.dir\n      );\n\n      middlewares.push(staticCache(newOptions));\n    }\n\n    return await this.middlewareService.compose(middlewares, app, 'staticFile');\n  }\n\n  static getName() {\n    return 'staticFile';\n  }\n}\n"]}

package/package.json

@@ -1,26 +1,27 @@
 {
   "name": "@midwayjs/static-file",
   "description": "midway static file component",
-  "version": "3.0.0-beta.16",
+  "version": "3.0.2",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
     "dist/**/*.js",
     "dist/**/*.d.ts",
-    "index.d.ts"
+    "index.d.ts",
+    "dist/**/*.js.map"
   ],
   "dependencies": {
     "koa-range": "0.3.0",
-    "ylru": "1.2.1",
-    "koa-static-cache": "5.1.4"
+    "koa-static-cache": "5.1.4",
+    "ylru": "1.2.1"
   },
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.16",
-    "@midwayjs/decorator": "^3.0.0-beta.16",
-    "@midwayjs/koa": "^3.0.0-beta.16",
-    "@midwayjs/faas": "^3.0.0-beta.16",
-    "@midwayjs/mock": "^3.0.0-beta.16",
-    "@midwayjs/serverless-app": "^3.0.0-beta.16"
+    "@midwayjs/core": "^3.0.2",
+    "@midwayjs/decorator": "^3.0.2",
+    "@midwayjs/faas": "^3.0.2",
+    "@midwayjs/koa": "^3.0.2",
+    "@midwayjs/mock": "^3.0.2",
+    "@midwayjs/serverless-app": "^3.0.2"
   },
   "keywords": [
     "midway",
@@ -43,5 +44,6 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
-  }
+  },
+  "gitHead": "ca77247d229978a736e79bb208579c014ed226fc"
 }

package/CHANGELOG.md

@@ -1,135 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [3.0.0-beta.16](https://github.com/midwayjs/midway/compare/v3.0.0-beta.15...v3.0.0-beta.16) (2022-01-11)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.15](https://github.com/midwayjs/midway/compare/v3.0.0-beta.14...v3.0.0-beta.15) (2022-01-07)
-
-
-### Features
-
-* add info middleware ([#1530](https://github.com/midwayjs/midway/issues/1530)) ([7077f1d](https://github.com/midwayjs/midway/commit/7077f1d84355633a1c2fced35bfcc2152f42a7ac))
-* add secret filter ([#1531](https://github.com/midwayjs/midway/issues/1531)) ([ce77e48](https://github.com/midwayjs/midway/commit/ce77e4804aaffc18a0a091d3726e36d7ec1514b2))
-
-
-
-
-
-# [3.0.0-beta.14](https://github.com/midwayjs/midway/compare/v3.0.0-beta.13...v3.0.0-beta.14) (2022-01-04)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.13](https://github.com/midwayjs/midway/compare/v3.0.0-beta.12...v3.0.0-beta.13) (2021-12-30)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.12](https://github.com/midwayjs/midway/compare/v3.0.0-beta.11...v3.0.0-beta.12) (2021-12-28)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.11](https://github.com/midwayjs/midway/compare/v3.0.0-beta.10...v3.0.0-beta.11) (2021-12-21)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.10](https://github.com/midwayjs/midway/compare/v3.0.0-beta.9...v3.0.0-beta.10) (2021-12-20)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.9](https://github.com/midwayjs/midway/compare/v3.0.0-beta.8...v3.0.0-beta.9) (2021-12-09)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.8](https://github.com/midwayjs/midway/compare/v3.0.0-beta.7...v3.0.0-beta.8) (2021-12-08)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.7](https://github.com/midwayjs/midway/compare/v3.0.0-beta.6...v3.0.0-beta.7) (2021-12-03)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.6](https://github.com/midwayjs/midway/compare/v3.0.0-beta.5...v3.0.0-beta.6) (2021-11-26)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.5](https://github.com/midwayjs/midway/compare/v3.0.0-beta.4...v3.0.0-beta.5) (2021-11-25)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.4](https://github.com/midwayjs/midway/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2021-11-24)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.3](https://github.com/midwayjs/midway/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-11-18)
-
-
-### Features
-
-* add component and framework config definition ([#1367](https://github.com/midwayjs/midway/issues/1367)) ([b2fe615](https://github.com/midwayjs/midway/commit/b2fe6157f99659471ff1333eca0b86bb889f61a3))
-
-
-
-
-
-# [3.0.0-beta.2](https://github.com/midwayjs/midway/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-11-16)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.1](https://github.com/midwayjs/midway/compare/v2.12.4...v3.0.0-beta.1) (2021-11-14)
-
-**Note:** Version bump only for package @midwayjs/info