open-index/open-npm huggingface dataset:
npm package: @openland/spacex-cli
Description: Compiler for SpaceX GraphQL.
Latest version: 6.0.6

# SpaceX GraphQL Compiler

Compiler for SpaceX GraphQL.

## Install

```bash
yarn add -D @openland/spacex-cli get-graphql-schema
```

## Generate Client

### Requirements

- API Endpoint too download schema from (ex: https://api.example.com/graphql)
- .graphql files with operations (ex: ./src/api/definitions/\*.graphql)

### Generate Client

SpaceX Compiler generates three files:

- `spacex.definitions.json`: Descriptors of all fragments and operations for GraphQL Engines
- `spacex.types.ts`: Typescript fragments and operations files
- `spacex.ts`: Client itself

```bash
get-graphql-schema https://api.example.com/graphql --json > schema.json
yarn spacex-cli compile \
    --path "./src/api/definitions/*.graphql" \
    --schema ./schema.json \
    --output ./src/api/ \
    --name ExampleClient
```

# License

MIT
npm package: @openland/spacex-web
Description: Web Engine for SpaceX GraphQL.
Latest version: 6.0.6

# Web Engine for SpaceX GraphQL

Web Engine for SpaceX GraphQL.

## Install

```bash
yarn add @openland/spacex @openland/spacex-web
```

### Web Engine

```js
import { WebEngine, createCommonTransport } from '@openland/spacex-web'

// Transport
const transport = createCommonTransport({
  url: 'wss://api.example.com/graphql',
  mode: 'transport-ws',
  connectionParams: {
    token: 'some-fancy-token'
  }
});

// Engine
const engine = new WebEngine({
  definitions: require('./spacex.descriptor.json'),
  transport
});
```

## Web Worker Engine

Since there are multiple ways to deploy web workers `SpaceX` provides API for integration and leaves developer a freedom to deploy any way they wish.

### Create Web Worker host

This is a code to run web worker host - the code that executes queries itself and answers for requests from main process.

```js
import {
  WebEngine,
  createCommonTransport,
  WorkerInterface,
  WorkerHost
} from '@openland/spacex-web'
var host

//
// Handler for first message: It fetches connectionParams and creates an engine
//
const initHandler = (ev: MessageEvent) => {
  // Read init package
  let msg = ev.data
  if (msg.type !== 'init') {
    throw Error('Worker need to be inited first!')
  }
  self.removeEventListener('message', initHandler)

  // Define Worker Interface
  let workerInterface: WorkerInterface = {
    post: src => self.postMessage(src),
    setHandler: handler =>
      self.addEventListener('message', (src: any) => handler(src.data))
  }

  // Create transport
  const transport = createCommonTransport({
    url: 'wss://api.example.com/graphql',
    mode: 'transport-ws',
    connectionParams: {
      token: msg.token
    }
  })

  // Create Engine
  const engine = new WebEngine({
    definitions: require('./spacex.descriptor.json'),
    transport
  })

  // Create Host
  host = new WorkerHost({
    engine,
    worker: workerInterface
  })
}

self.addEventListener('message', initHandler)
```

### Create Web Worker Engine

```js

// Our connection token
const token: string = 'some-fancy-worker'

// Create WebWorker
const W = require('./spacex.worker') // NOTE: We using WebPack plugin to generate web workers
let thread: Worker = new W()
thread.onerror = e => {
  console.error(e) // There are no way to recover easily
}

// Send init package to worker
thread.postMessage({ type: 'init', token })

// Create Engine
let threadInterface: WorkerInterface = {
  post: src => thread.postMessage(src),
  setHandler: handler =>
    (thread.onmessage = src => {
      handler(src.data)
    })
}
const engine = new WorkerEngine({ worker: threadInterface });
```

# License

MIT