@oxy.so/core 1.0.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,16 @@
+============================================================================
+ NOTICE
+ @oxy.so/core
+ Copyright (c) 2025-present The Oxy Collective, Inc.
+============================================================================
+
+This product is licensed under the Apache License, Version 2.0. See the
+LICENSE file in this directory.
+
+----------------------------------------------------------------------------
+ THIRD PARTY COMPONENTS
+----------------------------------------------------------------------------
+
+This package contains no third party source. Its dependencies are resolved
+and installed by the package manager and remain governed by their own
+licenses.

package/README.md

@@ -0,0 +1,221 @@
+# @oxy.so/core
+
+OxyHQ SDK Foundation. Platform-agnostic core library that works in Node.js, browser, and React Native environments. No React dependency.
+
+## Installation
+
+```bash
+bun add @oxy.so/core
+```
+
+## Contents
+
+- **OxyServices API client** — all API methods for interacting with OxyHQ services
+- **Device-first session engine** — `SessionClient` (`src/session/`), `runSessionColdBoot`, and the device-session mixin that back `OxyProvider` in `@oxy.so/services`
+- **OAuth helpers** — `generatePkcePair`, `generateOAuthState`, `buildOAuthAuthorizeUrl` for third-party "Sign in with Oxy" (see [docs/auth/integration-guide.md](../../docs/auth/integration-guide.md))
+- **Crypto** — KeyManager, SignatureService, RecoveryPhraseService
+- **Models and types** — User, ApiError, ClientSession, and more
+- **i18n** — translate function and locale files
+- **Shared utilities** — color, theme, error, network, debug helpers
+- **Platform detection utilities**
+- **Device management**
+- **Linked clients** for app backends that need the active Oxy bearer token
+- **User identity contracts and handle normalization** so apps render display names and build local/federated profile handles consistently
+- **Server middleware** for Express request identity, per-user rate limiting, and shared security headers / CSP baseline
+
+## Exports
+
+The package exposes two public entry points:
+
+- `@oxy.so/core` — main entry (API client, session, crypto, models, shared utilities, i18n, platform, device)
+- `@oxy.so/core/server` — Express-only helpers (`createOxyRateLimit`, `createOxyAuthMiddleware`, `requireOxyAuth`, `getOxyUserId`, `getRequiredOxyUserId`, `createOxyCors`, `createOxySecurityHeaders`, `buildOxyCspDirectives`, `safeFetch`, `verifySecret`, and request types)
+
+All client/runtime symbols (including `SessionClient`, `KeyManager`, `SignatureService`, `RecoveryPhraseService`, and the shared color / theme / error / network / debug helpers) are re-exported from the package root. Server-only Express helpers live under `@oxy.so/core/server` so React Native and browser bundles never import Express.
+
+## Usage
+
+```ts
+import { OxyServices, oxyClient, KeyManager } from '@oxy.so/core';
+import type { User, ApiError } from '@oxy.so/core';
+
+// Get user
+const user = await oxyClient.getUserById('123');
+
+// Crypto (KeyManager methods are static)
+const hasIdentity = await KeyManager.hasIdentity();
+```
+
+## Device-First Sessions
+
+The session authority is the server-side `DeviceSession` (one document per device: signed-in accounts + active account + revision). `@oxy.so/core` owns the whole client side of that contract:
+
+- **`SessionClient`** (`src/session/`) — reads `GET /session/device/state`, mutates via `POST /session/device/{add,switch,signout}`, and applies `session_state` socket pushes (room `device:<deviceId>`, token-free payload) so every app on the same device stays in sync.
+- **`runSessionColdBoot`** (`src/boot/sessionColdBoot.ts`) — the ordered, short-circuit cold-boot runner used by `OxyProvider`. It restores silently from device state or resolves to logged-out; it NEVER auto-redirects to a login page.
+- **Zero-cookie transport** — every successful sign-in returns `deviceId` + a 256-bit `deviceSecret`, which the client persists first-party (localStorage per web origin; SecureStore on native). `POST /session/device/token` mints/refreshes a short access token from `{ deviceId, deviceSecret }` (no bearer, no cookies — possession of the secret is the proof) and rotates the secret in-use. There is no cookie, no refresh-token family, and no `#oxy_boot` bootstrap hop. Full contract: [docs/auth/device-session.md](../../docs/auth/device-session.md).
+
+Consumers never build session restore themselves — mount `OxyProvider` from `@oxy.so/services` with a registered `clientId`.
+
+## OAuth Helpers (third party)
+
+Third-party apps sign users in with standard OAuth 2.0 Authorization Code + PKCE against `auth.oxy.so`:
+
+```ts
+import { generatePkcePair, generateOAuthState, buildOAuthAuthorizeUrl } from '@oxy.so/core';
+
+const [pkce, state] = await Promise.all([generatePkcePair(), generateOAuthState()]);
+const url = buildOAuthAuthorizeUrl({
+  clientId: 'oxy_dk_…',
+  redirectUri: 'https://merchant.example/auth/callback',
+  codeChallenge: pkce.codeChallenge,
+  state,
+});
+```
+
+`OxySignInButton` in `@oxy.so/services` uses these internally when the resolved Application is `third_party`. See [docs/auth/integration-guide.md](../../docs/auth/integration-guide.md).
+
+## User Identity And Handles
+
+SDK user payloads may arrive with either `id` or Mongo-style `_id`; normalize
+them before exposing state to apps:
+
+```ts
+import { getNormalizedUserId, normalizeUserIdentity } from '@oxy.so/core';
+
+const id = getNormalizedUserId(user);
+const normalizedUser = normalizeUserIdentity(user);
+```
+
+`User.name.displayName` is **optional** — federated or unresolved actors routinely
+omit it. Render it directly when present; when absent, fall back to the
+normalized handle (`displayName ?? handle`). Never rebuild names from
+`name.first`, `name.last`, `name.full`, or `username`.
+
+For profile display/routing, use `getNormalizedUserHandle()`. It strips a
+leading `@`, preserves an existing `user@instance` handle, and appends
+`instance`/`federation.domain` only for federated users:
+
+```ts
+import { getNormalizedUserHandle } from '@oxy.so/core';
+
+getNormalizedUserHandle({ username: 'alice' }); // "alice"
+getNormalizedUserHandle({ username: 'alice', isFederated: true, instance: 'example.social' }); // "alice@example.social"
+```
+
+## Linked App API Clients
+
+Apps that call their own backend should derive API clients from the active SDK
+instance instead of re-implementing auth headers, session restore, CSRF fetches,
+or user forwarding.
+
+```ts
+import { OxyServices } from '@oxy.so/core';
+
+const oxy = new OxyServices({ baseURL: 'https://api.oxy.so' });
+const mentionApi = oxy.createLinkedClient({ baseURL: 'https://api.mention.earth' });
+
+await mentionApi.post('/posts', { content: 'Hello from Oxy' });
+```
+
+Linked clients send the current Oxy bearer token for authenticated requests.
+State-changing bearer requests do not fetch app-local CSRF tokens; cookie-only
+writes still use CSRF.
+
+**GET response caching is OFF by default for linked clients.** The
+SDK's per-instance GET cache is only safe on the canonical `OxyServices` client,
+where every mutation (`updateProfile`, `followUser`, `blockUser`, …) busts the
+matching cached GET. A linked client targets the consuming app's own backend,
+whose resources and write endpoints the SDK cannot know or invalidate — so a
+cached GET there would serve stale data after the app mutates its own data.
+Caching is left to the consumer's own layer (React Query / stores). Pass
+`oxy.createLinkedClient({ baseURL, enableCache: true })` to opt back in when the
+consumer accepts responsibility for invalidation.
+
+## Backend Auth Middleware
+
+Backends should use the SDK server helpers instead of local auth request types
+or `requireAuth` copies.
+
+```ts
+import { OxyServices } from '@oxy.so/core';
+import {
+  createOxyRateLimit,
+  requireOxyAuth,
+  getRequiredOxyUserId,
+  type OxyAuthRequest,
+} from '@oxy.so/core/server';
+
+const oxy = new OxyServices({ baseURL: 'https://api.oxy.so' });
+
+app.use(createOxyRateLimit(oxy, { store: redisStore }));
+router.use(requireOxyAuth);
+
+router.get('/me', (req: OxyAuthRequest, res) => {
+  const userId = getRequiredOxyUserId(req);
+  res.json({ userId });
+});
+```
+
+For routers that are not mounted after `createOxyRateLimit`, use
+`createOxyAuthMiddleware(oxy)` to resolve the bearer session and require a user
+in one middleware.
+
+## Security Headers And CSP
+
+`createOxySecurityHeaders` is Helmet plus the Oxy-wide Content-Security-Policy
+baseline: the Cloudflare Web Analytics beacon (which Cloudflare injects into
+proxied HTML, and which needs `static.cloudflareinsights.com` in `script-src`
+AND `cloudflareinsights.com` in `connect-src`), the Oxy API and CDN origins the
+SDK talks to, and the standard hardening floor. Apps never name those hosts
+themselves.
+
+Mount it on backends that SERVE HTML. A JSON-only API gains nothing from a
+source-list CSP — it governs no browsing context — so harden those with the
+non-CSP headers (`hsts`, `noSniff`, `frameguard`, CORP) instead.
+
+```ts
+import { createOxySecurityHeaders } from '@oxy.so/core/server';
+
+app.use(createOxySecurityHeaders({
+  csp: {
+    connectSrc: ['https://api.example.com', 'wss://api.example.com'],
+    frameSrc: ['https://player.vimeo.com'],
+  },
+  helmet: { crossOriginResourcePolicy: { policy: 'cross-origin' } },
+}));
+```
+
+`csp` entries are ADDED to the baseline and deduped — a directive can never be
+replaced, so `'self'` (and the beacon hosts) cannot be dropped; extending a
+directive the baseline does not define seeds it with `'self'` first. The
+`helmet` passthrough covers every non-CSP header (`hsts`, `frameguard`,
+`referrerPolicy`, CORP/COOP, …) and rejects `contentSecurityPolicy` at compile
+time so the baseline cannot be bypassed. Surfaces that set the header
+themselves (a Next.js `headers()`, an edge worker) can call
+`buildOxyCspDirectives(extensions)` for the resolved directive map.
+
+## User Identity Normalization
+
+`@oxy.so/core` normalizes user payloads returned by auth and user APIs so `id` is
+always present when `_id` is the only identifier provided by the backend.
+Consumers should compare `user.id` for ownership and permissions instead of
+using backend-specific fields.
+
+## Build
+
+```bash
+bun run build
+```
+
+Compiles with TypeScript, producing CJS, ESM, and type declaration outputs. The
+ESM build must never contain `require()` calls — use `await import()` for
+optional/platform-specific modules.
+
+## KeyManager Safety
+
+- `_persistIdentityAtomic` backs up the EXISTING identity before any overwrite, writes the new primary, runs a sign/verify probe, then refreshes the backup. A failed `createIdentity({overwrite:true})` rolls the primary back to the exact prior bytes — prior identity is never destroyed.
+- `restoreIdentityFromBackup()` treats keychain-read exceptions as transient — never clobbers a healthy-but-locked primary. Rejects mismatched backups (dual mismatch guards).
+- `deleteIdentity(skipBackup=false, force=false, userConfirmed=false)` — `force=true` also deletes the backup slot.
+
+## `verifyChallenge` Token Planting
+
+`OxyServices.verifyChallenge()` plants the freshly-minted access token internally before returning. Callers do not need to plant tokens manually after `verifyChallenge` — the SDK handles it.