@jmruthers/pace-core 0.6.2 → 0.6.4

package/docs/api/classes/RBACCache.md

@@ -1,322 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACCache
-
-# Class: RBACCache
-
-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)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](RBACCache.md#constructor)
-
-### Methods
-
-- [get](RBACCache.md#get)
-- [set](RBACCache.md#set)
-- [delete](RBACCache.md#delete)
-- [invalidate](RBACCache.md#invalidate)
-- [clear](RBACCache.md#clear)
-- [getStats](RBACCache.md#getstats)
-- [onInvalidate](RBACCache.md#oninvalidate)
-- [generateKey](RBACCache.md#generatekey)
-- [generatePermissionKey](RBACCache.md#generatepermissionkey)
-- [generateAccessLevelKey](RBACCache.md#generateaccesslevelkey)
-- [generatePermissionMapKey](RBACCache.md#generatepermissionmapkey)
-
-## Constructors
-
-### constructor
-
-• **new RBACCache**(): [`RBACCache`](RBACCache.md)
-
-#### Returns
-
-[`RBACCache`](RBACCache.md)
-
-## Methods
-
-### get
-
-▸ **get**\<`T`\>(`key`, `useSessionCache?`): ``null`` \| `T`
-
-Get a value from the cache
-
-Checks both short-term cache and session cache.
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `key` | `string` | `undefined` | Cache key |
-| `useSessionCache` | `boolean` | `true` | Whether to check session cache (default: true) |
-
-#### Returns
-
-``null`` \| `T`
-
-Cached value or null if not found/expired
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L36)
-
-___
-
-### set
-
-▸ **set**\<`T`\>(`key`, `data`, `ttl?`, `useSessionCache?`): `void`
-
-Set a value in the cache
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `key` | `string` | `undefined` | Cache key |
-| `data` | `T` | `undefined` | Data to cache |
-| `ttl` | `number` | `undefined` | 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`
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L70)
-
-___
-
-### delete
-
-▸ **delete**(`key`): `void`
-
-Delete a specific key from the cache
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `key` | `string` | Cache key to delete |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L96)
-
-___
-
-### invalidate
-
-▸ **invalidate**(`pattern`): `void`
-
-Invalidate cache entries matching a pattern
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `pattern` | `string` | Pattern to match against cache keys |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L106)
-
-___
-
-### clear
-
-▸ **clear**(): `void`
-
-Clear all cache entries
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:154](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L154)
-
-___
-
-### getStats
-
-▸ **getStats**(): `Object`
-
-Get cache statistics
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `size` | `number` |
-| `sessionSize` | `number` |
-| `ttl` | `number` |
-| `sessionTtl` | `number` |
-| `keys` | `string`[] |
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:162](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L162)
-
-___
-
-### onInvalidate
-
-▸ **onInvalidate**(`callback`): () => `void`
-
-Add an invalidation callback
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | (`pattern`: `string`) => `void` | Function to call when cache is invalidated |
-
-#### Returns
-
-`fn`
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:183](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L183)
-
-___
-
-### generateKey
-
-▸ **generateKey**(`userId`, `permission`, `organisationId?`, `eventId?`, `appId?`, `pageId?`): `string`
-
-Generate cache key for permission check (simplified signature)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `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
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:203](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L203)
-
-___
-
-### generatePermissionKey
-
-▸ **generatePermissionKey**(`key`): `string`
-
-Generate cache key for permission check (object signature)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `key` | `PermissionCacheKey` | Permission cache key object |
-
-#### Returns
-
-`string`
-
-String cache key
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:230](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L230)
-
-___
-
-### generateAccessLevelKey
-
-▸ **generateAccessLevelKey**(`userId`, `organisationId`, `eventId?`, `appId?`): `string`
-
-Generate cache key for access level
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `userId` | `string` | User ID |
-| `organisationId` | `string` | Organisation ID |
-| `eventId?` | `string` | Event ID (optional) |
-| `appId?` | `string` | App ID (optional) |
-
-#### Returns
-
-`string`
-
-String cache key
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:253](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L253)
-
-___
-
-### generatePermissionMapKey
-
-▸ **generatePermissionMapKey**(`userId`, `organisationId`, `eventId?`, `appId?`): `string`
-
-Generate cache key for permission map
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `userId` | `string` | User ID |
-| `organisationId` | `string` | Organisation ID |
-| `eventId?` | `string` | Event ID (optional) |
-| `appId?` | `string` | App ID (optional) |
-
-#### Returns
-
-`string`
-
-String cache key
-
-#### Defined in
-
-[packages/core/src/rbac/cache.ts:279](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/cache.ts#L279)