sk-query-builder - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "sk-query-builder",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "An even simpler es5 friendly GraphQL query builder",
-  "main": "sk-query.js",
+  "main": "dist/sk-query.min.js",
   "directories": {
@@ -7,0 +7,0 @@ "example": "example"

README.md

 # SK GraphQL Query Builder
 
-#### An even simpler, es5 friendly, GraphQL query builder
-No need for multiple functions, commands, or es5 compatible compiling. Just create a single Query with an options object and get a GraphQL ready query string in return.
+### An even simpler, ES5 friendly, GraphQL query builder
+**No need for multiple functions, commands, or es5 compatible compiling. Just create a single Query with an options object and get a GraphQL ready query string in return.**
 
-Forked from https://github.com/codemeasandwich/graphql-query-builder - a simple es6 graphql query builder;
+*Forked from https://github.com/codemeasandwich/graphql-query-builder - a simple ES6 graphql query builder*
 
-<!-- **info:**
+**info:**
 
-[![npm version](https://badge.fury.io/js/graphql-query-builder.svg)](https://badge.fury.io/js/graphql-query-builder)
+[![npm version](https://badge.fury.io/js/sk-query-builder.svg)](https://badge.fury.io/js/sk-query-builder)
 [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
-[![pull requests welcome](https://img.shields.io/badge/Pull%20requests-welcome-pink.svg)](https://github.com/codemeasandwich/graphql-query-builder/pulls)
-[![GitHub stars](https://img.shields.io/github/stars/codemeasandwich/graphql-query-builder.svg?style=social&label=Star)](https://github.com/codemeasandwich/graphql-query-builder)
+[![pull requests welcome](https://img.shields.io/badge/Pull%20requests-welcome-pink.svg)](https://github.com/sean6bucks/sk-gql-query-builder/pulls)
+[![GitHub stars](https://img.shields.io/github/stars/sean6bucks/sk-gql-query-builder.svg?style=social&label=Star)](https://github.com/sean6bucks/sk-gql-query-builder)
 
-
+<!--
 **tests:**
 
 [![build](https://api.travis-ci.org/codemeasandwich/graphql-query-builder.svg)](https://travis-ci.org/codemeasandwich/graphql-query-builder)
-[![Coverage Status](https://coveralls.io/repos/github/codemeasandwich/graphql-query-builder/badge.svg?branch=master)](https://coveralls.io/github/codemeasandwich/graphql-query-builder?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/codemeasandwich/graphql-query-builder/badge.svg?branch=master)](https://coveralls.io/github/codemeasandwich/graphql-query-builder?branch=master) -->
 
-
+<!--
 **quality:**
@@ -31,170 +31,132 @@
 
-*tested on [**NodeJS**](https://nodejs.org) and [**Webpack**](https://webpack.github.io)*
 
+## Install
 
-## [Demo / Sandbox](https://tonicdev.com/codemeasandwich/57a0727c80254315001cb366) :thumbsup:
+`npm install sk-query-builder`
 
-# Install
+## Query function:
+Query is available out of the box on the Window object, but can also be required to prevent namespace interference.
 
-`npm install graphql-query-builder`
+``` js
+var Query = require('sk-query-builder');
+```
 
-# Api
+### Use:
+Query can be called with a single arguement of either a single query object or an array of query objects and will return a GraphQL formatted string to be attached to query.
 
 ``` js
-const Query = require('graphql-query-builder');
+var query = Query( [ queryOptions ] );
 ```
 
-### constructor
-query/mutator you wish to use, and an alias or filter arguments.
+### Constructor / Options:
+Single query object or an array of multiple queries to turn into a GQL query string.
 
-| Argument (**one** to **two**)  | Description
-|--- |---
-| String | the name of the query function
-| * String / Object | (**optional**) This can be an `alias` or `filter` values 
+| Key Value | Argument | Description |
+|--- |--- |--- |
+| func: | String | the name of the query function |
+| alias: | String | alias value that result will be returned under |
+| filters: | Object | An object mapping attribute to values |
+| value: | String or Object | Attribute name or nested query you want returned.<br> ***Can be an array of multiple values with the values: key***  |
+| values: | Array | An Array of value items ( String or Obj ) to return multiple values |
 
+##### Example: ( get the sum of users in given timeframe )
 ``` js
-let profilePicture = new Query("profilePicture",{size : 50});
+var sumQuery = Query({
+  func: "sum",
+  alias: "total_sum",
+  filters: { from: 0, to: 1501234567890 },
+  value: "count"
+});
 ``` 
+##### Output: ( returns formatted string )
+``` js
+"{total_sum: sum(from: 0,to: 1501234567890){count}}"
+```
 
-### setAlias
-set an alias for this result.
+<br>
+## Enum Values:
+This library also creates an Enum function on the Window object that can be used to create enumeration values in the query string.
 
-| Argument | Description
-|--- |---
-| String | The alias for this result
+### Use:
+Add Enum values inside query objects buy either the Enum() function with a string to represent the final value or by simply using any string starting with "e$"
 
-``` js
-profilePicture.setAlias("MyPic");
-``` 
+``` Enum( 'VALUE' ) == 'e$VALUE' ```
 
-### filter
-the parameters to run the query against.
+| Argument (one)  | Description |
+|--- |--- |
+| String | the name of the query function |
 
-| Argument | Description
-|--- |---
-| Object | An object mapping attribute to values
-
+##### Example: ( get the sum of users in given timeframe )
 ``` js
-profilePicture.filter({ height : 200, width : 200});
-``` 
+var eventQuery = Query({
+  alias: 'event_123',
+  func: 'event',
+  filters: {
+    frequency: Enum( 'DAILY' ), // can also be "e$DAILY"
+    value: Enum( 'CLICKS' )
+  },
+  values: [ 'timestamp', 'value' ]
+});
 
-### find
-outlines the properties you wish to be returned from the query.
-
-| Argument (**one** to **many**) | Description
-|--- |---
-| String or Object |  representing each attribute you want Returned
-| ... | *same as above*
-
-``` js
-    profilePicture.find( { link : "uri"}, "width", "height");
+console.log( eventQuery );
+// "{event_123:event(frequency:DAILY,value:CLICKS){timestamp,value}}"
 ``` 
 
-### toString
-return to the formatted query string
+<br>
 
-``` js
-  // A (ES6)
-  `${profilePicture}`;
-  // B
-  profilePicture+'';
-  // C
-  profilePicture.toString();
-``` 
+## Examples:
+#### Nested query values
 
-## run samples
+``` js 
+var FetchLeeAndSam = Query({
+  alias: 'FetchLeeAndSam',
+  func: 'users',
+  values: [
+    {
+      alias: 'lee',
+      func: 'user',
+      filters: { id: '1' },
+      values: ['name', 'id' ]
+    },
+    {
+      alias: 'sam',
+      func: 'user',
+      filters: { id: '2' },
+      values: ['name', 'id' ]
+    }
+  ]
+});
 
-``` bash
-node example/simple.js
+console.log( FetchLeeAndSam );
+//"{FetchLeeAndSam:users{lee:user(id:"1"){name,id},sam:user(id:"2"){name,id}}}"
 ```
 
-# Example
+#### Multiple query array with reusable values
 
 ``` js 
-var Query = require('graphql-query-builder');
+var reusable = function( model, year ) {
+  return {
+    alias: model,
+    func: 'vehicle',
+    filters: { year: year },
+    values: [
+      "num_produced",
+      "horsepower"
+    ]
+  };
+};
 
-// example of nesting Querys
-let profilePicture = new Query("profilePicture",{size : 50});
-    profilePicture.find( "uri", "width", "height");
-    
-let user = new Query("user",{id : 123});
-    user.find(["id", {"nickname":"name"}, "isViewerFriend",  {"image":profilePicture}])
-    
-    console.log(user)
-    /*
-     user( id:123 ) {
-    id,
-    nickname : name,
-    isViewerFriend,
-    
-    image : profilePicture( size:50 ) {
-        uri,
-        width,
-        height
-    }
-  }
-    */
-    
-// And another example
+var CarCatalog = Query([
+  reusable( 'Mustang', '1964' ),
+  reusable( 'Camero', '1988' )
+]);
 
-let MessageRequest = { type:"chat", message:"yoyo",
-                   user:{
-                            name:"bob",
-                            screen:{
-                                    height:1080,
-                                    width:1920
-                                    }
-                    },
-                    friends:[
-                             {id:1,name:"ann"},
-                             {id:2,name:"tom"}
-                             ]
-                    };
-                    
-let MessageQuery = new Query("Message","myPost");
-    MessageQuery.filter(MessageRequest);
-    MessageQuery.find({ messageId : "id"}, {postedTime : "createTime" });
-    
-    console.log(MessageQuery);
-    
-    /*
-    myPost:Message( type:"chat",
-                    message:"yoyo",
-                    user:{name:"bob",screen:{height:1080,width:1920}},
-                    friends:[{id:1,name:"ann"},{id:2,name:"tom"}])
-        {
-            messageId : id,
-            postedTime : createTime
-        }
-    */
+console.log( CarCatalog );
+//"{Mustang:vehicle(year:"1964"){num_produced,horsepower} Camero:vehicle(year:"1988"){num_produced,horsepower}}"
+```
 
-    // Simple nesting
-    
-    let user = new Query("user");
-        user.find([{"profilePicture":["uri", "width", "height"]}])
-    
-    /* 
-    user {
-      profilePicture {
-        uri,
-        width,
-        height
-       }
-     }
-    */ 
-    
-    // Simple nesting with rename
-    
-    let user = new Query("user");
-        user.find([{"image":{"profilePicture":["uri", "width", "height"]}}])
-    
-    /* 
-    user {
-      image : profilePicture {
-        uri,
-        width,
-        height
-       }
-     }
-    */ 
+### run Examples
+
+``` bash
+node example/simple.js
 ```

No alert changes

Worsened metrics

Total package byte prevSize

37396

decreased by-1.18%

Number of lines in readme file

162

decreased by-19%

No dependency changes