# k-server-query

> Derby server-query plugin

Latest version **0.1.1** (published 2014-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install k-server-query
pnpm add k-server-query
yarn add k-server-query
bun add k-server-query
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2014-11-19 |
| First published | 2014-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Artur Zayats |
| Maintainers | ile |
| Keywords | derby |

## Links

- npm: https://www.npmjs.com/package/k-server-query
- npm.io page: https://npm.io/package/k-server-query

## Recent versions

- 0.1.1 (latest) — 2014-11-19

## README

## server-query

Derby/racer server-query plugin. It allows only server-defined queries and denies arbitrary client queries.

### install

With [npm](https://npmjs.org) do:

```
npm install server-query
```

### usage

In our derby-app:

```js
derby.use(require('server-query'));

// or if you wish to use usual queries for some collections
// you should provide collections whitelist like here

derby.use(require('server-query'), ['auth', 'users', 'topics']);
```

On the server:
```js

// Add server queries  

derby.on('serverQuery', function(store){ // Or racer.on

  // function addServerQuery accept
  // 'collection' - collection name
  // 'queryName'  - name of query
  // 'cb' - function that accepts 'params' and 'session'
  // and returns a query-object or error-string
  
  store.addServerQuery('items', 'main', function(params, session){
    return {type: 'public'};
  });
  
  store.addServerQuery('items', 'myItems', function(params, session){
    return {ownerId: session.userId};
  });
  
  store.addServerQuery('items', 'byType', function(params, session){
    
    // ++++++++++++++++++++++++++++
    // Should check params here!!!!
    // it's a security issue
    // ++++++++++++++++++++++++++++
    
    return {type: params.type};
  });
}

```

In order to bypass all checks for queries on some collections, just
add those collection to the whitelist. This means that you will be able to use 
the usual `model.query()` on those collections - both server-side and client-side.

If you want to fine-grained access control to collections, please have a look
at [`share-access`](https://github.com/dmapper/share-access) module.

Using queries:

```js
  // function serverQuery accepts 3 arguments:
  // 'collection' - collection name (should match one from addServerQuery)
  // 'queryName' - name of query (should match one from addServerQuery)
  // 'params' - object with query-params
  
  var query = model.serverQuery('items', 'byType', {
    type: 'global'
  });

  model.subscribe(query, function(){
    page.render('home');
  });
```

What is still allowed:
```js

// You still can use path-query
var query = model.server('items', '_page.itemIds');

model.subscribe(query, function(){
  page.render('home');
});

// one-item fetch/subscriptions also aren't dennied
var itemId = params.itemId

var item = model.at('items.'+itemId);

model.subscribe(item,  function(){
  //...
});

// Or just
model.subscribe('items.' + itemId,  function(){
  //...
});

// But

model.subscribe('items',  function(err){
  // Will get Error here!!!!!
});
```

## MIT License
Copyright (c) 2014 by Artur Zayats

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.

---
_Source: https://npm.io/package/k-server-query · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._