@jmruthers/pace-core 0.5.1 → 0.5.3

package/docs/api/classes/RBACEngine.md

@@ -0,0 +1,141 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / RBACEngine
+
+# Class: RBACEngine
+
+RBAC Engine
+
+Implements the core permission algorithm with deny-overrides-allow precedence.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](RBACEngine.md#constructor)
+
+### Methods
+
+- [isPermitted](RBACEngine.md#ispermitted)
+- [getAccessLevel](RBACEngine.md#getaccesslevel)
+- [getPermissionMap](RBACEngine.md#getpermissionmap)
+- [getAppConfig](RBACEngine.md#getappconfig)
+
+## Constructors
+
+### constructor
+
+• **new RBACEngine**(`supabase`): [`RBACEngine`](RBACEngine.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `supabase` | `default`\<`Database`, ``"public"``, ``"public"``, `never`, {}\> |
+
+#### Returns
+
+[`RBACEngine`](RBACEngine.md)
+
+#### Defined in
+
+[packages/core/src/rbac/engine.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/engine.ts#L52)
+
+## Methods
+
+### isPermitted
+
+▸ **isPermitted**(`input`, `securityContext?`): `Promise`\<`boolean`\>
+
+Check if a user has a specific permission
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `input` | [`PermissionCheck`](../modules.md#permissioncheck) | Permission check input |
+| `securityContext?` | `SecurityContext` | Optional security context for enhanced validation |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise resolving to permission result
+
+#### Defined in
+
+[packages/core/src/rbac/engine.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/engine.ts#L64)
+
+___
+
+### getAccessLevel
+
+▸ **getAccessLevel**(`input`): `Promise`\<[`AccessLevel`](../modules.md#accesslevel)\>
+
+Get user's access level in a scope
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `input` | `Object` | Access level input |
+| `input.userId` | `string` | - |
+| `input.scope` | [`Scope`](../modules.md#scope) | - |
+
+#### Returns
+
+`Promise`\<[`AccessLevel`](../modules.md#accesslevel)\>
+
+Promise resolving to access level
+
+#### Defined in
+
+[packages/core/src/rbac/engine.ts:298](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/engine.ts#L298)
+
+___
+
+### getPermissionMap
+
+▸ **getPermissionMap**(`input`): `Promise`\<[`PermissionMap`](../modules.md#permissionmap)\>
+
+Get user's permission map for a scope
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `input` | `Object` | Permission map input |
+| `input.userId` | `string` | - |
+| `input.scope` | [`Scope`](../modules.md#scope) | - |
+
+#### Returns
+
+`Promise`\<[`PermissionMap`](../modules.md#permissionmap)\>
+
+Promise resolving to permission map
+
+#### Defined in
+
+[packages/core/src/rbac/engine.ts:361](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/engine.ts#L361)
+
+___
+
+### getAppConfig
+
+▸ **getAppConfig**(`appId`): `Promise`\<``null`` \| \{ `requires_event`: `boolean`  }\>
+
+Get app configuration including requires_event setting
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appId` | `string` | App ID |
+
+#### Returns
+
+`Promise`\<``null`` \| \{ `requires_event`: `boolean`  }\>
+
+Promise resolving to app configuration
+
+#### Defined in
+
+[packages/core/src/rbac/engine.ts:461](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/engine.ts#L461)

package/docs/api/classes/RBACError.md

@@ -0,0 +1,76 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / RBACError
+
+# Class: RBACError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`RBACError`**
+
+  ↳↳ [`PermissionDeniedError`](PermissionDeniedError.md)
+
+  ↳↳ [`OrganisationContextRequiredError`](OrganisationContextRequiredError.md)
+
+  ↳↳ [`RBACNotInitializedError`](RBACNotInitializedError.md)
+
+  ↳↳ [`InvalidScopeError`](InvalidScopeError.md)
+
+  ↳↳ [`MissingUserContextError`](MissingUserContextError.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](RBACError.md#constructor)
+
+### Properties
+
+- [code](RBACError.md#code)
+- [context](RBACError.md#context)
+
+## Constructors
+
+### constructor
+
+• **new RBACError**(`message`, `code`, `context?`): [`RBACError`](RBACError.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+| `code` | `string` |
+| `context?` | `Record`\<`string`, `any`\> |
+
+#### Returns
+
+[`RBACError`](RBACError.md)
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[packages/core/src/rbac/types.ts:283](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L283)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/types.ts:285](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L285)
+
+___
+
+### context
+
+• `Optional` **context**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[packages/core/src/rbac/types.ts:286](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L286)

package/docs/api/classes/RBACNotInitializedError.md

@@ -0,0 +1,66 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / RBACNotInitializedError
+
+# Class: RBACNotInitializedError
+
+## Hierarchy
+
+- [`RBACError`](RBACError.md)
+
+  ↳ **`RBACNotInitializedError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](RBACNotInitializedError.md#constructor)
+
+### Properties
+
+- [code](RBACNotInitializedError.md#code)
+- [context](RBACNotInitializedError.md#context)
+
+## Constructors
+
+### constructor
+
+• **new RBACNotInitializedError**(): [`RBACNotInitializedError`](RBACNotInitializedError.md)
+
+#### Returns
+
+[`RBACNotInitializedError`](RBACNotInitializedError.md)
+
+#### Overrides
+
+[RBACError](RBACError.md).[constructor](RBACError.md#constructor)
+
+#### Defined in
+
+[packages/core/src/rbac/types.ts:315](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L315)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+#### Inherited from
+
+[RBACError](RBACError.md).[code](RBACError.md#code)
+
+#### Defined in
+
+[packages/core/src/rbac/types.ts:285](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L285)
+
+___
+
+### context
+
+• `Optional` **context**: `Record`\<`string`, `any`\>
+
+#### Inherited from
+
+[RBACError](RBACError.md).[context](RBACError.md#context)
+
+#### Defined in
+
+[packages/core/src/rbac/types.ts:286](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L286)

package/docs/api/classes/SecureSupabaseClient.md

@@ -0,0 +1,135 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / SecureSupabaseClient
+
+# Class: SecureSupabaseClient
+
+Secure Supabase Client that enforces organisation context
+
+This client automatically injects organisation context into all requests
+and prevents queries that don't have the required context.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SecureSupabaseClient.md#constructor)
+
+### Methods
+
+- [getOrganisationId](SecureSupabaseClient.md#getorganisationid)
+- [getEventId](SecureSupabaseClient.md#geteventid)
+- [getAppId](SecureSupabaseClient.md#getappid)
+- [withContext](SecureSupabaseClient.md#withcontext)
+- [getClient](SecureSupabaseClient.md#getclient)
+
+## Constructors
+
+### constructor
+
+• **new SecureSupabaseClient**(`supabaseUrl`, `supabaseKey`, `organisationId`, `eventId?`, `appId?`): [`SecureSupabaseClient`](SecureSupabaseClient.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `supabaseUrl` | `string` |
+| `supabaseKey` | `string` |
+| `organisationId` | `string` |
+| `eventId?` | `string` |
+| `appId?` | `string` |
+
+#### Returns
+
+[`SecureSupabaseClient`](SecureSupabaseClient.md)
+
+#### Defined in
+
+[packages/core/src/rbac/secureClient.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/secureClient.ts#L30)
+
+## Methods
+
+### getOrganisationId
+
+▸ **getOrganisationId**(): `string`
+
+Get the current organisation ID
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[packages/core/src/rbac/secureClient.ts:151](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/secureClient.ts#L151)
+
+___
+
+### getEventId
+
+▸ **getEventId**(): `undefined` \| `string`
+
+Get the current event ID
+
+#### Returns
+
+`undefined` \| `string`
+
+#### Defined in
+
+[packages/core/src/rbac/secureClient.ts:158](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/secureClient.ts#L158)
+
+___
+
+### getAppId
+
+▸ **getAppId**(): `undefined` \| `string`
+
+Get the current app ID
+
+#### Returns
+
+`undefined` \| `string`
+
+#### Defined in
+
+[packages/core/src/rbac/secureClient.ts:165](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/secureClient.ts#L165)
+
+___
+
+### withContext
+
+▸ **withContext**(`updates`): [`SecureSupabaseClient`](SecureSupabaseClient.md)
+
+Create a new client with updated context
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `updates` | `Object` |
+| `updates.organisationId?` | `string` |
+| `updates.eventId?` | `string` |
+| `updates.appId?` | `string` |
+
+#### Returns
+
+[`SecureSupabaseClient`](SecureSupabaseClient.md)
+
+#### Defined in
+
+[packages/core/src/rbac/secureClient.ts:172](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/secureClient.ts#L172)
+
+___
+
+### getClient
+
+▸ **getClient**(): `default`\<`Database`, ``"public"``, ``"public"``, `never`, {}\>
+
+Get the underlying Supabase client (for internal use only)
+
+#### Returns
+
+`default`\<`Database`, ``"public"``, ``"public"``, `never`, {}\>
+
+#### Defined in
+
+[packages/core/src/rbac/secureClient.ts:190](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/secureClient.ts#L190)

package/docs/api/interfaces/AggregateConfig.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / AggregateConfig
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / AggregateConfig
 
 # Interface: AggregateConfig
 

package/docs/api/interfaces/ButtonProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / ButtonProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / ButtonProps
 
 # Interface: ButtonProps
 

package/docs/api/interfaces/CardProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / CardProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / CardProps
 
 # Interface: CardProps
 

package/docs/api/interfaces/ColorPalette.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / ColorPalette
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / ColorPalette
 
 # Interface: ColorPalette
 

package/docs/api/interfaces/ColorShade.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / ColorShade
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / ColorShade
 
 # Interface: ColorShade
 

package/docs/api/interfaces/DataAccessRecord.md

@@ -0,0 +1,96 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / DataAccessRecord
+
+# Interface: DataAccessRecord
+
+## Table of contents
+
+### Properties
+
+- [table](DataAccessRecord.md#table)
+- [operation](DataAccessRecord.md#operation)
+- [userId](DataAccessRecord.md#userid)
+- [scope](DataAccessRecord.md#scope)
+- [allowed](DataAccessRecord.md#allowed)
+- [timestamp](DataAccessRecord.md#timestamp)
+- [query](DataAccessRecord.md#query)
+- [filters](DataAccessRecord.md#filters)
+
+## Properties
+
+### table
+
+• **table**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L65)
+
+___
+
+### operation
+
+• **operation**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L66)
+
+___
+
+### userId
+
+• **userId**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L67)
+
+___
+
+### scope
+
+• **scope**: [`Scope`](../modules.md#scope)
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L68)
+
+___
+
+### allowed
+
+• **allowed**: `boolean`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L69)
+
+___
+
+### timestamp
+
+• **timestamp**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L70)
+
+___
+
+### query
+
+• `Optional` **query**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L71)
+
+___
+
+### filters
+
+• `Optional` **filters**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L72)

package/docs/api/interfaces/DataTableAction.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / DataTableAction
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / DataTableAction
 
 # Interface: DataTableAction\<TData\>
 

package/docs/api/interfaces/DataTableColumn.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / DataTableColumn
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / DataTableColumn
 
 # Interface: DataTableColumn\<TData\>
 

package/docs/api/interfaces/DataTableProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / DataTableProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / DataTableProps
 
 # Interface: DataTableProps\<TData\>
 

package/docs/api/interfaces/DataTableToolbarButton.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / DataTableToolbarButton
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / DataTableToolbarButton
 
 # Interface: DataTableToolbarButton
 

package/docs/api/interfaces/EmptyStateConfig.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / EmptyStateConfig
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / EmptyStateConfig
 
 # Interface: EmptyStateConfig