npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

no-brainer-sdk

v1.0.17

Published

No Brainer SDK

Downloads

297

Readme

No-Brainer SDK Builder 😎

The No-Brainer SDK Builder is a tool that generates an SDK based on a GraphQL schema. It simplifies the process of interacting with a GraphQL API by automatically creating TypeScript types and client methods for queries and mutations.

Generating SDK file

To use the No-Brainer SDK Builder, run the following command to:

npx no-brainer-sdk@latest http://localhost:3001/graphql ./src/types/sdk-types.ts

This command will generate the SDK based on the provided GraphQL schema and output it to the specified TypeScript file (sdk-types.ts in this case).

At your first installation, remember to install graphql-request as well

npm i [email protected]

Usage Example

Once you have generated the SDK, you can start using it in your project. Here's an example of how to use the generated SDK:

import { SdkClient, SdkClientInstance, CreateCriticalTaskArgs, CriticalTaskStatus } from '../types/sdk-types';

const client = new SdkClient('http://localhost:3001/graphql');
// Alternatively, you can use the pre-configured instance
SdkClientInstance; // Ready with the configured endpoint

client.setGlobalAuthToken('jwt'); // Sets Authorization header
client.setGlobalCustomHeader('custom-header', 'custom-value');

// Specify normal fields, or nested ones with object {}
await client.user({ fields: ['user_id', { sessions: ['id', 'session_id'] }] });

const args: CreateCriticalTaskArgs = {
    title: 'test',
    date: '2020-01-01',
};

// Queries and mutations map to functions, with strict types safety
const task = await client.create_critical_task({
    args,
    fields: ['id'],
    headers: { 'custom-header': 'override' },
});

if (task.status === CriticalTaskStatus.win) {
    console.log('You won!');
}

In this example, the generated SDK allows you to perform GraphQL queries and mutations. You can customize request headers, set global authentication tokens, and access auto-generated methods for specific queries and mutations.

Auto generated types, interfaces and enums

It's just an example, of what structures SDK generates

export const SdkClientInstance = new SdkClient('http://localhost:3001/graphql');

// Interfaces
export interface User {
    created_at: string;
    user_id: string;
    email: string;
    sessions: Session[];
    critical_tasks: CriticalTask[];
}

// Enums
export enum CriticalTaskStatus {
    win = 'win',
    lose = 'lose',
    in_progress = 'in_progress',
}

// Query & Mutations types!
export type QueryType = 'user' | 'user_power_list';

export type MutationType = 'create_critical_task' | 'update_critical_task';

export enum QueryEnum {
    user = 'user',
    user_power_list = 'user_power_list',
}

export enum MutationEnum {
    create_critical_task = 'create_critical_task',
    update_critical_task = 'update_critical_task',
}

Enjoy 🚀🚀🚀

I appreciate all ideas for improvement, feel free to create a pull request or just contact me.