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

@foxford/services

v1.3.0

Published

Foxford services

Downloads

31

Readme

Сервисы Foxford

Библиотека фронтовых сервисов, которые помогут реализовать тот или иной функционал на уровне приложения. Здесь будут появляться сервисы фокса, которые будут "отвязаны" от других сервисов и функций, не принадлежащих им.

Captcha Service

Сервис для работы с капчей. В зависимости от данных с бэка используется или Google-капча, или Cloudflare Turnstile


API Service

Для чего?

Чтобы разные проекты использовали единый HTTP-клиент (Axios) сервис апи был вынесен в пакеты и опубликован в npm

Апи из пакета сервисов представляет собой фабрику, которая принимает параметры и возвращает инстанс клиента, подробнее описано здесь


Как обесепечивается единобразное использование HTTP-клиента?

Точкой правды, поставщиком HTTP-клиента является @foxford/foxford-js-sdk (FoxfordService) Все "потребители" должны использовать HTTP-клиент из FoxfordService

FoxfordService использует пакет сервисов @foxford/services для получения инстанса Api конфигурирует его и примешивает Interceptors и отдает наружу два клиента:

  1. FoxfordService.foxApi - инстанс Api, ориентированный на использование внутренних сервисов Фоксфорда, в нем:
  • Используются Api Interceptors По умолчанию используются два обязательных перехватчика(camelize и referrer) и один опциональный(captcha) в interceptors.request, это:
    • camelize - для преобразования кейса в ответе запроса
    • referrer - для проброса реферрера в запросе
    • captcha - опциональный, будет добавлен, если при инициализации FoxfordService, в конфиге будет передан конфиг для капчи. Подробнее здесь
  • Используется axiosRetry - плагин Api, перехватывающий упавшие запрос и поторяющий его (3 раза)
  • Указан baseURL
  1. FoxfordService.api - "базовый" инстанс Api, который имеет минимальную конфигурацию и не использует Interceptors и в нем не указан baseUrl Предназначен для хождения "наружу"

Базовый конфиг Api используемый для FoxfordService.api

{
  xsrfCookieName: CSRF_COOKIE_NAME,
  xsrfHeaderName: 'X-CSRF-Token',
  headers: { 'X-Requested-With': 'XMLHttpRequest' },
}

Конфиг Api используемый для FoxfordService.foxApi

{
  xsrfCookieName: CSRF_COOKIE_NAME,
  xsrfHeaderName: 'X-CSRF-Token',
  headers: { 'X-Requested-With': 'XMLHttpRequest' },
  withCredentials: true,
}

При необходимости можно расширить или переопределить конфиг для FoxfordService.foxApi


Пример использования апи из FoxfordService

import { Foxford } from '@foxford/foxford-js-sdk'

const myHost = 'exampleHost'
const FoxfordService = new Foxford({
  api: {
    config: {
      baseURL: myHost,
    },
  },
  host: myHost, // легаси, на работу апи не влияет, есть "на всякий случай",
  recaptchaConfig: {
    locale: 'ru',
    sitekey: 'captchaSecretKey',
  },
})

const getInternalData = () => {
  FoxfordService.foxApi.get(`/some-internal-url-protected-with-captcha`).then(({ data }) => data)
}

const getExternalData = () => {
  FoxfordService.api.get(`https://some.external.source`).then(({ data }) => data)
}

Пример использования апи в stoege

import { Api, BaseApi } from 'services/api'

const getInternalData = () => {
  Api.get(`/some-internal-url-protected-with-captcha`).then(({ data }) => data)
}

const getExternalData = () => {
  BaseApi.get(`https://some.external.source`).then(({ data }) => data)
}