🦕 Dinocollab Http Service

A TypeScript library for sending HTTP and GraphQL requests with automatic site detection, customizable headers, and flexible configuration. Suitable for DinoCollab projects.

Installation

1npm install dinocollab-http-service@latest

Initialization Per Dependency

1npm install graphql-ts-client-api@3.1.17
2npm install --save-dev graphql-ts-client-codegen@3.1.17

Basic Usage

1. Sending a GraphQL Request

1// Create an instance for the GraphQL endpoint
2import { createGraphqlRequest } from 'dinocollab-http-service'
3import { execute } from '../__generated'
4
5export const Graphql = createGraphqlRequest({ execute, baseUrl: '/grql/api/v1/graphql' })
6
7// Use the instance to send a query
8import { media$$, mediaPage$, mediaStoreGraphDbContext$, query$ } from '../__generated/fetchers'
9const MediaSelector = media$$
10export type TMedia = ModelType<typeof MediaSelector>
11
12export type TMediasFilterParams = Parameters<typeof mediaStoreGraphDbContext$.medias>[0]
13
14export const Medias = (params: TMediasFilterParams) => {
15  const MediaPage = mediaPage$.items(MediaSelector).hasNextPage.hasPreviousPage.totalItems
16  return query$.mediaStore(mediaStoreGraphDbContext$.medias(params, MediaPage))
17}
18
19// Send a request to get the media list
20export const fetchMedias = async (params: TMediasFilterParams) => {
21  const res = await Graphql.query(Medias(params))
22  return res
23}

2. Customization

1// Set custom headers
2await graphql.addCustomHeader({ headers: { 'x-custom-header': 'value' } })
3
4// Set the current site
5await graphql.setSite('site2')
6
7// Get the current site
8const site = await graphql.getSite()

CLI Tool

This package provides a CLI tool to generate TypeScript code from a remote GraphQL schema.

Usage

1npx dinocollab-http-service --schema-url=<GRAPHQL_SCHEMA_URL> [--secure] [--out-dir=<OUTPUT_DIR>]

• --schema-url: (required) URL to the GraphQL schema endpoint.
• --secure: (optional) Enable SSL certificate validation. By default, SSL validation is disabled.
• --out-dir: (optional) Output directory for generated code. Defaults to __generated at the project root.

Example

1npx dinocollab-http-service --schema-url=https://your-graphql-endpoint/graphql --out-dir=src/__generated

Main API

GraphqlRequest

• Query(fetcher, options?): Send a GraphQL query/mutation.
• QueryPushNotify(fetcher, options?): Send a query and push errors to the notification context.
• addCustomHeader(config?): Add headers for the next request.
• setSite(site: string): Set the current site.
• getSite(): Get the current site.

HttpRequest

• Request(fetcher, options?): Send an HTTP request.
• addCustomHeader(config?): Add headers for the next request.
• setSite(site: string): Set the current site.
• getSite(): Get the current site.

Main Types

• IGraphqlRequestOptions, IHttpRequestOptions: Options for instance initialization.
• IGraphqlQueryOptions, IHttpRequestConfig: Options for sending requests.
• IGraphqlResult<T>: Standard result for list queries.

Development

• Clone the repo
• Install dependencies: npm install
• Build: npm run build
• Test: npm test

License

MIT