Naming

PermDock has one naming rule: the brand is the noun. The decision object is a PermDock, the variable is permdock, the factory is createPermDock, and the import path, not the identifier, says which framework you are in. Every package, docs page, skill, error message and example follows this page.

The three core namesCopy Anchor Link

import { createPermDock } from "permdock"; // core: PermDock
import { createPermDock } from "permdock/next"; // Next.js: { getPermDock, getPermission, getSnapshot, requireAccess, PermDockProvider, permdockHandler }
import { createPermDock } from "permdock/hono"; // Hono: { permdock, protect }
import { createPermDock } from "permdock/mcp"; // MCP: { protectServer }

There is no NextDock, HonoDock, createNextPermDock or createMcpPermDock. When two adapters are used in one file, alias at the import: import { createPermDock as createHonoPermDock } from 'permdock/hono'.

use* on the client, get* on the serverCopy Anchor Link

React reads permissions synchronously from a snapshot; servers resolve them asynchronously per request. PermDock follows the duality next-intl uses for useTranslations / getTranslations and useExtracted / getExtracted:

The client hooks and <Protected> are direct exports with no factory: the permission reference carries all the types, so usePermission(permissions.post.update, post) is fully typed without a generic wrapper. Only the server side needs a factory, because only the server holds the policy. describe(decision) is a framework-free core export used by every UI adapter and by Problem Details (UI). Vue keeps the use* composable names. Svelte does not: it exports setPermDock / getPermDock and readable stores (permission, permissions, filter, tenant, …) because Svelte has no React-style hooks. Solid uses accessor functions. The UI parity table lists them.

Definition and policy vocabularyCopy Anchor Link

Strings appear only as .key and .scope on the wire, in audit events and in catalogs. The public API takes references.

The subjectFrom<Provider> pattern names the source of the material (a JWT, a Supabase claims object, a Clerk auth object, a Better Auth session, MCP authInfo), always returns a Subject (anonymous when the material cannot be trusted) and never throws, so every provider reads the same way at the call site: createPermDock(policy, subjectFromClerk(await auth())). See Authentication and PermDock.

Reserved wordsCopy Anchor Link

These never appear as public identifiers, for the reasons given:

What each adapter's createPermDock returnsCopy Anchor Link

These entries deliberately do not export createPermDock:

• permdock/react and permdock/react-native export PermDockProvider, usePermDock, usePermission, usePermissions, useFilter, useTenant, useMemberships, useRoles, useAssignableRoles, useAssignablePermissions, useApproval, useSubject, useDescribe and <Protected> directly. permdock/react-native adds subjectId (required, null when signed out), the storage wrappers memoryStorage, secureStoreStorage and mmkvStorage, the subscriptions appStateForeground and netInfoOnline, the Expo Router guards usePermissionGuard and useSnapshotReady, and the snapshot sources localSnapshot and powersyncSource. permdock/vue exports permdockPlugin plus the same composable names and <Protected>. permdock/svelte and permdock/solid keep the same surface under each framework's idiom.
• permdock/better-auth, permdock/clerk and permdock/supabase export their subjectFrom* mapper and, where the provider stores roles, a <provider>RoleSource; both are values you pass to a factory.
• permdock/webmcp exports registerTools(document.modelContext, group, { permdock }) because it consumes a client PermDock rather than creating one. permdock/drizzle, permdock/prisma and permdock/kysely export toWhere. permdock/prisma also exports permdockExtension, resolveRelated, toPredicate and prismaModelFields. All three also export withSubject and checkRow. permdock/jwt exports subjectFromJwt, createJwtSubjectResolver, verifyDpopProof, joseTokenVerifier and joseTokenSigner because it produces subjects, verifiers and signers for a factory, not an instance. Structurally typed providers (permdock/supabase, permdock/clerk, permdock/better-auth, permdock/convex, permdock/prisma, permdock/mcp, permdock/react-native) declare no peer dependency: they duck-type the SDK you already installed. permdock/supabase/middleware is the exception on the Supabase side: it calls defineMiddleware, so @supabase/middleware is its optional peer, while @supabase/server's JWTClaims is still duck-typed.
• permdock/approvals exports memoryApprovalStore and approvalsHandler, and permdock/cloud exports cloud; both produce values you pass to a factory (store, sink, policies) or a client provider (source) rather than a PermDock.
• permdock/testing, permdock/testing/saas and permdock/testing/saas/permissions export the test runners (describePolicy, the test<Interface> runners, rlsParity, ormParity, testClientParity, testHttpAdapter, testAuthZen) and the shared SaaS domain. Test files import them; application entries never do, and Vitest is an optional peer.
• permdock/cli exports defineConfig (for permdock.config.ts) and run (the permdock binary as a function) plus the config types, and parseHookMarker / parseGrantsMarker with their result types SupabaseHookMarker / SupabaseGrantsMarker. It is a build-time entry: no runtime entry imports it.
• Build hooks: permdock/next/plugin exports createPermDockPlugin and permdock/unplugin exports createPermDockUnplugin (Vite, Rollup, webpack, Rspack, esbuild through unplugin). Both run collect at build time and never wire runtime API. The create prefix and the PermDock noun follow the factory rule; the suffix names the host (Plugin for Next's config API, Unplugin for the bundler family).

Names shared on purposeCopy Anchor Link

• PermDock methods and snapshot fields share a name when the field is the method's result serialized: permdock.actions(resource) and snapshot.actions, permdock.audiences() and snapshot.audiences, permdock.snapshot() and a snapshot option or prop, permdock.tenant(id) and principal.tenant. The method is on the instance; the field is the wire form a client hydrates from.
• One name can be exported by several entries with that entry's meaning, like createPermDock. PermDockPluginOptions is the build plugin's options in permdock/next/plugin and permdock/unplugin, and the Vue app plugin's options in permdock/vue.
• Every adapter returns <Adapter>PermDock from createPermDock and takes <Adapter>PermDockOptions, rather than <Prefix><Thing>, so the adapter is the first word wherever both appear (recorded in the repository's docs/decisions/0019-adapter-suffix-and-no-dollar-members.md).

Spec namesCopy Anchor Link

PermDock's subject vocabulary is TypeScript, camelCase and typed; the specifications it consumes are JSON claims with short registered names. subject fixes the rule: where a spec name exists, PermDock either uses it verbatim or maps to it exactly once, in the table below and on subject; PermDock never coins a second spelling for a concept a specification already names.

Files and foldersCopy Anchor Link

• The server factory lives in src/permdock/server.ts in every example. The definition is src/permissions.ts; the policy is src/policy.ts; generated definitions are src/permissions.generated.ts.
• Example apps are apps/examples/<adapter>; the docs page is /docs/adapters/<adapter>; the source folder is packages/permdock/src/<adapter>. The same short name is used in all three.
• Errors are PermDockDeniedError, PermDockApprovalRequiredError and PermDockValidationError. Problem Details type URIs end in /denied, /approval-required and /validation. The first two carry digest (React's name for the property that survives the Server Component boundary): PERMDOCK_DENIED;<permission> and PERMDOCK_APPROVAL_REQUIRED;<permission>;<token>, read with parsePermDockDigest.

Renamed before 0.1.0Copy Anchor Link