@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/classes/RBACAuditManager.md

@@ -0,0 +1,299 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RBACAuditManager
+
+# Class: RBACAuditManager
+
+Defined in: [rbac/audit.ts:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L112)
+
+RBAC Audit Manager
+
+Handles emission of structured audit events for all RBAC operations.
+
+## Constructors
+
+### Constructor
+
+> **new RBACAuditManager**(`supabase`, `useBatching?`, `batchConfig?`): `RBACAuditManager`
+
+Defined in: [rbac/audit.ts:119](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L119)
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`\<`Database`\>
+
+##### useBatching?
+
+`boolean` = `true`
+
+##### batchConfig?
+
+###### batchWindow?
+
+`number`
+
+###### batchSize?
+
+`number`
+
+#### Returns
+
+`RBACAuditManager`
+
+## Methods
+
+### setEnabled()
+
+> **setEnabled**(`enabled`): `void`
+
+Defined in: [rbac/audit.ts:136](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L136)
+
+Enable or disable audit logging
+
+#### Parameters
+
+##### enabled
+
+`boolean`
+
+Whether to enable audit logging
+
+#### Returns
+
+`void`
+
+***
+
+### isEnabled()
+
+> **isEnabled**(): `boolean`
+
+Defined in: [rbac/audit.ts:145](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L145)
+
+Check if audit logging is enabled
+
+#### Returns
+
+`boolean`
+
+True if audit logging is enabled
+
+***
+
+### setFallbackEnabled()
+
+> **setFallbackEnabled**(`enabled`): `void`
+
+Defined in: [rbac/audit.ts:154](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L154)
+
+Enable or disable fallback logging (console logging when database fails)
+
+#### Parameters
+
+##### enabled
+
+`boolean`
+
+Whether to enable fallback logging
+
+#### Returns
+
+`void`
+
+***
+
+### emitEvent()
+
+> **emitEvent**(`event`): `Promise`\<`void`\>
+
+Defined in: [rbac/audit.ts:164](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L164)
+
+Emit an audit event
+
+#### Parameters
+
+##### event
+
+`AuditEventPayload`
+
+Audit event payload
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when event is logged
+
+***
+
+### emitPermissionCheck()
+
+> **emitPermissionCheck**(`event`): `Promise`\<`void`\>
+
+Defined in: [rbac/audit.ts:296](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L296)
+
+Emit a permission check audit event
+
+#### Parameters
+
+##### event
+
+`Omit`\<`PermissionCheckAuditEvent`, `"type"`\>
+
+Permission check event data
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### emitPermissionDenied()
+
+> **emitPermissionDenied**(`event`): `Promise`\<`void`\>
+
+Defined in: [rbac/audit.ts:308](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L308)
+
+Emit a permission denied audit event
+
+#### Parameters
+
+##### event
+
+`Omit`\<`PermissionDeniedAuditEvent`, `"type"`\>
+
+Permission denied event data
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### emitRoleGranted()
+
+> **emitRoleGranted**(`event`): `Promise`\<`void`\>
+
+Defined in: [rbac/audit.ts:320](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L320)
+
+Emit a role granted audit event
+
+#### Parameters
+
+##### event
+
+`Omit`\<`RoleGrantedAuditEvent`, `"type"`\>
+
+Role granted event data
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### emitRoleRevoked()
+
+> **emitRoleRevoked**(`event`): `Promise`\<`void`\>
+
+Defined in: [rbac/audit.ts:332](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L332)
+
+Emit a role revoked audit event
+
+#### Parameters
+
+##### event
+
+`Omit`\<`RoleRevokedAuditEvent`, `"type"`\>
+
+Role revoked event data
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### emitRLSDenied()
+
+> **emitRLSDenied**(`event`): `Promise`\<`void`\>
+
+Defined in: [rbac/audit.ts:344](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L344)
+
+Emit an RLS denied audit event
+
+#### Parameters
+
+##### event
+
+`Omit`\<`RLSDeniedAuditEvent`, `"type"`\>
+
+RLS denied event data
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### getUserAuditEvents()
+
+> **getUserAuditEvents**(`userId`, `limit?`): `Promise`\<`RBACAuditEvent`[]\>
+
+Defined in: [rbac/audit.ts:358](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L358)
+
+Get audit events for a user
+
+#### Parameters
+
+##### userId
+
+`string`
+
+User ID
+
+##### limit?
+
+`number` = `100`
+
+Maximum number of events to return
+
+#### Returns
+
+`Promise`\<`RBACAuditEvent`[]\>
+
+Promise resolving to audit events
+
+***
+
+### getOrganisationAuditEvents()
+
+> **getOrganisationAuditEvents**(`organisationId`, `limit?`): `Promise`\<`RBACAuditEvent`[]\>
+
+Defined in: [rbac/audit.ts:403](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L403)
+
+Get audit events for an organisation
+
+#### Parameters
+
+##### organisationId
+
+`string`
+
+Organisation ID
+
+##### limit?
+
+`number` = `100`
+
+Maximum number of events to return
+
+#### Returns
+
+`Promise`\<`RBACAuditEvent`[]\>
+
+Promise resolving to audit events

package/docs/api/classes/RBACCache.md

@@ -0,0 +1,389 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RBACCache
+
+# Class: RBACCache
+
+Defined in: [rbac/cache.ts:19](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L19)
+
+In-memory cache for RBAC operations
+
+Provides two-tier caching:
+- Short-term cache: 120 seconds for frequently changing permissions
+- Session cache: 15 minutes for stable permissions (page-level checks)
+
+## Constructors
+
+### Constructor
+
+> **new RBACCache**(): `RBACCache`
+
+#### Returns
+
+`RBACCache`
+
+## Methods
+
+### get()
+
+> **get**\<`T`\>(`key`, `useSessionCache?`): `T` \| `null`
+
+Defined in: [rbac/cache.ts:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L35)
+
+Get a value from the cache
+
+Checks both short-term cache and session cache.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### key
+
+`string`
+
+Cache key
+
+##### useSessionCache?
+
+`boolean` = `true`
+
+Whether to check session cache (default: true)
+
+#### Returns
+
+`T` \| `null`
+
+Cached value or null if not found/expired
+
+***
+
+### set()
+
+> **set**\<`T`\>(`key`, `data`, `ttl?`, `useSessionCache?`): `void`
+
+Defined in: [rbac/cache.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L69)
+
+Set a value in the cache
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### key
+
+`string`
+
+Cache key
+
+##### data
+
+`T`
+
+Data to cache
+
+##### ttl?
+
+`number` = `...`
+
+Time to live in milliseconds (defaults to 60s)
+
+##### useSessionCache?
+
+`boolean` = `false`
+
+Whether to also store in session cache (default: false for page-level checks)
+
+#### Returns
+
+`void`
+
+***
+
+### delete()
+
+> **delete**(`key`): `void`
+
+Defined in: [rbac/cache.ts:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L95)
+
+Delete a specific key from the cache
+
+#### Parameters
+
+##### key
+
+`string`
+
+Cache key to delete
+
+#### Returns
+
+`void`
+
+***
+
+### invalidate()
+
+> **invalidate**(`pattern`): `void`
+
+Defined in: [rbac/cache.ts:105](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L105)
+
+Invalidate cache entries matching a pattern
+
+#### Parameters
+
+##### pattern
+
+`string`
+
+Pattern to match against cache keys
+
+#### Returns
+
+`void`
+
+***
+
+### clear()
+
+> **clear**(): `void`
+
+Defined in: [rbac/cache.ts:153](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L153)
+
+Clear all cache entries
+
+#### Returns
+
+`void`
+
+***
+
+### getStats()
+
+> **getStats**(): `object`
+
+Defined in: [rbac/cache.ts:161](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L161)
+
+Get cache statistics
+
+#### Returns
+
+`object`
+
+##### size
+
+> **size**: `number`
+
+##### sessionSize
+
+> **sessionSize**: `number`
+
+##### ttl
+
+> **ttl**: `number`
+
+##### sessionTtl
+
+> **sessionTtl**: `number`
+
+##### keys
+
+> **keys**: `string`[]
+
+***
+
+### onInvalidate()
+
+> **onInvalidate**(`callback`): () => `void`
+
+Defined in: [rbac/cache.ts:182](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L182)
+
+Add an invalidation callback
+
+#### Parameters
+
+##### callback
+
+(`pattern`) => `void`
+
+Function to call when cache is invalidated
+
+#### Returns
+
+> (): `void`
+
+##### Returns
+
+`void`
+
+***
+
+### generateKey()
+
+> `static` **generateKey**(`userId`, `permission`, `organisationId?`, `eventId?`, `appId?`, `pageId?`): `string`
+
+Defined in: [rbac/cache.ts:202](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L202)
+
+Generate cache key for permission check (simplified signature)
+
+#### Parameters
+
+##### userId
+
+`string`
+
+User ID
+
+##### permission
+
+`string`
+
+Permission string
+
+##### organisationId?
+
+`string`
+
+Organisation ID (optional)
+
+##### eventId?
+
+`string`
+
+Event ID (optional)
+
+##### appId?
+
+`string`
+
+App ID (optional)
+
+##### pageId?
+
+`string`
+
+Page ID (optional)
+
+#### Returns
+
+`string`
+
+String cache key
+
+***
+
+### generatePermissionKey()
+
+> `static` **generatePermissionKey**(`key`): `string`
+
+Defined in: [rbac/cache.ts:229](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L229)
+
+Generate cache key for permission check (object signature)
+
+#### Parameters
+
+##### key
+
+`PermissionCacheKey`
+
+Permission cache key object
+
+#### Returns
+
+`string`
+
+String cache key
+
+***
+
+### generateAccessLevelKey()
+
+> `static` **generateAccessLevelKey**(`userId`, `organisationId`, `eventId?`, `appId?`): `string`
+
+Defined in: [rbac/cache.ts:252](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L252)
+
+Generate cache key for access level
+
+#### Parameters
+
+##### userId
+
+`string`
+
+User ID
+
+##### organisationId
+
+`string`
+
+Organisation ID
+
+##### eventId?
+
+`string`
+
+Event ID (optional)
+
+##### appId?
+
+`string`
+
+App ID (optional)
+
+#### Returns
+
+`string`
+
+String cache key
+
+***
+
+### generatePermissionMapKey()
+
+> `static` **generatePermissionMapKey**(`userId`, `organisationId`, `eventId?`, `appId?`): `string`
+
+Defined in: [rbac/cache.ts:278](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L278)
+
+Generate cache key for permission map
+
+#### Parameters
+
+##### userId
+
+`string`
+
+User ID
+
+##### organisationId
+
+`string`
+
+Organisation ID
+
+##### eventId?
+
+`string`
+
+Event ID (optional)
+
+##### appId?
+
+`string`
+
+App ID (optional)
+
+#### Returns
+
+`string`
+
+String cache key