[OPTIC-RELEASE-AUTOMATION] release/v3.2.0 (#1036)

Release v3.2.0

Co-authored-by: RangerMauve <[email protected]>

Author: optic-release-automation[bot]

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

@@ -93,6 +93,7 @@
 ### Type Aliases
 
 - [AddProjectQuery](type-aliases/AddProjectQuery.md)
+- [Attachment](type-aliases/Attachment.md)
 - [BitField](type-aliases/BitField.md)
 - [BlobFilter](type-aliases/BlobFilter.md)
 - [BlobId](type-aliases/BlobId.md)
@@ -145,6 +146,7 @@
 - [RoleId](type-aliases/RoleId.md)
 - [SchemaName](type-aliases/SchemaName.md)
 - [SecretKey](type-aliases/SecretKey.md)
+- [SeenAttachments](type-aliases/SeenAttachments.md)
 - [State](type-aliases/State.md)
 - [SupportedBlobVariants](type-aliases/SupportedBlobVariants.md)
 - [SyncCapability](type-aliases/SyncCapability.md)

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

@@ -298,6 +298,80 @@ Clear data if we've left the project. No-op if you're still in the project.
 
 ***
 
+### \[kExportGeoJSONStream\]()
+
+> **\[kExportGeoJSONStream\]**(`options`?): `Readable`\<`Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `true`, `false`, `ReadableEvents`\<`Uint8Array` \| `Buffer`\>\>
+
+Export observations and or tracks as a stream of GeoJSON data
+
+#### Parameters
+
+• **options?** = `{}`
+
+• **options.lang?**: `undefined` \| `string`
+
+• **options.observations?**: `undefined` \| `boolean` = `true`
+
+Whether observations should be exported
+
+• **options.seenAttachments?**: `undefined` \| [`SeenAttachments`](../type-aliases/SeenAttachments.md) = `...`
+
+• **options.tracks?**: `undefined` \| `boolean` = `true`
+
+Whether all tracks and their observations should be exported
+
+#### Returns
+
+`Readable`\<`Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `true`, `false`, `ReadableEvents`\<`Uint8Array` \| `Buffer`\>\>
+
+***
+
+### \[kExportZipStream\]()
+
+> **\[kExportZipStream\]**(`options`?): `Readable`\<`Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `true`, `false`, `ReadableEvents`\<`Uint8Array` \| `Buffer`\>\>
+
+Export observations, tracks, and or attachments as a zip file stream.
+
+#### Parameters
+
+• **options?** = `{}`
+
+• **options.attachments?**: `undefined` \| `boolean` = `true`
+
+Whether all attachments for observations should be exported
+
+• **options.lang?**: `undefined` \| `string`
+
+• **options.observations?**: `undefined` \| `boolean` = `true`
+
+Whether observations should be exported
+
+• **options.tracks?**: `undefined` \| `boolean` = `true`
+
+Whether all tracks and their observations should be exported
+
+#### Returns
+
+`Readable`\<`Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `Uint8Array` \| `Buffer`, `true`, `false`, `ReadableEvents`\<`Uint8Array` \| `Buffer`\>\>
+
+***
+
+### \[kGeoJSONFileName\]()
+
+> **\[kGeoJSONFileName\]**(`observations`, `tracks`): `Promise`\<`string`\>
+
+#### Parameters
+
+• **observations**: `boolean`
+
+• **tracks**: `boolean`
+
+#### Returns
+
+`Promise`\<`string`\>
+
+***
+
 ### \[kProjectLeave\]()
 
 > **\[kProjectLeave\]**(): `Promise`\<`void`\>
@@ -420,6 +494,74 @@ When device ID cannot be found.
 
 ***
 
+### exportGeoJSONFile()
+
+> **exportGeoJSONFile**(`exportFolder`, `options`?): `Promise`\<`string`\>
+
+Export observations and or tracks as a GeoJSON file
+
+#### Parameters
+
+• **exportFolder**: `string`
+
+Path to save the file. The file name is auto-generated
+
+• **options?** = `{}`
+
+• **options.lang?**: `undefined` \| `string`
+
+• **options.observations?**: `undefined` \| `boolean` = `true`
+
+Whether observations should be exported
+
+• **options.tracks?**: `undefined` \| `boolean` = `true`
+
+Whether all tracks and their observations should be exported
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The full path that the file was exported at
+
+***
+
+### exportZipFile()
+
+> **exportZipFile**(`exportFolder`, `options`?): `Promise`\<`string`\>
+
+Export observations, tracks, and or attachments as a zip file.
+
+#### Parameters
+
+• **exportFolder**: `string`
+
+Path to save the file. The file name is auto-generated
+
+• **options?** = `{}`
+
+• **options.attachments?**: `undefined` \| `boolean` = `true`
+
+Whether all attachments for observations should be exported
+
+• **options.lang?**: `undefined` \| `string`
+
+• **options.observations?**: `undefined` \| `boolean` = `true`
+
+Whether observations should be exported
+
+• **options.tracks?**: `undefined` \| `boolean` = `true`
+
+Whether all tracks and their observations should be exported
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The full path that the file was exported at
+
+***
+
 ### importConfig()
 
 > **importConfig**(`opts`): `Promise`\<`Error`[]\>

docs/api/md/-internal-/type-aliases/Attachment.md

@@ -0,0 +1,9 @@
+[**API**](../../README.md) • **Docs**
+
+***
+
+[API](../../README.md) / [\<internal\>](../README.md) / Attachment
+
+# Type Alias: Attachment
+
+> **Attachment**: `Observation`\[`"attachments"`\]\[`0`\]

docs/api/md/-internal-/type-aliases/SeenAttachments.md

@@ -0,0 +1,11 @@
+[**API**](../../README.md) • **Docs**
+
+***
+
+[API](../../README.md) / [\<internal\>](../README.md) / SeenAttachments
+
+# Type Alias: SeenAttachments
+
+> **SeenAttachments**\<\>: `Map`\<`string`, [`Attachment`](Attachment.md)\>
+
+## Type Parameters

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@comapeo/core",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "Offline p2p mapping library",
   "main": "src/index.js",
   "types": "dist/index.d.ts",