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

@vladbasin/strong-api-client

v1.1.1

Published

Strongly typed API client

Downloads

238

Readme

Strong API client

Share request/response models with your API consumers, so they don't need to repeat the same mapping & validation logic.

This is CLIENT library. See SERVER library: @vladbasin/strong-api-middleware

Installation

npm

npm install @vladbasin/strong-api-client @vladbasin/strong-api-middleware @vladbasin/strong-api-mapping @vladbasin/ts-result reflect-metadata joi

yarn

yarn add @vladbasin/strong-api-client @vladbasin/strong-api-middleware @vladbasin/strong-api-mapping @vladbasin/ts-result reflect-metadata joi

Usage

  1. Import reflect-metadata ONCE in your index file:
import 'reflect-metadata';
  1. Define Request model
import { body, header, path, query } from '@vladbasin/strong-api-mapping';

export class RequestPayload {
    @path()
    public userId!: number;

    @path({ key: 'userId' })
    public id!: number;

    @query()
    public name!: string;

    @query()
    public isAdmin!: boolean;

    @query({ key: 'lastname' })
    public surname!: string;

    @query({ parser: String })
    public cars!: string[];

    @query({ parser: Number })
    public cash!: number[];

    @body()
    public details!: DetailsType;

    @header({ key: 'Content-Type' })
    public contentType!: string;

    @header({ key: 'X-Info', parser: String })
    public info!: string[];
}
  1. Define Response model
import { body } from '@vladbasin/strong-api-mapping';

export class ResponsePayload {
    @body()
    public user!: UserType;
}
  1. Define validation rules with Joi
export const RequestPayloadSchema = Joi.object<RequestPayload>({
    surname: Joi.string().min(10),
    cars: Joi.array().max(3),
    // other rules for field content...
});
  1. Call fetchPayloadRequestWithBodyAsync() to execute a request:
fetchWithBodyAsync({
        request: {
            url: 'http://your-backend/api/users/{userId}',
            method: HttpRequestMethods.Post,
            payload: assign(new RequestPayload(), { id: 12 }),
        },
        response: {
            // process success response (automapped to model instance by the library)
            data: {
                Model: ResponsePayload,
                schema: ResponsePayloadSchema,
            },
            // OPTIONAL: process error response with custom format (automapped to model instance by the library)
            error: {
                element: {
                    Model: ErrorPayload,
                    schema: ErrorPayloadSchema,
                },
                handler: (statusCode, errorPayload) => {
                    //return Error object based on arguments
                },
            },
        },
    })
    .onSuccess(({ user }: response) => { 
        // process response data model
    })
    .onFailureWithError(error => {
        // process error (see FetchError below)
    })
    .run();

By default this library creates FetchError when reponse fails. You can use it to process the data:

class FetchError extends CodedError {
    constructor(
        public httpStatusCode: number,
        public code: string,
        public message: string,
        public errors: InnerErrorType[] = [],
        public stack = '',
        public details: Record<string, unknown> = {}
    )
}

type InnerErrorType = {
    code: string;
    message: string;
};