kansoku-js 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# kansoku-js
+
+## 0.1.0
+
+### Minor Changes
+
+- b1c1458: Initial browser SDK: page views with navigation and attribution capture, session
+  and identity helpers (including set-once traits and keyed email), experiment exposure,
+  bounded persistent batching with retries, and lifecycle-safe beacon/keepalive exit delivery
+  with `page_leave`. Cross-origin identity via parent-domain cookies and `linkTo` handoff,
+  configurable bot flagging, and opt-in client error and web vitals capture (measurement code
+  loads on demand). React provider and hooks support StrictMode and server rendering.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nadeem Bitar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,211 @@
-# Temporary Holding Version
+# kansoku-js
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Browser SDK for the Kansoku analytics service. Zero runtime dependencies; ESM with TypeScript declarations.
+
+```typescript
+import { createKansoku } from "kansoku-js"
+
+const analytics = createKansoku({
+  baseUrl: "https://analytics.example.com",
+  writeKey: "ksk_w_public_write_key",
+})
+analytics.track("signup_started", { plan: "team" })
+await analytics.flush()
+```
+
+## Browser capture
+
+By default the client records the initial `page_view`, History API navigations and
+`session_start`. Each view can emit one best-effort `page_leave` on navigation or exit,
+with a monotonic duration and the original page identity/session. BFCache restoration starts
+a new view interval. Set `autocapture.pageLeave: false` to disable it. Initialise after the page title is set. Page views include the full URL,
+path, title, document referrer and UTM attribution (`utmSource`, `utmMedium`, `utmCampaign`,
+`utmContent`, `utmTerm`). History changes are captured on the next task so a router's
+push/replace pair records once; hash-only changes are ignored.
+
+Call `page(properties?, options?)` for explicit page views. Disable automatic capture with
+`autocapture: { pageViews: false, sessions: false, pageLeave: false }`. `autoStart: false` defers the initial
+page view and History patch until `start()`. `stop()` removes the patch; restarting on the
+same URL does not record another initial view.
+
+Each event collects locale, timezone, screen size, viewport size, user agent and library
+version. `options.context` can override these values. No IP address, fingerprint or precise
+location is collected by the SDK. URLs and caller-supplied properties may contain personal
+data: use `beforeSend` to redact them.
+
+The default `botDetection: "flag"` adds Boolean context.bot using a bounded synthetic v1
+matcher and preserves an existing true. `"drop"` reports bot drops through onDrop/statistics;
+`"off"` adds no client flag. Privacy gates run first. The server independently classifies its
+request user agent, so client off does not turn off server bot handling.
+
+See [one account across several properties](../../docs/guides/cross-origin-identity.md) for
+parent-domain cookies, open-tab reset/opt-out synchronization and explicit allowlisted linkTo
+handoff. Cross-site handoff acceptance is opt-in; it is not authentication.
+
+## Identity and experiments
+
+`identify(userId, traits?, options?)` persists the user ID and sends governed set traits with
+explicit schema version 2. `identifyOnce(userId, traits?, options?)` does the same with set-once
+version 1. Both preserve the anonymous ID for server stitching. Governed string traits are
+`plan`, `signup_source`, `initial_plan`, `country` and `role`; `company_size` is a finite,
+nonnegative integer. Omitted traits stay unchanged and null is rejected. Set-once initializes
+an unset value; a later set replaces it. An explicit `{ schemaVersion: 1 }` on identify retains
+identity-only behavior. Current traits can reclassify historical metrics and are public
+analytics observations, never access-control facts.
+`alias(previousId, newId, properties?)` links identities for one event and leaves the stored
+user unchanged. Its ID arguments override any same-named custom properties.
+`group(organizationId, properties?)` persists the organisation for later
+events. `setIdentifiers({ device, fingerprint, email_hmac, email_sha256, cookie })` replaces optional
+identity signals; provide only the keys needed. Values must contain 1–256 printable,
+non-space ASCII characters. The anonymous ID already supplies the implicit cookie signal.
+
+`reset()` clears user, organisation, signals and exposure history and rotates anonymous and
+session IDs. Events already queued retain their original attribution. Call it explicitly at logout.
+
+`experiment(name, variant, properties?, { force?: boolean })` records `experiment_viewed`
+when a variant is actually shown. Names match `^[a-z0-9_.:-]{1,128}$`. The same pair is sent
+once per session unless `force: true` is given; it can be recorded again after `reset()`.
+The SDK records exposure and does not assign variants or evaluate feature flags.
+
+`respectGlobalPrivacyControl: true` honors `navigator.globalPrivacyControl === true`.
+`respectDoNotTrack: true` honors the legacy DNT signal. Both default to false. These gates
+and opt-out silently skip automatic capture; explicit calls report `opted_out` drops.
+
+## Core API
+
+`track(name, properties?, options?)` queues an event with anonymous and session IDs.
+`flush()` waits for pending batches. `stats` reports queued, accepted, bestEffortQueued, rejected and dropped
+counts. `onDrop(info)` receives `bot`, `queue_full`, `rejected`, `permanent_error`,
+`retries_exhausted`, `before_send`, `opted_out` or `invalid` and the affected events.
+`beforeSend(event)` can redact fields or return `null` to drop an event.
+
+The client starts automatically. Pass `autoStart: false` to defer listeners and timers;
+call `start()` to activate them and `stop()` to remove them and begin a final flush.
+Both calls are idempotent and reversible. Framework integrations should pair them in their
+effect setup and cleanup. `shutdown()` stops, awaits the final flush and permanently closes
+the client. Explicit tracking while stopped still queues events.
+
+`optOut()` persists suppression and drops queued events; `optIn()` resumes acceptance.
+`getAnonymousId()`, `getUserId()` and `getSessionId()` expose current identity.
+Sessions renew after thirty minutes of inactivity by default.
+
+## Delivery and storage
+
+Normal deliveries use `POST /v1/batch` with the public write key in `X-Api-Key`.
+HTTP 202 ends delivery, including individual rejections, which are counted as drops.
+400, 401, 403, 404 and non-retryable 503 responses are permanent. Oversized batches (413)
+are split; an oversized single event is dropped. Unknown outcomes, transient 503 responses,
+network failures and timeouts retry with the same IDs and bounded exponential full jitter.
+A positive whole-second 429 Retry-After is a minimum delay. Every transmission stamps a
+serialization copy with sentAt from the same injected now clock; producer content and IDs stay fixed.
+
+Defaults: flush at 20 events or every five seconds, 100 events and 1 MiB per request,
+1000 queued events, five retries, ten-second request timeout. The newest event is dropped
+when the queue is full. `schemaVersions` supplies event-level pins; a call's
+`options.schemaVersion` takes precedence. Supported versions are integers in `1..65535`.
+
+Identity, session and opt-out state use localStorage by default. Choose `storage: "cookie"`,
+`"memory"` or a custom `{ get, set, remove }` adapter. Keys use `storageKeyPrefix` (`kansoku`):
+`.anonymous_id`, `.user_id`, `.organization_id`, `.identifiers`, `.session`, `.opt_out`.
+The `.queue` mirror always uses per-tab sessionStorage (`persistQueue: false` disables it).
+Blocked browser storage falls back to memory. No fingerprint is generated. Keyed email identifiers are opaque backend-produced values; never expose the HMAC pepper to browser code. The normalization and rotation contract is owned by `mori://shinzui/kansoku` (`docs/guides/send-events.md`; artifact-level URI pending).
+
+On page exit, `exitTransport: "keepalive"` is the default. Opt into `"beacon"` with a server
+containing `mori://shinzui/kansoku/plans/39-beacon-ingest-route-for-page-exit-delivery`.
+Beacon sends a text/plain UTF-8 `{writeKey,batch}` envelope at `/v1/beacon`. No query-string
+credential or auth header is used. A true return increments `bestEffortQueued` and retains
+every mirrored event; it never increments accepted or permits HTTP-status fallback. False,
+missing or throwing APIs try keepalive fetch if the shared allowance permits. A later normal
+acknowledged retry removes the same IDs using server deduplication.
+
+All client instances share a conservative 60 KiB allowance per document, measuring complete
+UTF-8 serialized bodies including sentAt and body credentials. Keepalive reservations release
+when fetch settles; beacon has no completion callback, so its reservation lasts for that
+document, including BFCache restoration. Oversized events remain queued for normal delivery.
+Visibilitychange followed by pagehide performs one exit attempt. Other scripts can still consume
+the browser's shared quota; both exit transports may fail. Pending events are bounded by queue
+capacity, remain in per-tab sessionStorage when enabled, and can be lost when the tab closes.
+
+The package imports safely without browser globals. Supported Node versions can use
+`require(esm)` (Node 20.19+, or 22.12+ on Node 22). Jest's default CommonJS mode needs an
+ESM transform allowlist or native ESM configuration.
+
+## TypeScript reference
+
+```typescript
+export interface KansokuOptions {
+  baseUrl: string
+  writeKey: string
+  sourceService?: string
+  autoStart?: boolean
+  flushAt?: number
+  flushIntervalMs?: number
+  maxQueueSize?: number
+  maxBatchEvents?: number
+  maxBatchBytes?: number
+  maxRetries?: number
+  retryBaseDelayMs?: number
+  requestTimeoutMs?: number
+  persistQueue?: boolean
+  storage?: "localStorage" | "cookie" | "memory" | StorageAdapter
+  storageKeyPrefix?: string
+  cookieDomain?: string
+  sessionTimeoutMs?: number
+  schemaVersions?: Record<string, number>
+  autocapture?: { pageViews?: boolean; sessions?: boolean }
+  optOut?: boolean
+  respectDoNotTrack?: boolean
+  respectGlobalPrivacyControl?: boolean
+  beforeSend?: (event: AnalyticsEvent) => AnalyticsEvent | null
+  onDrop?: (info: DropInfo) => void
+  fetch?: typeof globalThis.fetch
+  now?: () => number
+  timers?: { setTimeout: typeof setTimeout; clearTimeout: typeof clearTimeout }
+  debug?: boolean
+}
+
+export interface KansokuClient {
+  page(properties?: JsonObject, options?: TrackOptions): void
+  identify(userId: string, traits?: JsonObject, options?: TrackOptions): void
+  identifyOnce(userId: string, traits?: JsonObject, options?: TrackOptions): void
+  alias(previousId: string, newId: string, properties?: JsonObject): void
+  group(organizationId: string, properties?: JsonObject): void
+  experiment(
+    experiment: string,
+    variant: string,
+    properties?: JsonObject,
+    options?: ExperimentOptions,
+  ): void
+  setIdentifiers(identifiers: Partial<Record<IdentifierKind, string>>): void
+  reset(): void
+  track(eventName: string, properties?: JsonObject, options?: TrackOptions): void
+  flush(): Promise<void>
+  start(): void
+  stop(): void
+  shutdown(): Promise<void>
+  optOut(): void
+  optIn(): void
+  isOptedOut(): boolean
+  getAnonymousId(): string
+  getUserId(): string | undefined
+  getSessionId(): string
+  readonly stats: Readonly<KansokuStats>
+  readonly config: ResolvedKansokuOptions
+}
+export interface ExperimentOptions {
+  force?: boolean
+}
+```
+
+### Optional browser diagnostics
+
+`autocapture.clientErrors` and `autocapture.webVitals` are independent Boolean options, both
+`false` by default. Set either to `true` to capture sanitized uncaught errors or document-scoped
+performance measurements through the usual queue and `beforeSend`. Errors are bounded to ten
+per recorded view and thirty per minute. Vitals load a separate measurement file on demand;
+FCP/TTFB report immediately and LCP/CLS/INP finalize once on exit. They describe the first page
+view of a document or BFCache restore, not later SPA routes. Reset/opt-out retire pending
+attribution. Both event types count as server engagement and can change bounce and duration
+reports. Read the [delivery and privacy guide](../../docs/guides/delivery-and-privacy.md#optional-client-errors-and-web-vitals)
+for sanitization, units, exclusions, lifecycle and privacy details. The vanilla example's
+`?capture=1` switch enables both and exposes a **Throw error** button.

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,206 @@
+web-vitals 6.2.3
+Copyright 2020 Google LLC
+https://github.com/GoogleChrome/web-vitals
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Google LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/attribution.d.ts

@@ -0,0 +1,5 @@
+import type { WebFields } from "./envelope.js";
+export declare function readAttribution(loc: {
+    href: string;
+    search: string;
+}, referrer: string): WebFields;

package/dist/bot.d.ts

@@ -0,0 +1 @@
+export declare function isBot(userAgent: string): boolean;

package/dist/client.d.ts

@@ -0,0 +1,63 @@
+import type { AnalyticsEvent, JsonObject } from "./contract/wire.js";
+import type { WebFields } from "./envelope.js";
+import type { DropReason, KansokuClient, KansokuOptions, ResolvedKansokuOptions, TrackOptions } from "./types.js";
+export declare function resolveOptions(options: KansokuOptions): ResolvedKansokuOptions;
+export declare function createInternalClient(options: KansokuOptions, deferStart?: boolean): {
+    config: Readonly<Required<Omit<KansokuOptions, "beforeSend" | "cookieDomain" | "onDrop">> & Pick<KansokuOptions, "beforeSend" | "cookieDomain" | "onDrop">>;
+    readonly stats: Readonly<{
+        accepted: number;
+        bestEffortQueued: number;
+        rejected: number;
+        dropped: number;
+        queued: number;
+    }>;
+    track(name: string, properties?: JsonObject, trackOptions?: TrackOptions): void;
+    flush: () => Promise<void>;
+    start(): void;
+    stop(): void;
+    shutdown(): Promise<void>;
+    optOut(): void;
+    optIn(): void;
+    isOptedOut: () => boolean;
+    getAnonymousId: () => string;
+    getUserId: () => string | undefined;
+    getSessionId: () => string;
+    buildEvent: (name: string, properties?: JsonObject, trackOptions?: TrackOptions, webFields?: WebFields, ids?: {
+        anonymousId?: string;
+        userId?: string;
+    }) => AnalyticsEvent;
+    enqueueBuilt: (event: AnalyticsEvent, save?: boolean) => boolean;
+    enqueueMany(events: AnalyticsEvent[]): void;
+    registerContextProvider(provider: () => JsonObject): () => void;
+    onStart: (install: () => (() => void) | void) => void;
+    onExit(listener: () => void): () => void;
+    drop: (reason: DropReason, events: AnalyticsEvent[], detail?: string) => void;
+    isSuppressed: () => boolean;
+    isStarted: () => boolean;
+    setSuppression(check: () => boolean): void;
+    identity: {
+        hadPersistedIdentity: boolean;
+        adoptAnonymousId(value: string): void;
+        snapshot(): import("./envelope.js").IdentitySnapshot;
+        setUserId(value: string): void;
+        setOrganizationId(value: string): void;
+        setIdentifiers(value: Partial<Record<import("./types.js").IdentifierKind, string>>): void;
+        rotateAnonymousId(): string;
+        clearUser(): void;
+    };
+    session: {
+        current(nowMs: number): {
+            id: string;
+            started: boolean;
+        };
+        touch(nowMs: number): void;
+        rotate: (nowMs: number) => {
+            id: string;
+            started: boolean;
+        };
+    };
+    storage: import("./types.js").StorageAdapter;
+    rotateSession(): void;
+};
+export type InternalClient = ReturnType<typeof createInternalClient>;
+export declare function createKansoku(options: KansokuOptions): KansokuClient;

package/dist/context.d.ts

@@ -0,0 +1,4 @@
+import type { JsonObject } from "./contract/wire.js";
+export declare function collectContext(version: string): JsonObject;
+export declare function isDoNotTrackEnabled(): boolean;
+export declare function isGlobalPrivacyControlEnabled(): boolean;

package/dist/contract/events.d.ts

@@ -0,0 +1,12 @@
+export declare const PAGE_VIEW = "page_view";
+export declare const SESSION_START = "session_start";
+export declare const EXPERIMENT_VIEWED = "experiment_viewed";
+export declare const IDENTIFY = "identify";
+export declare const IDENTIFY_ONCE = "identify_once";
+export declare const ALIAS = "alias";
+export declare const GROUP = "group";
+export declare const BUILT_IN_SCHEMA_VERSIONS: Readonly<Record<string, number>>;
+export { IDENTIFIER_KINDS } from "../generated/identifier-kinds.js";
+export declare const MIN_SCHEMA_VERSION = 1;
+export declare const MAX_SCHEMA_VERSION = 65535;
+export declare const EXPERIMENT_NAME_PATTERN: RegExp;

package/dist/contract/validate.d.ts

@@ -0,0 +1,6 @@
+import type { AnalyticsEvent } from "./wire.js";
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
+export declare function validateIdentifiers(value: unknown): string[];
+export declare function validateExperimentName(value: unknown): boolean;
+export declare function validateEvent(event: AnalyticsEvent): string[];
+export declare function validateGovernedTraits(event: Pick<AnalyticsEvent, "eventName" | "schemaVersion" | "userId" | "properties">): string[];

package/dist/contract/wire.d.ts

@@ -0,0 +1,18 @@
+import type { components } from "../generated/schema.js";
+export type JsonValue = string | number | boolean | null | JsonObject | JsonValue[];
+export interface JsonObject {
+    [key: string]: JsonValue;
+}
+export type { paths } from "../generated/schema.js";
+export type AnalyticsEvent = components["schemas"]["AnalyticsEvent"];
+export type BeaconEnvelope = components["schemas"]["BeaconEnvelope"];
+export type BatchAck = components["schemas"]["BatchAck"];
+export type RejectedEvent = components["schemas"]["RejectedEvent"];
+export type ProblemDetails = components["schemas"]["ProblemDetails"];
+export type SchemaCatalog = components["schemas"]["SchemaCatalog"];
+export type EventVersions = components["schemas"]["EventVersions"];
+export type VersionedEventSchema = components["schemas"]["VersionedEventSchema"];
+export type ContractProperty = components["schemas"]["ContractProperty"];
+export type EventSource = components["schemas"]["EventSource"];
+export type IngestAck = components["schemas"]["IngestAck"];
+export type MetricPoint = components["schemas"]["MetricPoint"];

package/dist/envelope.d.ts

@@ -0,0 +1,24 @@
+import type { AnalyticsEvent, JsonObject } from "./contract/wire.js";
+import type { IdentifierKind, TrackOptions } from "./types.js";
+export interface IdentitySnapshot {
+    anonymousId: string;
+    userId?: string;
+    organizationId?: string;
+    identifiers?: Partial<Record<IdentifierKind, string>>;
+}
+export type WebFields = Pick<AnalyticsEvent, "url" | "referrer" | "utmSource" | "utmMedium" | "utmCampaign" | "utmContent" | "utmTerm">;
+export interface EnvelopeDependencies {
+    identity: IdentitySnapshot;
+    sessionId: string;
+    config: {
+        sourceService?: string;
+        schemaVersions: Readonly<Record<string, number>>;
+        now: () => number;
+    };
+    baseContext?: JsonObject;
+}
+export declare function randomId(): string;
+export declare function buildEvent(deps: EnvelopeDependencies, eventName: string, properties?: JsonObject, options?: TrackOptions, webFields?: WebFields, ids?: {
+    anonymousId?: string;
+    userId?: string;
+}): AnalyticsEvent;

package/dist/errors.d.ts

@@ -0,0 +1,4 @@
+import type { InternalClient } from "./client.js";
+import type { AnalyticsEvent, JsonObject } from "./types.js";
+export declare function errorProperties(value: unknown, rejection?: boolean, crossOrigin?: boolean): JsonObject;
+export declare function createErrorCapture(core: InternalClient, snapshot: () => AnalyticsEvent | undefined, copy: (original: AnalyticsEvent, name: string, properties: JsonObject) => AnalyticsEvent): () => void;

package/dist/experiment.d.ts

@@ -0,0 +1,3 @@
+import type { InternalClient } from "./client.js";
+import type { ExperimentOptions, JsonObject } from "./types.js";
+export declare function recordExposure(client: InternalClient, experiment: string, variant: string, properties?: JsonObject, options?: ExperimentOptions): void;

package/dist/generated/identifier-kinds.d.ts

@@ -0,0 +1 @@
+export declare const IDENTIFIER_KINDS: readonly ["cookie", "device", "fingerprint", "email_sha256", "email_hmac"];