@findsignal/recorder 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2026 John Fazio
+
+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,30 @@
-# Temporary Holding Version
+# @findsignal/recorder
 
-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.
+Signal's session recorder for your app. It records how people use it (page views, clicks, rage and dead clicks, errors, web vitals, network timing, the shape of what people type and the validation messages they see, a sample of the page's sizes and colours (never its text), and a replay of each session), masked by default, and sends it to Signal so Signal can find what's going wrong. (Signal is the new name of Aura, so the setup command is still `npx getaura` and the dashboard still says Aura for now.) It is built on [posthog-js](https://github.com/PostHog/posthog-js), pinned to one exact version.
+
+**Nothing is recorded or sent, not even a request, until each person using your app agrees.** Call `optIn()` from your consent banner, when the person says yes.
+The recorder then marks that yes in the replay (`aura_opt_in`, with a kind and a time only), so Signal can tell which trackers ran before it.
+When your consent tool passes on a yes the person gave on an earlier visit (Cookiebot and OneTrust do, on every page), call `optIn({ earlier: true })` instead, so it isn't taken for a new one.
+
+Easiest: run `npx getaura` in your repo and it adds the recorder for you. By hand, with a bundler:
+
+```sh
+npm install @findsignal/recorder
+```
+
+```ts
+import { init, optIn } from '@findsignal/recorder';
+
+init({ key: 'arp_…' }); // your project's recorder key, from Settings in your dashboard
+optIn(); // when the person agrees to be recorded
+```
+
+Without a bundler, add the script tag to your layout:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@findsignal/recorder@0.1/dist/signal-recorder.js" data-key="arp_…"></script>
+```
+
+Every option, what is masked and kept, and how to send through your own domain: [the recorder's docs](https://github.com/Aura-Factory/aura/blob/main/docs/how-it-works/recorder.md).
+
+MIT. posthog-js's own license (Apache-2.0 and MIT) is in `THIRD-PARTY-NOTICES.md`.

package/THIRD-PARTY-NOTICES.md

@@ -0,0 +1,429 @@
+# Third-party notices
+
+`@findsignal/recorder` depends on posthog-js, and its script-tag build (`dist/signal-recorder.js`) bundles posthog-js code. posthog-js keeps its own license, reproduced here in full as it requires.
+
+## posthog-js 1.438.7
+
+https://github.com/PostHog/posthog-js
+
+License: Apache-2.0 AND MIT (its package.json). Its LICENSE file follows, including the MIT notices for the code it carries from others.
+
+```
+Copyright 2020 Posthog / Hiberly, Inc.
+
+Copyright 2015 Mixpanel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License below, or at:
+
+   http://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.
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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
+
+       http://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.
+
+
+---
+
+The @posthog/core package in packages/core is licensed under the MIT License below.
+Third-party code remains subject to its respective notices in this file.
+This owning notice is preserved from posthog-js-lite, from which @posthog/core was migrated:
+https://github.com/PostHog/posthog-js-lite/blob/5fb7bee96f739b243dfea5589e2027f16629e8cd/LICENSE
+
+MIT License
+
+Copyright (c) 2022 PostHog (part of Hiberly Inc)
+
+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.
+
+---
+
+packages/core/src/error-tracking/parsers/index.ts and its compiled distributions contain code
+derived from TraceKit. This license only applies to the relevant code.
+
+MIT License
+
+Copyright (c) 2013 Onur Can Cakmak onur.cakmak@gmail.com and all TraceKit contributors.
+
+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.
+
+---
+
+packages/core/src/vendor/uuidv7.ts and its compiled distributions contain code from uuidv7:
+https://github.com/LiosK/uuidv7/blob/f30b7a7faff73afbce0b27a46c638310f96912ba/src/index.ts
+
+Copyright 2021-2023 LiosK
+
+This code is licensed under the Apache License, Version 2.0, reproduced above.
+
+---
+
+Some files in this codebase contain code from getsentry/sentry-javascript.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+MIT License
+
+Copyright (c) 2012 Functional Software, Inc. dba Sentry
+
+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.
+
+---
+
+Some files in this codebase contain code from getsentry/sentry-react-native.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Sentry
+
+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.
+
+---
+
+Some files in this codebase contain code from facebook/metro by Meta Platforms, Inc. and affiliates.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases. 
+
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+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.
+
+---
+
+Some files in this codebase contain code from expo/expo by 650 Industries, Inc. (aka Expo).
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases. 
+
+The MIT License (MIT)
+
+Copyright (c) 2015-present 650 Industries, Inc. (aka Expo)
+
+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.
+
+---
+
+Some files in this codebase contain code from agentcathq/agentcat-typescript-sdk (formerly MCPCat/mcpcat-typescript-sdk).
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+MIT License
+
+Copyright (c) 2025 AgentCat, Inc. (formerly MCPcat)
+
+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/dist/backoff.d.ts

@@ -0,0 +1,19 @@
+/** The first pause after a 429, doubling up to the longest. */
+export declare const FIRST_PAUSE_MS: number;
+export declare const LONGEST_PAUSE_MS: number;
+/** The pause after a 413. */
+export declare const TOO_LARGE_PAUSE_MS: number;
+/** What backing off needs from posthog-js. */
+export interface Pausable {
+    has_opted_out_capturing(): boolean;
+    stopSessionRecording?(): void;
+    startSessionRecording?(): void;
+}
+export interface Backoff {
+    /** Whether events should be held back now. */
+    paused(): boolean;
+    /** An answer Aura gave to a batch (posthog-js's `on_request_error`). Anything but 413 and 429 is ignored. */
+    noticed(statusCode: number | undefined): void;
+}
+/** A back-off for this posthog-js instance. `now` and `later` are for tests. */
+export declare function backoff(instance: () => Pausable | null, now?: () => number, later?: (fn: () => void, ms: number) => unknown): Backoff;

package/dist/config.d.ts

@@ -0,0 +1,57 @@
+import type { PostHogConfig } from 'posthog-js/dist/module.full.no-external';
+import { IGNORE_INPUT_CLASS, MASK_CLASS, type MergedRecordingSettings, NO_CAPTURE_CLASS, type PageRecordingSettings, PRIVATE_ATTRIBUTE } from './settings';
+export { IGNORE_INPUT_CLASS, MASK_CLASS, NO_CAPTURE_CLASS, PRIVATE_ATTRIBUTE };
+/** Signal's API, where the recorder sends what it records. */
+export declare const DEFAULT_HOST = "https://api.findsignal.io";
+/** The API's first address, still served: a page that names it as its host is going straight to Signal, not through a proxy. */
+export declare const FIRST_HOST = "https://aura-liart-mu.vercel.app";
+/** The path on Aura's API that speaks PostHog's capture protocol. */
+export declare const INGEST_PATH = "/v1/ingest";
+/** The first-party proxy setup adds on the team's own domain: `/_aura/v1/ingest/*` forwards to Aura's ingest. */
+export declare const PROXY_PATH = "/_aura";
+/** Sessions shorter than this aren't sent (and the ingest drops any that are). */
+export declare const MIN_SESSION_MS = 5000;
+export type Consent = 'granted' | 'pending';
+/**
+ * The page's own recording settings (masking, maskAllText, maskSelectors, blockSelectors, neverRecord, sampleRate) are merged with
+ * the project's from Aura's dashboard, and can only make them stricter (src/settings.ts).
+ */
+export interface RecorderOptions extends PageRecordingSettings {
+    /** The project's recorder key from Aura (it starts with `arp_`). It's public, like an analytics key. */
+    key: string;
+    /**
+     * Aura's API (the default), or a proxy on your own domain that forwards `/v1/ingest/*` to it: `'/_aura'` (a path on
+     * the page's own site) or a full address. If the proxy answers 404, the recorder goes straight to Aura for the visit.
+     */
+    host?: string;
+    /** Your app's release (a version or commit), so each session says which release it saw. */
+    release?: string;
+    /**
+     * Whether the visitor already agreed to be recorded. Until they do (the default), posthog-js isn't started: nothing is
+     * recorded, stored or sent, not even a request. Their answer from an earlier visit counts too (`optIn`, `optOut`).
+     */
+    consent?: Consent;
+}
+/** A path on the page's own site, like `/_aura` (not `//cdn.example`, which is another site). */
+export declare const isRelativeHost: (host: string | undefined) => boolean;
+/**
+ * Where requests go: `host` without a trailing slash, plus the ingest path unless the host already ends in it. A
+ * relative host (`/_aura`) is resolved against the page's origin, so posthog-js always gets a full address.
+ */
+export declare function ingestHost(host: string | undefined, origin?: string): string;
+/** Aura's own ingest, where the recorder goes when there's no proxy, or when the proxy isn't there. */
+export declare const DIRECT_INGEST: string;
+/** Whether `host` is a proxy rather than Aura's own address. */
+export declare const isProxy: (host: string | undefined, origin?: string) => boolean;
+/** The page's origin (`https://shop.example.com`), or undefined when its address can't be read. */
+export declare function originOf(href: string | undefined): string | undefined;
+/** PostHog adds a trailing slash to its paths (`/e/`); Aura's routes have none, so a browser never follows a redirect. */
+export declare function withoutTrailingSlash(url: URL): URL;
+/**
+ * The posthog-js settings for these options. `location` is the page's, read at send time. `settings` is what the
+ * recorder runs with now: the page's own until the project's arrive with the remote config, then both merged.
+ */
+export declare function auraConfig(options: RecorderOptions, location?: () => {
+    href: string;
+    hostname: string;
+} | undefined, settings?: () => MergedRecordingSettings, paused?: () => boolean): Partial<PostHogConfig>;

package/dist/consent.d.ts

@@ -0,0 +1,23 @@
+/** Where the answer is kept, in local storage. */
+export declare const CONSENT_KEY = "aura_recorder_consent";
+export type Answer = 'granted' | 'denied';
+type Storage = Pick<globalThis.Storage, 'getItem' | 'setItem'>;
+/** The visitor's remembered answer, or null when they haven't answered (or storage is blocked). */
+export declare function rememberedAnswer(storage?: Storage | null): Answer | null;
+/** The replay event's tag. */
+export declare const OPT_IN_TAG = "aura_opt_in";
+/**
+ * `explicit`: the person said yes on this page view (`optIn()`, when no yes was remembered). `stored`: a yes remembered
+ * from an earlier visit, one the page's consent tool passes on from an earlier visit (`optIn({ earlier: true })`), or one
+ * the page said as it loaded (`consent: 'granted'`, `data-consent="granted"`).
+ */
+export declare const OPT_IN_KINDS: readonly ['explicit', 'stored'];
+export type OptInKind = (typeof OPT_IN_KINDS)[number];
+/** The mark's payload: its kind, and when the yes was given, in milliseconds since 1970. */
+export interface OptInMark {
+    kind: OptInKind;
+    at: number;
+}
+/** Remembers the visitor's answer. In a private window or with blocked storage, it lasts the page. */
+export declare function rememberAnswer(answer: Answer, storage?: Storage | null): void;
+export {};

package/dist/events.d.ts

@@ -0,0 +1,36 @@
+/** An event's name: letters, digits, `_`, `.` and `-`, up to 64 characters, like `upgrade_payment_failed`. */
+export declare const EVENT_NAME: RegExp;
+/** A property's name: the same, starting with a letter. */
+export declare const PROPERTY_NAME: RegExp;
+/** The most properties one event may carry. */
+export declare const PROPERTIES_MOST = 20;
+/** The longest string a property may hold. */
+export declare const PROPERTY_TEXT_MAX = 200;
+/** A plan's name, like `pro` or `team-annual`. */
+export declare const PLAN_NAME: RegExp;
+/** The super property the plan goes in, which detection splits by. */
+export declare const PLAN_PROPERTY = "aura_plan";
+/**
+ * A property name that could hold a secret or something about the person: dropped. It's the ingest's list
+ * (SENSITIVE_PROPERTY in @getaura/shared, which a test holds this to) plus `name`, since an app's own event is the one
+ * place a person's name could be passed in on purpose.
+ */
+export declare const SENSITIVE_KEY: RegExp;
+/**
+ * Something shaped like a secret: a known key prefix, a JWT, a private key, an address with a password in it, or a
+ * long run of random-looking letters and digits. The ingest masks secrets again with Aura's full list.
+ */
+export declare function looksLikeSecret(value: string): boolean;
+export type PropertyValue = string | number | boolean | null;
+export type EventProperties = Record<string, PropertyValue>;
+export interface CheckedEvent {
+    /** What may be sent, or null when the event is refused. */
+    event: string | null;
+    properties: EventProperties;
+    /** Why the event, or each property left out, was refused: shown to the builder as a warning. */
+    problems: string[];
+}
+/** An event's name and properties, with everything unsafe left out and the reason for each. */
+export declare function checkEvent(event: unknown, properties?: unknown): CheckedEvent;
+/** Why a plan name can't be used, or null when it can. */
+export declare function planProblem(plan: unknown): string | null;

package/dist/field-facts.d.ts

@@ -0,0 +1,30 @@
+import { type MergedRecordingSettings } from './settings';
+export declare const VALUE_SHAPE_EVENT = "aura_value_shape";
+export declare const VALIDATION_EVENT = "aura_validation";
+/** The same lists and rules as `valueShape` in @getaura/shared (the tests hold them together). */
+export declare const VALUE_LENGTH_MOST = 1000;
+/** A value's shape as the recorder sends it: `kind:length:marks`, like `email:17:plus`. */
+export declare function valueShape(value: string): string;
+/** The most events of each kind one page view sends. */
+export declare const FIELD_EVENTS_MOST = 50;
+type Field = HTMLInputElement | HTMLTextAreaElement;
+/** A field people type into: a text-like input or a text box. */
+export declare function typedField(el: unknown): el is Field;
+/** An element's part of the chain, as autocapture writes it: `input.wide:attr__id="email"`. Tag, id and first class only. */
+export declare function part(el: Element): string;
+/** A field's chain: itself, then its form. */
+export declare function fieldChain(el: Element): string;
+export type Send = (event: string, properties: Record<string, string>) => void;
+/** The `aura_value_shape` event's properties for a field the person left, or null when it gets none. */
+export declare function shapeProperties(el: unknown, settings: MergedRecordingSettings): Record<string, string> | null;
+/**
+ * The `aura_validation` event's properties, or null for a field that gets none. `message` is the element whose words
+ * are the message, if any. With the shape of the field's value as the message appeared, so what it judged is known.
+ */
+export declare function validationProperties(el: unknown, via: 'aria-invalid' | 'alert' | 'invalid', message: Element | null, settings: MergedRecordingSettings): Record<string, string> | null;
+/**
+ * Watches the page's fields and sends the two events with `send`. Returns how to stop. Started once posthog-js runs
+ * (after consent); `settings` is read at each event, so the project's level applies as soon as it arrives.
+ */
+export declare function watchFields(doc: Document, send: Send, settings: () => MergedRecordingSettings): () => void;
+export {};