w-serv-orm 1.0.0

package/docs/styles/prettify.css

@@ -0,0 +1,79 @@
+.pln {
+  color: #ddd;
+}
+
+/* string content */
+.str {
+  color: #61ce3c;
+}
+
+/* a keyword */
+.kwd {
+  color: #fbde2d;
+}
+
+/* a comment */
+.com {
+  color: #aeaeae;
+}
+
+/* a type name */
+.typ {
+  color: #8da6ce;
+}
+
+/* a literal value */
+.lit {
+  color: #fbde2d;
+}
+
+/* punctuation */
+.pun {
+  color: #ddd;
+}
+
+/* lisp open bracket */
+.opn {
+  color: #000000;
+}
+
+/* lisp close bracket */
+.clo {
+  color: #000000;
+}
+
+/* a markup tag name */
+.tag {
+  color: #8da6ce;
+}
+
+/* a markup attribute name */
+.atn {
+  color: #fbde2d;
+}
+
+/* a markup attribute value */
+.atv {
+  color: #ddd;
+}
+
+/* a declaration */
+.dec {
+  color: #EF5050;
+}
+
+/* a variable name */
+.var {
+  color: #c82829;
+}
+
+/* a function name */
+.fun {
+  color: #4271ae;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin-top: 0;
+  margin-bottom: 0;
+}

package/g.mOrm.mjs

@@ -0,0 +1,54 @@
+import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+import ds from './schema/index.mjs' //先行建置schema
+import WServOrm from './src/WServOrm.mjs'
+
+
+//st
+let st = {
+    dbUsername: 'username',
+    dbPassword: 'password',
+    dbName: 'wservorm',
+    dbIP: 'localhost',
+    dbPort: 27017,
+}
+
+//WServOrm
+let opt = {
+    url: `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`,
+    db: st.dbName,
+    getUserById: null,
+    bCheckUser: false,
+    bExcludeWhenNotAdmin: false,
+}
+let r = WServOrm(ds, WOrm, opt)
+console.log(r) //回傳server用orm相關函數
+// => {
+//   backup: [AsyncFunction: backup],
+//   recover: [AsyncFunction: recover],
+//   woItems: {
+//     tests: EventEmitter {
+//       _events: [Object: null prototype] {},
+//       _eventsCount: 0,
+//       _maxListeners: undefined,
+//       select: [AsyncFunction: select],
+//       insert: [AsyncFunction: insert],
+//       save: [AsyncFunction: save],
+//       del: [AsyncFunction: del],
+//       delAll: [AsyncFunction: delAll],
+//       selectGfs: [AsyncFunction: selectGfs],
+//       insertGfs: [AsyncFunction: insertGfs],
+//       delGfs: [AsyncFunction: delGfs],
+//       delAllGfs: [AsyncFunction: delAllGfs],
+//       [Symbol(kCapture)]: false
+//     }
+//   },
+//   addFunCheck: [Function: addFunCheck],
+//   addFunPreProcessing: [Function: addFunPreProcessing],
+//   addFunPostProcessing: [Function: addFunPostProcessing],
+//   procOrm: [AsyncFunction: procOrm]
+// }
+
+// export default r
+
+
+//node --experimental-modules --es-module-specifier-resolution=node g.mOrm.mjs

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "w-serv-orm",
+  "version": "1.0.0",
+  "description": "An operator for orm in server.",
+  "main": "dist/w-serv-orm.umd.js",
+  "dependencies": {
+    "lodash": "^4.17.21",
+    "wsemi": "^1.6.55"
+  },
+  "devDependencies": {
+    "w-orm-mongodb": "^1.1.26",
+    "w-data-collector": "^1.0.13",
+    "w-package-tools": "^1.0.65"
+  },
+  "scripts": {
+    "test": "mocha --parallel --timeout 60000 --experimental-modules --es-module-specifier-resolution=node",
+    "deploy": "gh-pages -d docs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yuda-lyu/w-serv-orm.git"
+  },
+  "keywords": [
+    "package",
+    "tool",
+    "operator",
+    "server",
+    "ORM",
+    "nodejs"
+  ],
+  "author": "yuda-lyu(semisphere)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/yuda-lyu/w-serv-orm/issues"
+  },
+  "homepage": "https://github.com/yuda-lyu/w-serv-orm#readme"
+}

package/schema/gi.mjs

@@ -0,0 +1,8 @@
+import genIndex from 'w-data-collector/src/genIndex.mjs'
+
+
+//genIndex
+genIndex('./schema/tables', './schema')
+
+
+//node --experimental-modules --es-module-specifier-resolution=node ./schema/gi.mjs

package/schema/index.mjs

@@ -0,0 +1,16 @@
+import tests from './tables/tests.mjs'
+import build from 'w-data-collector/src/build.mjs'
+
+
+let cs = {
+    tests,
+}
+
+//ds
+let ds = {}
+for (let k in cs) {
+    ds[k] = build(cs[k], { useCreateStorage: false })
+}
+
+
+export default ds

package/schema/tables/tests.mjs

@@ -0,0 +1,78 @@
+import map from 'lodash/map'
+import keys from 'lodash/keys'
+import genID from 'wsemi/src/genID.mjs'
+import dtmapping from 'wsemi/src/dtmapping.mjs'
+import dtpick from 'wsemi/src/dtpick.mjs'
+import nowms2str from 'wsemi/src/nowms2str.mjs'
+import now2strp from 'wsemi/src/now2strp.mjs'
+import isestr from 'wsemi/src/isestr'
+
+
+let keyTable = 'tests'
+let tableNameCht = 'Tests'
+let tableNameEng = 'Tests'
+
+let settings = {
+    'id': {
+        pk: true,
+        name: '主鍵',
+        type: 'STRING',
+    },
+    'timeCreate': {
+        name: '創建時間',
+        type: 'STRING',
+    },
+    'timeUpdate': {
+        name: '更新時間',
+        type: 'STRING',
+    },
+    'isActive': {
+        name: '是否有效',
+        type: 'STRING',
+    },
+}
+
+let funNew = (ndata = {}) => {
+    let o = dtmapping(ndata, keys(settings))
+    o.id = `${now2strp()}-${genID()}`
+    o.timeCreate = nowms2str()
+    o.timeUpdate = o.timeCreate
+    o.isActive = 'y'
+    return o
+}
+
+let funTest = () => {
+    let rs = map([
+        {
+            'id': 'id-for-tests-1',
+        },
+        {
+            'id': 'id-for-tests-2',
+        },
+        {
+            'id': 'id-for-tests-3',
+        },
+    ], (item, k) => {
+        let v = funNew({ ...item, order: k })
+        v.id = item.id
+        if (isestr(item.timeUpdate)) {
+            v.timeUpdate = item.timeUpdate
+        }
+        v = dtpick(v, keys(settings))
+        return v
+    })
+    console.log(`已產生: {keyTable} 測試資料`, rs)
+    return rs
+}
+
+let tab = {
+    keyTable,
+    tableNameCht,
+    tableNameEng,
+    settings,
+    funNew,
+    funTest,
+}
+
+
+export default tab

package/src/WServOrm.mjs

@@ -0,0 +1,102 @@
+import getDbBackupAndRecover from './getDbBackupAndRecover.mjs'
+import getWoItems from './getWoItems.mjs'
+import getMapOrm from './getMapOrm.mjs'
+import getProc from './getProc.mjs'
+
+
+/**
+ * 產生伺服器ORM的支援物件
+ *
+ * @class
+ * @param {Object} ds 輸入資料表設定物件
+ * @param {Object} WOrm 輸入資料庫ORM物件
+ * @param {Object} [opt={}] 輸入設定物件，預設{}
+ * @param {String} [opt.url=''] 輸入資料庫連線位址字串，預設''
+ * @param {String} [opt.db=''] 輸入資料庫名稱字串，預設''
+ * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
+ * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
+ * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
+ * @returns {Object} 回傳通訊物件，可監聽事件open、error、clientChange、execute、broadcast、deliver，可使用函數broadcast
+ * @example
+ *
+ * import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+ * import ds from './schema/index.mjs' //先行建置schema
+ * import WServOrm from './src/WServOrm.mjs'
+ *
+ * //st
+ * let st = {
+ *     dbUsername: 'username',
+ *     dbPassword: 'password',
+ *     dbName: 'wservorm',
+ *     dbIP: 'localhost',
+ *     dbPort: 27017,
+ * }
+ *
+ * //WServOrm
+ * let opt = {
+ *     url: `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`,
+ *     db: st.dbName,
+ *     getUserById: null,
+ *     bCheckUser: false,
+ *     bExcludeWhenNotAdmin: false,
+ * }
+ * let r = WServOrm(ds, WOrm, opt)
+ * console.log(r) //回傳server用orm相關函數
+ * // => {
+ * //   backup: [AsyncFunction: backup],
+ * //   recover: [AsyncFunction: recover],
+ * //   woItems: {
+ * //     tests: EventEmitter {
+ * //       _events: [Object: null prototype] {},
+ * //       _eventsCount: 0,
+ * //       _maxListeners: undefined,
+ * //       select: [AsyncFunction: select],
+ * //       insert: [AsyncFunction: insert],
+ * //       save: [AsyncFunction: save],
+ * //       del: [AsyncFunction: del],
+ * //       delAll: [AsyncFunction: delAll],
+ * //       selectGfs: [AsyncFunction: selectGfs],
+ * //       insertGfs: [AsyncFunction: insertGfs],
+ * //       delGfs: [AsyncFunction: delGfs],
+ * //       delAllGfs: [AsyncFunction: delAllGfs],
+ * //       [Symbol(kCapture)]: false
+ * //     }
+ * //   },
+ * //   addFunCheck: [Function: addFunCheck],
+ * //   addFunPreProcessing: [Function: addFunPreProcessing],
+ * //   addFunPostProcessing: [Function: addFunPostProcessing],
+ * //   procOrm: [AsyncFunction: procOrm]
+ * // }
+ *
+ * // export default r
+ *
+ */
+function WServOrm(ds, WOrm, opt = {}) {
+    // url:'',
+    // db:'',
+    // bCheckUser: true,
+    // getUserById: null,
+    // bExcludeWhenNotAdmin: true,
+
+    //getWoItems
+    let woItems = getWoItems(ds, WOrm, opt)
+    // console.log('woItems', woItems)
+
+    //getMapOrm
+    let mapOrm = getMapOrm(ds, woItems)
+    // console.log('mapOrm', mapOrm)
+
+    //getProc
+    let proc = getProc(mapOrm, opt)
+    // console.log('proc', proc)
+
+    return {
+        ...getDbBackupAndRecover,
+        woItems,
+        // mapOrm,
+        ...proc,
+    }
+}
+
+
+export default WServOrm

package/src/getDbBackupAndRecover.mjs

@@ -0,0 +1,90 @@
+// import path from 'path'
+import fs from 'fs'
+import trim from 'lodash/trim'
+import size from 'lodash/size'
+import pmSeries from 'wsemi/src/pmSeries.mjs'
+import fsIsFile from 'wsemi/src/fsIsFile.mjs'
+import iseobj from 'wsemi/src/iseobj.mjs'
+import isfun from 'wsemi/src/isfun.mjs'
+import isbol from 'wsemi/src/isbol.mjs'
+import j2o from 'wsemi/src/j2o.mjs'
+
+
+async function backup(woItems) {
+
+    //rs
+    let rs = await pmSeries(woItems, async (v, k) => {
+        console.log('backup...', k)
+        let r = await v.select()
+        return {
+            name: k,
+            data: r,
+        }
+    })
+    // console.log('backup rs', rs)
+
+    return rs
+}
+
+
+async function recover(fp, woItems, genModels, needCreateStorage = false) {
+
+    //check
+    if (!fsIsFile(fp)) {
+        console.log('fp', fp)
+        throw new Error('fp is not exist')
+    }
+    if (!iseobj(woItems)) {
+        console.log('woItems', woItems)
+        throw new Error('invalid woItems')
+    }
+
+    //genModels
+    if (!isfun(genModels)) {
+        genModels = null
+    }
+
+    //needCreateStorage
+    if (!isbol(needCreateStorage)) {
+        needCreateStorage = false
+    }
+
+    //readFileSync
+    let j = fs.readFileSync(fp, 'utf8')
+    j = trim(j) //去除bom
+    // console.log('j', j)
+
+    //rs
+    let rs = j2o(j)
+    // console.log('recover rs', rs)
+
+    //genModels
+    if (isfun(genModels)) {
+        genModels()
+    }
+
+    //funTest
+    await pmSeries(rs, async (v) => {
+        console.log('recover...', v.name)
+        if (needCreateStorage) {
+            console.log('needCreateStorage')
+            await woItems[v.name].createStorage()
+        }
+        // await woItems[v.name].delAll() //清空資料庫
+        let r = null
+        if (size(v.data) > 0) {
+            r = await woItems[v.name].insert(v.data) //需人工先清空資料庫, 用insert匯入比較快
+        }
+        return r
+    })
+
+}
+
+
+let getDbBackupAndRecover = {
+    backup,
+    recover,
+}
+
+
+export default getDbBackupAndRecover