@databob/sdk 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

package/README.md

@@ -1,3 +1,159 @@
-# Temporary Holding Version
+# @databob/sdk
 
-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.
+Privacy-first product analytics you define in code. Write your events and metrics in TypeScript, track from your server, and show each of your customers their own numbers, live.
+
+```sh
+npm install @databob/sdk
+npx databob dev
+```
+
+`databob dev` creates `databob/schema.ts` and `databob/metrics.ts` if they are missing, starts a local API on `http://127.0.0.1:4100`, writes `DATABOB_URL` and `DATABOB_SECRET_KEY` to `.env.local`, and regenerates types whenever you save.
+
+## 1. Define events
+
+```ts
+// databob/schema.ts
+import { defineSchema, event, v } from "@databob/sdk";
+
+export default defineSchema({
+  tenants: true, // each event belongs to one of your customers
+  events: {
+    pageview: event({ path: v.string() }),
+    signup: event({ plan: v.enum(["free", "pro"]) }),
+    purchase: event({ amount: v.number({ min: 0 }), plan: v.enum(["free", "pro"]) }),
+  },
+});
+```
+
+Validators: `v.string({ max })`, `v.number({ integer, min, max })`, `v.boolean()`, `v.enum([...])`, `v.optional(...)`, and `v.range()` for metric arguments.
+
+## 2. Define metrics
+
+```ts
+// databob/metrics.ts
+import { v } from "@databob/sdk";
+import { metric } from "./_generated/server";
+
+export const topPages = metric({
+  args: { range: v.optional(v.range()) },
+  query: (q, { range }) => q.events("pageview").range(range ?? "7d").by("path").count("views").limit(10),
+});
+
+export const revenue = metric({
+  query: (q) => q.events("purchase").range("30d").by("$day").sum("amount", "revenue"),
+});
+
+export const activation = metric({
+  query: (q) => q.funnel("signup", "purchase").within("7d").range("30d"),
+});
+```
+
+The builder is typed from your schema. A misspelled event, a property that does not exist, or `sum()` on a string fails to compile.
+
+| Builder | Meaning |
+| --- | --- |
+| `q.events(...names)` | Some events, or all of them with no names |
+| `.where(field, value)` / `.where(field, op, value)` | `eq neq gt gte lt lte in contains`. A filter on an optional argument that was not passed is skipped |
+| `.range("24h" \| "7d" \| "12mo" \| "today" \| "yesterday" \| { from, to })` | Defaults to 30 days |
+| `.by(...dimensions)` | Properties, `$event`, or one of `$hour $day $week $month` (in the caller's time zone, empty buckets filled with 0) |
+| `.count() .users() .sum(f) .avg(f) .min(f) .max(f)` | Each takes an optional output name |
+| `.orderBy(key, dir)` `.limit(n)` | |
+| `q.funnel(...steps).within("7d")` | Ordered steps per identified user |
+
+A metric definition runs once, with placeholders for its arguments, and becomes a JSON query. The server compiles that JSON to SQL with bound values. Your code never runs on the server, and a browser can never send SQL.
+
+## 3. Track from your server
+
+```ts
+import { Databob } from "@databob/sdk/server";
+import type { Schema } from "./databob/_generated/server";
+
+const databob = new Databob<Schema>(); // reads DATABOB_URL and DATABOB_SECRET_KEY
+
+await databob.track("purchase", { amount: 49, plan: "pro" }, { tenant: org.id, user: user.id, key: order.id });
+```
+
+- `user` is stored as a keyed hash, never as the id. `databob.deleteUser(id)` erases that user from every tenant.
+- `key` makes retries safe: the same key is stored once.
+- Outside production a refused event throws, so you see mistakes while you build. In production it logs a warning and never breaks your request. Set `strict` to choose.
+
+## 4. Show your customers their numbers
+
+Mint a short-lived token on your server. It can read one tenant's metrics and nothing else.
+
+```ts
+const { token } = await databob.createToken({ tenant: org.id, metrics: [api.topPages] });
+```
+
+```tsx
+"use client";
+import { DatabobProvider, useMetric } from "@databob/sdk/react";
+import { api } from "@/databob/_generated/api";
+
+export function Analytics({ token }: { token: string }) {
+  return (
+    <DatabobProvider url={process.env.NEXT_PUBLIC_DATABOB_URL} token={token}>
+      <TopPages />
+    </DatabobProvider>
+  );
+}
+
+function TopPages() {
+  const { data, isLoading } = useMetric(api.topPages, { range: "7d" }, { live: true });
+  if (isLoading) return null;
+  return <ul>{data?.rows.map((row) => <li key={String(row.path)}>{row.path}: {row.views}</li>)}</ul>;
+}
+```
+
+`live: true` keeps the result current over server-sent events. Pass `fetchToken` instead of `token` and the provider refreshes expired tokens for you.
+
+## Privacy rules
+
+databob refuses personal data at the door instead of cleaning it up later.
+
+- Property names such as `email`, `phone`, `ip`, `address`, `password` are rejected when the schema is defined.
+- String values that look like an email address, IP address, phone number, or card number are rejected on ingest.
+- Unknown events and unknown properties are rejected. Nothing is stored that the schema does not describe.
+- Each tenant is stored apart. Deleting a tenant deletes its data.
+
+## Deploy to databob cloud
+
+Create an app under **Apps** in the dashboard. It shows three values once:
+
+```sh
+DATABOB_URL=https://engine.databob.dev
+DATABOB_SECRET_KEY=dbsk_live_...   # your server: track, read, mint tokens
+DATABOB_DEPLOY_KEY=dbdk_live_...   # CI or your laptop: npx databob deploy
+```
+
+```sh
+npx databob deploy
+```
+
+`deploy` validates `databob/` locally, then the cloud validates it again and stores it as a new version. It reads `.env.local` and `.env` when the variables are not already set. Tracking and reads answer `409 not_deployed` until the first deploy. The deploy key cannot track or read, and the secret key cannot deploy.
+
+## For agents
+
+Every command prints JSON or plain lines.
+
+```sh
+npx databob describe                     # schema and metrics as JSON
+npx databob check                        # exit 1 with a list of problems
+npx databob query revenue --tenant acme --args '{"range":"7d"}' --tz Europe/Berlin --compare
+npx databob track signup --props '{"plan":"pro"}' --tenant acme --user u1
+npx databob deploy                       # ship databob/ to the cloud app
+```
+
+The HTTP API is the same everywhere: `POST /v1/track`, `POST /v1/metrics/:name`, `GET /v1/metrics/:name/live`, `POST /v1/query`, `POST /v1/tokens`, `GET /v1/describe`, `DELETE /v1/users/:id`, `DELETE /v1/tenants/:id`. Errors are `{ "error": code, "message": text }`.
+
+## Self-host
+
+```sh
+DATABOB_SECRET_KEY=dbsk_... DATABOB_SIGNING_KEY=... DATABOB_USER_KEY=... npx databob start
+```
+
+One SQLite file per tenant under `DATABOB_DATA_DIR` (default `.databob/data`). Node 22.13 or newer.
+
+## License
+
+Apache-2.0. The engine it runs on, `@databob/engine`, is FSL-1.1-ALv2: free to use and self-host, not to resell as a competing hosted service, and Apache-2.0 two years after each release.

package/dist/api.d.ts

@@ -0,0 +1,17 @@
+import type { InferShape, MetricDef, Shape } from "@databob/engine";
+export type MetricRef<Args = Record<string, unknown>, Result = unknown> = {
+    readonly name: string;
+    readonly " args"?: Args;
+    readonly " result"?: Result;
+};
+export type RefArgs<R> = R extends {
+    readonly " args"?: infer A;
+} ? A : never;
+export type RefResult<R> = R extends {
+    readonly " result"?: infer T;
+} ? T : never;
+export type ApiFromModule<M> = {
+    [K in keyof M as M[K] extends MetricDef<Shape, unknown> ? K : never]: M[K] extends MetricDef<infer A, infer R> ? MetricRef<InferShape<A>, R> : never;
+};
+export declare function makeApi<M>(): ApiFromModule<M>;
+export declare function ref<Args = Record<string, unknown>, Result = unknown>(name: string): MetricRef<Args, Result>;

package/dist/api.js

@@ -0,0 +1,13 @@
+// `export const api = makeApi<typeof metrics>()` in generated code.
+export function makeApi() {
+    return new Proxy({}, {
+        get(_target, property) {
+            if (typeof property !== "string" || property === "then" || property.startsWith("$$"))
+                return undefined;
+            return { name: property };
+        },
+    });
+}
+export function ref(name) {
+    return { name };
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};