From b843775ef9c6fc397f4cea7b9531e150d3cabf55 Mon Sep 17 00:00:00 2001 From: gmaclennan Date: Tue, 21 Oct 2025 14:25:07 +0000 Subject: [PATCH] Release v4.4.1-0 --- docs/api/md/-internal-/README.md | 2 +- docs/api/md/-internal-/classes/CoreManager.md | 4 +-- docs/api/md/-internal-/classes/DataType.md | 6 ++-- docs/api/md/-internal-/classes/Downloader.md | 2 +- .../api/md/-internal-/classes/MapeoProject.md | 36 ++++++++++++++++--- .../README.md | 2 +- .../{kClearDataIfLeft.md => kClearData.md} | 6 ++-- .../md/-internal-/type-aliases/BlobFilter.md | 9 ----- .../-internal-/type-aliases/ListedProject.md | 28 +-------------- .../type-aliases/ListedProjectSettings.md | 11 ++++++ .../md/-internal-/type-aliases/ProjectInfo.md | 2 +- .../type-aliases/ProjectToAddDetails.md | 4 +++ docs/api/md/classes/MapeoManager.md | 8 ++++- package-lock.json | 4 +-- package.json | 2 +- 15 files changed, 69 insertions(+), 57 deletions(-) rename docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/variables/{kClearDataIfLeft.md => kClearData.md} (54%) delete mode 100644 docs/api/md/-internal-/type-aliases/BlobFilter.md create mode 100644 docs/api/md/-internal-/type-aliases/ListedProjectSettings.md diff --git a/docs/api/md/-internal-/README.md b/docs/api/md/-internal-/README.md index 9846c2e78..c34d8c2fb 100644 --- a/docs/api/md/-internal-/README.md +++ b/docs/api/md/-internal-/README.md @@ -91,7 +91,6 @@ - [AddProjectQuery](type-aliases/AddProjectQuery.md) - [Attachment](type-aliases/Attachment.md) - [BitField](type-aliases/BitField.md) -- [BlobFilter](type-aliases/BlobFilter.md) - [BlobIdBase](type-aliases/BlobIdBase.md) - [BlobStoreEntriesStream](type-aliases/BlobStoreEntriesStream.md) - [BlobType](type-aliases/BlobType.md) @@ -117,6 +116,7 @@ - [Keypair](type-aliases/Keypair.md) - [KeyPair](type-aliases/KeyPair-1.md) - [ListedProject](type-aliases/ListedProject.md) +- [ListedProjectSettings](type-aliases/ListedProjectSettings.md) - [MapeoDocTableName](type-aliases/MapeoDocTableName.md) - [MapeoDocTables](type-aliases/MapeoDocTables.md) - [Namespace](type-aliases/Namespace.md) diff --git a/docs/api/md/-internal-/classes/CoreManager.md b/docs/api/md/-internal-/classes/CoreManager.md index b07663159..3a656fbd7 100644 --- a/docs/api/md/-internal-/classes/CoreManager.md +++ b/docs/api/md/-internal-/classes/CoreManager.md @@ -24,7 +24,7 @@ Immediately start downloading cores - should only be set to false for tests -• **options.db**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> +• **options.db**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>, `any`\> Drizzle better-sqlite3 database instance @@ -249,7 +249,7 @@ Resolves when all cores have finished loading #### Parameters -• **blobFilter**: `null` \| [`BlobFilter`](../type-aliases/BlobFilter.md) +• **blobFilter**: `null` \| `_RequireAtLeastOne`\<`object`, `"photo"` \| `"video"` \| `"audio"`\> • **peer**: [`HypercorePeer`](../type-aliases/HypercorePeer.md) diff --git a/docs/api/md/-internal-/classes/DataType.md b/docs/api/md/-internal-/classes/DataType.md index 22eb96c98..6cc525d08 100644 --- a/docs/api/md/-internal-/classes/DataType.md +++ b/docs/api/md/-internal-/classes/DataType.md @@ -34,7 +34,7 @@ • **opts.dataStore**: `TDataStore` -• **opts.db**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> +• **opts.db**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>, `any`\> • **opts.getDeviceIdForVersionId** @@ -116,11 +116,11 @@ only used internally to skip the checkExisting check when creating a document wi ### \[kSelect\]() -> **\[kSelect\]**(): `Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, `"sync"`, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, `"single"`, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`, `false`, `never`, `{ [K in string]: { [Key in string]: SelectResultField[Key], true> }[K] }`[], `BuildSubquerySelection`\<`GetSelectTableSelection`\<`TTable`\>, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`\>\>, `"then"` \| `"catch"` \| `"finally"`\> & `object`\> +> **\[kSelect\]**(): `Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, `"sync"`, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, `"single"`, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`, `false`, `never`, \{ \[K in string \| number \| symbol\]: \{ \[Key in string \| number \| symbol\]: SelectResultField\\[Key\], true\> \}\[K\] \}[], `BuildSubquerySelection`\<`GetSelectTableSelection`\<`TTable`\>, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`\>\>, `"then"` \| `"catch"` \| `"finally"`\> & `object`\> #### Returns -`Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, `"sync"`, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, `"single"`, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`, `false`, `never`, `{ [K in string]: { [Key in string]: SelectResultField[Key], true> }[K] }`[], `BuildSubquerySelection`\<`GetSelectTableSelection`\<`TTable`\>, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`\>\>, `"then"` \| `"catch"` \| `"finally"`\> & `object`\> +`Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, `"sync"`, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, `"single"`, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`, `false`, `never`, \{ \[K in string \| number \| symbol\]: \{ \[Key in string \| number \| symbol\]: SelectResultField\\[Key\], true\> \}\[K\] \}[], `BuildSubquerySelection`\<`GetSelectTableSelection`\<`TTable`\>, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`\>\>, `"then"` \| `"catch"` \| `"finally"`\> & `object`\> *** diff --git a/docs/api/md/-internal-/classes/Downloader.md b/docs/api/md/-internal-/classes/Downloader.md index 93aea1509..21ff7c609 100644 --- a/docs/api/md/-internal-/classes/Downloader.md +++ b/docs/api/md/-internal-/classes/Downloader.md @@ -39,7 +39,7 @@ downloading deleted and previous versions may be desirable behavior anyway • **options?** = `{}` -• **options.filter?**: `undefined` \| `null` \| [`BlobFilter`](../type-aliases/BlobFilter.md) +• **options.filter?**: `undefined` \| `null` \| `_RequireAtLeastOne`\<`object`, `"photo"` \| `"video"` \| `"audio"`\> Filter blobs of specific types and/or sizes to download diff --git a/docs/api/md/-internal-/classes/MapeoProject.md b/docs/api/md/-internal-/classes/MapeoProject.md index 781252a72..45b5c7f87 100644 --- a/docs/api/md/-internal-/classes/MapeoProject.md +++ b/docs/api/md/-internal-/classes/MapeoProject.md @@ -32,6 +32,8 @@ Path to store project sqlite db. Use `:memory:` for memory storage Encryption keys for each namespace +• **opts.getFallbackProjectInfo** + • **opts.getMediaBaseUrl** • **opts.isArchiveDevice**: `boolean` @@ -60,7 +62,7 @@ path for drizzle migration folder for project 32-byte secret key of the project creator core -• **opts.sharedDb**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> +• **opts.sharedDb**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>, `any`\> • **opts.sharedIndexWriter**: [`IndexWriter`](IndexWriter.md)\<[`MapeoDocTables`](../type-aliases/MapeoDocTables.md)\> @@ -84,6 +86,12 @@ path for drizzle migration folder for project > `static` **EMPTY\_PROJECT\_SETTINGS**: `Readonly`\<`object`\> +#### Type declaration + +##### sendStats + +> **sendStats**: `false` = `false` + ## Accessors ### \[kBlobStore\] @@ -286,11 +294,11 @@ DataTypes object mappings, used for tests ## Methods -### \[kClearDataIfLeft\]() +### \[kClearData\]() -> **\[kClearDataIfLeft\]**(): `Promise`\<`void`\> +> **\[kClearData\]**(): `Promise`\<`void`\> -Clear data if we've left the project. No-op if you're still in the project. +Clear synced data, but keep auth data and own data #### Returns @@ -410,6 +418,22 @@ and only this project will replicate. *** +### $importCategories() + +> **$importCategories**(`opts`): `Promise`\<`void`\> + +#### Parameters + +• **opts** + +• **opts.filePath**: `string` + +#### Returns + +`Promise`\<`void`\> + +*** + ### ~~$originalVersionIdToDeviceId()~~ > **$originalVersionIdToDeviceId**(`originalVersionId`): `Promise`\<`string`\> @@ -526,7 +550,7 @@ The full path that the file was exported at *** -### importConfig() +### ~~importConfig()~~ > **importConfig**(`opts`): `Promise`\<`Error`[]\> @@ -540,6 +564,8 @@ The full path that the file was exported at `Promise`\<`Error`[]\> +#### Deprecated + *** ### ready() diff --git a/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/README.md b/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/README.md index 9830200ae..c2efb7e6d 100644 --- a/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/README.md +++ b/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/README.md @@ -22,7 +22,7 @@ ### Variables - [kBlobStore](variables/kBlobStore.md) -- [kClearDataIfLeft](variables/kClearDataIfLeft.md) +- [kClearData](variables/kClearData.md) - [kCoreManager](variables/kCoreManager.md) - [kCoreOwnership](variables/kCoreOwnership.md) - [kDataTypes](variables/kDataTypes.md) diff --git a/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/variables/kClearDataIfLeft.md b/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/variables/kClearData.md similarity index 54% rename from docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/variables/kClearDataIfLeft.md rename to docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/variables/kClearData.md index 29265b00a..ba1bc8b6d 100644 --- a/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/variables/kClearDataIfLeft.md +++ b/docs/api/md/-internal-/namespaces/home_runner_work_comapeo-core_comapeo-core_src_mapeo-project/variables/kClearData.md @@ -2,8 +2,8 @@ *** -[API](../../../../README.md) / [\](../../../README.md) / ["/home/runner/work/comapeo-core/comapeo-core/src/mapeo-project"](../README.md) / kClearDataIfLeft +[API](../../../../README.md) / [\](../../../README.md) / ["/home/runner/work/comapeo-core/comapeo-core/src/mapeo-project"](../README.md) / kClearData -# Variable: kClearDataIfLeft +# Variable: kClearData -> `const` **kClearDataIfLeft**: *typeof* [`kClearDataIfLeft`](kClearDataIfLeft.md) +> `const` **kClearData**: *typeof* [`kClearData`](kClearData.md) diff --git a/docs/api/md/-internal-/type-aliases/BlobFilter.md b/docs/api/md/-internal-/type-aliases/BlobFilter.md deleted file mode 100644 index 07b115fb0..000000000 --- a/docs/api/md/-internal-/type-aliases/BlobFilter.md +++ /dev/null @@ -1,9 +0,0 @@ -[**API**](../../README.md) • **Docs** - -*** - -[API](../../README.md) / [\](../README.md) / BlobFilter - -# Type Alias: BlobFilter - -> **BlobFilter**: `RequireAtLeastOne`\<`{ [KeyType in BlobType]: BlobVariant[] }`\> diff --git a/docs/api/md/-internal-/type-aliases/ListedProject.md b/docs/api/md/-internal-/type-aliases/ListedProject.md index 90697be44..50981bab5 100644 --- a/docs/api/md/-internal-/type-aliases/ListedProject.md +++ b/docs/api/md/-internal-/type-aliases/ListedProject.md @@ -6,32 +6,6 @@ # Type Alias: ListedProject -> **ListedProject**\<\>: `object` +> **ListedProject**\<\>: [`ListedProjectSettings`](ListedProjectSettings.md) & `object` \| [`ProjectInfo`](ProjectInfo.md) & `object` ## Type Parameters - -## Type declaration - -### createdAt? - -> `optional` **createdAt**: `string` - -### name? - -> `optional` **name**: `string` - -### projectColor? - -> `optional` **projectColor**: `string` - -### projectDescription? - -> `optional` **projectDescription**: `string` - -### projectId - -> **projectId**: `string` - -### updatedAt? - -> `optional` **updatedAt**: `string` diff --git a/docs/api/md/-internal-/type-aliases/ListedProjectSettings.md b/docs/api/md/-internal-/type-aliases/ListedProjectSettings.md new file mode 100644 index 000000000..48258a7e9 --- /dev/null +++ b/docs/api/md/-internal-/type-aliases/ListedProjectSettings.md @@ -0,0 +1,11 @@ +[**API**](../../README.md) • **Docs** + +*** + +[API](../../README.md) / [\](../README.md) / ListedProjectSettings + +# Type Alias: ListedProjectSettings + +> **ListedProjectSettings**\<\>: `Pick`\<`ProjectSettings`, `"createdAt"` \| `"updatedAt"` \| `"name"` \| `"projectColor"` \| `"projectDescription"` \| `"sendStats"`\> + +## Type Parameters diff --git a/docs/api/md/-internal-/type-aliases/ProjectInfo.md b/docs/api/md/-internal-/type-aliases/ProjectInfo.md index bc9e42362..b056cb9af 100644 --- a/docs/api/md/-internal-/type-aliases/ProjectInfo.md +++ b/docs/api/md/-internal-/type-aliases/ProjectInfo.md @@ -6,6 +6,6 @@ # Type Alias: ProjectInfo -> **ProjectInfo**\<\>: `Pick`\<`ProjectSettings`, `"name"` \| `"projectColor"` \| `"projectDescription"`\> +> **ProjectInfo**\<\>: `Pick`\<`ProjectSettings`, `"name"` \| `"projectColor"` \| `"projectDescription"` \| `"sendStats"`\> ## Type Parameters diff --git a/docs/api/md/-internal-/type-aliases/ProjectToAddDetails.md b/docs/api/md/-internal-/type-aliases/ProjectToAddDetails.md index 9cce8809d..62084913e 100644 --- a/docs/api/md/-internal-/type-aliases/ProjectToAddDetails.md +++ b/docs/api/md/-internal-/type-aliases/ProjectToAddDetails.md @@ -22,4 +22,8 @@ > **projectName**: `string` +### sendStats? + +> `optional` **sendStats**: `boolean` + ## Type Parameters diff --git a/docs/api/md/classes/MapeoManager.md b/docs/api/md/classes/MapeoManager.md index f8a8aceea..022c0bfdd 100644 --- a/docs/api/md/classes/MapeoManager.md +++ b/docs/api/md/classes/MapeoManager.md @@ -240,7 +240,13 @@ isArchiveDevice ### listProjects() -> **listProjects**(): `Promise`\<[`ListedProject`](../-internal-/type-aliases/ListedProject.md)[]\> +> **listProjects**(`opts`?): `Promise`\<[`ListedProject`](../-internal-/type-aliases/ListedProject.md)[]\> + +#### Parameters + +• **opts?** = `{}` + +• **opts.includeLeft?**: `boolean` = `false` #### Returns diff --git a/package-lock.json b/package-lock.json index 35bd340ad..49c596f3d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@comapeo/core", - "version": "4.4.0", + "version": "4.4.1-0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@comapeo/core", - "version": "4.4.0", + "version": "4.4.1-0", "license": "MIT", "dependencies": { "@comapeo/fallback-smp": "^1.0.0", diff --git a/package.json b/package.json index 1c65e961f..8844b02aa 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@comapeo/core", - "version": "4.4.0", + "version": "4.4.1-0", "description": "Offline p2p mapping library", "main": "src/index.js", "types": "dist/index.d.ts",