not-options 0.2.0 → 0.2.2

package/index.js

@@ -11,10 +11,10 @@ try{
 	});
 
 	module.exports = {
-		name: 'not-options',
+		name: require('./src/const').MODULE_NAME,
 		paths,
-		getMiddleware(options){
-			log.info('...options middleware');
+		getMiddleware(){
+			log?.info('...options middleware');
 			return middleware.bind(this);
 		},
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "not-options",
-	"version": "0.2.0",
+	"version": "0.2.2",
 	"description": "not-* family options model in not- environment",
 	"main": "index.js",
 	"scripts": {
@@ -37,4 +37,4 @@
 		"jsdoc": "^3.6.7",
 		"mocha": "*"
 	}
-}
+}

package/src/const.js

@@ -0,0 +1,4 @@
+module.exports  ={
+    MODULE_NAME: 'not-options',
+    DATA_MODEL_NAME: "options"
+};

package/src/controllers/common/actions/json.import.export/export.to.json.js

@@ -0,0 +1,103 @@
+import CRUDGenericActionRead from "not-bulma/src/frame/crud/actions/generic/read";
+import UIExportToJSON from "./export.to.json.svelte";
+import { MODULE_NAME, DATA_MODEL_NAME } from "../../../../const.js";
+
+const DEFAULT_BREADCRUMB_TAIL = `${MODULE_NAME}:action_export_to_json_title`;
+
+ class ncaExportToJSON extends CRUDGenericActionRead {
+    /**
+     * @static {string} ACTION this controller action name, used in URI
+     */
+    static get ACTION() {
+        return "exportToJSON";
+    }
+
+    static get deafultBreadcrumbsTail() {
+        return DEFAULT_BREADCRUMB_TAIL;
+    }
+
+    static get breadcrumbsTails() {
+        return {
+            preset: DEFAULT_BREADCRUMB_TAIL,
+            set: DEFAULT_BREADCRUMB_TAIL,
+        };
+    }
+
+    /**
+     * @static {string} MODEL_ACTION    network model interface action name, used in API
+     */
+    static get MODEL_ACTION_GET() {
+        return "exportToJSON";
+    }
+
+    /**
+     * @static {object} UIConstructor    constructor of UI component
+     */
+    static get UIConstructor() {
+        return UIExportToJSON;
+    }
+
+    static actionButton(controller) {
+        return {
+            title: `${MODULE_NAME}:action_export_to_json_title`,
+            action() {
+                controller.navigateAction(undefined, ncaExportToJSON.ACTION);
+            },
+        };
+    }
+
+    static prepareUIOptions(controller, response) {
+        const actionName = this.getModelActionName(controller);
+        return {
+            target: controller.getContainerInnerElement(),
+            props: {
+                value: response.result,
+                actionName,
+            },
+        };
+    }
+
+    static async loadData(controller, params) {
+        return await controller
+            .getModel(DATA_MODEL_NAME, {
+                moduleName: controller.getModuleName(),
+            })
+            .$getForModule();
+    }
+
+    static async run(controller, params) {
+        try {
+            //inform that we are starting
+            controller.emit(`before:render:${this.ACTION}`, params);
+            //if UI for this action exists exiting
+            if (this.isUIRendered(controller)) {
+                return;
+            }
+            //setting initial state of breadcrumbs tail
+            this.presetBreadcrumbs(controller, params);
+            const response = await this.loadData(controller, params);
+            if (this.isResponseBad(response)) {
+                return controller.showErrorMessage(response);
+            }
+            //creating action UI component
+            const uiComponent = this.UIConstructor;
+            this.setUI(
+                controller,
+                new uiComponent(this.prepareUIOptions(controller, response))
+            );
+            //bind events to UI
+            this.bindUIEvents(controller, params, response);
+            //inform that we are ready
+            controller.emit(`after:render:${this.ACTION}`, params, response);
+        } catch (e) {
+            //informing about exception
+            controller.emit(`exception:render:${this.ACTION}`, params, e);
+            //reporting exception
+            controller.report(e);
+            //showing error message
+            controller.showErrorMessage(e);
+        }
+    }
+}
+
+export default ncaExportToJSON;

package/src/controllers/common/actions/json.import.export/export.to.json.svelte

@@ -0,0 +1,19 @@
+<script>
+    export let value = {};
+    import UIButtons from "not-bulma/src/elements/button/ui.buttons.svelte";
+
+    $: json = value && JSON.stringify(value, null, 4);
+
+    const BUTTONS = [
+        {
+            icon: "clipboard",
+            action: () => {
+                navigator.clipboard.writeText(json);
+            },
+        },
+    ];
+</script>
+
+<pre class="not-top-padding">
+    <UIButtons values={BUTTONS} right={true} />
+{json}</pre>

package/src/controllers/common/actions/json.import.export/import.from.json.js

@@ -0,0 +1,139 @@
+import CRUDGenericActionCreate from "not-bulma/src/frame/crud/actions/generic/create";
+import UIImportFromJSON from "./import.from.json.svelte";
+import { MODULE_NAME,DATA_MODEL_NAME } from "./../../../../const.js";
+import notCommon from "not-bulma/src/frame/common";
+
+const DEFAULT_BREADCRUMB_TAIL = `${MODULE_NAME}:action_import_from_json_title`;
+
+class ncaImportFromJSON extends CRUDGenericActionCreate {
+    static get deafultBreadcrumbsTail() {
+        return DEFAULT_BREADCRUMB_TAIL;
+    }
+
+    static get breadcrumbsTails() {
+        return {
+            preset: DEFAULT_BREADCRUMB_TAIL,
+            set: DEFAULT_BREADCRUMB_TAIL,
+        };
+    }
+
+    /**
+     * @static {string} ACTION this controller action name, used in URI
+     */
+    static get ACTION() {
+        return "importFromJSON";
+    }
+
+    static get MODEL_ACTION_GET() {
+        return undefined;
+    }
+
+    static get MODEL_ACTION_PUT() {
+        return "updateForModule";
+    }
+
+    /**
+     * @static {object} UIConstructor    constructor of UI component
+     */
+    static get UIConstructor() {
+        return UIImportFromJSON;
+    }
+
+    static prepareUIOptions(controller, value) {
+        const actionName = this.getModelActionName(controller);
+        return {
+            props: {
+                actionName,
+            },
+            target: controller.getContainerInnerElement(),
+        };
+    }
+
+    static actionButton(controller) {
+        return {
+            action() {
+                controller.navigateAction(undefined, ncaImportFromJSON.ACTION);
+            },
+            title: `${MODULE_NAME}:action_import_from_json_title`,
+        };
+    }
+
+    static async run(controller, params) {
+        try {
+            //inform that we are starting
+            controller.emit(`before:render:${this.ACTION}`, params);
+            //if UI for this action exists exiting
+            if (this.isUIRendered(controller)) {
+                return;
+            }
+            //setting initial state of breadcrumbs tail
+            this.presetBreadcrumbs(controller, params);
+            //creating action UI component
+            const uiComponent = this.UIConstructor;
+            const response = {};
+            this.setUI(
+                controller,
+                new uiComponent(this.prepareUIOptions(controller, response))
+            );
+            //bind events to UI
+            this.bindUIEvents(controller, params, response);
+            //inform that we are ready
+            controller.emit(`after:render:${this.ACTION}`, params, response);
+        } catch (e) {
+            //informing about exception
+            controller.emit(`exception:render:${this.ACTION}`, params, e);
+            //reporting exception
+            controller.report(e);
+            //showing error message
+            controller.showErrorMessage(e);
+        }
+    }
+
+    static bindUIEvents(controller, params, response) {
+        if (notCommon.isFunc(controller.goBack)) {
+            this.bindUIEvent(controller, "reject", () => controller.goBack());
+        }
+
+        this.bindUIEvent(controller, "import", ({ detail }) => {
+            ncaImportFromJSON.import(controller, detail);
+        });
+    }
+
+    static setUILoading(controller) {
+        this.getUI(controller).$set({ loading: true });
+    }
+
+    static setUILoaded(controller) {
+        this.getUI(controller).$set({ loading: false });
+    }
+
+    static setUIError(controller, message) {
+        this.getUI(controller).$set({ error: message });
+    }
+
+    static async import(controller, jsonAsText) {
+        try {
+            ncaImportFromJSON.setUILoading(controller);
+            const res = await controller
+                .getModel(DATA_MODEL_NAME, { 
+                    moduleName: controller.MODULE_NAME,
+                    options: jsonAsText 
+                })
+                [`$${ncaImportFromJSON.MODEL_ACTION_PUT}`]();
+            if (this.isResponseBad(res)) {
+                controller.showErrorMessage(res);
+            } else {
+                controller.showSuccessMessage(
+                    "",
+                    `${MODULE_NAME}:action_import_success`
+                );
+                controller.navigateAction(undefined, "list", "NORMAL");
+            }
+        } catch (e) {
+            controller.showErrorMessage(e);
+        } finally {
+            ncaImportFromJSON.setUILoaded(controller);
+        }
+    }
+}
+export default ncaImportFromJSON;

package/src/controllers/common/actions/json.import.export/import.from.json.svelte

@@ -0,0 +1,21 @@
+<script>
+    import { createEventDispatcher } from "svelte";
+    const dispatch = createEventDispatcher();
+    import UITextarea from "not-bulma/src/elements/form/ui.textarea.svelte";
+    import UIButton from "not-bulma/src/elements/button/ui.button.svelte";
+    import { MODULE_NAME } from "../../../../const.js";
+    export let value = "";
+    export let loading = false;
+</script>
+
+<UITextarea bind:value rows={20} disabled={loading} placeholder={""} />
+
+<UIButton
+    action={() => {
+        dispatch("import", value);
+    }}
+    color={"primary"}
+    disabled={loading}
+    {loading}
+    title={`${MODULE_NAME}:action_import_from_json_title`}
+/>

package/src/controllers/common/index.js

@@ -1,3 +1,5 @@
+import 'styles.scss';
+
 export default class Common{
 	static DEFAULT_REDIRECT_TIMEOUT = 5000;
 	static CLASS_OK = 'is-success';

package/src/controllers/common/styles.scss

@@ -0,0 +1,3 @@
+.not-top-padding{
+    padding-top: 0rem!important;
+}

package/src/controllers/root/ncOptions.js

@@ -1,176 +1,166 @@
-import Validators from '../common/validators.js';
-import {
-	Frame
-} from 'not-bulma';
+import Validators from "../common/validators.js";
+import { Frame } from "not-bulma";
 
 const notCRUD = Frame.notCRUD;
 
-import UIImport from '../common/import.svelte';
+import UIImport from "../common/import.svelte";
+import CRUDActionList from "not-bulma/src/frame/crud/actions/list";
 
 const LABELS = {
-	plural: 'Настройки',
-	single: 'Настройка',
+    plural: "Настройки",
+    single: "Настройка",
 };
 
-const MODEL = 'options';
+const MODEL = "options";
 
 class ncOptions extends notCRUD {
-	static MODEL_NAME = MODEL;
-	static MODULE_NAME = '';
-	constructor(app, params, schemes) {
-		super(app, MODEL);
-		this.setModuleName('');
-		this.setModelName(MODEL);
-		this.setOptions('names', LABELS);
-		this.setOptions('Validators', Validators);
-		this.setOptions('params', params);
-		this.setOptions('role', 'root');
-		this.setOptions('urlSchemes', schemes);
-		this.setOptions('list', {
-			actions: [{
-					title: 'Экспорт',
-					action: this.openExport.bind(this)
-				},
-				{
-					title: 'Импорт',
-					action: this.openImport.bind(this)
-				}
-			],
-			fields: [{
-				path: ':optionsID',
-				title: 'ID',
-				searchable: true,
-				sortable: true
-			}, {
-				path: ':id',
-				title: 'Название',
-				searchable: true,
-				sortable: true
-			}, {
-				path: ':value',
-				title: 'Значение',
-				searchable: true,
-				sortable: true,
-				hideOnMobile: true
-			}, {
-				path: ':active',
-				title: 'Активна',
-				type: 'boolean',
-				searchable: true,
-				sortable: true,
-				preprocessor: (value) => {
-					return [{
-						value
-					}];
-				},
-				hideOnMobile: true
-			}, {
-				path: ':_id',
-				title: 'Действия',
-				type: 'button',
-				preprocessor: (value) => {
-					return [{
-							action: this.goDetails.bind(this, value),
-							title: 'Подробнее',
-							size: 'small'
-						},
-						{
-							action: this.goUpdate.bind(this, value),
-							title: 'Изменить',
-							size: 'small'
-						},
-						{
-							action: this.goDelete.bind(this, value),
-							type: 'danger',
-							title: 'Удалить',
-							size: 'small',
-							style: 'outlined'
-						}
-					];
-				},
-			}]
-		});
-		this.start();
-		return this;
-	}
+    static MODEL_NAME = MODEL;
+    static MODULE_NAME = "";
+    constructor(app, params, schemes) {
+        super(app, MODEL);
+        this.setModuleName("");
+        this.setModelName(MODEL);
+        this.setOptions("names", LABELS);
+        this.setOptions("Validators", Validators);
+        this.setOptions("params", params);
+        this.setOptions("role", "root");
+        this.setOptions("urlSchemes", schemes);
+        this.setOptions("list", {
+            actions: [
+                {
+                    title: "Экспорт",
+                    action: this.openExport.bind(this),
+                },
+                {
+                    title: "Импорт",
+                    action: this.openImport.bind(this),
+                },
+            ],
+            fields: [
+                {
+                    path: ":optionsID",
+                    title: "ID",
+                    searchable: true,
+                    sortable: true,
+                },
+                {
+                    path: ":id",
+                    title: "Название",
+                    searchable: true,
+                    sortable: true,
+                },
+                {
+                    path: ":value",
+                    title: "Значение",
+                    searchable: true,
+                    sortable: true,
+                    hideOnMobile: true,
+                },
+                {
+                    path: ":active",
+                    title: "Активна",
+                    type: "boolean",
+                    searchable: true,
+                    sortable: true,
+                    preprocessor: (value) => {
+                        return [
+                            {
+                                value,
+                            },
+                        ];
+                    },
+                    hideOnMobile: true,
+                },
+                {
+                    path: ":_id",
+                    title: "Действия",
+                    type: "button",
+                    preprocessor: (value) => {
+                        return CRUDActionList.createActionsButtons(this, value);
+                    },
+                },
+            ],
+        });
+        this.start();
+        return this;
+    }
 
-	createDefault() {
-		let newRecord = this.make[this.getModelName()]({
-			'_id': null,
-			id: LABELS.single,
-			value: '',
-			active: true,
-		});
-		return newRecord;
-	}
+    createDefault() {
+        let newRecord = this.make[this.getModelName()]({
+            _id: null,
+            id: LABELS.single,
+            value: "",
+            active: true,
+        });
+        return newRecord;
+    }
 
-	openExport() {
-		window.location.assign('/api/options/export');
-		/*this.make[this.getModelName()]({}).$export()
+    openExport() {
+        window.location.assign("/api/options/export");
+        /*this.make[this.getModelName()]({}).$export()
 			.then((data)=>{
 				this.log(data);
 			})
 			.catch(e => this.error(e));*/
-	}
+    }
 
-	closeImportPopup() {
-		if (this.ui.import) {
-			this.ui.import.$destroy();
-			this.ui.import = null;
-		}
-	}
+    closeImportPopup() {
+        if (this.ui.import) {
+            this.ui.import.$destroy();
+            this.ui.import = null;
+        }
+    }
 
-	openImport() {
-		this.log('import');
-		this.closeImportPopup();
-		this.ui.import = new UIImport({
-			target: document.body
-		});
-		this.ui.import.$on('reject', (ev) => {
-			if (ev.detail.error) {
-				this.error(ev.detail.error);
-			}
-			this.closeImportPopup();
-		});
-		this.ui.import.$on('resolve', () => this.closeImportPopup());
-		this.ui.import.$on('import', async (ev) => {
-			if (ev.detail.options) {
-				try {
-					let res = await this.requestImport(ev.detail.options);
-					this.log(res);
-					if (res.status === 'ok') {
-						if (res.result && res.result.info) {
-							this.ui.import.setInfo(res.result.info);
-							this.afterImportSuccess(res.result);
-						}
-					} else {
-						this.error(res.error);
-						this.ui.import.setError(res.error);
-					}
-				} catch (e) {
-					this.ui.import.setError(e.message);
-					this.error(e);
-				}
-			}
-		});
-	}
+    openImport() {
+        this.log("import");
+        this.closeImportPopup();
+        this.ui.import = new UIImport({
+            target: document.body,
+        });
+        this.ui.import.$on("reject", (ev) => {
+            if (ev.detail.error) {
+                this.error(ev.detail.error);
+            }
+            this.closeImportPopup();
+        });
+        this.ui.import.$on("resolve", () => this.closeImportPopup());
+        this.ui.import.$on("import", async (ev) => {
+            if (ev.detail.options) {
+                try {
+                    let res = await this.requestImport(ev.detail.options);
+                    this.log(res);
+                    if (res.status === "ok") {
+                        if (res.result && res.result.info) {
+                            this.ui.import.setInfo(res.result.info);
+                            this.afterImportSuccess(res.result);
+                        }
+                    } else {
+                        this.error(res.error);
+                        this.ui.import.setError(res.error);
+                    }
+                } catch (e) {
+                    this.ui.import.setError(e.message);
+                    this.error(e);
+                }
+            }
+        });
+    }
 
-	afterImportSuccess(result) {
-		let delay = parseInt(result.shutdown) + 2000;
-		this.refresh(delay);
-		setTimeout(() => this.closeImportPopup(), delay);
-	}
+    afterImportSuccess(result) {
+        let delay = parseInt(result.shutdown) + 2000;
+        this.refresh(delay);
+        setTimeout(() => this.closeImportPopup(), delay);
+    }
 
-	requestImport(data) {
-		return this.make[this.getModelName()]({
-			options: data
-		}).$import();
-	}
-
-	getItemTitle(item) {
-		return `${item.optionsID}#${item.id}`;
-	}
+    requestImport(data) {
+        return this.make[this.getModelName()]({
+            options: data,
+        }).$import();
+    }
 
+    getItemTitle(item) {
+        return `${item.optionsID}#${item.id}`;
+    }
 }
 
 export default ncOptions;

package/src/locales/en.json

@@ -1,4 +1,6 @@
 {
   "title": "Options module",
-  "document_not_found": "Document was not found"
-}
+  "document_not_found": "Document was not found",
+  "action_export_to_json_title": "Export to JSON",
+  "action_import_from_json_title": "Import from JSON"
+}

package/src/locales/ru.json

@@ -1,4 +1,7 @@
 {
   "title": "Модуль настроек",
-  "document_not_found": "Документ не найден"
-}
+  "document_not_found": "Документ не найден",
+  "action_export_to_json_title": "Экспорт в JSON",
+  "action_import_from_json_title": "Импорт из JSON",
+  "action_import_success": "Импорт успешно завершен!"
+}