@meiroio/web-sdk 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,74 @@
+export type MptConsent = 'denied' | 'granted';
+
+export type MptConsentOptions = {
+  storagePersistence?: MptConsent;
+  userId?: MptConsent;
+  sessionId?: MptConsent;
+};
+
+export type MptLinkTrackingOptions = {
+  enabled: boolean;
+  domainsBlacklist?: string[];
+};
+
+export type MptIdSyncOptions = {
+  googleAnalytics?: boolean;
+  meta?: boolean;
+};
+
+export type MptTradeDeskOptions = {
+  pid: string;
+  gdpr?: 0 | 1;
+  gdprConsent?: string;
+};
+
+export type MptGooglePixelOptions = {
+  googleNid: string;
+};
+
+export type MptTrackingRulesStorageAllowlist = {
+  cookies?: string[];
+  localStorage?: string[];
+  sessionStorage?: string[];
+};
+
+export type MptTrackingRulesOptions = {
+  enabled: boolean;
+  debug?: boolean;
+  storageAllowlist?: MptTrackingRulesStorageAllowlist;
+};
+
+export type MptWebBannersOptions = {
+  enabled?: boolean;
+};
+
+export type MptConfig = {
+  collectionEndpoint: string;
+  crossDomainWhitelist?: string[];
+  linkTracking?: MptLinkTrackingOptions;
+  idSync?: MptIdSyncOptions;
+  theTradeDesk?: MptTradeDeskOptions;
+  googlePixel?: MptGooglePixelOptions;
+  trackingRules?: MptTrackingRulesOptions;
+  webBanners?: MptWebBannersOptions;
+};
+
+export type MptConfigUpdate = Partial<MptConfig>;
+
+export type MptOptions = MptConfig & {
+  consent?: MptConsentOptions;
+};
+
+export type MptEventPayload = Record<string, unknown>;
+
+export type MptSharedPayload = Record<string, unknown>;
+
+export type MptFieldName = 'userId' | 'sessionId';
+
+export interface MptClient {
+  config(config: MptConfigUpdate): void;
+  consent(consent: MptConsentOptions): void;
+  event(eventName: string, payload?: MptEventPayload): Promise<void>;
+  set(payload: MptSharedPayload): void;
+  get(fieldName: MptFieldName): string;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@meiroio/web-sdk",
+  "version": "0.1.0",
+  "description": "Browser SDK for collecting website events with Meiro Pipes.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "bun run ../scripts/build-web-sdk-package.ts",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "bun test ../src/server/sdk/npm.test.ts ../src/server/sdk/npm-client.test.ts ../src/server/sdk/npm-config.test.ts",
+    "prepack": "bun run build",
+    "prepublishOnly": "bun run typecheck && bun run test"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meiroio/pipes.git",
+    "directory": "web-sdk"
+  },
+  "homepage": "https://github.com/meiroio/pipes#readme",
+  "bugs": {
+    "url": "https://github.com/meiroio/pipes/issues"
+  },
+  "keywords": [
+    "analytics",
+    "cdp",
+    "customer-data",
+    "meiro",
+    "tracking",
+    "web-sdk"
+  ],
+  "license": "UNLICENSED"
+}