middleware/utils

Type Aliases

Router

type Router = Record<string, {
  excludePaths: string[];
  handler: MiddlewareHandler;
}>;

Defined in: studiocms/packages/studiocms/src/middleware/utils.ts:11^

Middleware Router Type.

Functions

defineMiddlewareRouter()

function defineMiddlewareRouter(router: Router): MiddlewareHandler

Defined in: studiocms/packages/studiocms/src/middleware/utils.ts:24^

Define a middleware router that routes requests to different handlers based on the request path.

Parameters

router

Router

Returns

MiddlewareHandler

Example

const router: Router = {};
router["/"] = (context, next) => {};
router["/about"] = (context, next) => {};
export const onRequest = defineMiddlewareRouter(router);

---

getUserPermissions()

function getUserPermissions(userData: UserSessionData): Effect<AEff, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, E, _R>>] ? E : never, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, _E, R>>] ? R : never>

Defined in: studiocms/packages/studiocms/src/middleware/utils.ts:49^

Retrieves the user’s permission levels based on their session data.

Parameters

userData

UserSessionData

The session data of the user.

Returns

Effect<AEff, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, E, _R>>] ? E : never, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, _E, R>>] ? R : never>

An object containing boolean flags indicating the user’s permission levels:

• isVisitor: True if the user has at least visitor-level permissions.
• isEditor: True if the user has at least editor-level permissions.
• isAdmin: True if the user has at least admin-level permissions.
• isOwner: True if the user has owner-level permissions.