expressa 1.1.3 → 1.2.0

package/modules/admin/src/views/ListDocuments2.vue

@@ -1,309 +1,309 @@
-<template>
-  <div class="px-3">
-    <div class="d-flex align-items-center py-2">
-      <h3 class="mb-0 text-capitalize">
-        {{ collectionName }}
-      </h3>
-
-      <span class="mx-auto" />
-
-      <el-checkbox
-        v-model="isFiltersVisible"
-        class="mb-0 mr-4"
-      >
-        Show Filters
-      </el-checkbox>
-
-      <el-pagination
-        :page-size="pageSize"
-        :total="count"
-        :page-sizes="pageSizes"
-        :current-page.sync="page"
-        layout="sizes, prev, pager, next"
-        @current-change="update()"
-        @size-change="pageSize = $event, update()"
-      />
-    </div>
-
-    <el-table
-      :data="tableRows"
-      element-loading-text="Loading"
-      border
-      fit
-      highlight-current-row
-    >
-      <el-table-column v-for="(name, i) in listedProperties" :key="name" :label="name" align="center">
-        <template slot-scope="scope">
-          <div v-if="scope.$index === 0 && isFiltersVisible" class="text-left">
-            <el-input
-              v-model="searchFilters[name]"
-              :placeholder="`Search by ${name}`"
-              :type="getFieldType(name) === 'number' ? 'number' : 'text'"
-              @change="update()"
-            />
-
-            <el-checkbox
-              v-model="exactSearches[name]"
-              :disabled="getFieldType(name) === 'number'"
-              class="mt-3"
-              @change="update()"
-            >
-              Exact match
-            </el-checkbox>
-          </div>
-
-          <template v-else>
-            <router-link v-if="i === 0 && collectionName !== 'requestlog'" :to="'/edit/'+collectionName+'/'+scope.row._id">
-              {{ getPath(scope.row, name) }}
-            </router-link>
-            <router-link v-if="i === 0 && collectionName === 'requestlog'" :to="'/dev/viewrequest/'+scope.row._id">
-              {{ getPath(scope.row, name) }}
-            </router-link>
-            <span v-if="i !== 0">{{ getPath(scope.row, name) }}</span>
-          </template>
-        </template>
-      </el-table-column>
-    </el-table>
-
-    <div class="d-flex align-items-center my-3">
-      <router-link v-if="showAddButton" :to="'/edit/' + collectionName + '/create'" class="mr-2">
-        <button class="btn btn-primary">
-          Add
-        </button>
-      </router-link>
-
-      <button class="btn btn-secondary download-button mr-2" @click="downloadCSV()">
-        Download
-      </button>
-
-      <button class="btn btn-secondary download-button" @click="downloadAllCSV()">
-        Download All
-      </button>
-
-      <span class="mx-auto" />
-
-      <el-pagination
-        :page-size="pageSize"
-        :total="count"
-        :page-sizes="pageSizes"
-        :current-page.sync="page"
-        layout="sizes, prev, pager, next"
-        @current-change="update()"
-        @size-change="pageSize = $event, update()"
-      />
-    </div>
-  </div>
-</template>
-
-<script>
-import request from '@/utils/request'
-import saveAs from 'file-saver'
-import objectPath from 'object-path'
-
-const pageSizes = [25, 50, 100, 500]
-
-export default {
-  name: 'ListDocuments',
-  props: {
-    collectionName: {
-      type: String,
-      default: 'collection'
-    },
-    filter: {
-      type: Object,
-      default: () => {}
-    },
-    columns: {
-      type: Array,
-      default: () => undefined
-    },
-    showAddButton: {
-      type: Boolean,
-      default: true
-    },
-    showPaginateOnBottom: {
-      type: Boolean,
-      default: true
-    },
-  },
-  data: () => ({
-    start: 0,
-    page: 1,
-    count: 0,
-    data: [],
-    schema: {},
-    exactSearches: {},
-    searchFilters: {},
-    listedProperties: [],
-    pageSizes: pageSizes,
-    pageSize: pageSizes[0],
-    isFiltersVisible: true,
-  }),
-  computed: {
-    tableRows() {
-      if (!this.isFiltersVisible) {
-        return this.data
-      }
-
-      return [
-        // INFO: This empty row is used to display the search filters.
-        {},
-        ...this.data
-      ]
-    },
-    appliedSearchFilters() {
-      return Object.keys(this.searchFilters).reduce((filter, fieldName) => {
-        const searchKeyword = this.searchFilters[fieldName]
-
-        const fieldtype = this.getFieldType(fieldName)
-
-        if (!searchKeyword || fieldtype === 'custom') {
-          return filter
-        }
-
-        const queryBuilder = this.getQueryBuilder(fieldtype)
-
-        return {
-          ...filter,
-          [fieldName]: queryBuilder({ fieldName, searchKeyword })
-        }
-      }, {})
-    },
-    allFilters() {
-      const params = {
-        page: this.page,
-        limit: this.pageSize,
-        orderby: '{"meta.created":-1}',
-        ...this.filter,
-        query: { ...this.appliedSearchFilters }
-      }
-
-      const columns = this.columns || (this.collection.admin && this.collection.admin.columns)
-
-      if (columns) {
-        params.fields = columns.reduce((map, field) => {
-          map[field] = 1
-          return map
-        }, {})
-      }
-
-      return params
-    },
-  },
-  watch: {
-    collectionName: {
-      handler: 'update'
-    },
-    '$route.params.collectionName': {
-      handler: 'resetFilters'
-    }
-  },
-  mounted() {
-    this.update()
-  },
-  methods: {
-    getPath(obj, path, defaultValue) {
-      const result = String.prototype.split.call(path, /[,[\].]+?/)
-        .filter(Boolean)
-        .reduce((res, key) => (res !== null && res !== undefined) ? res[key] : res, obj)
-      return (result === undefined || result === obj) ? defaultValue : result
-    },
-    async update() {
-      if (this.$route.params.collectionName) {
-        this.collectionName = this.$route.params.collectionName
-      }
-      // Avoid refetching schema info if name hasn't changed
-      if (!this.collection || this.collection._id !== this.collectionName) {
-        this.collection = (await request({ url: `/collection/${this.collectionName}` })).data
-        this.schema = this.collection.schema
-      }
-      const params = { ...this.allFilters }
-      const columns = this.columns || (this.collection.admin && this.collection.admin.columns)
-      const info = (await request({ url: `/${this.collectionName}/`, params })).data
-      this.count = info.itemsTotal
-      this.data = this.applyCustomColumnFilter(info.data)
-      this.listedProperties = columns || Object.keys(this.schema.properties)
-    },
-    applyCustomColumnFilter(tableData) {
-      const customColumnSearches = Object.keys(this.searchFilters)
-        .filter((fieldName) => this.getFieldType(fieldName) === 'custom')
-
-      return tableData.filter((row) => {
-        return customColumnSearches.every(fieldName => {
-          const searchKeyword = this.searchFilters[fieldName]
-
-          if (!searchKeyword) {
-            return true
-          }
-
-          const stringified = row[fieldName].toString()
-
-          if (this.exactSearches[fieldName]) {
-            return stringified === searchKeyword
-          } else {
-            return stringified.toLowerCase().includes(searchKeyword.toLowerCase())
-          }
-        })
-      })
-    },
-    downloadCSV(data = this.data) {
-      const collection = this.collectionName
-      let text = this.listedProperties.map((name) => '"' + name + '"').join(',') + '\n'
-      if (data) {
-        text += data.map((row) =>
-          this.listedProperties.map((key) => '"' + String(objectPath.get(row, key) || '').replace(/"/g, '""') + '"')
-        ).join('\n')
-        console.log(text)
-        const blob = new Blob([text], { type: 'text/plain;charset=utf-8' })
-        saveAs(blob, collection + '.csv')
-      }
-    },
-    async downloadAllCSV() {
-      let rows = []
-      let page = 1
-
-      while (this.count > rows.length) {
-        const params = {
-          ...this.allFilters,
-          page: page,
-          limit: 500,
-        }
-
-        const response = (await request({ url: `/${this.collectionName}/`, params })).data
-        rows = [...response.data, ...rows]
-        page += 1
-      }
-
-      this.downloadCSV(this.applyCustomColumnFilter(rows))
-    },
-    getFieldType(fieldName) {
-      return (this.schema.properties[fieldName] &&
-      this.schema.properties[fieldName].type) || 'custom'
-    },
-    getQueryBuilder(fieldType) {
-      const queryBuilders = {
-        'string': this.getStringSearchQuery,
-        'number': (payload) => parseInt(payload.searchKeyword)
-      }
-
-      return queryBuilders[fieldType] || this.getStringSearchQuery
-    },
-    getStringSearchQuery({ fieldName, searchKeyword }) {
-      const regexQuery = { '$regex': searchKeyword, '$options': 'i' }
-      return this.exactSearches[fieldName] ? searchKeyword : regexQuery
-    },
-    resetFilters() {
-      this.exactSearches = {}
-      this.searchFilters = {}
-    }
-  }
-}
-</script>
-
-<style scoped>
-.el-table >>> th {
- background-color: #343a40 !important;
- border-color: #454d55;
- color: #fff;
-}
-</style>
+<template>
+  <div class="px-3">
+    <div class="d-flex align-items-center py-2">
+      <h3 class="mb-0 text-capitalize">
+        {{ collectionName }}
+      </h3>
+
+      <span class="mx-auto" />
+
+      <el-checkbox
+        v-model="isFiltersVisible"
+        class="mb-0 mr-4"
+      >
+        Show Filters
+      </el-checkbox>
+
+      <el-pagination
+        :page-size="pageSize"
+        :total="count"
+        :page-sizes="pageSizes"
+        :current-page.sync="page"
+        layout="sizes, prev, pager, next"
+        @current-change="update()"
+        @size-change="pageSize = $event, update()"
+      />
+    </div>
+
+    <el-table
+      :data="tableRows"
+      element-loading-text="Loading"
+      border
+      fit
+      highlight-current-row
+    >
+      <el-table-column v-for="(name, i) in listedProperties" :key="name" :label="name" align="center">
+        <template slot-scope="scope">
+          <div v-if="scope.$index === 0 && isFiltersVisible" class="text-left">
+            <el-input
+              v-model="searchFilters[name]"
+              :placeholder="`Search by ${name}`"
+              :type="getFieldType(name) === 'number' ? 'number' : 'text'"
+              @change="update()"
+            />
+
+            <el-checkbox
+              v-model="exactSearches[name]"
+              :disabled="getFieldType(name) === 'number'"
+              class="mt-3"
+              @change="update()"
+            >
+              Exact match
+            </el-checkbox>
+          </div>
+
+          <template v-else>
+            <router-link v-if="i === 0 && collectionName !== 'requestlog'" :to="'/edit/'+collectionName+'/'+scope.row._id">
+              {{ getPath(scope.row, name) }}
+            </router-link>
+            <router-link v-if="i === 0 && collectionName === 'requestlog'" :to="'/dev/viewrequest/'+scope.row._id">
+              {{ getPath(scope.row, name) }}
+            </router-link>
+            <span v-if="i !== 0">{{ getPath(scope.row, name) }}</span>
+          </template>
+        </template>
+      </el-table-column>
+    </el-table>
+
+    <div class="d-flex align-items-center my-3">
+      <router-link v-if="showAddButton" :to="'/edit/' + collectionName + '/create'" class="mr-2">
+        <button class="btn btn-primary">
+          Add
+        </button>
+      </router-link>
+
+      <button class="btn btn-secondary download-button mr-2" @click="downloadCSV()">
+        Download
+      </button>
+
+      <button class="btn btn-secondary download-button" @click="downloadAllCSV()">
+        Download All
+      </button>
+
+      <span class="mx-auto" />
+
+      <el-pagination
+        :page-size="pageSize"
+        :total="count"
+        :page-sizes="pageSizes"
+        :current-page.sync="page"
+        layout="sizes, prev, pager, next"
+        @current-change="update()"
+        @size-change="pageSize = $event, update()"
+      />
+    </div>
+  </div>
+</template>
+
+<script>
+import request from '@/utils/request'
+import saveAs from 'file-saver'
+import objectPath from 'object-path'
+
+const pageSizes = [25, 50, 100, 500]
+
+export default {
+  name: 'ListDocuments',
+  props: {
+    collectionName: {
+      type: String,
+      default: 'collection'
+    },
+    filter: {
+      type: Object,
+      default: () => {}
+    },
+    columns: {
+      type: Array,
+      default: () => undefined
+    },
+    showAddButton: {
+      type: Boolean,
+      default: true
+    },
+    showPaginateOnBottom: {
+      type: Boolean,
+      default: true
+    },
+  },
+  data: () => ({
+    start: 0,
+    page: 1,
+    count: 0,
+    data: [],
+    schema: {},
+    exactSearches: {},
+    searchFilters: {},
+    listedProperties: [],
+    pageSizes: pageSizes,
+    pageSize: pageSizes[0],
+    isFiltersVisible: true,
+  }),
+  computed: {
+    tableRows() {
+      if (!this.isFiltersVisible) {
+        return this.data
+      }
+
+      return [
+        // INFO: This empty row is used to display the search filters.
+        {},
+        ...this.data
+      ]
+    },
+    appliedSearchFilters() {
+      return Object.keys(this.searchFilters).reduce((filter, fieldName) => {
+        const searchKeyword = this.searchFilters[fieldName]
+
+        const fieldtype = this.getFieldType(fieldName)
+
+        if (!searchKeyword || fieldtype === 'custom') {
+          return filter
+        }
+
+        const queryBuilder = this.getQueryBuilder(fieldtype)
+
+        return {
+          ...filter,
+          [fieldName]: queryBuilder({ fieldName, searchKeyword })
+        }
+      }, {})
+    },
+    allFilters() {
+      const params = {
+        page: this.page,
+        limit: this.pageSize,
+        orderby: '{"meta.created":-1}',
+        ...this.filter,
+        query: { ...this.appliedSearchFilters }
+      }
+
+      const columns = this.columns || (this.collection.admin && this.collection.admin.columns)
+
+      if (columns) {
+        params.fields = columns.reduce((map, field) => {
+          map[field] = 1
+          return map
+        }, {})
+      }
+
+      return params
+    },
+  },
+  watch: {
+    collectionName: {
+      handler: 'update'
+    },
+    '$route.params.collectionName': {
+      handler: 'resetFilters'
+    }
+  },
+  mounted() {
+    this.update()
+  },
+  methods: {
+    getPath(obj, path, defaultValue) {
+      const result = String.prototype.split.call(path, /[,[\].]+?/)
+        .filter(Boolean)
+        .reduce((res, key) => (res !== null && res !== undefined) ? res[key] : res, obj)
+      return (result === undefined || result === obj) ? defaultValue : result
+    },
+    async update() {
+      if (this.$route.params.collectionName) {
+        this.collectionName = this.$route.params.collectionName
+      }
+      // Avoid refetching schema info if name hasn't changed
+      if (!this.collection || this.collection._id !== this.collectionName) {
+        this.collection = (await request({ url: `/collection/${this.collectionName}` })).data
+        this.schema = this.collection.schema
+      }
+      const params = { ...this.allFilters }
+      const columns = this.columns || (this.collection.admin && this.collection.admin.columns)
+      const info = (await request({ url: `/${this.collectionName}/`, params })).data
+      this.count = info.itemsTotal
+      this.data = this.applyCustomColumnFilter(info.data)
+      this.listedProperties = columns || Object.keys(this.schema.properties)
+    },
+    applyCustomColumnFilter(tableData) {
+      const customColumnSearches = Object.keys(this.searchFilters)
+        .filter((fieldName) => this.getFieldType(fieldName) === 'custom')
+
+      return tableData.filter((row) => {
+        return customColumnSearches.every(fieldName => {
+          const searchKeyword = this.searchFilters[fieldName]
+
+          if (!searchKeyword) {
+            return true
+          }
+
+          const stringified = row[fieldName].toString()
+
+          if (this.exactSearches[fieldName]) {
+            return stringified === searchKeyword
+          } else {
+            return stringified.toLowerCase().includes(searchKeyword.toLowerCase())
+          }
+        })
+      })
+    },
+    downloadCSV(data = this.data) {
+      const collection = this.collectionName
+      let text = this.listedProperties.map((name) => '"' + name + '"').join(',') + '\n'
+      if (data) {
+        text += data.map((row) =>
+          this.listedProperties.map((key) => '"' + String(objectPath.get(row, key) || '').replace(/"/g, '""') + '"')
+        ).join('\n')
+        console.log(text)
+        const blob = new Blob([text], { type: 'text/plain;charset=utf-8' })
+        saveAs(blob, collection + '.csv')
+      }
+    },
+    async downloadAllCSV() {
+      let rows = []
+      let page = 1
+
+      while (this.count > rows.length) {
+        const params = {
+          ...this.allFilters,
+          page: page,
+          limit: 500,
+        }
+
+        const response = (await request({ url: `/${this.collectionName}/`, params })).data
+        rows = [...response.data, ...rows]
+        page += 1
+      }
+
+      this.downloadCSV(this.applyCustomColumnFilter(rows))
+    },
+    getFieldType(fieldName) {
+      return (this.schema.properties[fieldName] &&
+      this.schema.properties[fieldName].type) || 'custom'
+    },
+    getQueryBuilder(fieldType) {
+      const queryBuilders = {
+        'string': this.getStringSearchQuery,
+        'number': (payload) => parseInt(payload.searchKeyword)
+      }
+
+      return queryBuilders[fieldType] || this.getStringSearchQuery
+    },
+    getStringSearchQuery({ fieldName, searchKeyword }) {
+      const regexQuery = { '$regex': searchKeyword, '$options': 'i' }
+      return this.exactSearches[fieldName] ? searchKeyword : regexQuery
+    },
+    resetFilters() {
+      this.exactSearches = {}
+      this.searchFilters = {}
+    }
+  }
+}
+</script>
+
+<style scoped>
+.el-table >>> th {
+ background-color: #343a40 !important;
+ border-color: #454d55;
+ color: #fff;
+}
+</style>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expressa",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "API framework using JSON schemas",
   "main": "index.js",
   "repository": "https://github.com/thomas4019/expressa",

package/test/collections.js

@@ -159,11 +159,10 @@ describe('basic collections', function () {
 
   it('fail to read paged without permission', async function () {
     const token = await testutils.getUserWithPermissions(api)
-    const res = await request(app)
+    await request(app)
       .get('/testdoc/?page=1')
       .set('x-access-token', token)
-      .expect(200)
-    expect(res.body.data.length).to.equal(0)
+      .expect(401)
   })
 
   it('read a specific doc', async function () {

package/test/collections.querying.js

@@ -102,11 +102,10 @@ describe('querying collections', function () {
     expect(res.body).to.have.lengthOf(1)
   })
 
-  it('returns no documents without permission', async function () {
-    const res = await request(app)
+  it('errors without permission', async function () {
+    await request(app)
       .get('/testdoc')
-      .expect(200)
-    expect(res.body).to.have.lengthOf(0)
+      .expect(401)
   })
 
   it('page 0 returns an error', async function () {
@@ -147,6 +146,21 @@ describe('querying collections', function () {
     expect(res.body.data[0].title).to.equal('doc3')
   })
 
+  it('pagemetadisable url parameter strips additional page detail', async function () {
+    const res = await request(app)
+      .get('/testdoc?limit=2&page=2&pagemetadisable=1')
+      .set('x-access-token', token)
+      .expect(200)
+    expect(res.body.itemsTotal).to.equal(undefined)
+    expect(res.body.itemsPerPage).to.equal(2)
+    expect(res.body.pages).to.equal(undefined)
+    expect(res.body.pagePrev).to.equal(1)
+    expect(res.body.pageNext).to.equal(undefined)
+    expect(res.body.data).to.have.lengthOf(1)
+
+    expect(res.body.data[0].title).to.equal('doc3')
+  })
+
   it('page 3 is empty', async function () {
     const res = await request(app)
       .get('/testdoc?limit=2&page=3')