Init package

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+package-lock.json
+/pnpm-lock.yaml

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+#### v0.1.0 - 2024-06-26
+
+- Create package

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Makefile

@@ -0,0 +1,8 @@
+install:
+	pnpm install
+
+build:
+	pnpm run build
+
+publish:
+	npm publish --access public

README.md

@@ -0,0 +1,127 @@
+<div align="center">
+  <a href="https://bemi.io">
+    <img width="1201" alt="bemi-banner" src="https://docs.bemi.io/img/bemi-banner.png">
+  </a>
+
+  <p align="center">
+    <a href="https://bemi.io">Website</a>
+    ·
+    <a href="https://docs.bemi.io">Docs</a>
+    ·
+    <a href="https://github.com/BemiHQ/bemi-supabase-js-example">Example</a>
+    ·
+    <a href="https://github.com/BemiHQ/bemi-supabase-js/issues/new">Report Bug</a>
+    ·
+    <a href="https://github.com/BemiHQ/bemi-supabase-js/issues/new">Request Feature</a>
+    ·
+    <a href="https://discord.gg/mXeZ6w2tGf">Discord</a>
+    ·
+    <a href="https://x.com/BemiHQ">X</a>
+    ·
+    <a href="https://www.linkedin.com/company/bemihq/about">LinkedIn</a>
+  </p>
+</div>
+
+# Bemi Supabase JS
+
+[Bemi](https://bemi.io) plugs into [Supabase JS](https://github.com/supabase/supabase-js) to automatically track data changes in a PostgreSQL database. It unlocks robust context-aware audit trails and time travel querying inside your application.
+
+Designed with simplicity and non-invasiveness in mind, Bemi doesn't require any alterations to your existing database structure. It operates in the background, empowering you with data change tracking features.
+
+This library is an optional Supabase JS integration, enabling you to pass application-specific context when performing database changes. This can include context such as the 'where' (API endpoint, worker, etc.), 'who' (user, cron job, etc.), and 'how' behind a change, thereby enriching the information captured by Bemi.
+
+## Contents
+
+- [Highlights](#highlights)
+- [Use cases](#use-cases)
+- [Quickstart](#quickstart)
+- [Architecture overview](#architecture-overview)
+- [License](#license)
+
+## Highlights
+
+- Automatic and secure database change tracking with application-specific context in a structured form
+- 100% reliability in capturing data changes, even if executed through direct SQL outside the application
+- High performance without affecting code runtime execution and database workload
+- Easy-to-use without changing table structures and rewriting the code
+- Time travel querying and ability to easily group and filter changes
+- Scalability with an automatically provisioned cloud infrastructure
+- Full ownership of your data
+
+See [an example repo](https://github.com/BemiHQ/bemi-supabase-js-example) for Supabase JS that automatically tracks all changes.
+
+## Use cases
+
+There's a wide range of use cases that Bemi is built for! The tech was initially built as a compliance engineering system for fintech that supported $15B worth of assets under management, but has since been extracted into a general-purpose utility. Some use cases include:
+
+- **Audit Trails:** Use logs for compliance purposes or surface them to customer support and external customers.
+- **Change Reversion:** Revert changes made by a user or rollback all data changes within an API request.
+- **Time Travel:** Retrieve historical data without implementing event sourcing.
+- **Troubleshooting:** Identify the root cause of application issues.
+- **Distributed Tracing:** Track changes across distributed systems.
+- **Testing:** Rollback or roll-forward to different application test states.
+- **Analyzing Trends:** Gain insights into historical trends and changes for informed decision-making.
+
+## Quickstart
+
+Install the NPM package
+
+```sh
+npm install @bemi-db/supabase-js
+```
+
+Set application context by calling `setContext` in your [Supabase Edge Function](https://supabase.com/docs/guides/functions):
+
+```ts
+import { setContext } from 'https://esm.sh/@bemi-db/supabase-js@0.1.0'
+import { createClient } from 'https://esm.sh/@supabase/supabase-js@2.43.5'
+
+Deno.serve(async (req) => {
+  const supabase = createClient(...)
+  const { method, url } = req
+  const endpoint = `/${url.split('/')[3]}`
+  const payload = method === 'POST' ? await req.json() : {}
+
+  // Customizable context
+  await setContext(supabase, { method, endpoint, payload })
+
+  // Your code that performs data changes
+})
+```
+
+Make database changes and make sure they're all stored in a table called `changes` in the destination DB
+
+```
+psql -h [HOSTNAME] -U [USERNAME] -d [DATABASE] -c 'SELECT "primary_key", "table", "operation", "before", "after", "context", "committed_at" FROM changes;'
+
+ primary_key | table | operation |                       before                      |                       after                        |                        context                                                                |      committed_at
+-------------+-------+-----------+---------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------------------------+------------------------
+ 26          | todo  | CREATE    | {}                                                | {"id": 26, "task": "Sleep", "isCompleted": false}  | {"method": "POST", "endpoint": "/todos", "payload": {"task": "Sleep", "isCompleted": false}   | 2023-12-11 17:09:09+00
+ 27          | todo  | CREATE    | {}                                                | {"id": 27, "task": "Eat", "isCompleted": false}    | {"method": "POST", "endpoint": "/todos", "payload": {"task": "Eat", "isCompleted": false}}    | 2023-12-11 17:09:11+00
+ 28          | todo  | CREATE    | {}                                                | {"id": 28, "task": "Repeat", "isCompleted": false} | {"method": "POST", "endpoint": "/todos", "payload": {"task": "Repeat", "isCompleted": false}} | 2023-12-11 17:09:13+00
+ 26          | todo  | UPDATE    | {"id": 26, "task": "Sleep", "isCompleted": false} | {"id": 26, "task": "Sleep", "isCompleted": true}   | {"method": "PUT", "endpoint": "/todos/26/complete", "payload": {}}                            | 2023-12-11 17:09:15+00
+ 27          | todo  | DELETE    | {"id": 27, "task": "Eat", "isCompleted": false}   | {}                                                 | {"method": "DELETE", "endpoint": "/todos/27", "payload": {}}                                  | 2023-12-11 17:09:18+00
+```
+
+Check out our [Supabase JS docs](https://docs.bemi.io/orms/supabase-js) for more details.
+
+## Architecture overview
+
+Bemi is designed to be lightweight and secure. It takes a practical approach to achieving the benefits of [event sourcing](https://martinfowler.com/eaaDev/EventSourcing.html) without requiring rearchitecting existing code, switching to highly specialized databases, or using unnecessary git-like abstractions on top of databases. We want your system to work the way it already does with your existing database to allow keeping things as simple as possible.
+
+Bemi plugs into both the database and application levels, ensuring 100% reliability and a comprehensive understanding of every change.
+
+On the database level, Bemi securely connects to PostgreSQL's [Write-Ahead Log](https://www.postgresql.org/docs/current/wal-intro.html) and implements [Change Data Capture](https://en.wikipedia.org/wiki/Change_data_capture). This allows tracking even the changes that get triggered via direct SQL.
+
+On the application level, this package automatically passes application context by using [Database Functions and RPC](https://supabase.com/docs/guides/database/functions) to the replication logs to enhance the low-level database changes. For example, information about a user who made a change, an API endpoint where the change was triggered, a worker name that automatically triggered database changes, etc.
+
+Bemi workers then stitch the low-level data with the application context and store this information in a structured easily queryable format, as depicted below:
+
+![bemi-architechture](https://docs.bemi.io/img/architecture.png)
+
+The cloud solution includes worker ingesters, queues for fault tolerance, and an automatically scalable cloud-hosted PostgreSQL. Bemi currently doesn't support a self hosted option, but [contact us](mailto:hi@bemi.io) if this is required.
+
+## License
+
+Distributed under the terms of the [LGPL-3.0 License](LICENSE).
+If you need to modify and distribute the code, please release it to contribute back to the open-source community.

package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@bemi-db/supabase-js",
+  "version": "0.1.0",
+  "description": "Automatic data change tracking for Supabase JS",
+  "main": "dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "bin": {
+    "bemi": "dist/cli.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/BemiHQ/bemi-supabase-js.git"
+  },
+  "author": "",
+  "license": "LGPL-3.0",
+  "bugs": {
+    "url": "https://github.com/BemiHQ/bemi-supabase-js/issues"
+  },
+  "homepage": "https://github.com/BemiHQ/bemi-supabase-js#readme",
+  "dependencies": {
+    "commander": "^12.1.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.14.8",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "jest --watch"
+  },
+  "registry-url": "https://registry.npmjs.org/",
+  "tsup": {
+    "entry": [
+      "src/index.ts",
+      "src/cli.ts"
+    ],
+    "format": [
+      "cjs",
+      "esm"
+    ],
+    "dts": true,
+    "splitting": false,
+    "sourcemap": true,
+    "clean": true
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}