@jmruthers/pace-core 0.2.4

package/docs/api/interfaces/Organisation.md

@@ -0,0 +1,140 @@
+[@jmruthers/pace-core - v0.2.4](../README.md) / [Exports](../modules.md) / Organisation
+
+# Interface: Organisation
+
+## Table of contents
+
+### Properties
+
+- [id](Organisation.md#id)
+- [name](Organisation.md#name)
+- [display\_name](Organisation.md#display_name)
+- [description](Organisation.md#description)
+- [parent\_id](Organisation.md#parent_id)
+- [subscription\_tier](Organisation.md#subscription_tier)
+- [settings](Organisation.md#settings)
+- [is\_active](Organisation.md#is_active)
+- [created\_at](Organisation.md#created_at)
+- [updated\_at](Organisation.md#updated_at)
+- [created\_by](Organisation.md#created_by)
+- [updated\_by](Organisation.md#updated_by)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:9](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L9)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:10](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L10)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:11](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L11)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:12](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L12)
+
+___
+
+### parent\_id
+
+• `Optional` **parent\_id**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:13](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L13)
+
+___
+
+### subscription\_tier
+
+• **subscription\_tier**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L14)
+
+___
+
+### settings
+
+• **settings**: `Record`\<`string`, `unknown`\>
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L15)
+
+___
+
+### is\_active
+
+• **is\_active**: `boolean`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:16](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L16)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:17](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L17)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:18](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L18)
+
+___
+
+### created\_by
+
+• `Optional` **created\_by**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:19](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L19)
+
+___
+
+### updated\_by
+
+• `Optional` **updated\_by**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L20)

package/docs/api/interfaces/OrganisationContextType.md

@@ -0,0 +1,377 @@
+[@jmruthers/pace-core - v0.2.4](../README.md) / [Exports](../modules.md) / OrganisationContextType
+
+# Interface: OrganisationContextType
+
+## Table of contents
+
+### Properties
+
+- [selectedOrganisation](OrganisationContextType.md#selectedorganisation)
+- [organisations](OrganisationContextType.md#organisations)
+- [userMemberships](OrganisationContextType.md#usermemberships)
+- [isLoading](OrganisationContextType.md#isloading)
+- [error](OrganisationContextType.md#error)
+- [hasValidOrganisationContext](OrganisationContextType.md#hasvalidorganisationcontext)
+- [setSelectedOrganisation](OrganisationContextType.md#setselectedorganisation)
+- [switchOrganisation](OrganisationContextType.md#switchorganisation)
+- [getUserRole](OrganisationContextType.md#getuserrole)
+- [validateOrganisationAccess](OrganisationContextType.md#validateorganisationaccess)
+- [ensureOrganisationContext](OrganisationContextType.md#ensureorganisationcontext)
+- [refreshOrganisations](OrganisationContextType.md#refreshorganisations)
+- [getPrimaryOrganisation](OrganisationContextType.md#getprimaryorganisation)
+- [isOrganisationSecure](OrganisationContextType.md#isorganisationsecure)
+- [getOrganisationHierarchy](OrganisationContextType.md#getorganisationhierarchy)
+- [canAccessChildOrganisations](OrganisationContextType.md#canaccesschildorganisations)
+- [validateUserAccess](OrganisationContextType.md#validateuseraccess)
+- [getUserPermissions](OrganisationContextType.md#getuserpermissions)
+- [logOrganisationAccess](OrganisationContextType.md#logorganisationaccess)
+
+## Properties
+
+### selectedOrganisation
+
+• **selectedOrganisation**: [`Organisation`](Organisation.md)
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L106)
+
+___
+
+### organisations
+
+• **organisations**: [`Organisation`](Organisation.md)[]
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:107](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L107)
+
+___
+
+### userMemberships
+
+• **userMemberships**: [`OrganisationMembership`](OrganisationMembership.md)[]
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L108)
+
+___
+
+### isLoading
+
+• **isLoading**: `boolean`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:111](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L111)
+
+___
+
+### error
+
+• **error**: ``null`` \| `Error`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L112)
+
+___
+
+### hasValidOrganisationContext
+
+• **hasValidOrganisationContext**: `boolean`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:113](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L113)
+
+___
+
+### setSelectedOrganisation
+
+• **setSelectedOrganisation**: (`org`: [`Organisation`](Organisation.md)) => `void`
+
+#### Type declaration
+
+▸ (`org`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `org` | [`Organisation`](Organisation.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L116)
+
+___
+
+### switchOrganisation
+
+• **switchOrganisation**: (`orgId`: `string`) => `Promise`\<`void`\>
+
+#### Type declaration
+
+▸ (`orgId`): `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `orgId` | `string` |
+
+##### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L117)
+
+___
+
+### getUserRole
+
+• **getUserRole**: (`orgId?`: `string`) => `string`
+
+#### Type declaration
+
+▸ (`orgId?`): `string`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `orgId?` | `string` |
+
+##### Returns
+
+`string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:120](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L120)
+
+___
+
+### validateOrganisationAccess
+
+• **validateOrganisationAccess**: (`orgId`: `string`) => `boolean`
+
+#### Type declaration
+
+▸ (`orgId`): `boolean`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `orgId` | `string` |
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L121)
+
+___
+
+### ensureOrganisationContext
+
+• **ensureOrganisationContext**: () => [`Organisation`](Organisation.md)
+
+#### Type declaration
+
+▸ (): [`Organisation`](Organisation.md)
+
+##### Returns
+
+[`Organisation`](Organisation.md)
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:122](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L122)
+
+___
+
+### refreshOrganisations
+
+• **refreshOrganisations**: () => `Promise`\<`void`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`void`\>
+
+##### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L125)
+
+___
+
+### getPrimaryOrganisation
+
+• **getPrimaryOrganisation**: () => ``null`` \| [`Organisation`](Organisation.md)
+
+#### Type declaration
+
+▸ (): ``null`` \| [`Organisation`](Organisation.md)
+
+##### Returns
+
+``null`` \| [`Organisation`](Organisation.md)
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:126](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L126)
+
+___
+
+### isOrganisationSecure
+
+• **isOrganisationSecure**: () => `boolean`
+
+#### Type declaration
+
+▸ (): `boolean`
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:127](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L127)
+
+___
+
+### getOrganisationHierarchy
+
+• `Optional` **getOrganisationHierarchy**: (`orgId`: `string`) => `Promise`\<`OrganisationHierarchy`[]\>
+
+#### Type declaration
+
+▸ (`orgId`): `Promise`\<`OrganisationHierarchy`[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `orgId` | `string` |
+
+##### Returns
+
+`Promise`\<`OrganisationHierarchy`[]\>
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:130](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L130)
+
+___
+
+### canAccessChildOrganisations
+
+• `Optional` **canAccessChildOrganisations**: (`orgId`: `string`) => `boolean`
+
+#### Type declaration
+
+▸ (`orgId`): `boolean`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `orgId` | `string` |
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:131](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L131)
+
+___
+
+### validateUserAccess
+
+• `Optional` **validateUserAccess**: (`userId`: `string`, `orgId`: `string`) => `Promise`\<`boolean`\>
+
+#### Type declaration
+
+▸ (`userId`, `orgId`): `Promise`\<`boolean`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `userId` | `string` |
+| `orgId` | `string` |
+
+##### Returns
+
+`Promise`\<`boolean`\>
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:132](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L132)
+
+___
+
+### getUserPermissions
+
+• `Optional` **getUserPermissions**: (`orgId?`: `string`) => `Promise`\<`string`[]\>
+
+#### Type declaration
+
+▸ (`orgId?`): `Promise`\<`string`[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `orgId?` | `string` |
+
+##### Returns
+
+`Promise`\<`string`[]\>
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:133](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L133)
+
+___
+
+### logOrganisationAccess
+
+• `Optional` **logOrganisationAccess**: (`action`: `string`, `details?`: `unknown`) => `Promise`\<`void`\>
+
+#### Type declaration
+
+▸ (`action`, `details?`): `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | `string` |
+| `details?` | `unknown` |
+
+##### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:134](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L134)

package/docs/api/interfaces/OrganisationMembership.md

@@ -0,0 +1,140 @@
+[@jmruthers/pace-core - v0.2.4](../README.md) / [Exports](../modules.md) / OrganisationMembership
+
+# Interface: OrganisationMembership
+
+## Table of contents
+
+### Properties
+
+- [id](OrganisationMembership.md#id)
+- [user\_id](OrganisationMembership.md#user_id)
+- [organisation\_id](OrganisationMembership.md#organisation_id)
+- [role](OrganisationMembership.md#role)
+- [status](OrganisationMembership.md#status)
+- [granted\_at](OrganisationMembership.md#granted_at)
+- [granted\_by](OrganisationMembership.md#granted_by)
+- [revoked\_at](OrganisationMembership.md#revoked_at)
+- [revoked\_by](OrganisationMembership.md#revoked_by)
+- [notes](OrganisationMembership.md#notes)
+- [created\_at](OrganisationMembership.md#created_at)
+- [updated\_at](OrganisationMembership.md#updated_at)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L24)
+
+___
+
+### user\_id
+
+• **user\_id**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L25)
+
+___
+
+### organisation\_id
+
+• **organisation\_id**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L26)
+
+___
+
+### role
+
+• **role**: ``"org_admin"`` \| ``"leader"`` \| ``"member"`` \| ``"supporter"``
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L27)
+
+___
+
+### status
+
+• **status**: ``"active"`` \| ``"inactive"`` \| ``"suspended"``
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L28)
+
+___
+
+### granted\_at
+
+• **granted\_at**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L29)
+
+___
+
+### granted\_by
+
+• `Optional` **granted\_by**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L30)
+
+___
+
+### revoked\_at
+
+• `Optional` **revoked\_at**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L31)
+
+___
+
+### revoked\_by
+
+• `Optional` **revoked\_by**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:32](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L32)
+
+___
+
+### notes
+
+• `Optional` **notes**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:33](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L33)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:34](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L34)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L35)

package/docs/api/interfaces/OrganisationProviderProps.md

@@ -0,0 +1,19 @@
+[@jmruthers/pace-core - v0.2.4](../README.md) / [Exports](../modules.md) / OrganisationProviderProps
+
+# Interface: OrganisationProviderProps
+
+## Table of contents
+
+### Properties
+
+- [children](OrganisationProviderProps.md#children)
+
+## Properties
+
+### children
+
+• **children**: `ReactNode`
+
+#### Defined in
+
+[packages/core/src/types/organisation.ts:138](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L138)