@jichio/core - Jichio

@jichio/core est le SDK navigateur sans framework. @jichio/react et le plugin WordPress l’utilisent en interne : les options et méthodes ci-dessous s’appliquent à toutes les plateformes. Version actuelle : 0.2.1.

pnpm add @jichio/core

`createAnalytics(config)`

Crée une instance et démarre la capture automatique. Retourne un objet AnalyticsInstance.

import { createAnalytics } from "@jichio/core";

const analytics = createAnalytics({
  apiKey: "jch_pr_xxxxxxxxxxxxxxxx",
  source: "sdk-core",
});

Créez une seule instance par page : chaque instance installe ses propres écouteurs, et deux instances doubleraient les événements automatiques.

Options

string

requis

Clé d’ingestion de l’environnement visé (jch_sb_, jch_st_ ou jch_pr_).

string

requis

Plateforme émettrice, enregistrée dans chaque événement. "sdk-core" ou "sdk-vanilla" en usage direct. Les adaptateurs la renseignent eux-mêmes ("sdk-react", "sdk-wordpress").

string

défaut:"https://api.bissa.tech"

URL de base de l’API. /v1/events y est ajouté. À renseigner uniquement pour une API auto-hébergée ou locale.

boolean

défaut:"true"

Active tous les événements automatiques : première page vue, clics, scroll, sessions, conversions, erreurs, Web Vitals, friction. false les désactive tous.

boolean

défaut:"false"

Active le suivi des formulaires. Nécessite aussi autoCapture: true.

boolean

défaut:"false"

Affiche chaque événement mis en file dans la console (console.debug). La valeur est aussi enregistrée dans properties.sdk.debug.

number

défaut:"5000"

Délai maximal, en millisecondes, entre deux envois.

number

défaut:"10"

Nombre d’événements en file qui déclenche un envoi immédiat.

number

défaut:"10"

Nombre maximal de nouvelles tentatives pour un lot en échec.

number

défaut:"1000"

Délai avant la première nouvelle tentative. Il double ensuite à chaque échec.

number

défaut:"60000"

Délai maximal entre deux tentatives.

number

défaut:"32768"

Taille maximale des properties d’un événement. Au-delà, le contexte non essentiel est retiré. Voir Fiabilité & limites.

number

défaut:"100"

Longueur maximale du texte d’un élément cliqué. Les chaînes de vos propriétés sont coupées à 4 fois cette valeur.

string

Version de l’adaptateur, enregistrée dans properties.sdk.adapterVersion. Renseignée par les adaptateurs ; inutile en usage direct.

Méthodes

`track(eventName, properties?)`

track(eventName: string, properties?: Record<string, unknown>): Promise<void>

Envoie un événement personnalisé. Les propriétés sont rangées dans properties.custom. La promesse se résout quand l’événement est enregistré dans la file locale, pas quand il est envoyé.

`identify(userId, traits?)`

identify(userId: string, traits?: Record<string, unknown>): Promise<void>

Enregistre l’utilisateur dans le localStorage, envoie un événement identify et ajoute userId et properties.user à tous les événements suivants. Voir Identifier les utilisateurs.

`page(properties?)`

page(properties?: Record<string, unknown>): Promise<void>

Envoie un pageview pour l’URL courante. À appeler après chaque changement de route dans une SPA sans adaptateur. Les valeurs passées remplacent celles lues dans la page (url, title, referrer, loadType…). Deux appels pour la même URL à moins de 300 ms n’en envoient qu’un. Si l’URL a changé depuis la dernière page, un page_leave est envoyé pour la page précédente.

`flush()`

flush(): Promise<void>

Envoie immédiatement les événements en file. Utile dans les tests, ou avant une action qui ferme la page. Le SDK le fait déjà seul quand l’onglet est masqué.

`destroy()`

destroy(): void

Retire les écouteurs et arrête les minuteries. Les événements encore en file y restent et partiront au prochain chargement. destroy() n’efface pas l’identité : voir Déconnexion.

Exports

import {
  createAnalytics,
  DEFAULT_INGEST_ENDPOINT,
  SDK_VERSION,
  type AnalyticsCoreConfig,
  type AnalyticsInstance,
} from "@jichio/core";

Utilisation sans bundler

Le build produit aussi un fichier UMD qui expose window.AnalyticsCore. C’est ce fichier que charge le plugin WordPress :

<script src="/assets/analytics-core.umd.js"></script>
<script>
  window.AnalyticsCore.createAnalytics({
    apiKey: "jch_pr_xxxxxxxxxxxxxxxx",
    source: "sdk-vanilla",
  });
</script>

Aucune URL CDN publique n’est encore fournie : hébergez le fichier avec votre site.

​createAnalytics(config)

​Options

​Méthodes

​track(eventName, properties?)

​identify(userId, traits?)

​page(properties?)

​flush()

​destroy()

​Exports

​Utilisation sans bundler

`createAnalytics(config)`

Options

Méthodes

`track(eventName, properties?)`

`identify(userId, traits?)`

`page(properties?)`

`flush()`

`destroy()`

Exports

Utilisation sans bundler