@wooksjs/event-cli 0.1.0

package/README.md

@@ -0,0 +1,42 @@
+# @wooksjs/event-cli
+
+**!!! This is work-in-progress library, breaking changes are expected !!!**
+
+<p align="center">
+<img src="../../logo.png" width="128px"><br>
+<a  href="https://github.com/prostojs/wooks/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge" />
+</a>
+</p>
+
+As a part of `wooks` event processing framework, `@wooksjs/event-cli` implements CLI events and provides composables that let you:
+
+- access flags (- or --)
+
+## Install
+
+`npm install wooks @wooksjs/event-cli`
+
+## Quick Start
+
+```js
+import { useRouteParams, Wooks } from 'wooks'
+import { WooksCli, cliShortcuts, useFlags } from '@wooksjs/event-cli'
+
+const app = new Wooks().shortcuts(cliShortcuts)
+
+app.cli('test', () => {
+    console.log('flags:')
+    return useFlags()
+})
+
+app.cli(':arg', () => {
+    console.log('run argument:', useRouteParams().params)
+    return 'done'
+})
+
+app.subscribe(new WooksCli())
+
+// node ./index.js test
+// node ./index.js random
+```

package/dist/index.cjs

@@ -0,0 +1,105 @@
+'use strict';
+
+var eventCore = require('@wooksjs/event-core');
+var minimist = require('minimist');
+
+function createCliContext(data) {
+    return eventCore.createEventContext({
+        event: Object.assign(Object.assign({}, data), { type: 'CLI' }),
+    });
+}
+function useCliContext() {
+    return eventCore.useEventContext('CLI');
+}
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+const banner = () => `[${"@wooksjs/event-cli"}][${new Date().toISOString().replace('T', ' ').replace(/\.\d{3}z$/i, '')}] `;
+
+/* istanbul ignore file */
+function logError(error) {
+    console.error('' + '' + banner() + error + '');
+}
+
+const cliShortcuts = {
+    cli: 'CLI',
+};
+class WooksCli {
+    subscribe(lookup) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const argv = process.argv.slice(2);
+            const firstFlagIndex = argv.findIndex(a => a.startsWith('-')) + 1;
+            const routing = { method: 'CLI', url: '/' + (firstFlagIndex ? argv.slice(0, firstFlagIndex - 1) : argv).map(v => encodeURIComponent(v)).join('/') };
+            const { restoreCtx, clearCtx } = createCliContext({ argv });
+            const handlers = lookup(routing);
+            if (handlers) {
+                try {
+                    for (const handler of handlers) {
+                        restoreCtx();
+                        const response = yield handler();
+                        if (typeof response === 'string') {
+                            console.log(response);
+                        }
+                        else if (Array.isArray(response)) {
+                            response.forEach(r => console.log(typeof r === 'string' ? r : JSON.stringify(r, null, '  ')));
+                        }
+                        else {
+                            console.log(JSON.stringify(response, null, '  '));
+                        }
+                    }
+                }
+                catch (e) {
+                    logError(e.message);
+                    process.exit(1);
+                }
+                clearCtx();
+            }
+            else {
+                logError('Unknown command parameters');
+                process.exit(1);
+            }
+        });
+    }
+}
+
+function useFlags() {
+    const { store } = useCliContext();
+    const flags = store('flags');
+    if (!flags.value) {
+        flags.value = minimist(store('event').value.argv);
+    }
+    return flags.value;
+}
+function useFlag(name) {
+    return useFlags()[name];
+}
+
+exports.WooksCli = WooksCli;
+exports.cliShortcuts = cliShortcuts;
+exports.createCliContext = createCliContext;
+exports.useCliContext = useCliContext;
+exports.useFlag = useFlag;
+exports.useFlags = useFlags;

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+import { TGenericContextStore } from '@wooksjs/event-core';
+import { TGenericEvent } from '@wooksjs/event-core';
+import { TWooksLookupArgs } from 'wooks';
+import { TWooksLookupHandlers } from 'wooks';
+import { TWooksSubscribeAdapter } from 'wooks';
+
+export declare const cliShortcuts: {
+    cli: string;
+};
+
+export declare function createCliContext(data: TCliEventData): {
+    getCtx: () => TCliContextStore;
+    restoreCtx: () => TCliContextStore;
+    clearCtx: () => null;
+    store: <K extends keyof TCliContextStore>(key: K) => {
+        value: TCliContextStore[K];
+        hook: <K2 extends keyof Required<TCliContextStore>[K]>(key2: K2) => {
+            value: Required<TCliContextStore>[K][K2];
+            isDefined: boolean;
+        };
+        init: <K2_1 extends keyof Required<TCliContextStore>[K]>(key2: K2_1, getter: () => Required<Required<TCliContextStore>[K]>[K2_1]) => Required<Required<TCliContextStore>[K]>[K2_1];
+        set: <K2_2 extends keyof Required<TCliContextStore>[K]>(key2: K2_2, v: Required<TCliContextStore[K]>[K2_2]) => Required<TCliContextStore[K]>[K2_2];
+        get: <K2_3 extends keyof Required<TCliContextStore>[K]>(key2: K2_3) => Required<TCliContextStore>[K][K2_3];
+        has: <K2_4 extends keyof Required<TCliContextStore>[K]>(key2: K2_4) => boolean;
+        del: <K2_5 extends keyof Required<TCliContextStore>[K]>(key2: K2_5) => void;
+        entries: () => [string, unknown][];
+        clear: () => void;
+    };
+    getStore: <K_1 extends keyof TCliContextStore>(key: K_1) => TCliContextStore[K_1];
+    setStore: <K_2 extends keyof TCliContextStore>(key: K_2, v: TCliContextStore[K_2]) => void;
+};
+
+declare interface TCliContextStore extends TGenericContextStore<TCliEvent> {
+    flags?: {
+        [name: string]: boolean | string;
+    };
+}
+
+declare interface TCliEvent extends TGenericEvent, TCliEventData {
+    type: 'CLI';
+}
+
+declare interface TCliEventData {
+    argv: string[];
+}
+
+export declare function useCliContext<T extends object>(): {
+    getCtx: () => TCliContextStore & T;
+    restoreCtx: () => TCliContextStore & T;
+    clearCtx: () => null;
+    store: <K extends keyof TCliContextStore | keyof T>(key: K) => {
+        value: (TCliContextStore & T)[K];
+        hook: <K2 extends keyof Required<TCliContextStore & T>[K]>(key2: K2) => {
+            value: Required<TCliContextStore & T>[K][K2];
+            isDefined: boolean;
+        };
+        init: <K2_1 extends keyof Required<TCliContextStore & T>[K]>(key2: K2_1, getter: () => Required<Required<TCliContextStore & T>[K]>[K2_1]) => Required<Required<TCliContextStore & T>[K]>[K2_1];
+        set: <K2_2 extends keyof Required<TCliContextStore & T>[K]>(key2: K2_2, v: Required<(TCliContextStore & T)[K]>[K2_2]) => Required<(TCliContextStore & T)[K]>[K2_2];
+        get: <K2_3 extends keyof Required<TCliContextStore & T>[K]>(key2: K2_3) => Required<TCliContextStore & T>[K][K2_3];
+        has: <K2_4 extends keyof Required<TCliContextStore & T>[K]>(key2: K2_4) => boolean;
+        del: <K2_5 extends keyof Required<TCliContextStore & T>[K]>(key2: K2_5) => void;
+        entries: () => [string, unknown][];
+        clear: () => void;
+    };
+    getStore: <K_1 extends keyof TCliContextStore | keyof T>(key: K_1) => (TCliContextStore & T)[K_1];
+    setStore: <K_2 extends keyof TCliContextStore | keyof T>(key: K_2, v: (TCliContextStore & T)[K_2]) => void;
+};
+
+export declare function useFlag(name: string): string | boolean;
+
+export declare function useFlags(): {
+    [name: string]: string | boolean;
+};
+
+export declare class WooksCli implements TWooksSubscribeAdapter {
+    subscribe(lookup: (route: TWooksLookupArgs) => TWooksLookupHandlers | null): Promise<void>;
+}
+
+export { }

package/dist/index.mjs

@@ -0,0 +1,98 @@
+import { createEventContext, useEventContext } from '@wooksjs/event-core';
+import minimist from 'minimist';
+
+function createCliContext(data) {
+    return createEventContext({
+        event: Object.assign(Object.assign({}, data), { type: 'CLI' }),
+    });
+}
+function useCliContext() {
+    return useEventContext('CLI');
+}
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+const banner = () => `[${"@wooksjs/event-cli"}][${new Date().toISOString().replace('T', ' ').replace(/\.\d{3}z$/i, '')}] `;
+
+/* istanbul ignore file */
+function logError(error) {
+    console.error('' + '' + banner() + error + '');
+}
+
+const cliShortcuts = {
+    cli: 'CLI',
+};
+class WooksCli {
+    subscribe(lookup) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const argv = process.argv.slice(2);
+            const firstFlagIndex = argv.findIndex(a => a.startsWith('-')) + 1;
+            const routing = { method: 'CLI', url: '/' + (firstFlagIndex ? argv.slice(0, firstFlagIndex - 1) : argv).map(v => encodeURIComponent(v)).join('/') };
+            const { restoreCtx, clearCtx } = createCliContext({ argv });
+            const handlers = lookup(routing);
+            if (handlers) {
+                try {
+                    for (const handler of handlers) {
+                        restoreCtx();
+                        const response = yield handler();
+                        if (typeof response === 'string') {
+                            console.log(response);
+                        }
+                        else if (Array.isArray(response)) {
+                            response.forEach(r => console.log(typeof r === 'string' ? r : JSON.stringify(r, null, '  ')));
+                        }
+                        else {
+                            console.log(JSON.stringify(response, null, '  '));
+                        }
+                    }
+                }
+                catch (e) {
+                    logError(e.message);
+                    process.exit(1);
+                }
+                clearCtx();
+            }
+            else {
+                logError('Unknown command parameters');
+                process.exit(1);
+            }
+        });
+    }
+}
+
+function useFlags() {
+    const { store } = useCliContext();
+    const flags = store('flags');
+    if (!flags.value) {
+        flags.value = minimist(store('event').value.argv);
+    }
+    return flags.value;
+}
+function useFlag(name) {
+    return useFlags()[name];
+}
+
+export { WooksCli, cliShortcuts, createCliContext, useCliContext, useFlag, useFlags };

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@wooksjs/event-cli",
+  "version": "0.1.0",
+  "description": "@wooksjs/event-cli",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wooksjs/wooksjs.git",
+    "directory": "packages/event-cli"
+  },
+  "keywords": [
+    "http",
+    "wooks",
+    "composables",
+    "web",
+    "framework",
+    "app",
+    "api",
+    "rest",
+    "restful",
+    "prostojs"
+  ],
+  "author": "Artem Maltsev",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/wooksjs/wooksjs/issues"
+  },
+  "homepage": "https://github.com/wooksjs/wooksjs/tree/main/packages/event-cli#readme",
+  "dependencies": {
+    "minimist": "^1.2.6",
+    "@wooksjs/event-core": "0.1.0",
+    "wooks": "0.1.0"
+  }
+}