Skip to content

Commit c109d64

Browse files
author
gmaclennan
committed
Release v4.1.3
1 parent ab68ace commit c109d64

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+447
-173
lines changed

docs/api/md/-internal-/README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
### Namespaces
1212

1313
- ["/home/runner/work/comapeo-core/comapeo-core/src/local-peers"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_local-peers/README.md)
14+
- ["/home/runner/work/comapeo-core/comapeo-core/src/mapeo-project"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/README.md)
1415
- ["/home/runner/work/comapeo-core/comapeo-core/src/schema/client"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_client/README.md)
1516
- ["/home/runner/work/comapeo-core/comapeo-core/src/schema/project"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_project/README.md)
1617
- ["/home/runner/work/comapeo-core/comapeo-core/src/sync/core-sync-state"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_sync_core-sync-state/README.md)
@@ -66,8 +67,6 @@
6667
### Interfaces
6768

6869
- [AbstractEncoding](interfaces/AbstractEncoding.md)
69-
- [BitmapOpts](interfaces/BitmapOpts.md)
70-
- [BlobRef](interfaces/BlobRef.md)
7170
- [Channel](interfaces/Channel.md)
7271
- [Context](interfaces/Context.md)
7372
- [CorestoreEvents](interfaces/CorestoreEvents.md)
@@ -78,28 +77,23 @@
7877
- [HyperdriveOptions](interfaces/HyperdriveOptions.md)
7978
- [LocalCoreState](interfaces/LocalCoreState.md)
8079
- [MapsPluginOpts](interfaces/MapsPluginOpts.md)
81-
- [MemberInfo](interfaces/MemberInfo.md)
8280
- [Message](interfaces/Message.md)
83-
- [Metadata](interfaces/Metadata.md)
8481
- [PeerInfoBase](interfaces/PeerInfoBase.md)
8582
- [RemoteDeviceNamespaceGroupSyncState](interfaces/RemoteDeviceNamespaceGroupSyncState.md)
8683
- [RemoteDeviceSyncState](interfaces/RemoteDeviceSyncState.md)
8784
- [Role](interfaces/Role.md)
8885
- [StartOpts](interfaces/StartOpts.md)
8986
- [State](interfaces/State.md)
90-
- [SvgOpts](interfaces/SvgOpts.md)
9187

9288
### Type Aliases
9389

9490
- [AddProjectQuery](type-aliases/AddProjectQuery.md)
9591
- [Attachment](type-aliases/Attachment.md)
9692
- [BitField](type-aliases/BitField.md)
9793
- [BlobFilter](type-aliases/BlobFilter.md)
98-
- [BlobId](type-aliases/BlobId.md)
9994
- [BlobIdBase](type-aliases/BlobIdBase.md)
10095
- [BlobStoreEntriesStream](type-aliases/BlobStoreEntriesStream.md)
10196
- [BlobType](type-aliases/BlobType.md)
102-
- [BlobVariant](type-aliases/BlobVariant.md)
10397
- [Chunk](type-aliases/Chunk.md)
10498
- [Core](type-aliases/Core.md)
10599
- [CoreOwnershipWithSignatures](type-aliases/CoreOwnershipWithSignatures.md)
@@ -108,7 +102,6 @@
108102
- [CoreStorage](type-aliases/CoreStorage.md)
109103
- [DeviceInfoDataType](type-aliases/DeviceInfoDataType.md)
110104
- [DeviceInfoParam](type-aliases/DeviceInfoParam.md)
111-
- [EditableProjectSettings](type-aliases/EditableProjectSettings.md)
112105
- [ElementOf](type-aliases/ElementOf.md)
113106
- [Encoding](type-aliases/Encoding.md)
114107
- [GenericBlobFilter](type-aliases/GenericBlobFilter.md)
@@ -119,7 +112,6 @@
119112
- [HypercoreRemoteBitfieldPage](type-aliases/HypercoreRemoteBitfieldPage.md)
120113
- [IconVariant](type-aliases/IconVariant.md)
121114
- [IndexedDocIds](type-aliases/IndexedDocIds.md)
122-
- [Invite](type-aliases/Invite.md)
123115
- [InviteInternal](type-aliases/InviteInternal.md)
124116
- [Keypair](type-aliases/Keypair.md)
125117
- [KeyPair](type-aliases/KeyPair-1.md)
@@ -142,10 +134,8 @@
142134
- [RawStream](type-aliases/RawStream.md)
143135
- [Readable](type-aliases/Readable.md)
144136
- [ReplicationStream](type-aliases/ReplicationStream.md)
145-
- [RoleId](type-aliases/RoleId.md)
146137
- [SchemaName](type-aliases/SchemaName.md)
147138
- [SecretKey](type-aliases/SecretKey.md)
148-
- [SeenAttachments](type-aliases/SeenAttachments.md)
149139
- [State](type-aliases/State.md)
150140
- [SupportedBlobVariants](type-aliases/SupportedBlobVariants.md)
151141
- [SyncCapability](type-aliases/SyncCapability.md)
@@ -158,6 +148,7 @@
158148
- [NAMESPACE\_SCHEMAS](variables/NAMESPACE_SCHEMAS.md)
159149
- [NAMESPACES](variables/NAMESPACES.md)
160150
- [ROLE\_IDS](variables/ROLE_IDS.md)
151+
- [ROLE\_IDS\_FOR\_NEW\_INVITE](variables/ROLE_IDS_FOR_NEW_INVITE.md)
161152
- [SUPPORTED\_BLOB\_VARIANTS](variables/SUPPORTED_BLOB_VARIANTS.md)
162153

163154
## References

docs/api/md/-internal-/classes/BlobApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Write blobs for provided variants of a file
4242

4343
**filepaths.thumbnail?**: `string`
4444

45-
**metadata**: [`Metadata`](../interfaces/Metadata.md)
45+
**metadata**: [`Metadata`](../../namespaces/BlobApi/interfaces/Metadata.md)
4646

4747
#### Returns
4848

@@ -74,7 +74,7 @@ Get a url for a blob based on its BlobId
7474

7575
#### Parameters
7676

77-
**blobId**: [`BlobId`](../type-aliases/BlobId.md)
77+
**blobId**: [`BlobId`](../../namespaces/BlobApi/type-aliases/BlobId.md)
7878

7979
#### Returns
8080

docs/api/md/-internal-/classes/BlobStore.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Set to `true` if this is an archive device which should download all blobs, or j
6464
6565
#### Parameters
6666

67-
**blobId**: [`BlobId`](../type-aliases/BlobId.md)
67+
**blobId**: [`BlobId`](../../namespaces/BlobApi/type-aliases/BlobId.md)
6868

6969
**options?** = `{}`
7070

@@ -119,7 +119,7 @@ Set to `true` to get a live stream of entries
119119
120120
#### Parameters
121121

122-
**blobId**: [`BlobId`](../type-aliases/BlobId.md)
122+
**blobId**: [`BlobId`](../../namespaces/BlobApi/type-aliases/BlobId.md)
123123

124124
**options?** = `...`
125125

@@ -172,7 +172,7 @@ Set to `true` to wait for a blob to download, otherwise will throw if blob is no
172172
173173
#### Parameters
174174

175-
**blobId**: `Omit`\<[`BlobId`](../type-aliases/BlobId.md), `"driveId"`\>
175+
**blobId**: `Omit`\<[`BlobId`](../../namespaces/BlobApi/type-aliases/BlobId.md), `"driveId"`\>
176176

177177
**options?**
178178

@@ -192,7 +192,7 @@ Metadata to store with the blob
192192
193193
#### Parameters
194194

195-
**blobId**: [`BlobId`](../type-aliases/BlobId.md)
195+
**blobId**: [`BlobId`](../../namespaces/BlobApi/type-aliases/BlobId.md)
196196

197197
**options?** = `...`
198198

@@ -220,7 +220,7 @@ Set to `true` to wait for a blob to download, otherwise will throw if blob is no
220220
221221
#### Parameters
222222

223-
**blobId**: [`BlobId`](../type-aliases/BlobId.md)
223+
**blobId**: [`BlobId`](../../namespaces/BlobApi/type-aliases/BlobId.md)
224224

225225
**opts** = `{}`
226226

@@ -282,7 +282,7 @@ Hyperdrive entry
282282
283283
#### Parameters
284284

285-
**blobId**: `Omit`\<[`BlobId`](../type-aliases/BlobId.md), `"driveId"`\>
285+
**blobId**: `Omit`\<[`BlobId`](../../namespaces/BlobApi/type-aliases/BlobId.md), `"driveId"`\>
286286

287287
**blob**: `Buffer`
288288

docs/api/md/-internal-/classes/IconApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
**iconId**: `string`
3838

39-
**opts**: [`BitmapOpts`](../interfaces/BitmapOpts.md) \| [`SvgOpts`](../interfaces/SvgOpts.md)
39+
**opts**: [`BitmapOpts`](../../namespaces/IconApi/interfaces/BitmapOpts.md) \| [`SvgOpts`](../../namespaces/IconApi/interfaces/SvgOpts.md)
4040

4141
#### Returns
4242

@@ -54,7 +54,7 @@
5454

5555
**icon.name**: `string`
5656

57-
**icon.variants**: [`BitmapOpts`](../interfaces/BitmapOpts.md) \| [`SvgOpts`](../interfaces/SvgOpts.md) & `object`[]
57+
**icon.variants**: [`BitmapOpts`](../../namespaces/IconApi/interfaces/BitmapOpts.md) \| [`SvgOpts`](../../namespaces/IconApi/interfaces/SvgOpts.md) & `object`[]
5858

5959
#### Returns
6060

@@ -70,7 +70,7 @@
7070

7171
**iconId**: `string`
7272

73-
**opts**: [`BitmapOpts`](../interfaces/BitmapOpts.md) \| [`SvgOpts`](../interfaces/SvgOpts.md)
73+
**opts**: [`BitmapOpts`](../../namespaces/IconApi/interfaces/BitmapOpts.md) \| [`SvgOpts`](../../namespaces/IconApi/interfaces/SvgOpts.md)
7474

7575
#### Returns
7676

docs/api/md/-internal-/classes/InviteApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ part of this project.
6161

6262
#### Parameters
6363

64-
**invite**: `Pick`\<[`Invite`](../type-aliases/Invite.md), `"inviteId"`\>
64+
**invite**: `Pick`\<[`Invite`](../../namespaces/InviteApi/type-aliases/Invite.md), `"inviteId"`\>
6565

6666
#### Returns
6767

@@ -71,7 +71,7 @@ part of this project.
7171

7272
### getById()
7373

74-
> **getById**(`inviteIdString`): [`Invite`](../type-aliases/Invite.md)
74+
> **getById**(`inviteIdString`): [`Invite`](../../namespaces/InviteApi/type-aliases/Invite.md)
7575
7676
Get an invite by inviteId
7777

@@ -81,19 +81,19 @@ Get an invite by inviteId
8181

8282
#### Returns
8383

84-
[`Invite`](../type-aliases/Invite.md)
84+
[`Invite`](../../namespaces/InviteApi/type-aliases/Invite.md)
8585

8686
***
8787

8888
### getMany()
8989

90-
> **getMany**(): [`Invite`](../type-aliases/Invite.md)[]
90+
> **getMany**(): [`Invite`](../../namespaces/InviteApi/type-aliases/Invite.md)[]
9191
9292
Get all invites (in all)
9393

9494
#### Returns
9595

96-
[`Invite`](../type-aliases/Invite.md)[]
96+
[`Invite`](../../namespaces/InviteApi/type-aliases/Invite.md)[]
9797

9898
***
9999

@@ -103,7 +103,7 @@ Get all invites (in all)
103103
104104
#### Parameters
105105

106-
**invite**: `Pick`\<[`Invite`](../type-aliases/Invite.md), `"inviteId"`\>
106+
**invite**: `Pick`\<[`Invite`](../../namespaces/InviteApi/type-aliases/Invite.md), `"inviteId"`\>
107107

108108
#### Returns
109109

docs/api/md/-internal-/classes/MapeoProject.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -382,11 +382,11 @@ and only this project will replicate.
382382

383383
### $getProjectSettings()
384384

385-
> **$getProjectSettings**(): `Promise`\<[`EditableProjectSettings`](../type-aliases/EditableProjectSettings.md)\>
385+
> **$getProjectSettings**(): `Promise`\<[`EditableProjectSettings`](../../type-aliases/EditableProjectSettings.md)\>
386386
387387
#### Returns
388388

389-
`Promise`\<[`EditableProjectSettings`](../type-aliases/EditableProjectSettings.md)\>
389+
`Promise`\<[`EditableProjectSettings`](../../type-aliases/EditableProjectSettings.md)\>
390390

391391
***
392392

@@ -424,15 +424,15 @@ When device ID cannot be found.
424424

425425
### $setProjectSettings()
426426

427-
> **$setProjectSettings**(`settings`): `Promise`\<[`EditableProjectSettings`](../type-aliases/EditableProjectSettings.md)\>
427+
> **$setProjectSettings**(`settings`): `Promise`\<[`EditableProjectSettings`](../../type-aliases/EditableProjectSettings.md)\>
428428
429429
#### Parameters
430430

431-
**settings**: `Partial`\<[`EditableProjectSettings`](../type-aliases/EditableProjectSettings.md)\>
431+
**settings**: `Partial`\<[`EditableProjectSettings`](../../type-aliases/EditableProjectSettings.md)\>
432432

433433
#### Returns
434434

435-
`Promise`\<[`EditableProjectSettings`](../type-aliases/EditableProjectSettings.md)\>
435+
`Promise`\<[`EditableProjectSettings`](../../type-aliases/EditableProjectSettings.md)\>
436436

437437
***
438438

docs/api/md/-internal-/classes/MemberApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,25 +117,25 @@ Allow insecure network connections. Should only be used in tests.
117117

118118
### getById()
119119

120-
> **getById**(`deviceId`): `Promise`\<[`MemberInfo`](../interfaces/MemberInfo.md)\>
120+
> **getById**(`deviceId`): `Promise`\<[`MemberInfo`](../../namespaces/MemberApi/interfaces/MemberInfo.md)\>
121121
122122
#### Parameters
123123

124124
**deviceId**: `string`
125125

126126
#### Returns
127127

128-
`Promise`\<[`MemberInfo`](../interfaces/MemberInfo.md)\>
128+
`Promise`\<[`MemberInfo`](../../namespaces/MemberApi/interfaces/MemberInfo.md)\>
129129

130130
***
131131

132132
### getMany()
133133

134-
> **getMany**(): `Promise`\<[`MemberInfo`](../interfaces/MemberInfo.md)[]\>
134+
> **getMany**(): `Promise`\<[`MemberInfo`](../../namespaces/MemberApi/interfaces/MemberInfo.md)[]\>
135135
136136
#### Returns
137137

138-
`Promise`\<[`MemberInfo`](../interfaces/MemberInfo.md)[]\>
138+
`Promise`\<[`MemberInfo`](../../namespaces/MemberApi/interfaces/MemberInfo.md)[]\>
139139

140140
***
141141

docs/api/md/-internal-/interfaces/BitmapOpts.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/api/md/-internal-/interfaces/BlobRef.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/api/md/-internal-/interfaces/Metadata.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)