@midwayjs/static-file 3.0.0-beta.16

package/CHANGELOG.md

@@ -0,0 +1,135 @@
+# 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

package/README.md

@@ -0,0 +1,85 @@
+# Midway Static File Component
+
+Static server plugin for egg, base on [koa-static-cache](https://github.com/koajs/static-cache).
+
+## Install
+
+```bash
+$ npm i @midwayjs/static-file --save
+```
+
+available in koa/egg/faas.
+
+## Usage
+
+import info component in `configuration.ts` file
+
+```ts
+import * as koa from '@midwayjs/koa';
+import * as staticFile from '@midwayjs/static-file';
+import { join } from 'path';
+
+@Configuration({
+  imports: [
+    koa,
+    staticFile,
+  ],
+  importConfigs: [
+    join(__dirname, './config')
+  ]
+})
+export class ContainerConfiguration {
+}
+
+```
+
+support all configurations in [koa-static-cache](https://github.com/koajs/static-cache). and with default configurations below:
+
+- dynamic: `true`
+- preload: `false`
+- maxAge: `31536000` in prod env, `0` in other envs
+- buffer: `true` in prod env, `false` in other envs
+
+provides one more option:
+
+- maxFiles: the maximum value of cache items, only effective when dynamic is true, default is `1000`.
+
+**All static files in `$appDir/public` can be visited with prefix `/public`, and all the files are lazy loaded.**
+
+- In non-production environment, assets won't be cached, your modification can take effect immediately.
+- In production environment, `@midwayjs/static-file` will cache the assets after visited, you need to restart the process to update the assets.
+- Dir default is `$appDir/public` but you can also define **multiple directory** by default, static server will use all these directories.
+
+```js
+// {app_root}/src/config/config.default.ts
+export const staticFile = {
+  dirs: {
+    default: {
+      prefix: '/public',
+      dir: 'xxx'
+    },
+    antoherDir: {
+      prefix: '/',
+      dir: 'xxx'
+    }
+  }
+};
+```
+
+if you want to override default prefix, just set `dirs.default`.
+
+```js
+// {app_root}/src/config/config.default.ts
+export const staticFile = {
+  dirs: {
+    default: {
+      prefix: '/',
+    },
+  }
+};
+```
+
+
+## License
+
+[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/config/config.default.d.ts

@@ -0,0 +1,6 @@
+import { StaticFileOptions } from '../interface';
+declare const _default: (appInfo: any) => {
+    staticFile: StaticFileOptions;
+};
+export default _default;
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+exports.default = appInfo => {
+    return {
+        staticFile: {
+            dirs: {
+                default: {
+                    prefix: '/public',
+                    dir: (0, path_1.join)(appInfo.appDir, 'public'),
+                },
+            },
+            dynamic: true,
+            preload: false,
+            buffer: false,
+            maxFiles: 1000,
+        },
+    };
+};
+//# sourceMappingURL=config.default.js.map

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

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

package/dist/config/config.prod.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.staticFile = void 0;
+exports.staticFile = {
+    maxAge: 31536000,
+    buffer: true,
+};
+//# sourceMappingURL=config.prod.js.map

package/dist/configuration.d.ts

@@ -0,0 +1,6 @@
+import { MidwayApplicationManager } from '@midwayjs/core';
+export declare class StaticFileConfiguration {
+    applicationManager: MidwayApplicationManager;
+    onReady(): Promise<void>;
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,41 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticFileConfiguration = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const static_middleware_1 = require("./middleware/static.middleware");
+const core_1 = require("@midwayjs/core");
+const DefaultConfig = require("./config/config.default");
+let StaticFileConfiguration = class StaticFileConfiguration {
+    async onReady() {
+        this.applicationManager
+            .getApplications(['koa', 'faas', 'egg'])
+            .forEach(app => {
+            app.getMiddleware().insertFirst(static_middleware_1.StaticMiddleware);
+        });
+    }
+};
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], StaticFileConfiguration.prototype, "applicationManager", void 0);
+StaticFileConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        namespace: 'info',
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
+    })
+], StaticFileConfiguration);
+exports.StaticFileConfiguration = StaticFileConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/error.d.ts

@@ -0,0 +1,8 @@
+import { MidwayError } from '@midwayjs/core';
+export declare const StaticFileErrorEnum: {
+    readonly DIRECTORY_NOT_EXISTS: "STATIC_FILE_10000";
+};
+export declare class DirectoryNotFoundError extends MidwayError {
+    constructor(p: string);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/error.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DirectoryNotFoundError = exports.StaticFileErrorEnum = void 0;
+const core_1 = require("@midwayjs/core");
+exports.StaticFileErrorEnum = (0, core_1.registerErrorCode)('static_file', {
+    DIRECTORY_NOT_EXISTS: 10000,
+});
+class DirectoryNotFoundError extends core_1.MidwayError {
+    constructor(p) {
+        super(`Path ${p} not exist, please check it.`, exports.StaticFileErrorEnum.DIRECTORY_NOT_EXISTS);
+    }
+}
+exports.DirectoryNotFoundError = DirectoryNotFoundError;
+//# sourceMappingURL=error.js.map

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { StaticFileConfiguration as Configuration } from './configuration';
+export * from './middleware/static.middleware';
+export * from './interface';
+export * from './error';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.StaticFileConfiguration; } });
+__exportStar(require("./middleware/static.middleware"), exports);
+__exportStar(require("./interface"), exports);
+__exportStar(require("./error"), exports);
+//# sourceMappingURL=index.js.map

package/dist/interface.d.ts

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

package/dist/interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interface.js.map

package/dist/middleware/static.middleware.d.ts

@@ -0,0 +1,12 @@
+import { MidwayMiddlewareService } from '@midwayjs/core';
+export declare class StaticMiddleware {
+    private staticFileConfig;
+    middlewareService: MidwayMiddlewareService<any, any>;
+    logger: any;
+    resolve(app: any): Promise<{
+        (context: any, next?: any): Promise<any>;
+        _name: string;
+    }>;
+    static getName(): string;
+}
+//# sourceMappingURL=static.middleware.d.ts.map

package/dist/middleware/static.middleware.js

@@ -0,0 +1,74 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticMiddleware = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const core_1 = require("@midwayjs/core");
+const assert = require("assert");
+const staticCache = require("koa-static-cache");
+const LRU = require("ylru");
+const range = require("koa-range");
+const error_1 = require("../error");
+let StaticMiddleware = class StaticMiddleware {
+    async resolve(app) {
+        const dirs = Object.values(this.staticFileConfig.dirs);
+        if (this.staticFileConfig.dir) {
+            dirs.push(this.staticFileConfig.dir);
+        }
+        const prefixs = [];
+        function rangeMiddleware(ctx, next) {
+            // if match static file, and use range middleware.
+            const isMatch = prefixs.some(p => ctx.path.startsWith(p));
+            if (isMatch) {
+                return range(ctx, next);
+            }
+            return next();
+        }
+        const middlewares = [rangeMiddleware];
+        for (const dirObj of dirs) {
+            assert(decorator_1.Types.isObject(dirObj) || decorator_1.Types.isString(dirObj), '`config.static.dir` must be `string | Array<string|object>`.');
+            const newOptions = Object.assign({}, this.staticFileConfig, dirObj);
+            if (newOptions.dynamic && !newOptions.files) {
+                newOptions.files = new LRU(newOptions.maxFiles);
+            }
+            if (newOptions.prefix) {
+                prefixs.push(newOptions.prefix);
+            }
+            // ensure directory exists
+            if (!(await decorator_1.FileUtils.exists(newOptions.dir))) {
+                throw new error_1.DirectoryNotFoundError(newOptions.dir);
+            }
+            this.logger.info('[@midwayjs/static] starting static serve %s -> %s', newOptions.prefix, newOptions.dir);
+            middlewares.push(staticCache(newOptions));
+        }
+        return await this.middlewareService.compose(middlewares, app, 'staticFile');
+    }
+    static getName() {
+        return 'staticFile';
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('staticFile'),
+    __metadata("design:type", Object)
+], StaticMiddleware.prototype, "staticFileConfig", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayMiddlewareService)
+], StaticMiddleware.prototype, "middlewareService", void 0);
+__decorate([
+    (0, decorator_1.Logger)('coreLogger'),
+    __metadata("design:type", Object)
+], StaticMiddleware.prototype, "logger", void 0);
+StaticMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], StaticMiddleware);
+exports.StaticMiddleware = StaticMiddleware;
+//# sourceMappingURL=static.middleware.js.map

package/index.d.ts

@@ -0,0 +1,8 @@
+import { StaticFileOptions } from './dist/index';
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    staticFile?: Partial<StaticFileOptions>;
+  }
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@midwayjs/static-file",
+  "description": "midway static file component",
+  "version": "3.0.0-beta.16",
+  "main": "dist/index",
+  "typings": "index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "koa-range": "0.3.0",
+    "ylru": "1.2.1",
+    "koa-static-cache": "5.1.4"
+  },
+  "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"
+  },
+  "keywords": [
+    "midway",
+    "koa-static",
+    "assets",
+    "static"
+  ],
+  "author": "czy88840616 <czy88840616@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
+    "ci": "npm run test",
+    "lint": "mwts check"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/midwayjs/midway.git"
+  }
+}