My first Open Source library

pigozzifr

Francesco Pigozzi

Posted on January 25, 2021

My first Open Source library

Thanks to Lisheng Chang @changlisheng for making this photo available freely on Unsplash ๐ŸŽ

Long story short

It all started as a pet project, I know you understand me.

But rapidly it became more like a developer need: to have something that works as you want it to, something you could share with other developers and be proud of it because, damn, youโ€™ve just became part of an amazing ecosystem called Open Source!

I was finding myself in the need of using the plain JS SDK of Amazonโ€™s Product Advertising API, link here, but it was barely usable, with a lot of conventions, zero explicitness and a whole set of unreadable code.

Maybe itโ€™s just me but in the past year Iโ€™ve started to appreciate when you jump into a project and you can understand easily how things get passed around. I needed Typescript.

There was little to no libraries as I expect them to be and finally I came to one conclusion: I needed to do it myself.

And I did it! ๐Ÿ‘‡โญ๏ธ

GitHub logo Pigotz / paapi5-typescript-sdk

TypeScript SDK for Product Advertising API 5.0

paapi5-typescript-sdk

Unofficial TypeScript SDK for Product Advertising API 5.0

Installation

In order to install this SDK, you just have to run you well-known npm or yarn scripts:

npm i -S paapi5-typescript-sdk
Enter fullscreen mode Exit fullscreen mode

Or

yarn add paapi5-typescript-sdk
Enter fullscreen mode Exit fullscreen mode

And there you go! Enjoy ๐Ÿ˜Ž

API

Everything is exported from the SDK: requests' classes, models, utility types, helper and so on..

If you want to import everything

import * as SDK from 'paapi5-typescript-sdk';
Enter fullscreen mode Exit fullscreen mode

And use what you need later

const request = new SDK.SearchItemsRequest(/* ... */);
Enter fullscreen mode Exit fullscreen mode

You can refer to the Amazon Product Advertising API 5.0 for further details about every request

Auth

In order to validate all the requests against the APIs, I've implemented almost from scratch the AWS V4 signing process, creating the SignHelper class.

This is intended for interal use, but if you want to use it for other purposes, here you canโ€ฆ

Honest work meme

I need feedback ๐Ÿ™†โ€โ™‚๏ธ

This is a small project but a whole set of TS is involved and needs to be maintained โš™๏ธ

This is my first time being the author of an Open Source repository so any feedback and proposal is welcome ๐Ÿ™

If you are just lazy, leave a GitHub โญ๏ธ and a ๐Ÿฆ„ here, it would be enough for me!

Thanks for reading!

๐Ÿ’– ๐Ÿ’ช ๐Ÿ™… ๐Ÿšฉ
pigozzifr
Francesco Pigozzi

Posted on January 25, 2021

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related

tsParticles 3.0.1 Released
typescript tsParticles 3.0.1 Released

December 6, 2023

tsParticles 2.12.0 Released
typescript tsParticles 2.12.0 Released

August 4, 2023

tsParticles 2.11.0 Released
typescript tsParticles 2.11.0 Released

July 12, 2023

My first Open Source library
typescript My first Open Source library

January 25, 2021

ยฉ TheLazy.dev

About