definePermissions

Call Signature

definePermissions<TRoles>(config): Permissions<TRoles>

Defined in: packages/permissions/src/define-permissions.ts:57

Creates a permission configuration that can be shared between server-side enforcement (@cfast/db) and client-side introspection (@cfast/actions).

Supports two calling styles:

• Direct: definePermissions(config) when no custom user type is needed.
• Curried: definePermissions<MyUser>()(config) to get typed where clause user parameters.

Type Parameters

TRoles

TRoles extends readonly string[]

Parameters

config

PermissionsConfig<TRoles>

The permissions configuration with roles, grants, and optional hierarchy.

Returns

Permissions<TRoles>

A Permissions object containing roles, raw grants, and hierarchy-expanded resolvedGrants.

Example

import { definePermissions, grant } from "@cfast/permissions";
import { eq } from "drizzle-orm";
import { posts, comments } from "./schema";

const permissions = definePermissions({
  roles: ["anonymous", "user", "admin"] as const,
  grants: {
    anonymous: [
      grant("read", posts, { where: (p) => eq(p.published, true) }),
    ],
    user: [
      grant("read", posts),
      grant("create", posts),
      grant("update", posts, { where: (p, u) => eq(p.authorId, u.id) }),
    ],
    admin: [grant("manage", "all")],
  },
});

Call Signature

definePermissions<TUser>(): <TRoles>(config) => Permissions<TRoles>

Defined in: packages/permissions/src/define-permissions.ts:60

Creates a permission configuration that can be shared between server-side enforcement (@cfast/db) and client-side introspection (@cfast/actions).

Supports two calling styles:

• Direct: definePermissions(config) when no custom user type is needed.
• Curried: definePermissions<MyUser>()(config) to get typed where clause user parameters.

Type Parameters

TUser

TUser

Returns

A Permissions object containing roles, raw grants, and hierarchy-expanded resolvedGrants.

<TRoles>(config): Permissions<TRoles>

Type Parameters

TRoles

TRoles extends readonly string[]

Parameters

config

PermissionsConfig<TRoles, TUser>

Returns

Permissions<TRoles>

Example

import { definePermissions, grant } from "@cfast/permissions";
import { eq } from "drizzle-orm";
import { posts, comments } from "./schema";

const permissions = definePermissions({
  roles: ["anonymous", "user", "admin"] as const,
  grants: {
    anonymous: [
      grant("read", posts, { where: (p) => eq(p.published, true) }),
    ],
    user: [
      grant("read", posts),
      grant("create", posts),
      grant("update", posts, { where: (p, u) => eq(p.authorId, u.id) }),
    ],
    admin: [grant("manage", "all")],
  },
});