
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@mrgis/snitch-mini-apps
Advanced tools
Добавить в разметку index.html:
window.snitch = createSnitch(...)
.Например:
<!DOCTYPE html>
<html>
<head>
<script>
// код @mrgis/snitch-mini-apps (https://unpkg.com/@mrgis/snitch-mini-apps@latest/dist/iife.min.js)
</script>
<script>
// инициализация счетчика snitch:
window.snitch = createSnitch({
initialScreen: { screenType: 'loading' },
flagApiEndpoint: 'https://flags.com/api/v1/' // опциональный параметр
})
</script>
<!-- ... -->
</head>
<body>
<!-- ... -->
</body>
</html>
⚠️ Важно подключать код библиотеки непосредственно в код страницы (inline) перед кодом приложения. Можно скопировать и вставить код в разметку вручную отсюда https://unpkg.com/@mrgis/snitch-mini-apps@latest/dist/iife.min.js или организовать вставку на этапе сборки проекта, например с помощью webpack-плагина InlineChunkHtmlPlugin
Для использования snitch
через TypeScript вам понадобится декларировать типы:
type SnitchEventPayload = {
[key: string]: string | number
}
type Flag = {
flagKey: string
match: boolean
variant?: string
attachment?: string
}
type FlagEvaluationContext = Record<string, string | number | boolean>
interface Snitch {
(eventName: string, eventPayload?: SnitchEventPayload): void
getFlag(flagKey: string, context?: FlagEvaluationContext): Promise<Flag>
getFlags(flagKeys: string[], context?: FlagEvaluationContext): Promise<Flag[]>
}
declare global {
interface Window {
snitch: Snitch
}
}
Функция snitch
имеет сигнатуру (eventName: string, eventPayload?: { [key: string]: string | number }) => void
. Для трекинга события необходимо вызвать функцию snitch
передав имя события и опциональные параметры, например:
snitch('startPlayingButtonPress') // пользователь нажал на кнопку «Начать игру»
snitch('characterLevelUp', { characterId: '123', level: 12 }) // пользователь прокачал персонажа с id '123' до 12 уровня
Чтобы собирать статистику о навигации пользователя внутри приложения вводится понятие экрана. Экран приложения описывается объектом с полем screenType
и опциональным полем screenId
, например: { screenType: 'onboarding', screenId: 'step1' }
screenType
: string — указывает на тип экрана, например: 'сatalogue'
, 'product'
, 'cart'
.screenId
: string — позволяет, когда это требуется, уточнить информацию об экране. Например, экран со статьей «Как есть печенье и не толстеть?» screenType
может иметь значение 'article'
, а screenId
значение 'how-to-eat-cokies-and-not-get-fat'
— уникальный slug статьи.
Пример разметки экранов приложения
window.snitch = createSnitch({
initialScreen: { screenType: 'loading' } // <- экран загрузки
})
screenChange
с информацией об экране в качестве параметров события, например:snitch('screenChange', { screenType: 'catalogue' }) // пользователь перешел на экран каталога
snitch('screenChange', { screenType: 'product', screenId: 'wagon-wheels-cookies' }) // пользователь перешел на экран продукта «Печенье Wagon Wheels»
snitch('screenChange', { screenType: 'cart' }) // пользователь перешел в корзину
Snitch позволяет работать с feature flags. Для этого при инициализации счетчика в параметре flagApiEndpoint
нужно указать URL эндпоинта сервиса флагов. Значения флагов можно получать методом snitch.getFlag
или батч методом snitch.getFlags
. Ответ будет содержать флаг или массив флагов в виде объекта с полями:
flagKey: string
— уникальное имя флагаmatch: boolean
— включен или отключен флагvariant: string
— вариант, если флаг имеет вариантыattachment: string
— дополнительные данные в формате JSON-строкиsnitch.getFlag('test-app-button-color').then(console.log)
{
"flagKey": "test-app-button-color",
"match": true,
"variant": "red",
"attachment": ""
}
snitch.getFlags(['test-app-button-color', 'test-app-illustration-toggle']).then(console.log)
[
{
"flagKey": "test-app-button-color",
"match": true,
"variant": "red",
"attachment": ""
},
{
"flagKey": "test-app-illustration-toggle",
"match": false,
"variant": "",
"attachment": ""
}
]
FAQs
## Установка
The npm package @mrgis/snitch-mini-apps receives a total of 3 weekly downloads. As such, @mrgis/snitch-mini-apps popularity was classified as not popular.
We found that @mrgis/snitch-mini-apps demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.