Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/restuwahyu13/sijago
SiJago is GraphQL Client for browser and node, you can write request graphql schema using javascript object style.
https://github.com/restuwahyu13/sijago
apollo browser fetch fetch-api graphql graphql-client graphql-schema graphql-tools http-client nodejs requests resolvers tools
Last synced: 2 months ago
JSON representation
SiJago is GraphQL Client for browser and node, you can write request graphql schema using javascript object style.
- Host: GitHub
- URL: https://github.com/restuwahyu13/sijago
- Owner: restuwahyu13
- License: mit
- Created: 2022-02-10T18:02:03.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-16T15:52:59.000Z (almost 3 years ago)
- Last Synced: 2024-09-27T21:40:58.437Z (3 months ago)
- Topics: apollo, browser, fetch, fetch-api, graphql, graphql-client, graphql-schema, graphql-tools, http-client, nodejs, requests, resolvers, tools
- Language: TypeScript
- Homepage:
- Size: 200 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-made-by-indonesian - SiJago (GraphQL Client) - `SiJago is GraphQL Client for browser and node, you can write request graphql schema using javascript object style.` *by [Restu Wahyu Saputra](https://github.com/restuwahyu13)* (S)
- made-in-indonesia - SiJago (GraphQL Client) - `SiJago is GraphQL Client for browser and node, you can write request graphql schema using javascript object style.` *by [Restu Wahyu Saputra](https://github.com/restuwahyu13)* (S)
README
# SiJago (GraphQL Client)
[](https://scrutinizer-ci.com/g/restuwahyu13/sijago/build-status/master) [](https://coveralls.io/github/restuwahyu13/jwt-transform?branch=main) [](https://www.codefactor.io/repository/github/restuwahyu13/sijago) [](https://codebeat.co/projects/github-com-restuwahyu13-sijago-master) [](https://www.codacy.com/gh/restuwahyu13/sijago/dashboard?utm_source=github.com&utm_medium=referral&utm_content=restuwahyu13/sijago&utm_campaign=Badge_Grade)   [](https://github.com/restuwahyu13/sijago/blob/main/CONTRIBUTING.md)
**SiJago** is GraphQL Client for Browser and Node.js, You can write request GraphQL schema using JavaScript Object Style, Why i create this tools, Because for reducing typo when writing GraphQL schema using HTTP client like Axios, Fetch or GraphQL client using Apollo and also to simplify calling the GraphQL schema easy to understand for human.
## Table Of Content
- [Installation](#installation)
- [Feature](#feature)
- [Sijago Options](#sijago-options)
- [Sijago Properties](#sijago-properties)
+ [Scalar](#scalar)
+ [Configs](#configs)
- [Sijago Methods](#sijago-methods)
+ [Query](#queryoptions-sijagooptions-promisesijagoresponse--promiseobject)
+ [Mutation](#mutationoptions-sijagooptions-promisesijagoresponse--promiseobject)
- [Example Usage](#example-usage)
- [Testing](#testing)
- [Bugs](#bugs)
- [Contributing](#contributing)
- [License](#license)
## Installation
```bash
npm install sijago -S or yarn add sijago -S
```
## Feature
- [X] Mutation
- [X] Query
- [X] Inline Fragments
- [ ] Variables (Comingsoon)
- [ ] Fragments (Comingsoon)
- [ ] Operation Name (Comingsoon)
- [ ] Aliases (Comingsoon)
- [ ] Directives (Comingsoon)
- [ ] Subscription (Comingsoon)
## SiJago Options
- **url**: is used for the address the graphql server that will be used to interaction.
- **input**: is used to send given request from client to graphql server, usually used when using mutation or query.
- **body**: is used to display the response data provided by the graphql server.
- **headers**: is used for interface of the Fetch API allows you to perform various actions on HTTP request and response headers.
## SiJago Properties
- ### Scalar
Scalar is used for data type identification in your GraphQL Schema, something like `scalar.GraphqlString` is equals to `String` in GraphQL Schema, **Important** this scalar is fake because, it is only used for data type identification in GraphQL Schema, and this below is scalar type identification support which you can use.
- **GraphqlString**
- **GraphqlNumber**
- **GraphqlFloat**
- **GraphqlBoolean**
- **GraphqlDate**
- **GraphqlObject**
- **GraphqlArray**
- **GraphqlArrayObject**
- **GraphqlBuffer**
- ### Configs
Configs is used for global custome headers, for interation request between client and server.
- **url**: is used for the address of the graphql server that will be used to interaction.
- **origin**: is used for response header indicates whether the response can be shared with requesting code from the given origin.
- **method**: used for response header specifies one or more methods allowed when accessing a resource in response or request.
- **allowedHeaders**: ise used for response header is used in response to a preflight request can be used during the actual request.
- **exposedHeaders**: is used for response header allows a server to indicate which response headers should be made available.
- **credentials**: is used for response header tells http whether to expose the response to server.
- **maxAge**: is used for response header indicates how long the results of a preflight request can be cached.
- **auth**: is used for request header can be used to provide credentials that authenticate a user agent with a server.
- **responseType**: is used representation header is used to indicate the original media type of the resource.
- **cache**: is used HTTP header field holds directives in both requests and responses, that control caching.
- **compression**: is used for compress the message data without losing information about the origin media type.
- **headers**: is used for interface of the Fetch API allows you to perform various actions on HTTP request and response headers.
## SiJago Methods
- ### Query(options: SiJagoOptions): Promise(SiJagoResponse) | Promise(Object)
Query allow your get data from server-side, and it also returns an object based on the operation performed.
- ### Mutation(options: SiJagoOptions): Promise(SiJagoResponse) | Promise(Object)
Mutation allow you to modify server side data, and it also returns an object based on the operation performed. It can be used to insert, update, or delete data.
## Example Usage
- ##### Before Usage Using SiJago With CommonJS Module
```javascript
const fetch = require('node-fetch')
(async function() {
fetch('https://graphqlzero.almansi.me/api', {
method: 'POST',
body: JSON.strgify({
query:`
albums(options: { sort: { order: DESC } }) {
data {
id
title
user {
name
email
}
photos {
data {
title
url
}
}
}
}
`
})
})
})()
```
- ##### After Usage Using SiJago With CommonJS Module
```javascript
const { sijago } = require('sijago')
(async function() {
const { res } = await sijago.query({
url: 'https://graphqlzero.almansi.me/api',
input: { options: { sort: { order: 'DESC' } } },
body: {
albums: {
data: {
title: sijago.scalar.GraphqlString,
user: {
name: sijago.scalar.GraphqlString,
email: sijago.scalar.GraphqlString
},
photos: {
data: {
title: sijago.scalar.GraphqlString,
url: sijago.scalar.GraphqlString
}
}
}
}
}
})
})()
/** Example response usage if you use sijago graphql client
{
data: { albums: { data: [Array] } },
error: undefined,
url: 'https://graphqlzero.almansi.me/api',
status: 200,
statusText: 'OK',
headers: Headers {
[Symbol(map)]: [Object: null prototype] {
'content-type': [Array],
'transfer-encoding': [Array],
connection: [Array],
'access-control-allow-credentials': [Array],
date: [Array],
'access-control-allow-origin': [Array],
'x-vercel-cache': [Array],
server: [Array],
'x-vercel-id': [Array],
'strict-transport-security': [Array],
'cache-control': [Array],
'content-encoding': [Array]
}
}
}
*/
```
- ##### Before Usage Using SiJago With ESM Module
```javascript
import fetch from 'node-fetch'
(async function() {
fetch('https://graphqlzero.almansi.me/api', {
method: 'POST',
body: JSON.strgify({
query:`
albums(options: { sort: { order: DESC } }) {
data {
id
title
user {
name
email
}
photos {
data {
title
url
}
}
}
}
`
})
})
})()
```
- ##### After Usage Using SiJago With ESM Module
```javascript
import { sijago } from 'sijago'
(async function() {
const { res } = await sijago.query({
url: 'https://graphqlzero.almansi.me/api',
input: { options: { sort: { order: 'DESC' } } },
body: {
albums: {
data: {
title: sijago.scalar.GraphqlString,
user: {
name: sijago.scalar.GraphqlString,
email: sijago.scalar.GraphqlString
},
photos: {
data: {
title: sijago.scalar.GraphqlString,
url: sijago.scalar.GraphqlString
}
}
}
}
}
})
})()
/** Example response usage if you use sijago graphql client
{
data: { albums: { data: [Array] } },
error: undefined,
url: 'https://graphqlzero.almansi.me/api',
status: 200,
statusText: 'OK',
headers: Headers {
[Symbol(map)]: [Object: null prototype] {
'content-type': [Array],
'transfer-encoding': [Array],
connection: [Array],
'access-control-allow-credentials': [Array],
date: [Array],
'access-control-allow-origin': [Array],
'x-vercel-cache': [Array],
server: [Array],
'x-vercel-id': [Array],
'strict-transport-security': [Array],
'cache-control': [Array],
'content-encoding': [Array]
}
}
}
*/
```
- ##### Example Usage Using SiJago With Local Headers
```javascript
import { sijago } from 'sijago'
(async function() {
const { res } = await sijago.query({
url: 'https://graphqlzero.almansi.me/api',
input: { options: { sort: { order: 'DESC' } } },
body: {
albums: {
data: {
title: sijago.scalar.GraphqlString,
user: {
name: sijago.scalar.GraphqlString,
email: sijago.scalar.GraphqlString
},
photos: {
data: {
title: sijago.scalar.GraphqlString,
url: sijago.scalar.GraphqlString
}
}
}
},
headers: {
origin: 'graphqlzero.almansi.me',
methods: ['POST', 'GET', 'PUT', 'DELETE', 'HEAD', 'OPTIONS']
}
}
})
})()
/** Example response usage if you use sijago graphql client
{
data: { albums: { data: [Array] } },
error: undefined,
url: 'https://graphqlzero.almansi.me/api',
status: 200,
statusText: 'OK',
headers: Headers {
[Symbol(map)]: [Object: null prototype] {
'content-type': [Array],
'transfer-encoding': [Array],
connection: [Array],
'access-control-allow-credentials': [Array],
date: [Array],
'access-control-allow-origin': [Array],
'x-vercel-cache': [Array],
server: [Array],
'x-vercel-id': [Array],
'strict-transport-security': [Array],
'cache-control': [Array],
'content-encoding': [Array]
}
}
}
*/
```
- ##### Example Usage Using SiJago With Global Headers
```javascript
import { sijago } from 'sijago'
sijago.configs = {
url: 'https://graphqlzero.almansi.me/api',
origin: 'graphqlzero.almansi.me',
methods: ['POST', 'GET', 'PUT', 'DELETE', 'HEAD', 'OPTIONS']
}
(async function() {
const { res } = await sijago.query({
input: { options: { sort: { order: 'DESC' } } },
body: {
albums: {
data: {
title: sijago.scalar.GraphqlString,
user: {
name: sijago.scalar.GraphqlString,
email: sijago.scalar.GraphqlString
},
photos: {
data: {
title: sijago.scalar.GraphqlString,
url: sijago.scalar.GraphqlString
}
}
}
}
}
})
})()
/** Example response usage if you use sijago graphql client
{
data: { albums: { data: [Array] } },
error: undefined,
url: 'https://graphqlzero.almansi.me/api',
status: 200,
statusText: 'OK',
headers: Headers {
[Symbol(map)]: [Object: null prototype] {
'content-type': [Array],
'transfer-encoding': [Array],
connection: [Array],
'access-control-allow-credentials': [Array],
date: [Array],
'access-control-allow-origin': [Array],
'x-vercel-cache': [Array],
server: [Array],
'x-vercel-id': [Array],
'strict-transport-security': [Array],
'cache-control': [Array],
'content-encoding': [Array]
}
}
}
*/
```
- ##### Example Usage Using SiJago With Global Custome Headers
```javascript
import { sijago } from 'sijago'
sijago.configs.headers.set('Content-Type', 'application/graphql')
sijago.configs.headers.set('Accept', 'application/graphql')
(async function() {
const { res } = await sijago.query({
input: { options: { sort: { order: 'DESC' } } },
body: {
albums: {
data: {
title: sijago.scalar.GraphqlString,
user: {
name: sijago.scalar.GraphqlString,
email: sijago.scalar.GraphqlString
},
photos: {
data: {
title: sijago.scalar.GraphqlString,
url: sijago.scalar.GraphqlString
}
}
}
}
}
})
})()
/** Example response usage if you use sijago graphql client
{
data: { albums: { data: [Array] } },
error: undefined,
url: 'https://graphqlzero.almansi.me/api',
status: 200,
statusText: 'OK',
headers: Headers {
[Symbol(map)]: [Object: null prototype] {
'content-type': [Array],
'transfer-encoding': [Array],
connection: [Array],
'access-control-allow-credentials': [Array],
date: [Array],
'access-control-allow-origin': [Array],
'x-vercel-cache': [Array],
server: [Array],
'x-vercel-id': [Array],
'strict-transport-security': [Array],
'cache-control': [Array],
'content-encoding': [Array]
}
}
}
*/
```
## Testing
- Testing Via Local
```sh
npm test or make test
```
- Testing Via Local And Build
```sh
make build
```
- Testing Via Docker
```sh
docker build -t sijago or make dkb tag=sijago
```
## Bugs
For information on bugs related to package libraries, please visit [here](https://github.com/restuwahyu13/sijagoissues)
## Contributing
Want to make **sijago** more perfect ? Let's contribute and follow the [contribution guide.](https://github.com/restuwahyu13/sijago/blob/main/CONTRIBUTING.md)
## License
- [MIT License](https://github.com/restuwahyu13/sijago/blob/main/LICENSE.md)