@enonic/js-utils/types/Auth.d.ts

Enonic XP JavaScript Utils

import type {LiteralUnion} from 'type-fest';
import type {
	GroupKey,
	RoleKey,
	UserKey,
} from '/lib/xp/auth';
import type {AccessControlEntry} from '/lib/xp/node';

// This wouldn't break backwards compatibility, but "loosens" the type, loosing good suggestions.
// Perhaps the best solution would be to move the generics and constans below into @enonic-types/core
// export type {
// 	PrincipalKey,
// } from '@enonic-types/core';

export type {Permission} from '/lib/xp/node';

//──────────────────────────────────────────────────────────────────────────────
// Generics
//──────────────────────────────────────────────────────────────────────────────
export type RoleKeyGeneric<T extends string> = `role:${T}`

export type UserKeyGeneric<
	IdProvider extends string,
	Login extends string
> = `user:${IdProvider}:${Login}`;


//──────────────────────────────────────────────────────────────────────────────
// Extenstions
//──────────────────────────────────────────────────────────────────────────────
export type RoleKeySystemAdmin = RoleKeyGeneric<'system.admin'>
export type RoleKeySystemAdminLogin = RoleKeyGeneric<'system.admin.login'>
export type RoleKeySystemAuthenticated = RoleKeyGeneric<'system.authenticated'>
export type RoleKeySystemAuditlog = RoleKeyGeneric<'system.auditlog'>
export type RoleKeySystemEveryone = RoleKeyGeneric<'system.everyone'>
export type RoleKeySystemUserAdmin = RoleKeyGeneric<'system.user.admin'>
export type RoleKeySystemUserApp = RoleKeyGeneric<'system.user.app'>

export type UserKeySystemSu = UserKeyGeneric<'system','su'>

export type PrincipalKeySystem =
	| RoleKeySystemEveryone
	| RoleKeySystemAuthenticated
	| RoleKeySystemAdmin
	| RoleKeySystemAdminLogin
	| RoleKeySystemAuditlog
	| RoleKeySystemUserAdmin
	| RoleKeySystemUserApp
	| UserKeySystemSu

export type PrincipalKey = LiteralUnion<
	PrincipalKeySystem,
	| GroupKey
	| RoleKey
	| UserKey
>

//──────────────────────────────────────────────────────────────────────────────
// Backwards compatibility
//──────────────────────────────────────────────────────────────────────────────
export type PrincipalKeyUser = UserKey;
export type PrincipalKeyGroup = GroupKey;
export type PrincipalKeyRole = RoleKey;
export type PermissionsParams = AccessControlEntry