Korbs/Zalvena
1
Fork 0
Code Issues Pull requests Activity

Strip down the entire project

Browse source
This commit is contained in:
Korbs 2025-02-18 20:19:12 -05:00
parent a0a02458b0
commit 7416341746
Signed by: Korbs
SSH key fingerprint: SHA256:Q0b0KraMldpAO9oKa+w+gcsXsOTykQ4UkAKn0ByGn5U
95 changed files with 647 additions and 43115 deletions
Download patch file Download diff file Expand all files Collapse all files

25
packages/web/CHANGELOG.md
View file

@ -1,3 +1,28 @@
# Zalvena
## 0.5.0
- Removed examples
- Removed Eslintrc file
- Removed package lock file
- Removed Engines from `packages.json`
- Removed `/.changeset/`
- Removed `/.github/`
- Removed `/.vscode/`
- Removed other packages: `["angular", "react", "browser"]`
- Removed `isInBrowserExtension` from `shared.ts`
- Removed `isInBrowserExtension` from `shared.ts`
- Updated license from MIT to MIT-NON-AI
- Updated the package `@types/node` from `v20.5.7` to `v22.13.4`
- Updated the package `prettier` from `v3.0.3` to `v3.5.1`
- Updated the package `tsup` from `v7.2.0` to `v8.3.6`
- Updated the package `turbo` from `v1.10.13` to `v2.4.2`
- Added SudoVanilla's Aptabase instance to `regions` list as `SV`
- Using Bun over NPM
You can view other changes by viewing the commit history.
___
# Officially from Aptabase
## 0.4.3
- Move browser locale and is debug reads from import to first event to better support SSR

26
packages/web/LICENSE
View file

@ -1,21 +1,15 @@
MIT License
Copyright (c) 2023 Sumbit Labs Ltd.
Copyright 2025 SudoVanilla
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:
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.
In addition, the following restrictions apply:
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.
1. The Software and any modifications made to it may not be used for the purpose of training or improving machine learning algorithms, including but not limited to artificial intelligence, natural language processing, or data mining. This condition applies to any derivatives, modifications, or updates based on the Software code. Any usage of the Software in an AI-training dataset is considered a breach of this License.
2. The Software may not be included in any dataset used for training or improving machine learning algorithms, including but not limited to artificial intelligence, natural language processing, or data mining.
3. Any person or organization found to be in violation of these restrictions will be subject to legal action and may be held liable for any damages resulting from such use.
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.

52
packages/web/README.md
View file

@ -1,52 +0,0 @@
![Aptabase](https://aptabase.com/og.png)
# Aptabase SDK for Web Apps
A tiny SDK (1 kB) to instrument your web app with Aptabase, an Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps.
Building a React app? Use the `@aptabase/react` package instead.
> 👉 **IMPORTANT**
>
> This SDK is for **Web Applications**, not websites. There's a subtle, but important difference. A web app is often a lot more interactive and does not cause a full page reload when the user interacts with it. It's often called a **Single-Page Application**. A website, on the other hand, is a lot more content-focused like marketing sites, landing pages, blogs, etc. While you can certainly use Aptabase to track events on websites, please be aware that each page reload will be considered a new session.
## Install
Install the SDK using npm or your preferred JavaScript package manager
```bash
npm add @aptabase/web
```
## Usage
First you need to get your `App Key` from Aptabase, you can find it in the `Instructions` menu on the left side menu.
Initialize the SDK using your `App Key`:
```js
import { init } from '@aptabase/web';
init('<YOUR_APP_KEY>'); // 👈 this is where you enter your App Key
```
The init function also supports an optional second parameter, which is an object with the `appVersion` property.
It's up to you to decide how to get the version of your app, but it's generally recommended to use your bundler (like Webpack, Vite, Rollup, etc.) to inject the values at build time. Alternatively you can also pass it in manually.
Afterwards you can start tracking events with `trackEvent`:
```js
import { trackEvent } from '@aptabase/web';
trackEvent('connect_click'); // An event with no properties
trackEvent('play_music', { name: 'Here comes the sun' }); // An event with a custom property
```
A few important notes:
1. The SDK will automatically enhance the event with some useful information, like the OS and other properties.
2. You're in control of what gets sent to Aptabase. This SDK does not automatically track any events, you need to call `trackEvent` manually.
- Because of this, it's generally recommended to at least track an event at startup
3. You do not need to await the `trackEvent` function, it'll run in the background.
4. Only strings and numeric values are allowed on custom properties

15
packages/web/package.json
View file

@ -1,8 +1,8 @@
{
"name": "@aptabase/web",
"version": "0.4.3",
"name": "@sudovanilla/zalvena",
"version": "1.0.0",
"type": "module",
"description": "JavaScript SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps",
"description": "JavaScript SDK for Aptabase",
"main": "./dist/index.cjs",
"module": "./dist/index.js",
"types": "./dist/index.d.ts",
@ -15,20 +15,19 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/aptabase/aptabase-js.git",
"url": "git+https://ark.sudovanilla.org/korbs/zalvena",
"directory": "packages/web"
},
"bugs": {
"url": "https://github.com/aptabase/aptabase-js/issues"
"url": "https://ark.sudovanilla.org/korbs/zalvena/issues"
},
"homepage": "https://github.com/aptabase/aptabase-js",
"homepage": "https://ark.sudovanilla.org/korbs/zalvena",
"license": "MIT",
"scripts": {
"build": "tsup",
"prepublishOnly": "npm run build"
"prepublishOnly": "bun run build"
},
"files": [
"README.md",
"LICENSE",
"dist",
"package.json"

2
packages/web/tsconfig.json
View file

@ -1,6 +1,6 @@
{
"compilerOptions": {
"target": "es2020",
"target": "es2022",
"strict": true,
"moduleResolution": "node",
"esModuleInterop": true,