@authzflow/core 0.0.0-stage → 0.1.0-beta.1

package/LICENSE

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

@@ -1,3 +1,61 @@
-# Temporary Holding Version
+# @authzflow/core
 
-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.
+MIT-licensed beta authorization-state runtime maintained by Accelflow Inc. Ships prebuilt Rust/Wasm, ESM JavaScript, TypeScript declarations and a checked reader. npm consumers need no Rust compiler.
+
+```js
+import { createRuntime, createCheckedReader } from '@authzflow/core';
+```
+
+The host supplies verified sessions, clocks, an atomic durable checkpoint store, an authenticated complete-check transport, and exact content/hash callbacks. Default diagnostics are disabled. Never treat a local checkpoint or client-provided metadata as authority.
+
+See https://github.com/Accelflow/AuthzFlow/blob/main/docs-public/getting-started.md for installation and the executable example, and https://github.com/Accelflow/AuthzFlow/blob/main/docs-public/adapters.md for the full callback contract. Node 22/24, ESM, TypeScript 5.9+ and modern secure-context WebAssembly browsers are initial targets.
+
+Offline permissions expire at their original bounded deadline and are lost across reader/process restarts. Server-side revocation cannot instantly reach disconnected clients. Already returned plaintext, raw store bypasses, multi-owner coordination and stream recovery are outside beta guarantees.
+
+LICENSE and THIRD_PARTY_NOTICES.md are included; the latter contains dependency and Rust standard-library attributions and license texts. Security reporting: https://github.com/Accelflow/AuthzFlow/security/advisories/new .
+
+Additional entrypoints: `@authzflow/core/replicas` provides editor-independent purge eligibility and completion types; `@authzflow/core/content-hash` connects explicit client/server projections to SHA-256; `@authzflow/core/testing` is an optional Node external-journal conformance suite. Hosts retain transaction, dirty-state, identity and encryption ownership. A blocked purge preserves denial and unsent changes and is not physical deletion completion.
+
+React Native hosts use `createNativeCheckedReader` from
+`@authzflow/core/native-reader` with a synchronous native JSON port. Authorization
+and checkpoint transitions execute the same Rust `authzflow-core::OwnedRuntime`
+as Wasm. The C ABI lives in `crates/authzflow-native`; it contains no policy engine.
+The native and Wasm entries share TypeScript protocol/host orchestration.
+Hosts supply prebuilt iOS/Android libraries, a native bridge, durable CAS storage,
+trusted session/clock/entropy and JSON-only content. Missing/incompatible native
+libraries fail closed; there is no TypeScript authorization fallback.
+
+### Reading an existing offline grant without renewing it
+
+`createCheckedReader(...).readCachedWithPermit()` uses the live Rust authority
+from an earlier successful full check. It performs no server request and never
+renews a deadline. It requires the same session context, boot, durable revision,
+content hash and an unexpired `offline_ttl` grant. Cold start and `online_only`
+do not supply that grant. A different cached value is rejected without destroying
+the valid grant for the original content. Session/clock/revision failures fence it.
+Hosts can use this for secondary cache projections; normal screen revalidation
+continues to call `readWithPermit()`. It cannot turn a cached checkpoint into permission.
+
+### Optional Resource Group integration
+
+The opt-in `resource-group` entrypoint aggregates invalidations for related
+Resources. `createResourceGroupCoordinator` uses Rust protocol v2;
+`createNativeResourceGroupCoordinator` in `native-reader` uses the same Rust
+transitions. Attach it through the Resource authority's `groups` option and pass
+`resourceGroupId` on each Resource input. Do not enable the legacy `changes`
+option on that same authority.
+
+`group-sqlite`, `group-indexeddb`, and `group-notifications` provide shared-store
+and wakeup adapters. The host must retain session checks and atomic, term-fenced
+purge. Group registration, shared state and notifications never grant content;
+each reader retains its own fresh-check permit. Cold start cannot inherit another
+tab's permit. Close the authority before closing its host-owned coordinator.
+
+`readCachedManyWithPermit` checks up to 64 cached Resource inputs (4 MiB aggregate)
+without HTTP checks or deadline renewal. It returns ordered per-item results and
+rechecks shared fences before delivery. It does not load missing permits or make
+an entire search index readable offline.
+
+Versioned source contracts live under `contracts/`. Browser-tab and independent
+SQLite-process contracts are tested; each product still needs its own integration
+acceptance and revision-fenced purge implementation.