Liigu põhisisu juurde

Raamistiku adapterid

Reacti ümbrisFlutteri ümbris

TypeScripti SDK

Üks pakett kuue sisenemispunktiga. Impordi see, mis sinu käituskeskkonnaga sobib, ja puuraputusega ehitus jätab ülejäänu sinu kimbust välja.

Kus see on avaldatud

@prodantix/sdk on npm.

Paigaldus

Bash
bun add @prodantix/sdk

Sisenemispunktid

Iga alamtee tarnib oma ESM- ja CommonJS-ehituse koos oma tüüpidega. Juur on käituskeskkonnast sõltumatu ja ülejäänud lisavad selle, mida üks keskkond vajab.

SubpathWhat it exports
@prodantix/sdkProdantixClient, createClient, evaluateFlag, FlagsClient, MessagesClient
@prodantix/sdk/webcreateWebClient, installAutocapture, installSessionReplay, WebTransport
@prodantix/sdk/nodecreateNodeClient
@prodantix/sdk/cspprodantixConnectSrc, prodantixScriptSrc
@prodantix/sdk/chatmountChat, ChatClient, ChatPanel, resolveAppearance
@prodantix/sdk/messengerfetchMessengerConfig, cachedMessengerConfig, MESSENGER_CACHE_KEY

@prodantix/sdk

Klient, lipuhindaja ning salvestus- ja transpordiliidesed. Miski siin ei puuduta DOM-i, seega võid anda oma salvestuse, transpordi, kella või id-tehase ja käivitada selle kus tahes.

TypeScript
import { createClient, MemoryStorage } from '@prodantix/sdk';

const prodantix = createClient({
  apiKey: PRODANTIX_PUBLIC_KEY,
  host: 'https://eu.api.prodantix.com',
  storage: new MemoryStorage(),
});

prodantix.capture('order.completed', { properties: { amount: 4200, currency: 'XAF' } });
await prodantix.flush();

@prodantix/sdk/web

Brauseriühendused sama kliendi peal: säilitamine kohalikus salvestuses, saatmine majakaga, kui leht peidetakse, ning lehevaatamiste ja klikkide automaatpüüdmine. Seansi taasesitus püsib väljas, kuni annad sellele taasesituse hosti.

TypeScript
import { createWebClient } from '@prodantix/sdk/web';

const prodantix = createWebClient({
  apiKey: PRODANTIX_PUBLIC_KEY,
  host: 'https://eu.api.prodantix.com',
  flagsHost: 'https://api.prodantix.com',
  autocaptureOptions: { clicks: true, pageviews: true },
});

prodantix.identify('user-42', { set: { plan: 'pro' } });

if (await prodantix.isFeatureEnabled('new-checkout')) {
  // ...
}

// Every per-flag read records one $feature_flag_called exposure.
const variant = await prodantix.getVariant('new-checkout');
if (variant?.key === 'treatment') {
  // ...
}

// A flag targeting a cohort reads this user's memberships from the store;
// pass them yourself to skip the lookup.
if (await prodantix.isFeatureEnabledLocal('members', { cohorts: ['<cohort id>'] })) {
  // ...
}

@prodantix/sdk/node

Sama klient serveri vaikeväärtustega. Sündmused puhverdatakse ja saadetakse taustal, seega kutsu enne protsessi lõppu shutdown, muidu ei lahku viimane partii kunagi.

TypeScript
import { createNodeClient } from '@prodantix/sdk/node';

// A node client streams flag changes over Socket.IO by default and refetches
// the snapshot on push; streamFlags: false leaves only the 30s poll.
const prodantix = createNodeClient({
  apiKey: process.env.PRODANTIX_PUBLIC_KEY,
  host: 'https://eu.api.prodantix.com',
  streamFlags: true,
});

prodantix.capture('job.completed', { properties: { queue: 'emails' } });
await prodantix.shutdown();

@prodantix/sdk/csp

Sisuturbepoliitika allikad, mida rakendus vajab Prodantixini jõudmiseks. See ei impordi midagi Reactist ega brauserist, seega saab ehitusseadistuse fail seda otse lugeda.

TypeScript
import { prodantixConnectSrc, prodantixScriptSrc } from '@prodantix/sdk/csp';

const hosts = {
  ingest: 'https://eu.api.prodantix.com',
  edge: 'https://eu.edge.prodantix.com',
  replay: 'https://eu.replay.prodantix.com',
};

const policy = [
  `connect-src ${prodantixConnectSrc(hosts)}`,
  `script-src ${prodantixScriptSrc(hosts)}`,
].join('; ');

@prodantix/sdk/chat

Tugividin. Paigalda see ja saad pideme, mis avab, sulgeb, hävitab ja tuvastab kasutaja. See renderdub suletud varijuure sees, nii et host-lehe stiilid sinna kunagi ei ulatu.

TypeScript
import { mountChat } from '@prodantix/sdk/chat';

const messenger = mountChat({
  apiKey: PRODANTIX_PUBLIC_KEY,
  host: 'https://eu.edge.prodantix.com',
  distinctId: prodantix.distinctId,
});

document.querySelector('#help')?.addEventListener('click', () => messenger.open());

@prodantix/sdk/messenger

Vidina taga olev seadistuste lugeja: see tõmbab projekti sõnumitooja seadistuse, puhverdab selle ja ütleb, kas projektil on sõnumitooja sisse lülitatud. Ise käivituv koodijupp ehitatakse eraldi ega ole selle alamtee kaudu kättesaadav.

TypeScript
import { fetchMessengerConfig } from '@prodantix/sdk/messenger';

const config = await fetchMessengerConfig({
  apiKey: PRODANTIX_PUBLIC_KEY,
  host: 'https://eu.edge.prodantix.com',
});

if (config?.enabled) {
  // the project has the messenger switched on
}