@atlasauth/pca-rag 0.1.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Atlas Authorization
+
+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.
+
+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.

package/README.md

@@ -0,0 +1,55 @@
+# @atlasauth/pca-rag
+
+Fine-grained authorization for RAG, built on Proof-Carrying Authority (PCA). At retrieval time it filters candidate documents down to the ones a given principal may see, deciding each one with the PCA policy engine. Every filtering decision is recorded with a content-addressed digest, so you can show the model was handed only authorized data.
+
+- Documents carry ACL metadata: a `{ relation, object }` entry, or `relation:object` tag strings.
+- Policy is either raw PCA predicates or an OpenFGA / Zanzibar model plus tuples (compiled through `@atlasauth/pca-policy-bridge`, including relation closures such as "viewer from parent").
+- **Fails closed**: a document is admitted only when a permit predicate matches and no deny matches. No ACL, an unresolved relation, a malformed document, or an incomplete policy translation drops the document.
+
+## Install
+
+```sh
+npm i @atlasauth/pca-rag
+```
+
+Depends on `@atlasauth/pca` and `@atlasauth/pca-policy-bridge`.
+
+## Usage
+
+```ts
+import { filterDocuments, withPcaFilter } from '@atlasauth/pca-rag';
+
+const policy = { openfga: { model, tuples } }; // OpenFGA authorization model + relationship tuples
+
+const candidates = [
+  { id: 'readme', text: '...', acl: { relation: 'can_view', object: 'document:readme' } },
+  { id: 'spec', text: '...', tags: ['can_view:document:spec'] },
+];
+
+const { documents, decision } = filterDocuments('user:alice', candidates, policy);
+decision.allowedIds; // ids the model may see
+decision.droppedIds; // ids dropped, with a reason per document in decision.decisions
+decision.digest;     // b64u commitment to the decision set, bindable into a receipt or proof
+
+// Or wrap any retriever so results are filtered before they reach the model:
+const safe = withPcaFilter(retriever, 'user:alice', policy); // retriever.retrieve(query, k)
+const docs = await safe.retrieve('how do I deploy?');
+safe.lastDecision(); // audit trail for the last call
+```
+
+Compile once with `compilePolicy(policy)` and reuse the result to avoid recompiling per call. To derive the principal from a verified PCActn, use `principalFromPCActn(pcactn, { id })`.
+
+## API
+
+- `filterDocuments(principal, candidates, policy, opts?)` returns `{ documents, decision }`
+- `withPcaFilter(retriever, principal, policy, opts?)` generic retriever wrapper
+- `withLangChainPcaFilter(...)`, `withLlamaIndexPcaFilter(...)` structural adapters for LangChain and LlamaIndex retrievers (no dependency on either library)
+- `compilePolicy`, `aclsFromMetadata`, `principalFromPCActn`
+
+## Status
+
+Part of [Proof-Carrying Authority](https://github.com/Atlas-Authorization/pca). This filters retrieval results; it does not control what a model does with documents it is allowed to see. PCA's cryptography has not been independently audited.
+
+## License
+
+MIT - see LICENSE

package/package.json

@@ -1,7 +1,27 @@
 {
   "name": "@atlasauth/pca-rag",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "FGA-for-RAG for PCA: retrieval-time, per-principal document filtering driven by the PCA policy engine, with the filtering decision captured in the proof trace (provable: the model only saw authorized data).",
+  "keywords": [
+    "rag",
+    "retrieval",
+    "document filtering",
+    "fine-grained authorization",
+    "agent authorization",
+    "proof-carrying authority",
+    "pca",
+    "ai agents"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/Atlas-Authorization/pca#readme",
+  "bugs": {
+    "url": "https://github.com/Atlas-Authorization/pca/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Atlas-Authorization/pca.git",
+    "directory": "packages/pca-rag"
+  },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -12,8 +32,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@atlasauth/pca": "0.1.0",
-    "@atlasauth/pca-policy-bridge": "0.1.0"
+    "@atlasauth/pca-policy-bridge": "0.3.0",
+    "@atlasauth/pca": "0.3.0"
   },
   "devDependencies": {
     "typescript": "^5.6.3",
@@ -21,8 +41,12 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
+  "engines": {
+    "node": ">=20"
+  },
   "publishConfig": {
     "access": "public"
   },