@midwayjs/one-shot 4.0.0-beta.10

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/configuration.d.ts

@@ -0,0 +1,6 @@
+/**
+ * One-shot component configuration.
+ */
+export declare class OneShotConfiguration {
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,35 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneShotConfiguration = void 0;
+const core_1 = require("@midwayjs/core");
+/**
+ * One-shot component configuration.
+ */
+let OneShotConfiguration = class OneShotConfiguration {
+};
+exports.OneShotConfiguration = OneShotConfiguration;
+exports.OneShotConfiguration = OneShotConfiguration = __decorate([
+    (0, core_1.Configuration)({
+        namespace: 'oneShot',
+        importConfigs: [
+            {
+                default: {
+                    midwayLogger: {
+                        clients: {
+                            oneShotLogger: {
+                                fileLogName: 'midway-one-shot.log',
+                            },
+                        },
+                    },
+                },
+            },
+        ],
+    })
+], OneShotConfiguration);
+//# sourceMappingURL=configuration.js.map

package/dist/framework.d.ts

@@ -0,0 +1,16 @@
+import { BaseFramework, IMidwayBootstrapOptions } from '@midwayjs/core';
+import { IMidwayOneShotApplication, IMidwayOneShotContext, OneShotConfigOptions, OneShotRunner } from './interface';
+/**
+ * Framework for one-shot scripts.
+ */
+export declare class MidwayOneShotFramework extends BaseFramework<IMidwayOneShotApplication, IMidwayOneShotContext, OneShotConfigOptions> {
+    protected frameworkLoggerName: string;
+    configure(): OneShotConfigOptions;
+    applicationInitialize(_options: IMidwayBootstrapOptions): Promise<void>;
+    run(): Promise<void>;
+    /**
+     * Execute a one-shot runner class once.
+     */
+    runScript<T = unknown, R = unknown>(Runner: new (...args: unknown[]) => OneShotRunner<T, R>, payload?: T, ctxData?: Partial<IMidwayOneShotContext>): Promise<R>;
+}
+//# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -0,0 +1,48 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MidwayOneShotFramework = void 0;
+const core_1 = require("@midwayjs/core");
+/**
+ * Framework for one-shot scripts.
+ */
+let MidwayOneShotFramework = class MidwayOneShotFramework extends core_1.BaseFramework {
+    frameworkLoggerName = 'oneShotLogger';
+    configure() {
+        return this.configService.getConfiguration('oneShot');
+    }
+    async applicationInitialize(_options) {
+        void _options;
+        this.app = {};
+    }
+    async run() {
+        // one-shot framework runs on demand
+    }
+    /**
+     * Execute a one-shot runner class once.
+     */
+    async runScript(Runner, payload, ctxData = {}) {
+        const ctx = this.app.createAnonymousContext({
+            ...ctxData,
+            payload,
+        });
+        const fn = await this.applyMiddleware(async (ctx) => {
+            const instance = (await ctx.requestContext.getAsync(Runner));
+            if (!instance?.run) {
+                throw new core_1.MidwayCommonError('One-shot runner must implement run().');
+            }
+            return await instance.run(payload, ctx);
+        });
+        return (await fn(ctx));
+    }
+};
+exports.MidwayOneShotFramework = MidwayOneShotFramework;
+exports.MidwayOneShotFramework = MidwayOneShotFramework = __decorate([
+    (0, core_1.Framework)()
+], MidwayOneShotFramework);
+//# sourceMappingURL=framework.js.map

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './interface';
+export { MidwayOneShotFramework as Framework } from './framework';
+export { OneShotConfiguration as Configuration } from './configuration';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 = exports.Framework = void 0;
+__exportStar(require("./interface"), exports);
+var framework_1 = require("./framework");
+Object.defineProperty(exports, "Framework", { enumerable: true, get: function () { return framework_1.MidwayOneShotFramework; } });
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.OneShotConfiguration; } });
+//# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -0,0 +1,19 @@
+import { IConfigurationOptions, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
+export interface OneShotConfigOptions extends IConfigurationOptions {
+}
+/**
+ * One-shot execution context.
+ */
+export interface IMidwayOneShotContext extends IMidwayContext {
+    payload?: unknown;
+}
+export type IMidwayOneShotApplication = IMidwayApplication<IMidwayOneShotContext>;
+export type Application = IMidwayOneShotApplication;
+export type Context = IMidwayOneShotContext;
+/**
+ * One-shot runner contract.
+ */
+export interface OneShotRunner<T = unknown, R = unknown> {
+    run(payload?: T, ctx?: IMidwayOneShotContext): R | Promise<R>;
+}
+//# 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/index.d.ts

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

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@midwayjs/one-shot",
+  "version": "4.0.0-beta.10",
+  "description": "Midway One-shot Framework",
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "keywords": [
+    "midway",
+    "component",
+    "one-shot"
+  ],
+  "author": "czy88840616@gmail.com",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "node -r ts-node/register ../../node_modules/jest/bin/jest.js --runInBand",
+    "cov": "node -r ts-node/register ../../node_modules/jest/bin/jest.js --runInBand --coverage --forceExit",
+    "ci": "npm run test",
+    "lint": "mwts check"
+  },
+  "dependencies": {
+    "@midwayjs/core": "^4.0.0-beta.10"
+  },
+  "devDependencies": {
+    "@midwayjs/mock": "^4.0.0-beta.10"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "license": "MIT",
+  "gitHead": "1b1856629913703f67304155aaf611ec936a81ac"
+}