initial commit

Author: dupski

.gitignore

@@ -0,0 +1,6 @@
+node_modules
+lib
+*.lock
+*.log
+*.tgz
+package-lock.json

.npmignore

@@ -0,0 +1,7 @@
+.vscode
+node_modules
+src
+__tests__
+example
+tsconfig.json
+*.tgz

LICENSE

@@ -0,0 +1,20 @@
+
+Copyright 2017 Russell Briggs
+
+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.

README.md

@@ -0,0 +1,125 @@
+# json-to-graphql
+
+This is a simple module that takes a JavaScript object and turns it into a
+GraphQL query to be sent to a GraphQL server.
+
+Mainly useful for applications that need to generate graphql queries dynamically.
+
+## Installation
+
+```
+npm install json-to-graphql
+```
+
+## Usage
+
+### Simple Query
+
+```typescript
+import { jsonToGraphQL } from 'json-to-graphql';
+
+const query = {
+    query: {
+        Posts: {
+            id: true,
+            title: true,
+            post_date: true
+        }
+    }
+}
+const graphql_query = jsonToGraphQL(query);
+```
+
+Resulting `graphql_query`
+
+```graphql
+query {
+    Posts {
+        id,
+        title,
+        post_date
+    }
+}
+```
+
+### Query with arguments
+
+```typescript
+import { jsonToGraphQL } from 'json-to-graphql';
+
+const query = {
+    query: {
+        Posts: {
+            __args: {
+                orderBy: 'post_date',
+                userId: 12
+            }
+            id: true,
+            title: true,
+            post_date: true
+        }
+    }
+}
+const graphql_query = jsonToGraphQL(query);
+```
+
+Resulting `graphql_query`
+
+```graphql
+query {
+    Posts (orderBy: "post_date", userId: 12) {
+        id,
+        title,
+        post_date
+    }
+}
+```
+
+### Query with nested objects
+
+```typescript
+import { jsonToGraphQL } from 'json-to-graphql';
+
+const query = {
+    query: {
+        Posts: {
+            id: true,
+            title: true,
+            comments: {
+                id: true,
+                comment: true,
+                user: true
+            }
+        }
+    }
+}
+const graphql_query = jsonToGraphQL(query);
+```
+
+Resulting `graphql_query`
+
+```graphql
+query {
+    Posts (orderBy: "post_date", userId: 12) {
+        id,
+        name,
+        post_date,
+        comments {
+            id,
+            comment,
+            user
+        }
+    }
+}
+```
+
+## TO-DO List
+
+ * Fragments
+ * Probably some other things!...
+
+Pull requests welcome!
+
+## License
+
+MIT

package.json

@@ -0,0 +1,25 @@
+{
+  "name": "json-to-graphql",
+  "version": "0.0.1",
+  "main": "lib/index.js",
+  "license": "MIT",
+  "scripts": {
+    "build": "tslint -p . && tsc",
+    "test": "mocha -r ts-node/register --recursive \"./src/**/__tests__/*\""
+  },
+  "typings": "lib/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dupski/json-to-graphql.git"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.0.10",
+    "@types/mocha": "^2.2.45",
+    "chai": "^4.1.2",
+    "mocha": "^4.1.0",
+    "sinon": "^4.1.3",
+    "ts-node": "^4.1.0",
+    "tslint": "5.8.0",
+    "typescript": "2.6.2"
+  }
+}

src/__tests__/jsonToGraphQL.tests.ts

@@ -0,0 +1,19 @@
+
+import { expect } from 'chai';
+import { jsonToGraphQL } from '../jsonToGraphQL';
+
+describe('jsonToGraphQL()', () => {
+
+    it('throws if no query object is specified', () => {
+        expect(() => {
+            (jsonToGraphQL as any)();
+        }).to.throw('query object not specified');
+    });
+
+    it('throws if query is not an object', () => {
+        expect(() => {
+            jsonToGraphQL('not a query object');
+        }).to.throw('query object not specified');
+    });
+
+});

src/index.ts

@@ -0,0 +1,2 @@
+
+export * from './jsonToGraphQL';

src/jsonToGraphQL.ts

@@ -0,0 +1,6 @@
+
+export function jsonToGraphQL(query: any) {
+    if (!query || typeof query != 'object') {
+        throw new Error('query object not specified');
+    }
+}

tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es5",
+        "noImplicitAny": true,
+        "outDir": "./lib",
+        "declaration": true,
+        "sourceMap": true,
+        "experimentalDecorators": true,
+        "removeComments": true,
+        "lib": [
+            "es2015"
+        ]
+    },
+    "include": [
+        "./src/**/*"
+    ]
+}

tslint.json

@@ -0,0 +1,30 @@
+{
+    "extends": [
+      "tslint:latest"
+    ],
+    "rules": {
+       "trailing-comma": [false],
+       "object-literal-sort-keys": false,
+       "ordered-imports": false,
+       "no-console": [false],
+       "no-unused-new": false,
+       "triple-equals": false,
+       "one-line": [false, "check-catch", "check-finally", "check-else"],
+       "only-arrow-functions": [false],
+       "quotemark": [true, "single"],
+       "forin": false,
+       "variable-name": [false],
+       "no-empty": false,
+       "no-implicit-dependencies": false,
+       "no-string-literal": false,
+       "no-submodule-imports": false,
+       "object-literal-shorthand": false,
+       "member-access": [false],
+       "prefer-conditional-expression": false,
+       "prefer-for-of": false,
+       "member-ordering": [false],
+       "prefer-object-spread": false,
+       "eofline": false
+    }
+  }
+