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

freebox-wrapper

v1.0.5

Published

Un wrapper pour l'API de Freebox OS, gère la connexion et facilite les requêtes.

Downloads

11

Readme

Freebox OS Wrapper

Une librairie pour faciliter l'utilisation de l'API de Freebox OS (interface pour les boxs françaises de l'opérateur Free). Facilite l'authentification et l'envoi de requêtes.

Pourquoi faire ?

L'API de Freebox OS est capable d'exécuter de nombreuses actions sur la box, comme la gestion des téléchargements et des fichiers sur le disque interne, ou la gestion des contacts et des appels sur le téléphone fixe. Cependant, l'authentification et la première connexion (register) sont assez complexes. Cette librairie permet de simplifier ces étapes, pour vous offrir une meilleure expérience de développement.

Installation

Une version récente de Node.js est requise. Nous n'offrons pas de support pour les versions non LTS, et pour les navigateurs.

# Avec npm
npm i freebox-wrapper

# Ou avec pnpm
pnpm i freebox-wrapper

Exemples

Register

Cette étape ne doit être effectuée qu'une seule fois, et permet d'obtenir un appToken. C'est une étape obligatoire pour utiliser l'API de Freebox OS. L'écran d'affichage de la Freebox demandera à l'utilisateur de confirmer l'opération.

var { RegisterFreebox } = require("freebox-wrapper")

RegisterFreebox({
	showLogs: true, // affiche les logs dans la console, true par défaut
	appId: "fbx.example",
	appName: "Mon appli",
	appVersion: "1.0.0",
	deviceName: "Mon ordi"
}).then(console.log)

Authentification

L'étape d'authentification permet d'obtenir un token de session, qui est nécessaire pour effectuer des requêtes à l'API.

L'authentification est automatiquement effectuée lors de l'envoi d'une requête si le token de session n'est pas encore disponible, l'utilisation de cette méthode n'est pas obligatoire.

var { FreeboxClient } = require("freebox-wrapper")

var client = new FreeboxClient({
	verbose: true, // affiche une sortie plus détaillée dans la console, false par défaut
	appId: "fbx.example",
	appToken: "<obtenu avec RegisterFreebox>",
	apiDomain: "<obtenu avec RegisterFreebox>",
	httpsPort: "<obtenu avec RegisterFreebox>"
})
client.authentificate().then(console.log)

Requête

Une fois authentifié, vous pourrez effectuer des requêtes à l'API de Freebox OS.

var systemInfo = await client.fetch({
	url: "v8/system",
	method: "GET", // Peut être omis si GET (valeur par défaut)
	parseJson: true // Retourne la réponse parsée en JSON, ou une erreur si la réponse n'est pas du JSON. Si false, retourne la réponse donnée par node-fetch.
})
console.log(systemInfo)

Le header Content-Type est automatiquement défini à application/json s'il n'est pas déjà défini.

Licence

MIT © Johan