@prsm/auth 1.0.0

package/types/user-roles.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Define a set of named roles as a frozen bitmask map. Each role gets the next
+ * power-of-two bit. Capped at 31 because postgres INTEGER is 32-bit signed.
+ *
+ * @param {...string} names
+ * @returns {Readonly<Record<string, number>>}
+ */
+export function defineRoles(...names: string[]): Readonly<Record<string, number>>;
+/**
+ * Add a role to a user's account using bitwise OR.
+ *
+ * @param {AuthConfig} config
+ * @param {UserIdentifier} identifier
+ * @param {number} role
+ * @throws {UserNotFoundError}
+ */
+export function addRoleToUser(config: AuthConfig, identifier: UserIdentifier, role: number): Promise<void>;
+/**
+ * Remove a role from a user's account using bitwise operations.
+ *
+ * @param {AuthConfig} config
+ * @param {UserIdentifier} identifier
+ * @param {number} role
+ * @throws {UserNotFoundError}
+ */
+export function removeRoleFromUser(config: AuthConfig, identifier: UserIdentifier, role: number): Promise<void>;
+/**
+ * Set a user's complete role mask, replacing any existing roles.
+ *
+ * @param {AuthConfig} config
+ * @param {UserIdentifier} identifier
+ * @param {number} rolemask
+ * @throws {UserNotFoundError}
+ */
+export function setUserRoles(config: AuthConfig, identifier: UserIdentifier, rolemask: number): Promise<void>;
+/**
+ * Get a user's current role mask.
+ *
+ * @param {AuthConfig} config
+ * @param {UserIdentifier} identifier
+ * @returns {Promise<number>}
+ * @throws {UserNotFoundError}
+ */
+export function getUserRoles(config: AuthConfig, identifier: UserIdentifier): Promise<number>;
+export type AuthConfig = import("./types.js").AuthConfig;
+export type AuthAccount = import("./types.js").AuthAccount;
+export type UserIdentifier = import("./types.js").UserIdentifier;

package/types/util.d.ts

@@ -0,0 +1,3 @@
+export function isValidEmail(email: string): boolean;
+export function validateEmail(email: string): void;
+export function createMapFromEnum(enumObj: Record<string, number>): Record<number, string>;