@irongraph/client 0.1.0

package/LICENSE.txt

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

@@ -0,0 +1,120 @@
+# IronGraph for JavaScript and React
+
+**Connect JavaScript and React to a GPU-first temporal graph database with built-in streaming and queues.**
+
+Query graph relationships, text documents, text and vectors, temporal property history, and graph
+analytics; administer Streams and Queues through Cypher. `@irongraph/client` provides a typed
+Query API client and React hooks for a running IronGraph instance. The browser package
+is remote-only; the database runs in a separate process. IronGraph is open-source software
+released under the Apache License 2.0.
+
+## Database capabilities
+
+| Capability | What you can do |
+| --- | --- |
+| **Graph queries and analytics** | Match relationships and paths with Cypher; run shortest paths, PageRank, connected components, and community detection. |
+| **Temporal properties and analysis** | Retain property history, read values with `AT TIME`, inspect samples with `HISTORY`, and aggregate with time windows and maintained rollups. |
+| **Text documents and search** | Store the full text of articles, notes, manuals, and other written content on graph nodes; search that text with text and vector indexes and automatic local embeddings. |
+| **Built-in Kafka-compatible Streams** | Produce and consume events through supported Kafka clients; manage topics, partitions, retention, and consumer-lag monitoring. |
+| **Built-in AMQP-compatible Queues** | Use classic and stream queues, direct/fanout/topic exchanges, bindings, and retention with supported AMQP clients. |
+
+Cypher handles graph operations, temporal analysis, search, and stream/queue administration.
+Message producers and consumers use the supported Kafka or AMQP protocols through the instance's
+configured listeners. The SDK query interface does not replace those protocol clients.
+
+Explicit projects and the `OBSERVED`, `KNOWLEDGE`, and `WORKSPACE` layers organize data.
+Indexes and unique constraints, transactions, asynchronous write-ahead logging, recovery, and
+periodic snapshots are part of the database.
+
+The standalone instance serves its web console at
+[http://127.0.0.1:18484/web/](http://127.0.0.1:18484/web/) by default and also supports local MCP
+access. Start the official standalone distribution before opening that address. Opening an
+embedded database through Python, Node.js, or Rust does not start a web server or expose the
+console. For a configured remote instance, use its HTTPS address followed by `/web/`, with
+the required browser-managed client certificate.
+
+Temporal reads apply to declared properties within their retention window. Graph topology and
+ordinary properties are read in their current state.
+
+## Install
+
+You need a browser with Fetch and streaming response support, an ES module application, and
+React 18 or later if using the React exports. After configuring the official npm package source
+supplied with your release:
+
+```sh
+npm install @irongraph/client
+```
+
+The matching release must be available in that source. React is supplied by your application;
+the plain JavaScript client does not require it.
+
+## Query a local instance
+
+For this example, run an official IronGraph instance on loopback port `18484`. In its Query
+console, create a project with `CREATE PROJECT IF NOT EXISTS notes`. Serve the browser
+application from the instance's origin so the request has same-origin access.
+
+```javascript
+import { Client } from '@irongraph/client'
+
+const client = new Client('http://127.0.0.1:18484')
+const result = await client.query({
+  cypher: "USE notes RETURN 'Connected to IronGraph' AS message",
+})
+console.log(result.rows[0][0].value)
+```
+
+Expected output: `Connected to IronGraph`. Next, query your project's text document nodes using
+`MATCH (document:Document) RETURN document.body` after `USE notes`.
+
+## Use React
+
+With the same local prerequisites, render this component in your application:
+
+```jsx
+import { IronGraphProvider, useIronGraphQuery } from '@irongraph/client/react'
+
+function Connection() {
+  const { result, error, loading } = useIronGraphQuery({
+    cypher: "USE notes RETURN 'Connected to IronGraph' AS message",
+  })
+  if (loading) return <p>Connecting…</p>
+  if (error) return <p>{String(error)}</p>
+  return <pre>{JSON.stringify(result?.rows)}</pre>
+}
+
+export default function App() {
+  return (
+    <IronGraphProvider baseUrl="http://127.0.0.1:18484">
+      <Connection />
+    </IronGraphProvider>
+  )
+}
+```
+
+Expected result: the typed row containing `Connected to IronGraph` appears. The hook exposes
+local loading and error states and cancels the previous request when its inputs change or the
+component unmounts. Next, replace the statement with your application's graph query.
+
+## Query the graph, text documents, and search
+
+Cypher provides text document updates, vector search, indexes, temporal data, algorithms, and stream
+and queue administration through `POST /api/query`, subject to your credential's permissions.
+Text documents are ordinary graph nodes whose complete text participates in graph relationships and
+declared embedding indexes. Select a project explicitly; there is no implicit default.
+`OBSERVED`, `KNOWLEDGE`, and `WORKSPACE` distinguish source facts, curated facts, and working data.
+
+Remote deployments require HTTPS and browser-managed mutual TLS certificates authorized for
+the required project and operations. Plain HTTP is loopback-only. The database process selects
+one CPU, Metal, or optional CUDA device; GPU admission rejects graphs and indexes that do not
+fit. Embedding runs in the database process, with no generative language model hosted by
+IronGraph.
+
+Native database release targets are macOS 15+ ARM64 and Linux with glibc 2.28+ on ARM64 or
+AMD64. These package build baselines apply to the database host; check its release qualification
+results before deploying. The browser client does not contain a native database binary.
+
+## License
+
+IronGraph is licensed under the Apache License 2.0.