datanotes 0.0.0-stage → 1.1.0

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/NOTICE

@@ -0,0 +1,4 @@
+Datanotes
+Copyright 2026 Davide Fornelli
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,66 @@
-# Temporary Holding Version
+# Datanotes
 
-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.
+The engine of your second brain: Markdown notes as database tables, for you and your AI agents.
+
+A row is any note whose `table` property names a table; tables are defined in
+`Database/database.yaml`. Every write is checked against its table, journaled and undoable. Agents
+use it through MCP (the separate `datanotes-mcp` server); programs use its HTTP API or the
+`datanotes/client` library; it also runs inside Obsidian as a plugin.
+
+**Documentation: [datanotes.dev](https://datanotes.dev)**
+
+## Quick start
+
+Requires Node.js 20 or newer. Connect an MCP client to a vault (here Claude Code):
+
+```bash
+claude mcp add datanotes -- npx -y datanotes-mcp --vault /path/to/vault
+```
+
+Other clients use the same command:
+
+```json
+{
+  "mcpServers": {
+    "datanotes": { "command": "npx", "args": ["-y", "datanotes-mcp", "--vault", "/path/to/vault"] }
+  }
+}
+```
+
+To keep the engine running for several clients and apps:
+
+```bash
+npx -y datanotes serve --vault /path/to/vault
+```
+
+It serves the HTTP API on `http://127.0.0.1:27150/datanotes/*`, with the owner's token in
+`<vault>/.datanotes/service.json`. From code:
+
+```js
+import { DatanotesClient } from "datanotes/client";
+
+const db = new DatanotesClient({ url: "http://127.0.0.1:27150", token });
+const { value } = await db.call("select_rows", { table: "book", where: { pages: { gt: 300 } } });
+```
+
+## Learn more
+
+- [How it works](https://datanotes.dev/concepts/how-it-works/)
+- [Connect agents](https://datanotes.dev/start/connect-agents/)
+- [Operations and MCP tools](https://datanotes.dev/reference/tools/)
+- [JavaScript client](https://datanotes.dev/guides/client/)
+- [Apps](https://datanotes.dev/guides/apps/)
+- [Obsidian plugin](https://datanotes.dev/guides/obsidian/)
+
+## Security
+
+See [SECURITY.md](SECURITY.md): how to report a vulnerability, what each credential may do, and
+which data leaves the machine (only what you turn on).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache License 2.0: see [LICENSE](LICENSE) and [NOTICE](NOTICE). Copyright 2026 Davide Fornelli.

package/SECURITY.md

@@ -0,0 +1,51 @@
+# Security
+
+## Reporting a vulnerability
+
+Please report vulnerabilities privately, through GitHub's **Report a vulnerability** button on this
+repository (Security → Advisories), not in a public issue. You will get an answer within a week.
+Include the version, how to reproduce it and what an attacker gains.
+
+## Security model
+
+Datanotes is an engine that reads and writes a folder of Markdown notes (the vault). It is meant to
+run on your own machine, for you and the agents you choose.
+
+### Network
+
+- The HTTP server listens on `127.0.0.1` unless told otherwise (`--host`). It answers no CORS
+  preflight, so web pages cannot call it.
+- Only `GET /` answers without a token (status and version).
+- To reach it from outside (a phone, a hosted assistant), publish it through a reverse proxy or a
+  tunnel, over HTTPS, and give each device or agent its own app token. Publish the MCP server
+  (`datanotes-mcp serve`) the same way: it holds no credentials and passes each agent's token on.
+
+### Credentials
+
+| Credential | Where | What it can do |
+| --- | --- | --- |
+| Owner token | `httpServerToken` in the settings | Everything: data, schema, apps, webhooks, undo. Keep it on the machine. |
+| App token | created with `POST /datanotes/apps/create/` (owner only), stored hashed | Read everything; write only the tables in its `write` patterns; change the schema only with `ddl`. It cannot create webhooks, manage apps or undo; with `maintain` it may also undo, restore, vacuum and configure (an agent's own token). |
+
+Prefer an **app token per device or agent**: it has only the permissions it needs and the journal
+names it. MCP clients use the same tokens: the MCP server passes them to the engine.
+
+Every write is journaled with its actor. The agent's name, model and session come from the client
+and are self-reported; the credential (`auth`: `owner` or `app`, and the app's name) is set
+by the server and cannot be claimed.
+
+### Files
+
+Every path is resolved inside the vault: a path with `..`, a backslash, a drive letter or a NUL is
+refused, both by the engine's operations and by the file host. Symbolic links inside the vault are
+followed: do not link to folders you would not give the engine.
+
+### Data that leaves the machine
+
+Nothing leaves the machine unless you turn it on:
+
+- **Semantic search** sends note text to the embedding provider you configure (`semanticProvider`,
+  off by default). A local provider (Ollama) keeps it on the machine.
+- **Telemetry** sends logs to the OTLP endpoint you configure (`telemetryEnabled`, off by default).
+- **Webhooks** (created by the owner) post change events to the URLs they name.
+- **Git sync** (`--git-sync`) pushes the vault to its git remote.

package/dist/api/catalog.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The operations of the HTTP API, described for their callers: name, description, input schema
+ * and hints. An MCP server offers each one as a tool of the same name (the shape is MCP's tool
+ * definition); the OpenAPI document and the docs are generated from it. The route and body each
+ * one sends: `requests.ts`.
+ */
+export interface OperationDef {
+    name: string;
+    description: string;
+    inputSchema: Record<string, unknown>;
+    annotations: {
+        title?: string;
+        readOnlyHint?: boolean;
+        destructiveHint?: boolean;
+        idempotentHint?: boolean;
+        openWorldHint?: boolean;
+    };
+}
+export declare const OPERATIONS: OperationDef[];

package/dist/api/client.d.ts

@@ -0,0 +1,100 @@
+/**
+ * A client of the Datanotes HTTP API, with no dependency: it runs in Node, in browsers and in
+ * Obsidian (pass Obsidian's `requestUrl` as the transport). `call` runs an operation of the
+ * catalogue by name, the way agents name them; `request` reaches any route.
+ */
+import { type OperationResult } from "./results";
+import type { OperationDef } from "./catalog";
+export interface HttpRequest {
+    url: string;
+    method: "GET" | "POST";
+    headers: Record<string, string>;
+    body?: string;
+}
+export interface HttpResponse {
+    status: number;
+    text: string;
+}
+export type Transport = (req: HttpRequest) => Promise<HttpResponse>;
+/** Who is calling, recorded with every write (header `X-Datanotes-Actor`). Self-reported. */
+export interface ActorInfo {
+    /** The program: "claude-code", "cursor", an app's name. */
+    harness?: string;
+    harness_version?: string;
+    model?: string;
+    /** The agent's session (the engine remembers the model an app reports for it). */
+    session?: string;
+    /** The tool the agent called, when the call comes from an MCP server. */
+    tool?: string;
+}
+export declare const ACTOR_HEADER = "X-Datanotes-Actor";
+export declare class DatanotesError extends Error {
+    readonly kind: "unreachable" | "auth" | "http";
+    readonly status: number;
+    readonly name = "DatanotesError";
+    /** `unreachable`: the engine did not answer; `auth`: the token was refused. */
+    constructor(message: string, kind?: "unreachable" | "auth" | "http", status?: number);
+}
+export interface ClientOptions {
+    /** The engine's address, e.g. `http://127.0.0.1:27150`. */
+    url: string;
+    token: string;
+    /** Recorded with every write unless a call names another actor. */
+    actor?: ActorInfo;
+    transport?: Transport;
+}
+/** A tool of a registered app, as `GET /datanotes/apps/tools/` lists it. */
+export interface AppTool extends Omit<OperationDef, "annotations"> {
+    annotations?: OperationDef["annotations"];
+    app: string;
+}
+/** One call of an operation or an app tool by an agent, for the engine's change feed. */
+export interface ToolCallRecord {
+    tool: string;
+    args: Record<string, unknown>;
+    ok: boolean;
+    durationMs: number;
+    value: unknown;
+    /** Who served it: "engine" or the app's name. */
+    servedBy: string;
+    session?: string;
+    resultChars?: number;
+    resultTokens?: number;
+}
+export declare const fetchTransport: Transport;
+export declare class DatanotesClient {
+    private readonly o;
+    readonly url: string;
+    private readonly send;
+    constructor(o: ClientOptions);
+    /** Send a request; the answer's status, its JSON (when it is JSON) and its text. */
+    request(method: "GET" | "POST", path: string, body?: unknown, opts?: {
+        actor?: ActorInfo;
+        accept?: string;
+    }): Promise<{
+        status: number;
+        json: unknown;
+        text: string;
+    }>;
+    /** `POST /datanotes/<route>` and its JSON answer; throws on an error status. */
+    post<T = unknown>(route: string, body?: unknown, actor?: ActorInfo): Promise<T>;
+    /** Run an operation of the catalogue (`select_rows`, `insert_row`, …) with an agent's arguments. */
+    call(name: string, args?: Record<string, unknown>, actor?: ActorInfo): Promise<OperationResult>;
+    /** Run an operation of the engine, or else a registered app's tool of that name. */
+    invoke(name: string, args?: Record<string, unknown>, actor?: ActorInfo): Promise<OperationResult & {
+        servedBy: string;
+    }>;
+    /** True when the engine answers `GET /` (no token needed). */
+    ping(): Promise<boolean>;
+    /** The tools of the registered apps and the apps' instructions for agents. */
+    appTools(): Promise<{
+        tools: AppTool[];
+        instructions: string;
+    }>;
+    /** Call an app's tool through the engine (which holds the app's credentials). */
+    callAppTool(name: string, args: Record<string, unknown>, actor?: ActorInfo): Promise<OperationResult & {
+        servedBy: string;
+    }>;
+    /** Record an agent's tool call in the change feed (what MCP servers report). */
+    recordToolCall(call: ToolCallRecord, actor?: ActorInfo): Promise<void>;
+}