sharing

# Sharing — Private by Default, Explicit Share ## Rule Any resource a user **creates** (dashboards, documents, forms, decks, compositions, booking links, issues, analyses) is **private to the creator** by default and visible to others only when they have been **explicitly shared** with or when the creator changes visibility to `org` or `public`. This is the framework-level primitive. Every ownable resource gets it for free — same API, same UI, same skill. Workspace apps are the intentional organization-scoped exception: their default visibility is `org`, configurable by an organization owner/admin. The creator is stored as the app owner, and the creator or an organization owner/admin can change the app's visibility or manage its share grants. ## Concepts ### Three visibility levels - **`private`** — owner + explicit share grants only. Default. - **`org`** — owner + explicit grants + anyone in the same org (read-only). - **`public`** — owner + explicit grants + **anyone with the link** (read-only). Public docs do NOT appear in other users' list/sidebar/search results — `accessFilter` omits them by default. They're reachable by id (`resolveAccess` admits them) so direct links and SSR routes like `/p/:id` keep working. If a list endpoint legitimately needs cross-user public discovery (a template gallery, etc.), pass `accessFilter(table, shares, ctx, minRole, { includePublic: true })`. Visibility is coarse. Explicit share grants are fine-grained (per user, reusable organization group, or per org). ### Roles on a share grant - **`viewer`** — read only. - **`commenter`** — read + add comments, but cannot edit the resource or manage shares. - **`editor`** — read + write. - **`admin`** — read + write + manage shares. Does NOT replace the single `owner_email` on the resource. Share roles apply to one resource; organization roles apply to a team; app roles apply within one app. These are separate permissions. For role setup, use `agent-native-docs` to find the current organization and app-role guide. Before adding an admin gate, identify which role system protects that operation and use its existing role descriptor and permission checks. Do not replace role checks with an email comparison or a custom `isAdmin` column. ### Anonymous public URLs stay separate Form "publish" slugs, booking-link slugs, any feature that exposes a URL to unauthenticated users — these are a different axis and are NOT controlled by the sharing system. Keep them alongside it. ## Make a resource ownable In your template's `server/db/schema.ts`: ```ts import { sql } from "drizzle-orm"; import { pgTable, text } from "drizzle-orm/pg-core"; import { createSharesTable, ownableColumns, } from "@agent-native/core/db/schema"; export const decks = pgTable("decks", { id: text("id").primaryKey(), title: text("title").notNull(), data: text("data").notNull(), createdAt: text("created_at").notNull().default(sql`now()`), updatedAt: text("updated_at").notNull().default(sql`now()`), ...ownableColumns(), // adds owner_email, org_id, visibility }); export const deckShares = createSharesTable("deck_shares"); ``` Then register it **in `server/db/index.ts`** (not the schema file — keeps the schema file free of the `getDb` closure and avoids circular imports): ```ts // server/db/index.ts import * as schema from "./schema.js"; import { createGetDb } from "@agent-native/core/db"; import { registerShareableResource } from "@agent-native/core/sharing"; export const getDb = createGetDb(schema); export { schema }; registerShareableResource({ type: "deck", resourceTable: schema.decks, sharesTable: schema.deckShares, displayName: "Deck", titleColumn: "title", getResourcePath: (deck) => `/deck/${deck.id}`, getDb, }); ``` The `type` string is the stable id the UI and actions use. `getDb` is required — the framework-level share actions use it to reach your template's DB. ### Restricting public visibility and cross-org user shares Some resources should NOT be reachable by an arbitrary authenticated user even with the link, and should NOT be shareable to an email outside the org. Two optional registration flags lock these axes down: ```ts registerShareableResource({ type: "extension", // ... allowPublic: false, // hides "Public" in the share dialog and rejects it server-side requireOrgMemberForUserShares: true, // user shares must target an org member or pending invitee supportsGroupShares: true, // enable reusable organization groups for this resource }); ``` - **`allowPublic: false`** — `set-resource-visibility('public')` throws `ForbiddenError`, `accessFilter` / `resolveAccess` treat any stored `'public'` row as private (defense in depth against bad data), and the share popover hides the "Public" option. `list-resource-shares` returns `policy.allowPublic: false` so the UI follows the server. - **`requireOrgMemberForUserShares: true`** — `share-resource` looks up `principalId` in `org_members` and `org_invitations` (pending) for the resource's `orgId` and rejects user shares to anyone else. The same flag also pins `principalType: "org"` shares to the resource's own org — sharing to a *different* org would let that org's members run code in the viewer's auth context (same threat model as a public extension). (The flag name is kept for backward compatibility; treat it as "lock both user and org shares to the resource's org".) Use both for resources that execute code or expose privileged data with the *viewer's* credentials. A public or cross-org-shared resource with that access could let an unrelated user act with the viewer's credentials. Defaults match historical behaviour: `allowPublic: true`, `requireOrgMemberForUserShares: false`. Resources that don't set the flags work as before. ### Reusable organization groups The workspace organization model stores reusable groups in `workspace_user_groups`. Organization owners/admins manage the groups and their members through the existing group actions. Set `supportsGroupShares: true` on a resource registration to enable `principalType: "group"` in the generic share actions and the shared popover's autocomplete. Group ids are always checked against the resource's organization, and membership is evaluated at access time so group changes apply to existing shares. Workspace apps opt into this flag and use the organization default visibility setting. The app creator is the durable `owner_email`, while organization owners/admins receive admin access through the registration's `canManageAccess` callback. ## Filter list/read queries ```ts import { accessFilter } from "@agent-native/core/sharing"; const rows = await db .select() .from(schema.decks) .where(accessFilter(schema.decks, schema.deckShares)); ``` `accessFilter` admits rows the current user owns, has been shared on, or that the user can reach via `org` visibility. `public` rows are NOT admitted by default — see the visibility section above for why and how to opt in. ## Guard write actions ```ts import { assertAccess } from "@agent-native/core/sharing"; export default defineAction({ schema: z.object({ id: z.string(), title: z.string() }), run: async (args) => { await assertAccess("deck", args.id, "editor"); // ...proceed }, }); ``` For delete actions use `"admin"` (or fold in `"owner"` to require the real owner). `authorize` is a different axis, not an alternative: it gates whether the caller may run the operation at all, while `assertAccess` scopes which row they may touch. A write action restricted to some teammates needs both — `authorize: appAccess.requireAny(...)` on the action, `assertAccess` inside `run`. ## Create actions must set owner When inserting a new row, fill `ownerEmail` and `orgId` from the request context: ```ts import { fail } from "@agent-native/core/action"; import { getRequestUserEmail, getRequestOrgId, } from "@agent-native/core/server/request-context"; const ownerEmail = getRequestUserEmail(); // Never fall back to a shared sentinel owner; require an authenticated session. if (!ownerEmail) fail("Not authenticated", { statusCode: 401 }); await db.insert(schema.decks).values({ id: crypto.randomUUID(), title, data, ownerEmail, orgId: getRequestOrgId(), // visibility defaults to 'private' // ... }); ``` ## Drop in the share UI ```tsx import { ShareButton } from "@agent-native/toolkit/app/sharing"; // In the resource's header/toolbar: <ShareButton resourceType="deck" resourceId={deck.id} resourceTitle={deck.title} />; ``` For list views, show `<VisibilityBadge visibility={row.visibility} />` next to each resource. ## Standard share surface All app share popovers should use the same compact surface contract: - Use the text-only `ShareTrigger` from `@agent-native/toolkit/sharing`. - Render ordinary links with `ShareCopyRow`, which exposes a Copy action without printing the raw URL. - Keep general access and individual people access in the standard Core sharing flow. The people flow supports email invites, roles, notifications, and removal through the shared share actions. - Add `ShareAgentsSection` only when the resource has a real agent-readable link or prompt. Keep it collapsed by default and supply domain-specific content through the shared section shell. - When `supportsGroupShares` is enabled, keep the existing people input as the only entry point and include organization groups in its autocomplete. Do not add a separate group-management surface to each resource. - App-specific tabs or controls may remain when they represent a real domain action (for example, an embed-code editor), but they should retain the same trigger, copy-row, access, and spacing language. `ShareDisclosureSection` is the toolkit-owned shell for optional expandable share details; use its `ShareAgentsSection` or `SharePeopleSection` wrappers instead of creating another collapsible share panel in a template. ## Actions available everywhere The framework auto-mounts these actions in every template — no per-template boilerplate: | Action | Args | Purpose | | -------------------------- | ------------------------------------------------------------------------------ | ----------------------------------------- | | `share-resource` | `resourceType, resourceId, principalType, principalId, role, notify?, resourceUrl?, message?` | Grant a user, group, or org access. `notify` defaults to true for individual user shares; `resourceUrl` can provide the direct app link and `message` an optional short note for the notification email. | | `unshare-resource` | `resourceType, resourceId, principalType, principalId` | Revoke access. | | `list-resource-shares` | `resourceType, resourceId` | Current visibility + all share grants. | | `set-resource-visibility` | `resourceType, resourceId, visibility` | Change to `private` / `org` / `public`. | Both the agent and the UI use these same actions. The agent calls them as tools; UI code should use `ShareButton` / `ShareDialog` or the action client hooks instead of hand-writing route calls. To re-skin the share notification email for the whole app, register `overrideTransactionalEmail("core.resource-shared", render)` from a server plugin. Do not fork `share-resource` or add another per-resource hook: the registration's `getBrandName` / `getLogoUrl` / `getSender` / `getHeroHtml` / `getShareEmailExtras` hooks still feed the default template and the override's props. See `/docs/deployment#email-templates`. ## Migration pattern for existing tables When retrofitting an existing resource table: 1. Add `owner_email`, `org_id`, `visibility` columns (defaults `'local@localhost'`, `NULL`, `'private'`). 2. Backfill `owner_email` from any prior creator trail; otherwise leave the default. 3. Add the companion `{type}_shares` table. 4. Register via `registerShareableResource`. 5. Update list/read actions to use `accessFilter`. 6. Update update/delete actions to `assertAccess` with the correct role. 7. Add `<ShareButton>` to the resource header. 8. Add `getResourcePath` in the registration so agent-triggered shares can email a direct link even when no UI supplied `resourceUrl`. ## Templates that opt out Sharing doesn't apply to: - **Personal-data apps** (mail) — user-scoped by design. - **External source-of-truth data** — apply the access policy enforced by the upstream system. - **Demo/boilerplate** (starter) — no resources. For these, add a short note to the template's `AGENTS.md` explaining why. ## Debugging - `ForbiddenError` from an action means the current user isn't owner / hasn't been shared / can't meet the role bar. - If the agent can't see a resource it just created, check that the insert actually set `owner_email` from the request context. - If a share doesn't take effect in the UI, confirm the template's `list-*` action uses `accessFilter` — the share rows are there but nothing is reading them yet.